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 \author -970929547 "Thibaut Cuvelier"
139 \author -712698321 "Jürgen Spitzmüller"
140 \author -495245474 "Jean-Marc Lasgouttes"
142 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
143 \author 1075283030 "Thibaut"
149 Customizing \SpecialChar LyX
150 : Features for the Advanced User
154 by the \SpecialChar LyX
159 \begin_layout Plain Layout
161 If you have comments or error corrections, please send them to the \SpecialChar LyX
164 \begin_inset CommandInset href
166 target "lyx-docs@lists.lyx.org"
174 \begin_inset Quotes eld
178 \begin_inset Quotes erd
181 in the subject header, and please cc the current maintainer of this file,
182 Richard Heck <rgheck@comcast.net>.
188 \begin_inset Newline newline
192 \begin_inset Newline newline
198 \begin_layout Standard
199 \begin_inset CommandInset toc
200 LatexCommand tableofcontents
207 \begin_layout Standard
208 \begin_inset Note Note
211 \begin_layout Plain Layout
212 Please use change tracking when modifying this document.
213 This makes it easier for our translators to recognize things that have
214 been changed, and it helps the maintainer keep up-to-date with what's been
223 \begin_layout Chapter
227 \begin_layout Standard
228 This manual covers the customization features present in \SpecialChar LyX
230 In it, we discuss issues like keyboard shortcuts, screen previewing options,
231 printer options, sending commands to \SpecialChar LyX
232 via the \SpecialChar LyX
233 Server, internationalization,
234 installing new \SpecialChar LaTeX
235 classes and \SpecialChar LyX
237 We can't possibly hope to touch on everything you can change—our developers
238 add new features faster than we can document them—but we will explain the
239 most common customizations and hopefully point you in the right direction
240 for some of the more obscure ones.
243 \begin_layout Standard
244 \begin_inset Branch OutDated
248 \begin_layout Standard
249 Information from previous versions of this document that now seems to be
250 outdated is contained in the OutDated branch of this document.
251 By default, this information will not appear in the \SpecialChar LaTeX
260 \begin_layout Chapter
265 \begin_layout Standard
266 This chapter aims to help you to find your way through the \SpecialChar LyX
269 Before continuing to read this chapter, you should find out where your
271 library and user directories are by using
272 \begin_inset Flex Noun
275 \begin_layout Plain Layout
276 Help\SpecialChar menuseparator
287 The library directory is the place where \SpecialChar LyX
288 places its system-wide configuration
289 files; the user directory is where you can place your modified versions.
290 We will call the former
291 \begin_inset Flex Code
294 \begin_layout Plain Layout
301 \begin_inset Flex Noun
304 \begin_layout Plain Layout
310 in the remainder of this document.
314 \begin_layout Section
316 \begin_inset Flex Code
319 \begin_layout Plain Layout
328 \begin_layout Standard
329 \begin_inset Flex Code
332 \begin_layout Plain Layout
338 and its sub-directories contain a number of files and that can be used
339 to customize \SpecialChar LyX
341 You can change many of these files from within \SpecialChar LyX
343 \begin_inset Flex Noun
346 \begin_layout Plain Layout
347 Tools\SpecialChar menuseparator
354 Most customization that you will want to do in \SpecialChar LyX
355 is possible through this
357 However, many other inner aspects of \SpecialChar LyX
358 can be customized by modifying the
360 \begin_inset Flex Code
363 \begin_layout Plain Layout
370 These files fall in different categories, described in the following subsection
374 \begin_layout Subsection
375 Automatically generated files
378 \begin_layout Standard
379 The files, which are to be found in
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
389 , are generated when you configure \SpecialChar LyX
391 They contain various default values that are guessed by inspection.
392 In general, it is not a good idea to modify them, since they might be overwritt
396 \begin_layout Labeling
397 \labelwidthstring 00.00.0000
398 \begin_inset Flex Code
401 \begin_layout Plain Layout
407 contains defaults for various commands.
410 \begin_layout Labeling
411 \labelwidthstring 00.00.0000
412 \begin_inset Flex Code
415 \begin_layout Plain Layout
421 contains the list of packages that have been recognized by \SpecialChar LyX
423 It is currently unused by the \SpecialChar LyX
424 program itself, but the information extracted,
425 and more, is made available with
426 \begin_inset Flex Noun
429 \begin_layout Plain Layout
430 Help\SpecialChar menuseparator
444 \begin_layout Labeling
445 \labelwidthstring 00.00.0000
446 \begin_inset Flex Code
449 \begin_layout Plain Layout
455 the list of text classes that have been found in your
456 \begin_inset Flex Code
459 \begin_layout Plain Layout
465 directories, along with the associated \SpecialChar LaTeX
466 document class and their description.
469 \begin_layout Labeling
470 \labelwidthstring 00.00.0000
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
480 the list of layout modules found in your
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Labeling
494 \labelwidthstring 00.00.0000
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
504 lists of various sorts of \SpecialChar LaTeX
505 -related files found on your system
508 \begin_layout Labeling
509 \labelwidthstring 00.00.0000
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
514 doc/\SpecialChar LaTeX
520 is automatically generated during configuration from the file
521 \begin_inset Flex Code
524 \begin_layout Plain Layout
532 It contains information on your \SpecialChar LaTeX
536 \begin_layout Subsection
540 \begin_layout Standard
541 These directories are duplicated between
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
552 \begin_inset Flex Code
555 \begin_layout Plain Layout
562 If a particular files exists in both places, the one in
563 \begin_inset Flex Code
566 \begin_layout Plain Layout
575 \begin_layout Labeling
576 \labelwidthstring 00.00.0000
577 \begin_inset Flex Code
580 \begin_layout Plain Layout
586 this directory contains files with the extension
587 \begin_inset Flex Code
590 \begin_layout Plain Layout
596 that define the keybindings used in \SpecialChar LyX
598 If there exists an internationalized version of the bind file named
599 \begin_inset Flex Code
602 \begin_layout Plain Layout
608 , that will be used first.
611 \begin_layout Labeling
612 \labelwidthstring 00.00.0000
613 \begin_inset Flex Code
616 \begin_layout Plain Layout
622 contains files with the extension
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
632 which define the diverse citation possibilities (natbib, biblatex etc.).
634 \begin_inset CommandInset ref
636 reference "subsec:Cite-Engine-Files"
646 \begin_layout Labeling
647 \labelwidthstring 00.00.0000
648 \begin_inset Flex Code
651 \begin_layout Plain Layout
657 contains graphics files that can be included in documents.
661 \begin_layout Labeling
662 \labelwidthstring 00.00.0000
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 contains \SpecialChar LyX
673 documentation files (including the one you are currently reading).
675 \begin_inset Flex Code
678 \begin_layout Plain Layout
685 deserves special attention, as noted above.
686 The internationalized help docs are in subdirectories
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
697 \begin_inset Quotes eld
701 \begin_inset Quotes erd
704 is the ISO language code.
706 \begin_inset CommandInset ref
708 reference "cha:Internationalizing-LyX"
715 \begin_layout Labeling
716 \labelwidthstring 00.00.0000
717 \begin_inset Flex Code
720 \begin_layout Plain Layout
726 contains example files that explain how to use some features.
727 In the file browser, press the
728 \begin_inset Flex Noun
731 \begin_layout Plain Layout
740 \begin_layout Labeling
741 \labelwidthstring 00.00.0000
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 contains image files that are used by the
752 \begin_inset Flex Noun
755 \begin_layout Plain Layout
762 In addition, it also contains the individual icons used in the toolbar
763 and the banners that can be shown when \SpecialChar LyX
767 \begin_layout Labeling
768 \labelwidthstring 00.00.0000
769 \begin_inset Flex Code
772 \begin_layout Plain Layout
778 contains keyboard keymapping files.
780 \begin_inset CommandInset ref
782 reference "sec:International-Keymap-Stuff"
789 \begin_layout Labeling
790 \labelwidthstring 00.00.0000
791 \begin_inset Flex Code
794 \begin_layout Plain Layout
800 contains the text class and module files described in
801 \begin_inset CommandInset ref
803 reference "cha:Installing-New-Document"
810 \begin_layout Labeling
811 \labelwidthstring 00.00.0000
812 \begin_inset Flex Code
815 \begin_layout Plain Layout
822 \begin_inset Flex Code
825 \begin_layout Plain Layout
831 Python scripts used to convert between \SpecialChar LyX
833 These can be run from the command line if, say, you want to batch-convert
837 \begin_layout Labeling
838 \labelwidthstring 00.00.0000
839 \begin_inset Flex Code
842 \begin_layout Plain Layout
848 contains some files that demonstrate the capabilities of the
849 \begin_inset Flex Noun
852 \begin_layout Plain Layout
863 Also contains some scripts used by \SpecialChar LyX
867 \begin_layout Labeling
868 \labelwidthstring 00.00.0000
869 \begin_inset Flex Code
872 \begin_layout Plain Layout
878 contains the standard \SpecialChar LyX
879 template files described in
880 \begin_inset CommandInset ref
882 reference "subsec:Creating-Templates"
889 \begin_layout Labeling
890 \labelwidthstring 00.00.0000
891 \begin_inset Flex Code
894 \begin_layout Plain Layout
900 contains files with the extension
901 \begin_inset Flex Code
904 \begin_layout Plain Layout
910 that define the user interface to \SpecialChar LyX
912 That is, the files define which items appear in which menus and the items
913 appearing on the toolbar.
916 \begin_layout Labeling
917 \labelwidthstring 00.00.0000
918 \begin_inset Flex Code
921 \begin_layout Plain Layout
927 contains files with the extension
928 \begin_inset Flex Code
931 \begin_layout Plain Layout
937 which define the templates for the insertion of external material to a
940 \begin_inset CommandInset ref
942 reference "chap:Including-External-Material"
949 \begin_layout Subsection
950 Files you don't want to modify
953 \begin_layout Standard
954 These files are used internally by \SpecialChar LyX
955 and you generally do not need to modify
956 them unless you are a developer.
959 \begin_layout Labeling
960 \labelwidthstring 00.00.0000
961 \begin_inset Flex Code
964 \begin_layout Plain Layout
970 this file contains the list of \SpecialChar LyX
972 The contents are displayed with the menu entry
973 \begin_inset Flex Noun
976 \begin_layout Plain Layout
977 Help\SpecialChar menuseparator
990 \begin_layout Labeling
991 \labelwidthstring 00.00.0000
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1001 this is a \SpecialChar LaTeX
1002 script used during the configuration process.
1003 Do not run directly.
1006 \begin_layout Labeling
1007 \labelwidthstring 00.00.0000
1008 \begin_inset Flex Code
1011 \begin_layout Plain Layout
1017 this is a Python script that is used to re-configure \SpecialChar LyX
1019 It creates configuration files in the directory it was run from.
1022 \begin_layout Subsection
1023 Other files needing a line or two
1026 \begin_layout Labeling
1027 \labelwidthstring 00.00.0000
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1037 this contains tables describing how different character encodings can be
1041 \begin_layout Labeling
1042 \labelwidthstring 00.00.0000
1043 \begin_inset Flex Code
1046 \begin_layout Plain Layout
1052 this file contains a list of all the languages currently supported by \SpecialChar LyX
1056 \begin_layout Labeling
1057 \labelwidthstring 00.00.0000
1058 \begin_inset Flex Code
1061 \begin_layout Plain Layout
1067 contains information about the supported fonts.
1070 \begin_layout Labeling
1071 \labelwidthstring 00.00.0000
1072 \begin_inset Flex Code
1075 \begin_layout Plain Layout
1081 this file contains translations for internationalized paragraph styles
1083 \begin_inset CommandInset ref
1085 reference "subsec:I18n"
1092 \begin_layout Labeling
1093 \labelwidthstring 00.00.0000
1094 \begin_inset Flex Code
1097 \begin_layout Plain Layout
1103 this file contains information about Unicode-encoded glyphs and the way
1104 they are supported by \SpecialChar LyX
1105 via \SpecialChar LaTeX
1109 \begin_layout Section
1110 Your local configuration directory
1113 \begin_layout Standard
1114 Even if you are using \SpecialChar LyX
1115 as an unprivileged user, you might want to change
1117 configuration for your own use.
1119 \begin_inset Flex Code
1122 \begin_layout Plain Layout
1128 directory contains all your personal configuration files.
1129 This is the directory described as
1130 \begin_inset Quotes eld
1134 \begin_inset Quotes erd
1138 \begin_inset Flex Noun
1141 \begin_layout Plain Layout
1142 Help\SpecialChar menuseparator
1144 \begin_inset space ~
1153 This directory is used as a mirror of
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1163 , which means that every file in
1164 \begin_inset Flex Code
1167 \begin_layout Plain Layout
1173 is a replacement for the corresponding file in
1174 \begin_inset Flex Code
1177 \begin_layout Plain Layout
1184 Any configuration file described in the above sections can be placed either
1185 in the system-wide directory, in which case it will affect all users, or
1186 in your local directory for your own use.
1189 \begin_layout Standard
1190 To make things clearer, let's provide a few examples:
1193 \begin_layout Itemize
1194 The preferences set in the
1195 \begin_inset Flex Noun
1198 \begin_layout Plain Layout
1199 Tools\SpecialChar menuseparator
1205 dialog are saved to a file
1206 \begin_inset Flex Code
1209 \begin_layout Plain Layout
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1228 \begin_layout Itemize
1229 When you reconfigure using
1230 \begin_inset Flex Noun
1233 \begin_layout Plain Layout
1234 Tools\SpecialChar menuseparator
1242 \begin_inset Flex Code
1245 \begin_layout Plain Layout
1251 script, and the resulting files are written in your local configuration
1253 This means that any additional text class file that you might have added
1255 \begin_inset Flex Code
1258 \begin_layout Plain Layout
1264 will be added to the list of classes in the
1265 \begin_inset Flex Noun
1268 \begin_layout Plain Layout
1269 Document\SpecialChar menuseparator
1278 \begin_layout Itemize
1279 If you get some updated documentation from \SpecialChar LyX
1280 ftp site and cannot install
1281 it because you do not have sysadmin rights on your system, you can just
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1292 and the items in the
1293 \begin_inset Flex Noun
1296 \begin_layout Plain Layout
1302 menu will open them!
1305 \begin_layout Section
1306 Running \SpecialChar LyX
1307 with multiple configurations
1310 \begin_layout Standard
1311 The configuration freedom of the local configuration directory may not suffice
1312 if you want to have more than one configuration at your disposal.
1313 For example, you may want to be use different key bindings or printer settings
1315 You can achieve this by having several such directories.
1316 You then specify which directory to use at run-time.
1319 \begin_layout Standard
1320 Invoking \SpecialChar LyX
1321 with the command line switch
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1335 instructs the program to read the configuration from that directory, and
1336 not from the default directory.
1337 (You can determine the default directory by running \SpecialChar LyX
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1348 switch.) If the specified directory does not exist, \SpecialChar LyX
1350 for you, just like it does for the default directory on the first time
1351 you run the program.
1352 You can modify the configuration options in this additional user directory
1353 exactly as you would for the default directory.
1354 These directories are completely independent (but read on).
1355 Note that setting the environment variable
1356 \begin_inset Flex Code
1359 \begin_layout Plain Layout
1365 to some value has exactly the same effect.
1368 \begin_layout Standard
1369 Having several configurations also requires more maintenance: if you want
1370 to add a new layout to
1371 \begin_inset Flex Code
1374 \begin_layout Plain Layout
1380 which you want available from all your configurations, you must add it
1381 to each directory separately.
1382 You can avoid this with the following trick: after \SpecialChar LyX
1383 creates the additional
1384 directory, most of the subdirectories (see above) are empty.
1385 If you want the new configuration to mirror an existing one, replace the
1386 empty subdirectory with a symbolic link to the matching subdirectory in
1387 the existing configuration.
1389 \begin_inset Flex Code
1392 \begin_layout Plain Layout
1398 subdirectory, however, since it contains a file written by the configuration
1399 script (also accessible through
1400 \begin_inset Flex Noun
1403 \begin_layout Plain Layout
1404 Tools\SpecialChar menuseparator
1410 ) which is configuration-specific.
1413 \begin_layout Chapter
1414 The Preferences dialog
1417 \begin_layout Standard
1418 All options of the preferences dialog are described in the Appendix
1420 The Preferences Dialog
1427 For some options you might find here more details.
1430 \begin_layout Section
1432 \begin_inset CommandInset label
1441 \begin_layout Standard
1442 The first step is to define your file formats if they are not already defined.
1444 \begin_inset Flex Noun
1447 \begin_layout Plain Layout
1448 Tools\SpecialChar menuseparator
1456 \begin_inset Flex Noun
1459 \begin_layout Plain Layout
1460 File Handling\SpecialChar menuseparator
1467 \begin_inset Flex Noun
1470 \begin_layout Plain Layout
1476 button to define your new format.
1478 \begin_inset Flex Noun
1481 \begin_layout Plain Layout
1487 field contains the name used to identify the format in the GUI.
1489 \begin_inset Flex Noun
1492 \begin_layout Plain Layout
1498 is used to identify the format internally.
1499 You will also need to enter a file extension.
1500 These are all required.
1502 \begin_inset Flex Noun
1505 \begin_layout Plain Layout
1511 field is used to provide a keyboard shortcut on the menus.
1512 (For example, pressing
1513 \begin_inset Flex Noun
1516 \begin_layout Plain Layout
1523 \begin_inset Flex Noun
1526 \begin_layout Plain Layout
1527 Document\SpecialChar menuseparator
1528 View (Other Formats)\SpecialChar menuseparator
1537 \begin_layout Standard
1539 \begin_inset Flex Noun
1542 \begin_layout Plain Layout
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1559 For example, you might want to use
1560 \begin_inset Flex Noun
1563 \begin_layout Plain Layout
1569 to view PostScript files.
1570 You can enter the command needed to start the program in the corresponding
1572 In defining this command, you can use the four variables listed in the
1574 The viewer is launched when you view an image in \SpecialChar LyX
1576 \begin_inset Flex Noun
1579 \begin_layout Plain Layout
1580 Document\SpecialChar menuseparator
1587 The editor is for example launched when you right-click on an image and
1589 \begin_inset Flex Noun
1592 \begin_layout Plain Layout
1598 in the appearing context menu.
1601 \begin_layout Standard
1603 \begin_inset Flex Noun
1606 \begin_layout Plain Layout
1612 type of a format is optional, but if it is specified, it must be unique
1614 It is used to detect files of this format from the file contents.
1615 For some important file formats there is no MIME type officially registered
1617 \begin_inset CommandInset href
1620 target "http://www.iana.org/assignments/media-types/"
1626 Therefore \SpecialChar LyX
1627 uses the extended list of MIME types as specified by
1628 \begin_inset CommandInset href
1630 name "freedesktop.org"
1631 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1639 \begin_layout Standard
1641 \begin_inset Flex Noun
1644 \begin_layout Plain Layout
1650 option tells \SpecialChar LyX
1651 that a format is suitable for document export.
1652 If this is set and if a suitable conversion route exists (see
1653 \begin_inset CommandInset ref
1655 reference "sec:Converters"
1659 ), the format will appear in the
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1664 File\SpecialChar menuseparator
1671 The format will also appear in the
1672 \begin_inset Flex Noun
1675 \begin_layout Plain Layout
1676 Document\SpecialChar menuseparator
1682 menu if a viewer is specified for the format.
1683 Pure image formats, such as
1684 \begin_inset Flex Code
1687 \begin_layout Plain Layout
1693 , should not use this option.
1694 Formats that can both represent vector graphics and documents like
1695 \begin_inset Flex Code
1698 \begin_layout Plain Layout
1707 \begin_layout Standard
1709 \begin_inset Flex Noun
1712 \begin_layout Plain Layout
1713 Vector graphics format
1718 tells \SpecialChar LyX
1719 that a format can contain vector graphics.
1720 This information is used to determine the target format of included graphics
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1732 Included graphics may need to be converted to either
1733 \begin_inset Flex Noun
1736 \begin_layout Plain Layout
1743 \begin_inset Flex Noun
1746 \begin_layout Plain Layout
1753 \begin_inset Flex Noun
1756 \begin_layout Plain Layout
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1772 cannot handle other image formats.
1773 If an included graphic is not already in
1774 \begin_inset Flex Noun
1777 \begin_layout Plain Layout
1784 \begin_inset Flex Noun
1787 \begin_layout Plain Layout
1794 \begin_inset Flex Noun
1797 \begin_layout Plain Layout
1803 format, it is converted to
1804 \begin_inset Flex Noun
1807 \begin_layout Plain Layout
1813 if the vector format option is set, and otherwise to
1814 \begin_inset Flex Noun
1817 \begin_layout Plain Layout
1826 \begin_layout Section
1830 \begin_layout Standard
1831 Since all conversions from one format to another take place in \SpecialChar LyX
1833 directory, it is sometimes necessary to modify a file before copying it
1834 to the temporary directory in order that the conversion may be performed.
1838 \begin_layout Plain Layout
1839 For example, the file may refer to other files—images, for example—using
1840 relative file names, and these may become invalid when the file is copied
1841 to the temporary directory.
1846 This is done by a Copier: It copies a file to (or from) the temporary directory
1847 and may modify it in the process.
1850 \begin_layout Standard
1851 The definitions of the copiers may use eight variables:
1854 \begin_layout Labeling
1855 \labelwidthstring 00.00.0000
1856 \begin_inset Flex Code
1859 \begin_layout Plain Layout
1865 The \SpecialChar LyX
1866 system directory (e.
1867 \begin_inset space \thinspace{}
1871 \begin_inset space \space{}
1875 \begin_inset Flex Noun
1878 \begin_layout Plain Layout
1887 \begin_layout Labeling
1888 \labelwidthstring 00.00.0000
1889 \begin_inset Flex Code
1892 \begin_layout Plain Layout
1901 \begin_layout Labeling
1902 \labelwidthstring 00.00.0000
1903 \begin_inset Flex Code
1906 \begin_layout Plain Layout
1915 \begin_layout Labeling
1916 \labelwidthstring 00.00.0000
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1926 The base name (without filename extension) in the \SpecialChar LyX
1930 \begin_layout Labeling
1931 \labelwidthstring 00.00.0000
1932 \begin_inset Flex Code
1935 \begin_layout Plain Layout
1941 The full directory path of the \SpecialChar LyX
1945 \begin_layout Labeling
1946 \labelwidthstring 00.00.0000
1947 \begin_inset Flex Code
1950 \begin_layout Plain Layout
1956 The full pathname to the original \SpecialChar LyX
1957 file being processed
1960 \begin_layout Labeling
1961 \labelwidthstring 00.00.0000
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1971 The filename (without any directory path) of the \SpecialChar LyX
1975 \begin_layout Labeling
1976 \labelwidthstring 00.00.0000
1977 \begin_inset Flex Code
1980 \begin_layout Plain Layout
1986 The `\SpecialChar LaTeX
1990 \begin_layout Standard
1991 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1999 It is relevant only when exporting files suitable for such inclusion.
2002 \begin_layout Standard
2003 Copiers can be used to do almost anything with output files.
2004 For example, suppose you want generated pdf files to be copied to a special
2006 \begin_inset Flex Code
2009 \begin_layout Plain Layout
2016 Then you could write a shell script such as this one:
2019 \begin_layout Standard
2020 \begin_inset listings
2024 \begin_layout Plain Layout
2029 \begin_layout Plain Layout
2034 \begin_layout Plain Layout
2036 TOFILE=`basename $2`
2039 \begin_layout Plain Layout
2041 cp $FROMFILE /home/you/pdf/$TOFILE
2046 Save it in your local \SpecialChar LyX
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2052 /home/you/.lyx/scripts/pdfcopier.sh
2057 —and make it executable, if you need to do so on your platform.
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2063 Tools\SpecialChar menuseparator
2069 dialog, select under
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2074 File Handling\SpecialChar menuseparator
2081 \begin_inset Flex Noun
2084 \begin_layout Plain Layout
2090 format—or one of the other pdf formats—and enter
2091 \begin_inset Flex Code
2094 \begin_layout Plain Layout
2095 pdfcopier.sh $$i $$o
2101 \begin_inset Flex Noun
2104 \begin_layout Plain Layout
2114 \begin_layout Standard
2115 Copiers are used by \SpecialChar LyX
2116 in various of its own conversions.
2117 For example, if appropriate programs are found, \SpecialChar LyX
2118 will automatically install
2120 \begin_inset Flex Noun
2123 \begin_layout Plain Layout
2130 \begin_inset Flex Noun
2133 \begin_layout Plain Layout
2135 \begin_inset space ~
2144 When these formats are exported, the copier sees that not just the main
2145 HTML file but various associated files (style files, images, etc.) are also
2147 All these files are written to a subdirectory of the directory in which
2148 the original \SpecialChar LyX
2153 \begin_layout Plain Layout
2154 This copier can be customized.
2156 \begin_inset Quotes eld
2160 \begin_inset Quotes erd
2163 argument takes a comma-separated list of extensions to be copied; if it
2164 is omitted, all files will be copied.
2166 \begin_inset Quotes eld
2170 \begin_inset Quotes erd
2173 argument determines the extension added to the generated directory.
2175 \begin_inset Quotes eld
2179 \begin_inset Flex Noun
2182 \begin_layout Plain Layout
2189 \begin_inset Quotes erd
2192 , so HTML generated from
2193 \begin_inset Flex Noun
2196 \begin_layout Plain Layout
2197 /path/to/filename.lyx
2203 \begin_inset Flex Noun
2206 \begin_layout Plain Layout
2207 /path/to/filename.html.LyXconv
2221 \begin_layout Section
2223 \begin_inset CommandInset label
2225 name "sec:Converters"
2232 \begin_layout Standard
2233 You can define your own Converters to convert files between different formats.
2235 \begin_inset Flex Noun
2238 \begin_layout Plain Layout
2239 Tools\SpecialChar menuseparator
2240 Preferences\SpecialChar menuseparator
2241 File Handling\SpecialChar menuseparator
2250 \begin_layout Standard
2251 To define a new converter, select the
2252 \begin_inset Flex Noun
2255 \begin_layout Plain Layout
2257 \begin_inset space ~
2266 \begin_inset Flex Noun
2269 \begin_layout Plain Layout
2271 \begin_inset space ~
2279 from the drop-down lists, enter the command needed for the conversion,
2281 \begin_inset Flex Noun
2284 \begin_layout Plain Layout
2291 Several variables can be used in the definition of converters:
2294 \begin_layout Labeling
2295 \labelwidthstring 00.00.0000
2296 \begin_inset Flex Code
2299 \begin_layout Plain Layout
2305 The \SpecialChar LyX
2309 \begin_layout Labeling
2310 \labelwidthstring 00.00.0000
2311 \begin_inset Flex Code
2314 \begin_layout Plain Layout
2323 \begin_layout Labeling
2324 \labelwidthstring 00.00.0000
2325 \begin_inset Flex Code
2328 \begin_layout Plain Layout
2337 \begin_layout Labeling
2338 \labelwidthstring 00.00.0000
2339 \begin_inset Flex Code
2342 \begin_layout Plain Layout
2348 The base filename of the input file (i.
2349 \begin_inset space \thinspace{}
2352 g., without the extension)
2355 \begin_layout Labeling
2356 \labelwidthstring 00.00.0000
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2366 The path to the input file
2369 \begin_layout Labeling
2370 \labelwidthstring 00.00.0000
2371 \begin_inset Flex Code
2374 \begin_layout Plain Layout
2380 The path to the original input file (this is different from $$p when a
2381 chain of converters is called)
2384 \begin_layout Labeling
2385 \labelwidthstring 00.00.0000
2386 \begin_inset Flex Code
2389 \begin_layout Plain Layout
2395 The iconv name for the encoding of the document.
2398 \begin_layout Standard
2400 \begin_inset Flex Noun
2403 \begin_layout Plain Layout
2405 \begin_inset space ~
2413 field you can enter the following flags, separated by commas:
2416 \begin_layout Labeling
2417 \labelwidthstring 00.00.0000
2418 \begin_inset Flex Code
2421 \begin_layout Plain Layout
2423 \change_inserted -712698321 1524656940
2431 This converter runs some form of \SpecialChar LaTeX
2433 This will make \SpecialChar LyX
2434 's \SpecialChar LaTeX
2435 error logs available.
2437 \change_inserted -712698321 1524657018
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2444 \change_inserted -712698321 1524657012
2452 value specifies the form of \SpecialChar LaTeX
2454 \begin_inset Flex Code
2457 \begin_layout Plain Layout
2459 \change_inserted -712698321 1524657005
2460 latex, pdflatex, platex, xetex, luatex
2468 If no value is specified,
2469 \begin_inset Flex Code
2472 \begin_layout Plain Layout
2474 \change_inserted -712698321 1524657018
2487 \begin_layout Labeling
2488 \labelwidthstring 00.00.0000
2489 \begin_inset Flex Code
2492 \begin_layout Plain Layout
2494 \change_inserted -712698321 1524656935
2502 Needs the \SpecialChar LaTeX
2504 \begin_inset Flex Noun
2507 \begin_layout Plain Layout
2513 file for the conversion.
2515 \change_inserted -712698321 1524657047
2517 \begin_inset Flex Code
2520 \begin_layout Plain Layout
2522 \change_inserted -712698321 1524657030
2528 value specifies the form of \SpecialChar LaTeX
2529 that is run in order to generate the
2530 \begin_inset Flex Noun
2533 \begin_layout Plain Layout
2535 \change_inserted -712698321 1524657047
2542 \begin_inset Flex Code
2545 \begin_layout Plain Layout
2547 \change_inserted -712698321 1524657030
2548 latex, pdflatex, platex, xetex, luatex
2554 If no value is specified,
2555 \begin_inset Flex Code
2558 \begin_layout Plain Layout
2560 \change_inserted -712698321 1524657030
2571 \begin_layout Labeling
2572 \labelwidthstring 00.00.0000
2573 \begin_inset Flex Code
2576 \begin_layout Plain Layout
2583 \begin_inset Quotes eld
2587 \begin_inset Quotes erd
2590 file from the backend, which in practice means a \SpecialChar LaTeX
2591 file like the one we
2592 would export, without
2593 \begin_inset Flex Code
2596 \begin_layout Plain Layout
2605 \begin_layout Labeling
2606 \labelwidthstring 00.00.0000
2607 \begin_inset Flex Code
2610 \begin_layout Plain Layout
2619 \begin_layout Standard
2620 The following three flags are not really flags at all because they take
2622 \begin_inset Flex Noun
2625 \begin_layout Plain Layout
2627 \begin_inset space ~
2631 \begin_inset space ~
2642 \begin_layout Labeling
2643 \labelwidthstring 00.00.0000
2645 \change_inserted -712698321 1523206314
2646 \begin_inset Flex Code
2649 \begin_layout Plain Layout
2651 \change_inserted -712698321 1523206193
2657 The name of the driver that needs to be loaded with the
2661 package for this converter.
2662 The loading of the correct driver is necessary to get some PDF-specific
2671 \begin_layout Labeling
2672 \labelwidthstring 00.00.0000
2673 \begin_inset Flex Code
2676 \begin_layout Plain Layout
2682 If set, the converter's standard error will be redirected to a file
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2692 , and the script given as argument will be run as:
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2697 script < infile.out > infile.log
2703 The argument may contain
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2716 \begin_layout Labeling
2717 \labelwidthstring 00.00.0000
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2727 The name of the directory in which the converter will dump the generated
2730 will not create this directory, and it does not copy anything into it,
2731 though it will copy this directory to the destination.
2732 The argument may contain
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2742 , which will be replaced by the base name of the input and output files,
2743 respectively, when the directory is copied.
2744 \begin_inset Newline newline
2747 Note that resultdir and usetempdir make no sense together.
2748 The latter will be ignored if the former is given.
2751 \begin_layout Labeling
2752 \labelwidthstring 00.00.0000
2753 \begin_inset Flex Code
2756 \begin_layout Plain Layout
2762 Determines the output file name and may, contain
2763 \begin_inset Flex Code
2766 \begin_layout Plain Layout
2773 Sensible only with resultdir and optional even then; if not given, it defaults
2777 \begin_layout Standard
2779 \change_inserted -712698321 1523206384
2780 A suitable hyperref-driver is set for some converters that are installed
2781 with \SpecialChar LyX
2784 \change_deleted -712698321 1523206388
2786 \change_inserted -712698321 1523206389
2790 \change_inserted -712698321 1523206400
2794 \change_inserted -712698321 1523206407
2798 \change_inserted -712698321 1523206437
2802 \change_deleted -712698321 1523206442
2803 that are installed with \SpecialChar LyX
2810 \begin_layout Standard
2811 You do not have to define converters for all formats between which you want
2813 For example, you will note that there is no `\SpecialChar LyX
2814 to PostScript' converter,
2815 but \SpecialChar LyX
2816 will export PostScript.
2817 It does so by first creating a \SpecialChar LaTeX
2818 file (no converter needs to be defined
2819 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2821 and finally converting the resulting DVI file to PostScript.
2823 finds such `chains' of converters automatically, and it will always choose
2824 the shortest possible chain.
2825 You can, though, still define multiple conversion methods between file
2827 For example, the standard \SpecialChar LyX
2828 configuration provides five ways to convert
2833 \begin_layout Enumerate
2835 \begin_inset Flex Noun
2838 \begin_layout Plain Layout
2847 \begin_layout Enumerate
2848 via (DVI and) PostScript, using
2849 \begin_inset Flex Noun
2852 \begin_layout Plain Layout
2861 \begin_layout Enumerate
2863 \begin_inset Flex Noun
2866 \begin_layout Plain Layout
2875 \begin_layout Enumerate
2877 \begin_inset Flex Noun
2880 \begin_layout Plain Layout
2890 \begin_layout Enumerate
2892 \begin_inset Flex Noun
2895 \begin_layout Plain Layout
2905 \begin_layout Standard
2906 To define such alternate chains, you must define multiple target `file formats',
2908 \begin_inset CommandInset ref
2910 reference "sec:Formats"
2915 For example, in the standard configuration, the formats named
2916 \begin_inset Flex Noun
2919 \begin_layout Plain Layout
2926 \begin_inset Flex Noun
2929 \begin_layout Plain Layout
2936 \begin_inset Flex Noun
2939 \begin_layout Plain Layout
2946 \begin_inset Flex Noun
2949 \begin_layout Plain Layout
2956 \begin_inset Flex Noun
2959 \begin_layout Plain Layout
2966 \begin_inset Flex Noun
2969 \begin_layout Plain Layout
2976 \begin_inset Flex Noun
2979 \begin_layout Plain Layout
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2997 \begin_inset Flex Noun
3000 \begin_layout Plain Layout
3007 \begin_inset Flex Noun
3010 \begin_layout Plain Layout
3017 ) are defined, all of which share the extension
3018 \begin_inset Flex Noun
3021 \begin_layout Plain Layout
3027 , and which correspond to the conversion methods just mentioned.
3030 \begin_layout Chapter
3031 Internationalizing \SpecialChar LyX
3033 \begin_inset CommandInset label
3035 name "cha:Internationalizing-LyX"
3042 \begin_layout Standard
3044 supports using a translated interface.
3045 Last time we checked, \SpecialChar LyX
3046 provided text in thirty languages.
3047 The language of choice is called your
3052 (For further reading on locale settings, see also the documentation for
3053 locale that comes with your operating system.
3054 For Linux, the manual page for
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3064 could be a good place to start).
3067 \begin_layout Standard
3068 Notice that these translations will work, but do contain a few flaws.
3069 In particular, all dialogs have been designed with the English text in
3070 mind, which means that some of the translated text will be too large to
3071 fit within the space allocated.
3072 This is only a display problem and will not cause any harm.
3073 Also, you will find that some of the translations do not define shortcut
3074 keys for everything.
3075 Sometimes, there are simply not enough free letters to do it.
3076 Other times, the translator just hasn't got around to doing it yet.
3077 Our localization team, which you may wish to join,
3081 \begin_layout Plain Layout
3082 If you are a fluent speaker of a language other than English, joining these
3083 teams is a great way to give back to the \SpecialChar LyX
3089 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3093 \begin_layout Section
3094 Translating \SpecialChar LyX
3098 \begin_layout Subsection
3099 Translating the graphical user interface (text messages).
3102 \begin_layout Standard
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3114 library to handle the internationalization of the interface.
3115 To have \SpecialChar LyX
3116 speak your favorite language in all menus and dialogs, you need
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 -file for that language.
3128 When this is available, you'll have to generate a
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3138 -file from it and install the
3139 \begin_inset Flex Code
3142 \begin_layout Plain Layout
3149 The process of doing all of this is explained in the documentation for
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3161 It is possible to do this just for yourself, but if you're going to do
3162 it, you might as well share the results of your labors with the rest of
3163 the \SpecialChar LyX
3165 Send a message to the \SpecialChar LyX
3166 developers' list for more information about how
3170 \begin_layout Standard
3171 In short, this is what you should do (xx denotes the language code):
3174 \begin_layout Itemize
3175 Check out the \SpecialChar LyX
3178 \begin_inset CommandInset href
3180 name "information on the web"
3181 target "https://www.lyx.org/HowToUseGIT"
3189 \begin_layout Itemize
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3200 to the folder of the
3201 \begin_inset Flex Code
3204 \begin_layout Plain Layout
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3232 doesn't exist anywhere, it can be remade with the console command
3233 \begin_inset Flex Code
3236 \begin_layout Plain Layout
3242 in that directory, or you can use an existing po-file for some other language
3246 \begin_layout Itemize
3248 \begin_inset Flex Code
3251 \begin_layout Plain Layout
3261 \begin_layout Plain Layout
3262 This is just a text file, so it can be edited in any text editor.
3263 But there are also specialized programs that support such editing, such
3268 (for all platforms) or
3277 contains a `mode' for editing
3278 \begin_inset Flex Code
3281 \begin_layout Plain Layout
3288 \begin_inset Flex URL
3291 \begin_layout Plain Layout
3293 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3303 For some menu- and widget-labels, there are also shortcut keys that should
3305 Those keys are marked after a `|', and should be translated according to
3306 the words and phrases of the language.
3307 You should also fill also out the information at the beginning of the new
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3318 -file with your email-address, etc., so people know where to reach you with
3319 suggestions and entertaining flames.
3322 \begin_layout Standard
3323 If you are just doing this on your own, then:
3326 \begin_layout Itemize
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3338 This can be done with
3339 \begin_inset Flex Code
3342 \begin_layout Plain Layout
3343 msgfmt -o xx.mo < xx.po
3351 \begin_layout Itemize
3353 \begin_inset Flex Code
3356 \begin_layout Plain Layout
3362 -file to your locale-tree, at the correct directory for application messages
3367 xx, and under the name
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3378 \begin_inset space \thinspace{}
3382 \begin_inset space \space{}
3386 \begin_inset Flex Code
3389 \begin_layout Plain Layout
3390 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3400 \begin_layout Standard
3401 As said, however, it would be best if the new
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 file could be added to the \SpecialChar LyX
3412 distribution, so others can use it.
3413 Adding it involves making additional changes to \SpecialChar LyX
3415 So send an email to the developers' mailing list if you're interested in
3419 \begin_layout Subsubsection
3423 \begin_layout Standard
3424 Sometimes it turns out that one English message needs to be translated into
3425 different messages in the target language.
3426 One example is the message
3427 \begin_inset Flex Code
3430 \begin_layout Plain Layout
3436 which has the German translation
3444 , depending upon exactly what the English
3445 \begin_inset Quotes eld
3449 \begin_inset Quotes erd
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3463 does not handle such ambiguous translations.
3464 Therefore you have to add some context information to the message: Instead
3466 \begin_inset Flex Code
3469 \begin_layout Plain Layout
3476 \begin_inset Flex Code
3479 \begin_layout Plain Layout
3480 To[[as in 'From format x to format y']]
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3490 To[[as in 'From page x to page y']].
3495 Now the two occurrences of
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3506 \begin_inset Flex Code
3509 \begin_layout Plain Layout
3515 and can be translated correctly to
3526 \begin_layout Standard
3527 Of course the context information needs to be stripped off the original
3528 message when no translation is used.
3529 Therefore you have to put it in double square brackets at the end of the
3530 message (see the example above).
3531 The translation mechanism of \SpecialChar LyX
3532 ensures that everything in double square
3533 brackets at the end of messages is removed before displaying the message.
3536 \begin_layout Subsection
3537 Translating the documentation.
3540 \begin_layout Standard
3541 The online documentation (in the
3542 \begin_inset Flex Noun
3545 \begin_layout Plain Layout
3551 -menu) can (and should!) be translated.
3552 If there are translated versions of the documentation available
3556 \begin_layout Plain Layout
3557 As of March 2008, at least some of the documents have been translated into
3558 fourteen languages, with the Tutorial available in a few more.
3563 and the locale is set accordingly, these will be used automagically by
3567 looks for translated versions as
3568 \begin_inset Flex Code
3571 \begin_layout Plain Layout
3572 LyXDir/doc/xx/DocName.lyx
3578 \begin_inset Flex Code
3581 \begin_layout Plain Layout
3587 is the code for the language currently in use.
3588 If there are no translated documents, the default English versions will
3590 Note that the translated versions must have the same filenames (
3591 \begin_inset Flex Code
3594 \begin_layout Plain Layout
3600 above) as the original.
3601 If you feel up to translating the documentation (an excellent way to proof-read
3602 the original documentation by the way!), there are a few things you should
3606 \begin_layout Itemize
3607 Check out the documentation translation web page at
3608 \begin_inset CommandInset href
3610 name "https://www.lyx.org/Translation"
3611 target "https://www.lyx.org/Translation"
3617 That way, you can find out which (if any) documents have already been translate
3618 d into your language.
3619 You can also find out who (if anyone) is organizing the effort to translate
3620 the documentation into your language.
3621 If no one is organizing the effort, please let us know that you're interested.
3624 \begin_layout Standard
3625 Once you get to actually translating, here's a few hints for you that may
3629 \begin_layout Itemize
3630 Join the documentation team! There is information on how to do that in
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3641 \begin_inset Flex Noun
3644 \begin_layout Plain Layout
3645 Help\SpecialChar menuseparator
3651 ), which by the way is the first document you should translate.
3654 \begin_layout Itemize
3655 Learn the typographic conventions for the language you are translating to.
3656 Typography is an ancient art and over the centuries, a great variety of
3657 conventions have developed throughout different parts of the world.
3658 Also study the professional terminology amongst typographers in your country.
3659 Inventing your own terminology will only confuse the users.
3662 (Warning! Typography is addictive!)
3665 \begin_layout Itemize
3666 Make a copy of the document.
3667 This will be your working copy.
3668 You can use this as your personal translated help-file by placing it in
3670 \begin_inset Flex Code
3673 \begin_layout Plain Layout
3680 \begin_inset Note Greyedout
3683 \begin_layout Plain Layout
3688 For a complex document with external material (images, etc.), if you make
3690 \begin_inset space \thinspace{}
3694 \begin_inset space \space{}
3697 in a temp dir, beware that the links to external material may be broken
3698 when the document is moved to a different place.
3699 The best way is to retrieve the \SpecialChar LyX
3701 \begin_inset Flex URL
3704 \begin_layout Plain Layout
3706 https://www.lyx.org/HowToUseGIT
3711 ) and to edit the doc file in place.
3719 \begin_layout Itemize
3720 Sometimes the original document (from the \SpecialChar LyX
3721 team) will be updated.
3722 Use the source viewer at
3723 \begin_inset CommandInset href
3725 name "https://www.lyx.org/trac/timeline"
3726 target "https://www.lyx.org/trac/timeline"
3731 to see what has been changed.
3732 That way you can easily see which parts of the translated document need
3736 \begin_layout Standard
3737 If you ever find an error in the original document, fix it and notify the
3738 rest of the documentation team of the changes! (You didn't forget to join
3739 the documentation team, did you?)
3742 \begin_layout Standard
3743 \begin_inset Branch OutDated
3747 \begin_layout Section
3748 International Keyboard Support
3751 \begin_layout Standard
3754 [Editor's Note: The following section is by
3762 It needs to be fixed to conform to the new Documentation Style sheet and
3763 to make use of the new v1.0 features.
3764 The whole thing also needs to be merged with the section following it.-jw
3765 It may also be badly out of date.-rh (2008)]
3768 \begin_layout Subsection
3769 Defining Own Keymaps: Keymap File Format
3772 \begin_layout Standard
3773 Let's look at a keyboard definition file a little closer.
3774 It is a plain text file defining
3777 \begin_layout Itemize
3778 key-to-key or key-to-string translations
3781 \begin_layout Itemize
3785 \begin_layout Itemize
3786 dead keys exceptions
3789 \begin_layout Standard
3790 To define key-to-key or key-to-string translation, use this command:
3793 \begin_layout Quotation
3794 \begin_inset Flex Code
3797 \begin_layout Plain Layout
3806 \begin_inset Flex Code
3809 \begin_layout Plain Layout
3818 \begin_layout Standard
3820 \begin_inset Flex Code
3823 \begin_layout Plain Layout
3829 is the key to be translated and
3830 \begin_inset Flex Code
3833 \begin_layout Plain Layout
3839 is the string to be inserted into the document.
3840 To define dead keys, use:
3843 \begin_layout Quotation
3844 \begin_inset Flex Code
3847 \begin_layout Plain Layout
3856 \begin_inset Flex Code
3859 \begin_layout Plain Layout
3868 \begin_layout Standard
3870 \begin_inset Flex Code
3873 \begin_layout Plain Layout
3879 is a keyboard key and
3880 \begin_inset Flex Code
3883 \begin_layout Plain Layout
3890 The following dead keys are supported (shortcut name is in parentheses):
3893 \begin_layout Quotation
3897 \begin_inset space \hfill{}
3903 \begin_layout Quotation
3905 \begin_inset space \hfill{}
3911 \begin_layout Quotation
3913 \begin_inset space \hfill{}
3919 \begin_layout Quotation
3921 \begin_inset space \hfill{}
3927 \begin_layout Quotation
3929 \begin_inset space \hfill{}
3935 \begin_layout Quotation
3937 \begin_inset space \hfill{}
3944 \begin_layout Plain Layout
3956 \begin_layout Quotation
3958 \begin_inset space \hfill{}
3964 \begin_layout Quotation
3966 \begin_inset space \hfill{}
3973 \begin_layout Plain Layout
3985 \begin_layout Quotation
3987 \begin_inset space \hfill{}
3993 \begin_layout Quotation
3995 \begin_inset space \hfill{}
4001 \begin_layout Quotation
4003 \begin_inset space \hfill{}
4010 \begin_layout Plain Layout
4022 \begin_layout Quotation
4024 \begin_inset space \hfill{}
4031 \begin_layout Plain Layout
4043 \begin_layout Quotation
4045 \begin_inset space \hfill{}
4051 \begin_layout Quotation
4052 hungarian umlaut (hug)
4053 \begin_inset space \hfill{}
4059 \begin_layout Quotation
4061 \begin_inset space \hfill{}
4067 \begin_layout Quotation
4069 \begin_inset space \hfill{}
4076 \begin_layout Plain Layout
4088 \begin_layout Standard
4089 Since in many international keyboards there are exceptions to what some
4090 dead keys should do, you can define them using
4093 \begin_layout Quotation
4094 \begin_inset Flex Code
4097 \begin_layout Plain Layout
4105 deadkey key outstring
4108 \begin_layout Standard
4109 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4113 \begin_layout Quotation
4114 \begin_inset Flex Code
4117 \begin_layout Plain Layout
4130 \begin_layout Standard
4131 to make it work correctly.
4132 Also, you have to define as exceptions dead keys over i and j, to remove
4133 the dot from them before inserting an accent mark.
4134 I will change this when the time comes, but so far I haven't had time.
4137 \begin_layout Standard
4138 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4141 \begin_inset Flex Code
4144 \begin_layout Plain Layout
4150 have different meaning.
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4161 marks comments, quotes start and end \SpecialChar LaTeX
4163 To enter quote, you'll need to use
4164 \begin_inset Flex Code
4167 \begin_layout Plain Layout
4176 \begin_inset Flex Code
4179 \begin_layout Plain Layout
4186 \begin_inset Flex Code
4189 \begin_layout Plain Layout
4200 \begin_layout Standard
4201 If you make a keyboard description file that works for your language, please
4202 mail it to me, so I can include it in the next keymap distribution.
4205 \begin_layout Standard
4206 More keywords will be supported in keymap configuration file in future,
4210 \begin_layout Itemize
4211 \begin_inset Flex Code
4214 \begin_layout Plain Layout
4225 \begin_inset space \hfill{}
4229 \begin_inset Flex Code
4232 \begin_layout Plain Layout
4241 \begin_layout Itemize
4242 \begin_inset Flex Code
4245 \begin_layout Plain Layout
4256 \begin_inset space \hfill{}
4260 \begin_inset Flex Code
4263 \begin_layout Plain Layout
4269 an external keymap translation program
4272 \begin_layout Standard
4273 Also, it should look into
4274 \begin_inset Flex Code
4277 \begin_layout Plain Layout
4283 file for defaults, too (for example, a
4284 \begin_inset Flex Code
4287 \begin_layout Plain Layout
4295 option to include default keyboard).
4303 \begin_layout Section
4304 International Keymap Stuff
4305 \begin_inset CommandInset label
4307 name "sec:International-Keymap-Stuff"
4314 \begin_layout Standard
4315 \begin_inset Note Note
4318 \begin_layout Plain Layout
4319 In doing the revisions on this document in March 2008, I did not look over
4320 this stuff, as I do not understand it.
4321 It would be good if someone else could do so.
4330 \begin_layout Standard
4331 The next two sections describe the
4332 \begin_inset Flex Code
4335 \begin_layout Plain Layout
4344 \begin_inset Flex Code
4347 \begin_layout Plain Layout
4355 file syntax in detail.
4356 These sections should help you design your own key map if the ones provided
4357 do not meet your needs.
4360 \begin_layout Subsection
4364 \begin_layout Standard
4368 \begin_inset Flex Code
4371 \begin_layout Plain Layout
4377 file maps keystrokes to characters or strings.
4378 As the name suggests, it sets a keyboard mapping.
4380 \begin_inset Flex Code
4383 \begin_layout Plain Layout
4394 \begin_inset Flex Code
4397 \begin_layout Plain Layout
4412 \begin_inset Flex Code
4415 \begin_layout Plain Layout
4428 \begin_inset Flex Code
4431 \begin_layout Plain Layout
4440 \begin_inset Flex Code
4443 \begin_layout Plain Layout
4451 are described in this section.
4454 \begin_layout Labeling
4455 \labelwidthstring 00.00.0000
4456 \begin_inset Flex Code
4459 \begin_layout Plain Layout
4467 Map a character to a string
4470 \begin_layout LyX-Code
4485 \begin_layout Standard
4518 the double-quote (")
4535 must be escaped with a preceding backslash (
4546 \begin_layout Standard
4548 \begin_inset Flex Noun
4551 \begin_layout Plain Layout
4559 statement to cause the symbol
4560 \begin_inset Flex Noun
4563 \begin_layout Plain Layout
4571 to be output for the keystroke
4572 \begin_inset Flex Noun
4575 \begin_layout Plain Layout
4586 \begin_layout LyX-Code
4592 \begin_layout Labeling
4593 \labelwidthstring 00.00.0000
4594 \begin_inset Flex Code
4597 \begin_layout Plain Layout
4605 Specify an accent character
4608 \begin_layout LyX-Code
4617 \begin_layout Standard
4618 This will make the cha
4656 This is the dead key
4660 \begin_layout Plain Layout
4667 refers to a key that does not produce a character by itself, but when followed
4668 with another key, produces the desired accent character.
4669 For example, a German characte
4671 r with an umlaut like
4681 can be produced in this manner.
4690 \begin_layout Standard
4703 and then another key not in
4720 followed by the other, not allowed key, as output.
4724 \begin_inset Flex Noun
4727 \begin_layout Plain Layout
4735 cancels a dead key, so if
4746 \begin_inset Flex Noun
4749 \begin_layout Plain Layout
4758 , the cursor will not go one position backwards but will instead cancel
4774 might have had on the next keystroke.
4778 \begin_layout Standard
4779 The following example specifies that the character ' is to be an acute accent,
4780 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4783 \begin_layout LyX-Code
4786 kmod ' acute aeiouAEIOU
4789 \begin_layout Labeling
4790 \labelwidthstring 00.00.0000
4791 \begin_inset Flex Code
4794 \begin_layout Plain Layout
4800 Specify an exception to the accent character
4803 \begin_layout LyX-Code
4812 \begin_layout Standard
4813 This defines an exce
4854 have been assigned a keystroke with a previous
4857 \begin_inset Flex Code
4860 \begin_layout Plain Layout
4884 must not belong in the
4931 If such a declaration does not exist in
4939 \begin_inset Flex Code
4942 \begin_layout Plain Layout
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
4993 \begin_layout Standard
4994 The following command produces causes äi to be produced when you enter acute-i
4998 \begin_layout LyX-Code
5012 \begin_layout Labeling
5013 \labelwidthstring 00.00.0000
5014 \begin_inset Flex Code
5017 \begin_layout Plain Layout
5023 Combine two accent characters
5026 \begin_layout LyX-Code
5032 accent1 accent2 allowed
5035 \begin_layout Standard
5036 This one is getting pretty esoteric.
5037 It allows you to combine the effect
5093 \begin_inset Flex Code
5096 \begin_layout Plain Layout
5124 \begin_layout Standard
5125 Consider this example from the
5126 \begin_inset Flex Code
5129 \begin_layout Plain Layout
5140 \begin_layout LyX-Code
5143 kmod ; acute aeioyvhAEIOYVH
5147 kcomb acute umlaut iyIY
5150 \begin_layout Standard
5151 This allows you to press
5152 \begin_inset Flex Noun
5155 \begin_layout Plain Layout
5163 and get the effect of
5164 \begin_inset Flex Code
5167 \begin_layout Plain Layout
5186 in this case cancels the last dead key, so if you press
5187 \begin_inset Flex Noun
5190 \begin_layout Plain Layout
5199 \begin_inset Flex Code
5202 \begin_layout Plain Layout
5215 \begin_layout Subsection
5219 \begin_layout Standard
5221 \begin_inset Flex Code
5224 \begin_layout Plain Layout
5232 mapping is performed, a
5233 \begin_inset Flex Code
5236 \begin_layout Plain Layout
5246 file maps the strings that the symbols generate to characters in the current
5248 The \SpecialChar LyX
5249 distribution currently includes at least the
5250 \begin_inset Flex Code
5253 \begin_layout Plain Layout
5262 \begin_inset Flex Code
5265 \begin_layout Plain Layout
5276 \begin_layout Standard
5278 \begin_inset Flex Code
5281 \begin_layout Plain Layout
5289 file is a sequence of declarations of the form
5292 \begin_layout LyX-Code
5305 \begin_layout Standard
5306 For example, in order to map
5307 \begin_inset Flex Noun
5310 \begin_layout Plain Layout
5320 to the corresponding character in the iso-8859-1 set (233), the following
5324 \begin_layout LyX-Code
5332 \begin_layout Standard
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5346 \begin_inset Flex Code
5349 \begin_layout Plain Layout
5367 the same character can apply to more than one string.
5369 \begin_inset Flex Code
5372 \begin_layout Plain Layout
5383 \begin_layout LyX-Code
5395 \begin_inset Newline newline
5411 \begin_layout Standard
5413 cannot find a mapping for the string produced by the keystroke or a
5414 deadkey sequence, it will check if it looks like an accented char and try
5415 to draw an accent over the character on screen.
5418 \begin_layout Subsection
5422 \begin_layout Standard
5423 There is a second way to add support for international characters through
5424 so-called dead-keys.
5425 A dead-key works in combination with a letter to produce an accented character.
5426 Here, we'll explain how to create a really simple dead-key to illustrate
5430 \begin_layout Standard
5431 Suppose you happen to need the circumflex character,
5432 \begin_inset Quotes eld
5436 \begin_inset Quotes erd
5441 \begin_inset Flex Noun
5444 \begin_layout Plain Layout
5451 \begin_inset space ~
5455 \begin_inset Flex Noun
5458 \begin_layout Plain Layout
5464 ] to the \SpecialChar LyX
5466 \begin_inset Flex Code
5469 \begin_layout Plain Layout
5476 \begin_inset Flex Code
5479 \begin_layout Plain Layout
5486 Now, whenever you type the
5487 \begin_inset Flex Noun
5490 \begin_layout Plain Layout
5496 -key followed by a letter, that letter will have a circumflex accent on
5498 For example, the sequence
5499 \begin_inset Quotes eld
5503 \begin_inset Flex Noun
5506 \begin_layout Plain Layout
5513 \begin_inset Quotes erd
5516 produces the letter:
5517 \begin_inset Quotes eld
5521 \begin_inset Quotes erd
5525 If you tried to type
5526 \begin_inset Quotes eld
5530 \begin_inset Flex Noun
5533 \begin_layout Plain Layout
5540 \begin_inset Quotes erd
5543 , however, \SpecialChar LyX
5544 will complain with a beep, since a
5545 \begin_inset Quotes eld
5549 \begin_inset Flex Noun
5552 \begin_layout Plain Layout
5559 \begin_inset Quotes erd
5562 never takes a circumflex accent.
5564 \begin_inset Flex Noun
5567 \begin_layout Plain Layout
5573 after a dead-key produces the bare-accent.
5574 Please note this last point! If you bind a key to a dead-key, you'll need
5575 to rebind the character on that key to yet another key.
5577 \begin_inset Flex Noun
5580 \begin_layout Plain Layout
5586 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5589 \begin_layout Standard
5590 One common way to bind dead-keys is to use
5591 \begin_inset Flex Noun
5594 \begin_layout Plain Layout
5601 \begin_inset Flex Noun
5604 \begin_layout Plain Layout
5611 \begin_inset Flex Noun
5614 \begin_layout Plain Layout
5620 in combination with an accent, like
5621 \begin_inset Quotes eld
5625 \begin_inset Flex Noun
5628 \begin_layout Plain Layout
5635 \begin_inset Quotes erd
5639 \begin_inset Quotes eld
5643 \begin_inset Flex Noun
5646 \begin_layout Plain Layout
5653 \begin_inset Quotes erd
5657 \begin_inset Quotes eld
5661 \begin_inset Flex Noun
5664 \begin_layout Plain Layout
5671 \begin_inset Quotes erd
5675 Another way involves using
5676 \begin_inset Flex Code
5679 \begin_layout Plain Layout
5686 \begin_inset Flex Code
5689 \begin_layout Plain Layout
5695 to set up the special
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5707 \begin_inset Flex Code
5710 \begin_layout Plain Layout
5716 acts in some ways just like
5717 \begin_inset Flex Noun
5720 \begin_layout Plain Layout
5726 and permits you to bind keys to accented characters.
5727 You can also turn keys into dead-keys by binding them to something like
5729 \begin_inset Flex Code
5732 \begin_layout Plain Layout
5738 and then binding this symbolic key to the corresponding \SpecialChar LyX
5743 \begin_layout Plain Layout
5748 : This is exactly what I do in my
5749 \begin_inset Flex Code
5752 \begin_layout Plain Layout
5759 \begin_inset Flex Code
5762 \begin_layout Plain Layout
5770 \begin_inset Flex Noun
5773 \begin_layout Plain Layout
5775 \begin_inset space ~
5784 \begin_inset Flex Code
5787 \begin_layout Plain Layout
5793 and a bunch of these
5794 \begin_inset Quotes eld
5798 \begin_inset Flex Code
5801 \begin_layout Plain Layout
5808 \begin_inset Quotes erd
5811 symbolic keys bound such things as
5812 \begin_inset Flex Noun
5815 \begin_layout Plain Layout
5817 \begin_inset space ~
5826 \begin_inset Flex Noun
5829 \begin_layout Plain Layout
5831 \begin_inset space ~
5840 This is how I produce my accented characters.
5845 You can make just about anything into the
5846 \begin_inset Flex Code
5849 \begin_layout Plain Layout
5856 \begin_inset Flex Noun
5859 \begin_layout Plain Layout
5865 keys, a spare function key, etc.
5866 As for the \SpecialChar LyX
5867 commands that produce accents, check the entry for
5868 \begin_inset Flex Code
5871 \begin_layout Plain Layout
5882 You'll find the complete list there.
5885 \begin_layout Subsection
5886 Saving your Language Configuration
5889 \begin_layout Standard
5890 You can edit your preferences so that your desired language environment
5891 is automatically configured when \SpecialChar LyX
5893 \begin_inset Flex Noun
5896 \begin_layout Plain Layout
5897 Edit\SpecialChar menuseparator
5906 \begin_layout Chapter
5907 Installing New Document Classes, Layouts, and Templates
5908 \begin_inset CommandInset label
5910 name "cha:Installing-New-Document"
5915 \begin_inset Argument 1
5918 \begin_layout Plain Layout
5919 Installing New Document Classes
5927 \begin_layout Standard
5928 In this chapter, we describe the procedures for creating and installing
5929 new \SpecialChar LyX
5930 layout and template files, as well as offer a refresher on correctly
5931 installing new \SpecialChar LaTeX
5936 \begin_layout Standard
5937 First, let us a say a few words about how one ought to think about the relation
5938 between \SpecialChar LyX
5939 and \SpecialChar LaTeX
5941 The thing to understand is that, in a certain sense, \SpecialChar LyX
5942 doesn't know anything
5943 about \SpecialChar LaTeX
5945 Indeed, from \SpecialChar LyX
5946 's point of view, \SpecialChar LaTeX
5947 is just one of several
5948 \begin_inset Quotes eld
5952 \begin_inset Quotes erd
5955 in which it is capable of producing output.
5956 Other such formats are DocBook, plaintext, and XHTML.
5958 is, of course, a particularly important format, but very little of the
5959 information \SpecialChar LyX
5960 has about \SpecialChar LaTeX
5961 is actually contained in the program itself.
5965 \begin_layout Plain Layout
5966 Some commands are sufficiently complex that they are
5967 \begin_inset Quotes eld
5971 \begin_inset Quotes erd
5974 into \SpecialChar LyX
5976 But the developers generally regard this as a Bad Thing.
5981 Rather, that information, even for the standard classes like
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5991 , is contained in `layout files'.
5992 Similarly, \SpecialChar LyX
5993 itself does not know much about DocBook or XHTML.
5994 What it knows is contained in layout files.
5997 \begin_layout Standard
5998 You can think of the layout file for a given document class as a translation
5999 manual between \SpecialChar LyX
6000 constructs—paragraphs with their corresponding styles,
6001 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6004 Almost everything \SpecialChar LyX
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6015 , for example, is contained in the file
6016 \begin_inset Flex Code
6019 \begin_layout Plain Layout
6025 and in various other files it includes.
6026 For this reason, anyone intending to write layout files should plan to
6027 study the existing files.
6028 A good place to start is with
6029 \begin_inset Flex Code
6032 \begin_layout Plain Layout
6038 , which is included in
6039 \begin_inset Flex Code
6042 \begin_layout Plain Layout
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6058 , and many of the other layout files for document classes.
6059 This file is where sections and the like are defined:
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6069 tells \SpecialChar LyX
6070 how paragraphs that are marked with the Section, Subsection, etc,
6071 styles can be translated into corresponding \SpecialChar LaTeX
6072 , DocBook, and XHTML commands
6075 \begin_inset Flex Code
6078 \begin_layout Plain Layout
6084 file basically just includes several of these
6085 \begin_inset Flex Code
6088 \begin_layout Plain Layout
6097 \begin_layout Standard
6098 Defining the \SpecialChar LyX
6100 correspondence is not the only thing layout files do, though.
6101 Their other job is to define how the \SpecialChar LyX
6102 constructs themselves will appear
6104 The fact that layout files have these two jobs is often a source of confusion,
6105 because they are completely separate.
6106 Telling \SpecialChar LyX
6107 how to translate a certain paragraph style into \SpecialChar LaTeX
6110 how to display it; conversely, telling \SpecialChar LyX
6111 how to display a certain paragraph
6112 style does not tell \SpecialChar LyX
6113 how to translate it into \SpecialChar LaTeX
6114 (let alone tell \SpecialChar LaTeX
6117 So, in general, when you define a new \SpecialChar LyX
6118 construct, you must always do two
6119 quite separate things: (i)
6120 \begin_inset space ~
6123 tell \SpecialChar LyX
6124 how to translate it into \SpecialChar LaTeX
6126 \begin_inset space ~
6129 tell \SpecialChar LyX
6133 \begin_layout Standard
6134 Much the same is true, of course, as regards \SpecialChar LyX
6135 's other backend formats, though
6136 XHTML is in some ways different, because in that case \SpecialChar LyX
6141 able, to some extent, to use information about how it should display a
6142 paragraph on the screen to output information (in the form of CSS) about
6143 how the paragraph should be displayed in a browser.
6144 Even in this case, however, the distinction between what \SpecialChar LyX
6146 and how things are rendered externally remains in force, and the two can
6147 be controlled separately.
6149 \begin_inset CommandInset ref
6151 reference "sec:Tags-for-XHTML"
6158 \begin_layout Section
6159 Installing new \SpecialChar LaTeX
6163 \begin_layout Standard
6164 Some installations may not include a \SpecialChar LaTeX
6165 package or class file that you would
6166 like to use within \SpecialChar LyX
6168 For example, you might need Foil\SpecialChar TeX
6169 , a package for preparing slides for overhead
6171 Modern \SpecialChar LaTeX
6172 distributions like \SpecialChar TeX
6173 Live (2008 or newer) or MiK\SpecialChar TeX
6174 provide a user interface
6175 for installing such packages.
6176 For example, with MiK\SpecialChar TeX
6177 , you start the program
6178 \begin_inset Quotes eld
6182 \begin_inset space ~
6186 \begin_inset Quotes erd
6189 to get a list of available packages.
6190 To install one of them, right click on it or use the corresponding toolbar
6194 \begin_layout Standard
6195 If your \SpecialChar LaTeX
6196 distribution does not provide such a `package manager', or if the
6197 package is not available from your distribution, then follow these steps
6198 to install it manually:
6201 \begin_layout Enumerate
6202 Get the package from
6203 \begin_inset CommandInset href
6206 target "http://www.ctan.org/"
6214 \begin_layout Enumerate
6215 If the package contains a file with the ending
6216 \begin_inset Quotes eld
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6230 \begin_inset Quotes erd
6233 (is the case for Foil\SpecialChar TeX
6234 ) then open a console, change to the folder of this
6235 file and execute the command
6236 \begin_inset Flex Code
6239 \begin_layout Plain Layout
6246 You have now unpacked the package and have all files to install it.
6247 Most \SpecialChar LaTeX
6248 -packages are not packed and you can skip this step.
6251 \begin_layout Enumerate
6252 Now you need to decide if the package should be available for all users
6257 \begin_layout Enumerate
6258 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6259 for all users on your system, then install it in your `local' \SpecialChar TeX
6261 install it in your own `user' \SpecialChar TeX
6263 Where these trees should be created, if they do not already exist, depends
6265 To find this out, look in the file
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6279 \begin_layout Plain Layout
6280 This is usually in the directory
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6290 , though you can execute the command
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6305 The location of the `local' \SpecialChar TeX
6306 tree is defined by the
6307 \begin_inset Flex Code
6310 \begin_layout Plain Layout
6316 variable; this is usually somewhere like
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6321 /usr/local/share/texmf
6326 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6329 The location of the `user' \SpecialChar TeX
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6341 \begin_inset Flex Code
6344 \begin_layout Plain Layout
6351 \begin_inset Flex Code
6354 \begin_layout Plain Layout
6363 (If these variables are not predefined, you have to define them.) You'll
6364 probably need root permissions to create or modify the `local' tree, but
6365 not for your `user' tree.
6366 \begin_inset Newline newline
6369 In general, it is recommended to install in the user tree because your user
6370 will not be modified or even overwritten when you upgrade your system.
6371 It will typically also be backed up together with everything else when
6372 you backup your home directory (which, of course, you do on a regular basis).
6375 \begin_layout Enumerate
6376 On Windows, if you want the new package to be available for all users on
6377 your system, change to the folder where \SpecialChar LaTeX
6378 is installed and then change to
6380 \begin_inset Flex Code
6383 \begin_layout Plain Layout
6394 (For MiK\SpecialChar TeX
6395 , this would be by default the folder
6396 \begin_inset Flex Code
6399 \begin_layout Plain Layout
6417 \begin_layout Plain Layout
6418 Note that this will be the correct path only on English installations.
6419 On a German one, it would be
6420 \begin_inset Flex Code
6423 \begin_layout Plain Layout
6437 , and similarly for other languages.
6442 Create there a new folder
6443 \begin_inset Flex Code
6446 \begin_layout Plain Layout
6452 and copy all files of the package into it.
6454 \begin_inset Newline newline
6457 If the package should only available for you or you don't have admin permissions
6458 , do the same, but in the local \SpecialChar LaTeX
6461 \begin_inset space \thinspace{}
6464 g., for MiK\SpecialChar TeX
6466 \begin_inset space ~
6469 2.8 under Windows XP, this would be the folder:
6470 \begin_inset Newline newline
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6482 Documents and Settings
6494 \begin_inset Newline newline
6500 \begin_inset Phantom HPhantom
6503 \begin_layout Plain Layout
6514 \begin_inset Flex Code
6517 \begin_layout Plain Layout
6530 \begin_inset Newline newline
6533 On Vista, it would be:
6534 \begin_inset Newline newline
6538 \begin_inset Flex Code
6541 \begin_layout Plain Layout
6567 \begin_layout Enumerate
6568 Now one only need to tell \SpecialChar LaTeX
6569 that there are new files.
6570 This depends on the used \SpecialChar LaTeX
6575 \begin_layout Enumerate
6576 For \SpecialChar TeX
6577 Live execute the command
6578 \begin_inset Flex Code
6581 \begin_layout Plain Layout
6588 If you installed the package for all users, then you will probably need
6589 to have root permissions for that.
6592 \begin_layout Enumerate
6593 For MiK\SpecialChar TeX
6594 , if you have installed the package for all users, start the program
6596 \begin_inset Quotes eld
6600 \begin_inset space ~
6604 \begin_inset Quotes erd
6607 and press the button marked
6608 \begin_inset Quotes eld
6612 \begin_inset Quotes erd
6616 Otherwise start the program
6617 \begin_inset Quotes eld
6621 \begin_inset Quotes erd
6628 \begin_layout Enumerate
6629 Finally, you need to tell \SpecialChar LyX
6630 that there are new packages available.
6631 So, in \SpecialChar LyX
6633 \begin_inset Flex Noun
6636 \begin_layout Plain Layout
6639 \SpecialChar menuseparator
6645 and then restart \SpecialChar LyX
6649 \begin_layout Standard
6650 Now the package is installed.
6651 In our example, the document class
6652 \begin_inset Flex Code
6655 \begin_layout Plain Layout
6661 will now be available under
6662 \begin_inset Flex Noun
6665 \begin_layout Plain Layout
6666 Document\SpecialChar menuseparator
6667 Settings\SpecialChar menuseparator
6674 \begin_inset Quotes eld
6678 \begin_inset Quotes erd
6685 \begin_layout Standard
6686 If you would like to use a \SpecialChar LaTeX
6687 document class that is not even listed in the
6689 \begin_inset Flex Noun
6692 \begin_layout Plain Layout
6693 Document\SpecialChar menuseparator
6694 Settings\SpecialChar menuseparator
6700 , then you need to create a `layout' file for it.
6701 That is the topic of the next section.
6704 \begin_layout Section
6705 Types of layout files
6708 \begin_layout Standard
6709 This section describes the various sorts of \SpecialChar LyX
6710 files that contain layout informati
6712 These files describe various paragraph and character styles, determining
6713 how \SpecialChar LyX
6714 should display them and how they should be translated into \SpecialChar LaTeX
6716 XHTML, or whatever output format is being used.
6720 \begin_layout Standard
6721 We shall try to provide a thorough description of the process of writing
6723 However, there are so many different types of documents supported even
6724 by just \SpecialChar LaTeX
6725 that we can't hope to cover every different possibility or problem
6726 you might encounter.
6727 The \SpecialChar LyX
6728 users' list is frequented by people with lots of experience with layout
6729 design who are willing to share what they've learned, so please feel free
6730 to ask questions there.
6733 \begin_layout Standard
6734 As you prepare to write a new layout, it is extremely helpful to look at
6735 the layouts distributed with \SpecialChar LyX
6737 If you write a \SpecialChar LyX
6738 layout for a \SpecialChar LaTeX
6739 document class that might also be used by
6740 others, or write a module that might be useful to others, then you should
6741 consider posting your layout to the
6742 \begin_inset CommandInset href
6744 name "layout section on the LyX wiki"
6745 target "https://wiki.lyx.org/Layouts/Layouts"
6750 or even to the \SpecialChar LyX
6751 developers' list, so that it might be included in \SpecialChar LyX
6756 \begin_layout Plain Layout
6757 Note that \SpecialChar LyX
6758 is licensed under the General Public License, so any material
6759 that is contributed to \SpecialChar LyX
6760 must be similarly licensed.
6768 \begin_layout Subsection
6770 \begin_inset CommandInset label
6772 name "subsec:Layout-modules"
6779 \begin_layout Standard
6780 We have spoken to this point about `layout files'.
6781 But there are different sorts of files that contain layout information.
6782 Layout files, strictly so called, have the
6783 \begin_inset Flex Code
6786 \begin_layout Plain Layout
6792 extension and provide \SpecialChar LyX
6793 with information about document classes.
6794 Since \SpecialChar LyX
6795 1.6 layout information can also be contained in layout
6800 \begin_inset Flex Code
6803 \begin_layout Plain Layout
6810 Modules are to \SpecialChar LaTeX
6811 packages much as layouts are to \SpecialChar LaTeX
6812 classes, and some modules—such
6814 \begin_inset Flex Code
6817 \begin_layout Plain Layout
6823 module—specifically provide support for one package.
6824 In a sense, layout modules are similar to included
6828 \begin_layout Plain Layout
6829 These can have any extension, but by convention have the
6830 \begin_inset Flex Code
6833 \begin_layout Plain Layout
6845 \begin_inset Flex Code
6848 \begin_layout Plain Layout
6854 —in that modules are not specific to a given document class but may be used
6855 with many different classes.
6856 The difference is that using an included file with
6857 \begin_inset Flex Code
6860 \begin_layout Plain Layout
6866 requires editing that file.
6867 Modules, by contrast, are selected in the
6868 \begin_inset Flex Noun
6871 \begin_layout Plain Layout
6872 Document\SpecialChar menuseparator
6881 \begin_layout Standard
6882 Building modules is the easiest way to get started with layout editing,
6883 since it can be as simple as adding a single new paragraph style or flex
6885 But modules may, in principle, contain anything a layout file can contain.
6888 \begin_layout Standard
6889 After creating a new module and copying it to the
6890 \begin_inset Flex Code
6893 \begin_layout Plain Layout
6899 folder, you will need to reconfigure and then restart \SpecialChar LyX
6902 However, changes you make to the module will be seen immediately, if you
6904 \begin_inset Flex Noun
6907 \begin_layout Plain Layout
6908 Document\SpecialChar menuseparator
6914 , highlight something, and then hit
6915 \begin_inset Quotes eld
6919 \begin_inset Quotes erd
6925 It is strongly recommended that you save your work before doing this
6930 it is strongly recommended that you not attempt to edit modules while simultaneo
6931 usly working on actual documents
6934 Though of course the developers strive to keep \SpecialChar LyX
6935 stable in such situations,
6936 syntax errors and the like in your module file could cause strange behavior.
6939 \begin_layout Subsubsection
6943 \begin_layout Standard
6944 Modules are to \SpecialChar LyX
6945 as packages are to \SpecialChar LaTeX
6947 Sometimes, however, you find yourself wanting a specific inset or character
6948 style just for one document and writing a module that will also be available
6949 to other documents makes little sense.
6950 What you need is \SpecialChar LyX
6952 \begin_inset Quotes eld
6956 \begin_inset Quotes erd
6962 \begin_layout Standard
6963 You will find it under
6965 Document\SpecialChar menuseparator
6966 Settings\SpecialChar menuseparator
6970 The large text box allows you to enter anything that you might enter in
6971 a layout file or module.
6972 You can think of a document's local layout, in fact, as a module that belongs
6974 So, in particular, you must enter a
6975 \begin_inset Flex Code
6978 \begin_layout Plain Layout
6985 Any format is acceptable, but one would normally use the format current
6987 (In \SpecialChar LyX
6994 , the current layout format is
7003 \begin_layout Standard
7004 When you have entered something in the
7005 \begin_inset Flex Code
7008 \begin_layout Plain Layout
7014 pane, \SpecialChar LyX
7016 \begin_inset Quotes eld
7020 \begin_inset Quotes erd
7023 button at the bottom.
7024 Clicking this button will cause \SpecialChar LyX
7025 to determine whether what you have entered
7026 is valid layout information for the chosen format.
7028 will report the result but, unfortunately, will not tell you what errors
7029 there might have been.
7030 These will be written to the terminal, however, if \SpecialChar LyX
7031 is started from a terminal.
7032 You will not be permitted to save your local layout until you have entered
7036 \begin_layout Standard
7037 The warnings at the end of the previous section apply here, too.
7038 Do not play with local layout while you are actually working, especially
7039 if you have not saved your document.
7040 That said, using local layout with a test document can be a very convenient
7041 way to try out layout ideas, or even to start developing a module.
7044 \begin_layout Subsection
7046 \begin_inset Flex Noun
7049 \begin_layout Plain Layout
7058 \begin_layout Standard
7059 There are two situations you are likely to encounter when wanting to support
7060 a new \SpecialChar LaTeX
7061 document class, involving style (
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7071 ) files and \SpecialChar LaTeX2e
7073 \begin_inset Flex Code
7076 \begin_layout Plain Layout
7083 Supporting a style file is usually fairly easy.
7084 Supporting a new class file is a bit harder.
7085 We'll discuss the former in this section and the latter in the next.
7087 \change_deleted 5863208 1594239023
7088 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7093 \begin_layout Standard
7094 The easier case is the one in which your new document class is provided
7095 as a style file that is to be used in conjunction with an already supported
7097 For the sake of the example, we'll assume that the style file is called
7099 \begin_inset Flex Noun
7102 \begin_layout Plain Layout
7108 and that it is meant to be used with
7109 \begin_inset Flex Noun
7112 \begin_layout Plain Layout
7118 , which is a standard class.
7122 \begin_layout Standard
7123 Start by copying the existing class's layout file into your local directory:
7127 \begin_layout Plain Layout
7128 Of course, which directory is your local directory will vary by platform,
7129 and \SpecialChar LyX
7130 allows you to specify your local directory on startup, too, using
7132 \begin_inset Flex Code
7135 \begin_layout Plain Layout
7149 \begin_layout LyX-Code
7150 cp report.layout ~/.lyx/layouts/myclass.layout
7153 \begin_layout Standard
7155 \begin_inset Flex Code
7158 \begin_layout Plain Layout
7164 and change the line:
7167 \begin_layout LyX-Code
7170 DeclareLaTeXClass{Report (Standard Class)}
7173 \begin_layout Standard
7177 \begin_layout LyX-Code
7180 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7183 \begin_layout Standard
7187 \begin_layout LyX-Code
7189 \begin_inset Newline newline
7195 \begin_inset Newline newline
7201 \begin_layout Standard
7202 near the top of the file.
7205 \begin_layout Standard
7206 Start \SpecialChar LyX
7208 \begin_inset Flex Noun
7211 \begin_layout Plain Layout
7212 Tools\SpecialChar menuseparator
7219 Then restart \SpecialChar LyX
7220 and try creating a new document.
7222 \begin_inset Flex Noun
7225 \begin_layout Plain Layout
7231 " as a document class option in the
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7236 Document\SpecialChar menuseparator
7243 It is likely that some of the sectioning commands and such in your new
7244 class will work differently from how they worked in the base class—
7245 \begin_inset Flex Code
7248 \begin_layout Plain Layout
7254 in this example—so you can fiddle around with the settings for the different
7255 sections if you wish.
7256 The layout information for sections is contained in
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7266 , but you do not need to copy and change this file.
7267 Instead, you can simply add your changes to your layout file, after the
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 , which itself includes
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7289 For example, you might add these lines:
7292 \begin_layout LyX-Code
7296 \begin_layout LyX-Code
7300 \begin_layout LyX-Code
7304 \begin_layout LyX-Code
7308 \begin_layout LyX-Code
7312 \begin_layout Standard
7313 to change the font for chapter headings to sans-serif.
7314 This will override (or, in this case, add to) the existing declaration
7315 for the Chapter style.
7319 \begin_layout Standard
7320 Your new package may also provide commands or environments not present in
7322 In this case, you will want to add these to the layout file.
7324 \begin_inset CommandInset ref
7326 reference "sec:TextClass"
7330 for information on how to do so.
7333 \begin_layout Standard
7335 \begin_inset Flex Noun
7338 \begin_layout Plain Layout
7344 can be used with several different document classes, and even if it cannot,
7345 you might find it easiest just to write a module that you can load with
7347 The simplest possible such module would be:
7350 \begin_layout LyX-Code
7353 DeclareLyXModule{My Class}
7356 \begin_layout LyX-Code
7360 \begin_layout LyX-Code
7361 #Support for myclass.sty.
7364 \begin_layout LyX-Code
7366 \begin_inset Newline newline
7372 \begin_layout LyX-Code
7380 \begin_inset Newline newline
7386 \begin_layout LyX-Code
7388 \begin_inset Newline newline
7394 \begin_inset Newline newline
7400 \begin_layout Standard
7401 A more complex module might modify the behavior of some existing constructs
7402 or define some new ones.
7404 \begin_inset CommandInset ref
7406 reference "sec:TextClass"
7413 \begin_layout Subsection
7415 \begin_inset Flex Noun
7418 \begin_layout Plain Layout
7427 \begin_layout Standard
7428 There are two possibilities here.
7429 One is that the class file is itself based upon an existing document class.
7430 For example, many thesis classes are based upon
7431 \begin_inset Flex Noun
7434 \begin_layout Plain Layout
7441 To see whether yours is, look for a line like
7444 \begin_layout LyX-Code
7450 \begin_layout Standard
7452 If so, then you may proceed largely as in the previous section, though
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7458 Declare\SpecialChar LaTeX
7464 line will be different.
7465 If your new class is
7466 \begin_inset Flex Code
7469 \begin_layout Plain Layout
7475 and it is based upon
7476 \begin_inset Flex Code
7479 \begin_layout Plain Layout
7485 , then the line should read:
7489 \begin_layout Plain Layout
7490 And it will be easiest if you save the file to
7491 \begin_inset Flex Code
7494 \begin_layout Plain Layout
7501 assumes that the document class has the same name as the layout file.
7510 \begin_layout LyX-Code
7513 DeclareLaTeXClass[thesis,book]{thesis}
7516 \begin_layout Standard
7517 If, on the other hand, the new class is not based upon an existing class,
7518 you will probably have to
7519 \begin_inset Quotes eld
7523 \begin_inset Quotes erd
7527 We strongly suggest copying an existing layout file which uses a similar
7529 class and then modifying it, if you can do so.
7530 At least use an existing file as a starting point so you can find out what
7531 items you need to worry about.
7532 Again, the specifics are covered below.
7535 \begin_layout Subsection
7537 \begin_inset CommandInset label
7539 name "subsec:Creating-Templates"
7546 \begin_layout Standard
7547 Once you have written a layout file for a new document class, you might
7548 want to consider writing a
7553 A template acts as a kind of tutorial for your layout, showing how it might
7554 be used, though containing dummy content.
7555 You can of course look at the various templates included with \SpecialChar LyX
7559 \begin_layout Standard
7560 Templates are created just like usual documents: using \SpecialChar LyX
7562 The only difference is that usual documents contain all possible settings,
7563 including the font scheme and the paper size.
7564 Usually a user doesn't want a template to overwrite his preferred settings
7565 for such parameters.
7566 For that reason, the designer of a template should remove the corresponding
7568 \begin_inset Flex Code
7571 \begin_layout Plain Layout
7580 \begin_inset Flex Code
7583 \begin_layout Plain Layout
7591 from the template \SpecialChar LyX
7593 This can be done with any simple text-editor, for example
7594 \begin_inset Flex Code
7597 \begin_layout Plain Layout
7604 \begin_inset Flex Code
7607 \begin_layout Plain Layout
7616 \begin_layout Standard
7617 Put the edited template files you create in
7618 \begin_inset Flex Code
7621 \begin_layout Plain Layout
7627 , copy the ones you use from the global template directory in
7628 \begin_inset Flex Code
7631 \begin_layout Plain Layout
7637 to the same place, and redefine the template path in the
7638 \begin_inset Flex Noun
7641 \begin_layout Plain Layout
7642 Tools\SpecialChar menuseparator
7643 Preferences\SpecialChar menuseparator
7652 \begin_layout Standard
7653 Note, by the way, that there is a template which has a particular meaning:
7654 \begin_inset Newline linebreak
7658 \begin_inset Flex Code
7661 \begin_layout Plain Layout
7668 This template is loaded every time you create a new document with
7669 \begin_inset Flex Noun
7672 \begin_layout Plain Layout
7673 File\SpecialChar menuseparator
7679 in order to provide useful defaults.
7680 To create this template from inside \SpecialChar LyX
7681 , all you have to do is to open a document
7682 with the correct settings, and use the
7683 \begin_inset Flex Noun
7686 \begin_layout Plain Layout
7687 Save as Document Defaults
7695 \begin_layout Subsection
7696 Upgrading old layout files
7699 \begin_layout Standard
7700 The format of layout files changes with each \SpecialChar LyX
7701 release, so old layout files
7702 need to be converted to the new format.
7704 reads a layout file in an older format, it automatically calls the
7706 \begin_inset Flex Code
7709 \begin_layout Plain Layout
7715 to convert it to a temporary file in current format.
7716 The original file is left untouched.
7717 If you use the layout file often, then, you may want to convert it permanently,
7718 so that \SpecialChar LyX
7719 does not have to do so itself every time.
7720 To do this, you can call the converter manually:
7723 \begin_layout Enumerate
7725 \begin_inset Flex Code
7728 \begin_layout Plain Layout
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7747 \begin_layout Enumerate
7749 \begin_inset Newline newline
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7757 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7763 \begin_inset Newline newline
7767 \begin_inset Flex Code
7770 \begin_layout Plain Layout
7776 is the name of your \SpecialChar LyX
7780 \begin_layout Standard
7781 Note that manual conversion does not affect included files, so these will
7782 have to be converted separately.
7785 \begin_layout Subsection
7786 \begin_inset CommandInset label
7788 name "subsec:Cite-Engine-Files"
7795 \begin_layout Standard
7796 A specific form of layout files are the so-called
7797 \begin_inset Flex Code
7800 \begin_layout Plain Layout
7806 files that are located in the
7807 \begin_inset Flex Code
7810 \begin_layout Plain Layout
7817 Their purpose is to define the specifics of \SpecialChar LaTeX
7818 packages aimed at bibliography
7831 , but also the way how normal Bib\SpecialChar TeX
7832 citations (without additional packages)
7833 are handled in \SpecialChar LyX
7834 is defined in such a file.
7838 \begin_layout Standard
7839 More specifically, it is defined which packages \SpecialChar LyX
7840 needs to load, which citation
7841 commands are available, how these are to be displayed in \SpecialChar LyX
7843 the dialogs, the context menus) as well as in the XHTML and plain text
7845 Furthermore, the files specify available style variants (author-year, numerical
7846 , etc.) and their specifics.
7847 The cite engine files are also used to generate the options that are available
7850 Document\SpecialChar menuseparator
7851 Settings\SpecialChar menuseparator
7852 Bibliography\SpecialChar menuseparator
7858 \begin_layout Standard
7859 Even though a cite engine file is essentially a normal layout file that
7860 could theoretically include any layout information, it usually primarily
7861 includes some specific parameters such as
7862 \begin_inset Flex Code
7865 \begin_layout Plain Layout
7872 \begin_inset Flex Code
7875 \begin_layout Plain Layout
7882 \begin_inset Flex Code
7885 \begin_layout Plain Layout
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7902 The syntax of the latter two is described in
7903 \begin_inset CommandInset ref
7905 reference "subsec:Citation-engine-description"
7913 \begin_inset CommandInset ref
7915 reference "subsec:Citation-format-description"
7919 , as well as in the files themselves.
7922 \begin_layout Section
7923 \begin_inset CommandInset label
7925 name "sec:TextClass"
7929 The layout file format
7932 \begin_layout Standard
7933 The following sections describe how layout files are structured and written.
7934 Our advice is to go slowly, save and test often.
7935 It is really not that hard, except that the multitude of options can become
7936 overwhelming, especially if you try to check out too many at once.
7937 It becomes easier if you use existing layouts of \SpecialChar LyX
7938 as examples/reference
7939 or if you modify an existing layout to your needs.
7942 \begin_layout Standard
7943 Note that all the tags used in layout files are case-insensitive.
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7955 \begin_inset Flex Code
7958 \begin_layout Plain Layout
7965 \begin_inset Flex Code
7968 \begin_layout Plain Layout
7974 are really the same tag.
7975 The possible arguments are printed in brackets after the tag's name.
7976 The default argument is typeset
7977 \begin_inset Flex Code
7980 \begin_layout Plain Layout
7989 If the argument has a data type like
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 \begin_inset Quotes eld
8002 \begin_inset Quotes erd
8005 , the default is shown like this:
8006 \begin_inset Flex Code
8009 \begin_layout Plain Layout
8020 \begin_layout Subsection
8021 The document class declaration and classification
8024 \begin_layout Standard
8025 Lines in a layout file which begin with
8026 \begin_inset Flex Code
8029 \begin_layout Plain Layout
8036 There is one exception to this rule.
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8047 files should begin with lines like:
8050 \begin_layout LyX-Code
8053 #% Do not delete the line below; configure depends on this
8056 \begin_layout LyX-Code
8061 DeclareLaTeXClass{Article (Standard Class)}
8064 \begin_layout LyX-Code
8069 DeclareCategory{Articles}
8072 \begin_layout Standard
8073 The second and third lines are used when you (re)configure \SpecialChar LyX
8075 The layout file is read by the \SpecialChar LaTeX
8077 \begin_inset Flex Code
8080 \begin_layout Plain Layout
8086 , in a special mode where
8087 \begin_inset Flex Code
8090 \begin_layout Plain Layout
8097 The first line is just a \SpecialChar LaTeX
8098 comment, the second one contains the mandatory
8099 declaration of the text class and the third line contains the optional
8100 classification of the class.
8101 If these lines appear in a file named
8102 \begin_inset Flex Code
8105 \begin_layout Plain Layout
8111 , then they define a text class of name
8112 \begin_inset Flex Code
8115 \begin_layout Plain Layout
8121 (the name of the layout file) which uses the \SpecialChar LaTeX
8123 \begin_inset Flex Code
8126 \begin_layout Plain Layout
8132 (the default is to use the same name as the layout).
8134 \begin_inset Quotes eld
8137 Article (Standard Class)
8138 \begin_inset Quotes erd
8141 that appears above is used as a description of the text class in the
8142 \begin_inset Flex Noun
8145 \begin_layout Plain Layout
8146 Document\SpecialChar menuseparator
8154 \begin_inset Quotes eld
8158 \begin_inset Quotes erd
8161 in the example) is also used in the
8162 \begin_inset Flex Noun
8165 \begin_layout Plain Layout
8166 Document\SpecialChar menuseparator
8172 dialog: the text classes are grouped by these categories (which are usually
8173 genres, so typical categories are
8174 \begin_inset Quotes eld
8178 \begin_inset Quotes erd
8182 \begin_inset Quotes eld
8186 \begin_inset Quotes erd
8190 \begin_inset Quotes eld
8194 \begin_inset Quotes erd
8198 \begin_inset Quotes eld
8202 \begin_inset Quotes erd
8206 \begin_inset Quotes eld
8210 \begin_inset Quotes erd
8214 \begin_inset Quotes eld
8218 \begin_inset Quotes erd
8222 If no category has been declared, the class will be put in the
8223 \begin_inset Quotes eld
8227 \begin_inset Quotes erd
8233 \begin_layout Standard
8234 Let's assume that you wrote your own text class that uses the
8235 \begin_inset Flex Code
8238 \begin_layout Plain Layout
8244 document class, but where you changed the appearance of the section headings.
8245 If you put it in a file
8246 \begin_inset Flex Code
8249 \begin_layout Plain Layout
8255 , the header of this file should be:
8258 \begin_layout LyX-Code
8261 #% Do not delete the line below; configure depends on this
8264 \begin_layout LyX-Code
8269 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8272 \begin_layout LyX-Code
8277 DeclareCategory{Articles}
8280 \begin_layout Standard
8281 This declares a text class
8282 \begin_inset Flex Code
8285 \begin_layout Plain Layout
8291 , associated with the \SpecialChar LaTeX
8293 \begin_inset Flex Code
8296 \begin_layout Plain Layout
8303 \begin_inset Quotes eld
8306 Article (with My Own Headings)
8307 \begin_inset Quotes erd
8311 If your text class depends on several packages, you can declare it as:
8314 \begin_layout LyX-Code
8317 #% Do not delete the line below; configure depends on this
8320 \begin_layout LyX-Code
8325 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8328 \begin_layout LyX-Code
8333 DeclareCategory{Articles}
8336 \begin_layout Standard
8337 This indicates that your text class uses the
8338 \begin_inset Flex Code
8341 \begin_layout Plain Layout
8349 \change_deleted 5863208 1594239179
8350 Finally, it is also possible to declare classes for DocBook code.
8351 Typical declarations will look like:
8354 \begin_layout LyX-Code
8356 \change_deleted 5863208 1594239179
8359 #% Do not delete the line below; configure depends on this
8362 \begin_layout LyX-Code
8364 \change_deleted 5863208 1594239179
8369 DeclareDocBookClass[article]{SGML (DocBook Article)}
8372 \begin_layout LyX-Code
8374 \change_deleted 5863208 1594239179
8379 DeclareCategory{Articles (DocBook)}
8384 \begin_layout Standard
8385 Note that these declarations can also be given an optional parameter declaring
8386 the name of the document class (but not a list).
8389 \begin_layout Standard
8390 So, to be as explicit as possible, the form of the layout declaration is:
8393 \begin_layout LyX-Code
8398 DeclareLaTeXClass[class,package.sty]{layout description}
8401 \begin_layout LyX-Code
8406 DeclareCategory{category}
8409 \begin_layout Standard
8410 The class need only be specified if the name of the \SpecialChar LaTeX
8412 name of the layout file are different or if there are packages to load.
8413 If the name of the class file is not specified, then \SpecialChar LyX
8415 that it is the same as the name of the layout file.
8418 \begin_layout Standard
8419 When the text class has been modified to your taste, all you have to do
8420 is to copy it either to
8421 \begin_inset Flex Code
8424 \begin_layout Plain Layout
8431 \begin_inset Flex Code
8434 \begin_layout Plain Layout
8441 \begin_inset Flex Noun
8444 \begin_layout Plain Layout
8445 Tools\SpecialChar menuseparator
8451 , exit \SpecialChar LyX
8453 Then your new text class should be available along with the others.
8456 \begin_layout Standard
8457 Once the layout file is installed, you can edit it and see your changes
8458 without having to reconfigure or to restart \SpecialChar LyX
8463 \begin_layout Plain Layout
8464 In versions of \SpecialChar LyX
8465 prior to 1.6, this was not true.
8466 As a result, editing layout files was very time consuming, since you had
8467 constantly to restart \SpecialChar LyX
8473 You can force a reload of the current layout by using the \SpecialChar LyX
8475 \begin_inset Flex Noun
8478 \begin_layout Plain Layout
8485 There is no default binding for this function—though, of course, you can
8486 bind it to a key yourself.
8487 But you will normally use this function simply by entering it in the mini-buffe
8492 \begin_layout Standard
8498 \begin_inset Flex Noun
8501 \begin_layout Plain Layout
8507 is very much an `advanced feature'.
8512 recommended that you save your work before using this function.
8517 recommended that you not attempt to edit layout information while simultaneousl
8518 y working on a document that you care about.
8519 Use a test document.
8520 Syntax errors and the like in your layout file could cause peculiar behavior.
8521 In particular, such errors could cause \SpecialChar LyX
8522 to regard the current layout as
8523 invalid and to attempt to switch to some other layout.
8527 \begin_layout Plain Layout
8528 Really bad syntax errors may even caused \SpecialChar LyX
8530 This is because certain sorts of errors may make \SpecialChar LyX
8541 The \SpecialChar LyX
8542 team strives to keep \SpecialChar LyX
8543 stable in such situations, but safe is better
8548 \begin_layout Plain Layout
8549 While we're giving advice: make regular backups.
8550 And be nice to your mother.
8558 \begin_layout Subsection
8559 The Module declaration
8562 \begin_layout Standard
8563 A module must begin with a line like the following:
8566 \begin_layout LyX-Code
8569 DeclareLyXModule[endnotes.sty]{Endnotes}
8570 \change_inserted -712698321 1554395911
8574 \begin_layout LyX-Code
8576 \change_inserted -712698321 1554395924
8581 DeclareCategory{Foot- and Endnotes}
8582 \change_deleted -712698321 1554395911
8590 \begin_layout Standard
8591 The mandatory argument
8592 \change_inserted -712698321 1554395956
8601 , in curly brackets, is the name of the module, as it should appear in
8602 \begin_inset Flex Noun
8605 \begin_layout Plain Layout
8606 Document\SpecialChar menuseparator
8607 Settings\SpecialChar menuseparator
8614 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8616 on which the module depends.
8617 It is also possible to use the form
8618 \begin_inset Flex Noun
8621 \begin_layout Plain Layout
8627 as an optional argument, which declares that the module can only be used
8628 when there exists a conversion chain between the formats `
8629 \begin_inset Flex Code
8632 \begin_layout Plain Layout
8639 \begin_inset Flex Code
8642 \begin_layout Plain Layout
8650 \change_inserted -712698321 1554396133
8657 declaration is not strictly mandatory, but you should add it, since it
8658 is helpful to find the module.
8659 Please have a look at the existing module categories and if appropriate,
8665 \begin_layout Standard
8667 \change_inserted -712698321 1554395988
8670 declaration should then be followed by lines like the following:
8674 \begin_layout Plain Layout
8675 Preferably in English if the module should be published with \SpecialChar LyX
8677 This description will appear in the list of messages to be translated and
8678 will be thus translated with the next interface update.
8686 \begin_layout LyX-Code
8690 \begin_layout LyX-Code
8691 #Adds an endnote command, in addition to footnotes.
8695 \begin_layout LyX-Code
8696 #You will need to add
8698 theendnotes in TeX code where you
8701 \begin_layout LyX-Code
8702 #want the endnotes to appear.
8706 \begin_layout LyX-Code
8710 \begin_layout LyX-Code
8711 #Requires: somemodule | othermodule
8714 \begin_layout LyX-Code
8715 #Excludes: badmodule
8718 \begin_layout Standard
8719 The description is used in
8720 \begin_inset Flex Noun
8723 \begin_layout Plain Layout
8724 Document\SpecialChar menuseparator
8725 Settings\SpecialChar menuseparator
8731 to provide the user with information about what the module does.
8733 \begin_inset Flex Code
8736 \begin_layout Plain Layout
8742 line is used to identify other modules with which this one must be used;
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8753 line is used to identify modules with which this one may not be used.
8754 Both are optional, and, as shown, multiple modules should be separated
8755 with the pipe symbol: |.
8756 Note that the required modules are treated disjunctively:
8760 of the required modules must be used.
8765 excluded module may be used.
8766 Note that modules are identified here by their filenames without the
8767 \begin_inset Flex Code
8770 \begin_layout Plain Layout
8778 \begin_inset Flex Code
8781 \begin_layout Plain Layout
8788 \begin_inset Flex Code
8791 \begin_layout Plain Layout
8800 \begin_layout Subsection
8801 The CiteEngine file declaration
8804 \begin_layout Standard
8805 A cite engine file must begin with a line like the following:
8808 \begin_layout LyX-Code
8811 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8814 \begin_layout Standard
8815 The mandatory argument, in curly brackets, is the name of the cite style,
8816 as it should appear in
8817 \begin_inset Flex Noun
8820 \begin_layout Plain Layout
8821 Document\SpecialChar menuseparator
8822 Settings\SpecialChar menuseparator
8829 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8831 on which the cite engine depends.
8834 \begin_layout Standard
8835 The cite engine declaration should then be followed by lines like the following:
8839 \begin_layout Plain Layout
8840 Preferably in English if the module should be published with \SpecialChar LyX
8842 This description will appear in the list of messages to be translated and
8843 will be thus translated with the next interface update.
8851 \begin_layout LyX-Code
8855 \begin_layout LyX-Code
8856 # Biblatex supports many author-year and numerical styles.
8859 \begin_layout LyX-Code
8860 # It is mainly aimed at the Humanities.
8864 \begin_layout LyX-Code
8865 # customizable, fully localized and provides many features
8868 \begin_layout LyX-Code
8869 # that are not possible with BibTeX.
8870 The use of 'biber' as
8873 \begin_layout LyX-Code
8874 # bibliography processor is advised.
8877 \begin_layout LyX-Code
8881 \begin_layout Standard
8882 The description is used in
8883 \begin_inset Flex Noun
8886 \begin_layout Plain Layout
8887 Document\SpecialChar menuseparator
8888 Settings\SpecialChar menuseparator
8894 to provide the user with information about the cite engine.
8897 \begin_layout Subsection
8901 \begin_layout Standard
8902 The first non-comment line of any layout file, included file, or module
8907 contain the file format number:
8910 \begin_layout Description
8911 \begin_inset Flex Code
8914 \begin_layout Plain Layout
8921 \begin_inset Flex Code
8924 \begin_layout Plain Layout
8930 ] The format number of the layout file.
8933 \begin_layout Standard
8934 This tag was introduced with \SpecialChar LyX
8936 \begin_inset space ~
8940 Layout files from older \SpecialChar LyX
8941 versions do not have an explicit file format and
8942 are considered to have
8943 \begin_inset Flex Code
8946 \begin_layout Plain Layout
8948 \begin_inset space ~
8957 The format for the present version of \SpecialChar LyX
8959 But each version of \SpecialChar LyX
8960 is capable of reading earlier versions' layout files,
8961 just as they are capable of reading files produced by earlier versions
8964 There is, however, no provision for converting to earlier formats.
8967 \begin_layout Subsection
8968 \begin_inset CommandInset label
8970 name "subsec:General-text-class"
8974 General text class parameters
8977 \begin_layout Standard
8978 These are general parameters that govern the behavior of an entire document
8984 mean that they must appear in
8985 \begin_inset Flex Code
8988 \begin_layout Plain Layout
8994 files rather than in modules.
8995 A module can contain any layout tag.)
8998 \begin_layout Description
9000 \change_inserted -712698321 1526899478
9001 \begin_inset Flex Code
9004 \begin_layout Plain Layout
9006 \change_inserted -712698321 1526898610
9007 AddToCiteEngine <engine>
9012 Extends the possibilities for displaying citation references.
9014 \begin_inset CommandInset ref
9016 reference "subsec:Citation-engine-description"
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9030 \change_inserted -712698321 1526898823
9041 \begin_layout Description
9042 \begin_inset Flex Code
9045 \begin_layout Plain Layout
9051 Adds information that will be output in the
9052 \begin_inset Flex Code
9055 \begin_layout Plain Layout
9061 block when the document is output to XHTML.
9062 Typically, this would be used to output CSS style information, but it can
9063 be used for anything that can appear in
9064 \begin_inset Flex Code
9067 \begin_layout Plain Layout
9075 \begin_inset Quotes eld
9079 \begin_inset Flex Code
9082 \begin_layout Plain Layout
9089 \begin_inset Quotes erd
9095 \begin_layout Description
9096 \begin_inset Flex Code
9099 \begin_layout Plain Layout
9105 Adds information to the document preamble.
9107 \begin_inset Newline newline
9111 \begin_inset Quotes eld
9115 \begin_inset Flex Code
9118 \begin_layout Plain Layout
9125 \begin_inset Quotes erd
9129 \change_inserted -712698321 1562592950
9133 \begin_layout Description
9135 \change_inserted -712698321 1562593040
9136 \begin_inset Flex Code
9139 \begin_layout Plain Layout
9141 \change_inserted -712698321 1562592954
9148 \begin_inset Flex Code
9151 \begin_layout Plain Layout
9153 \change_inserted -712698321 1562592950
9162 \begin_inset space \thinspace{}
9166 \begin_inset Flex Code
9169 \begin_layout Plain Layout
9171 \change_inserted -712698321 1562592950
9177 ] If the document class adds the bibliography to the table of contents,
9178 add this option with value
9179 \begin_inset Flex Code
9182 \begin_layout Plain Layout
9184 \change_inserted -712698321 1562592996
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9198 \change_inserted -712698321 1562593006
9207 This prevents the bibliography from being added twice.
9212 \begin_layout Description
9213 \begin_inset Flex Code
9216 \begin_layout Plain Layout
9222 Defines the possibilities for displaying citation references.
9224 \begin_inset CommandInset ref
9226 reference "subsec:Citation-engine-description"
9235 \begin_inset Quotes eld
9239 \begin_inset Flex Code
9242 \begin_layout Plain Layout
9249 \begin_inset Quotes erd
9253 Primarily used in cite engine files (see
9254 \begin_inset CommandInset ref
9256 reference "subsec:Cite-Engine-Files"
9265 \change_inserted -712698321 1526898530
9266 Note that if you specify this in a layout file or module, any cite engine
9267 definition will be overridden.
9269 \begin_inset Flex Code
9272 \begin_layout Plain Layout
9274 \change_inserted -712698321 1526898530
9287 \begin_layout Description
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9297 Defines formats for use in the display of bibliographic information.
9299 \begin_inset CommandInset ref
9301 reference "subsec:Citation-format-description"
9307 \begin_inset Quotes eld
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9321 \begin_inset Quotes erd
9325 Primarily used in cite engine files (see
9326 \begin_inset CommandInset ref
9328 reference "subsec:Cite-Engine-Files"
9337 \change_inserted -712698321 1526898585
9338 A cite format defined in a layout or module will override the cite engine
9344 \begin_layout Description
9345 \begin_inset Flex Code
9348 \begin_layout Plain Layout
9355 \begin_inset Flex Code
9358 \begin_layout Plain Layout
9367 \begin_inset Flex Code
9370 \begin_layout Plain Layout
9376 ] Determines whether
9380 or Bib\SpecialChar TeX
9381 is used to generate a Bibliography.
9382 Primarily used in cite engine files (see
9383 \begin_inset CommandInset ref
9385 reference "subsec:Cite-Engine-Files"
9395 \begin_layout Description
9396 \begin_inset Flex Code
9399 \begin_layout Plain Layout
9405 Describes various global options supported by the document class.
9407 \begin_inset CommandInset ref
9409 reference "subsec:ClassOptions"
9415 \begin_inset Quotes eld
9419 \begin_inset Flex Code
9422 \begin_layout Plain Layout
9429 \begin_inset Quotes erd
9435 \begin_layout Description
9436 \begin_inset Flex Code
9439 \begin_layout Plain Layout
9446 \begin_inset Flex Code
9449 \begin_layout Plain Layout
9458 \begin_inset space \thinspace{}
9462 \begin_inset Flex Code
9465 \begin_layout Plain Layout
9471 ] Whether the class should
9475 to having one or two columns.
9476 Can be changed in the
9477 \begin_inset Flex Noun
9480 \begin_layout Plain Layout
9481 Document\SpecialChar menuseparator
9490 \begin_layout Description
9491 \begin_inset Flex Code
9494 \begin_layout Plain Layout
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9510 ] This sequence defines the properties for a counter.
9511 If the counter does not yet exist, it is created; if it does exist, it
9514 \begin_inset Quotes eld
9518 \begin_inset Flex Code
9521 \begin_layout Plain Layout
9528 \begin_inset Quotes erd
9532 \begin_inset Newline newline
9536 \begin_inset CommandInset ref
9538 reference "subsec:Counters"
9542 for details on counters.
9545 \begin_layout Description
9546 \begin_inset Flex Code
9549 \begin_layout Plain Layout
9555 Sets the default font used to display the document.
9557 \begin_inset CommandInset ref
9559 reference "subsec:Font-description"
9563 for how to declare fonts.
9565 \begin_inset Quotes eld
9569 \begin_inset Flex Code
9572 \begin_layout Plain Layout
9579 \begin_inset Quotes erd
9585 \begin_layout Description
9586 \begin_inset Flex Code
9589 \begin_layout Plain Layout
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9605 ] Specifies a module to be included by default with this document class.
9606 The module is specified as filename without the
9607 \begin_inset Flex Code
9610 \begin_layout Plain Layout
9617 The user can still remove the module, but it will be active at the outset.
9618 (This applies only when new files are created, or when this class is chosen
9619 for an existing document.)
9622 \begin_layout Description
9623 \begin_inset Flex Code
9626 \begin_layout Plain Layout
9633 \begin_inset Flex Code
9636 \begin_layout Plain Layout
9642 ] This is the style that will be assigned to new paragraphs, usually
9643 \begin_inset Flex Noun
9646 \begin_layout Plain Layout
9653 This will default to the first defined style if not given, but you are
9654 encouraged to use this directive.
9657 \begin_layout Description
9659 \change_inserted -970929547 1515112870
9660 \begin_inset Flex Code
9663 \begin_layout Plain Layout
9665 \change_inserted -970929547 1515112782
9672 \begin_inset Flex Code
9675 \begin_layout Plain Layout
9677 \change_inserted -970929547 1515112766
9683 ] The root element (at the top of the document) to use when outputting documents
9684 with this class in DocBook.
9685 The default value is
9686 \begin_inset Quotes eld
9690 \begin_inset Flex Code
9693 \begin_layout Plain Layout
9695 \change_inserted -970929547 1515112845
9702 \begin_inset Quotes erd
9707 \change_deleted 1075283030 1594226862
9709 \change_inserted 1075283030 1594226777
9713 \begin_layout Description
9715 \change_inserted 1075283030 1594226859
9716 \begin_inset Flex Code
9719 \begin_layout Plain Layout
9721 \change_inserted 1075283030 1594226785
9722 DocBookForceAbstract
9728 \begin_inset Flex Code
9731 \begin_layout Plain Layout
9733 \change_inserted 1075283030 1594226804
9740 \begin_inset Quotes eld
9748 \begin_inset Quotes erd
9751 , the root element will always have an
9756 The default value is
9757 \begin_inset Quotes eld
9765 \begin_inset Quotes erd
9773 \begin_layout Description
9774 \begin_inset Flex Code
9777 \begin_layout Plain Layout
9784 \begin_inset Flex Code
9787 \begin_layout Plain Layout
9793 ] This tag indicates that the module (which is specified by filename without
9795 \begin_inset Flex Code
9798 \begin_layout Plain Layout
9804 extension) cannot be used with this document class.
9805 This might be used in a journal-specific layout file to prevent, say, the
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9816 module that numbers theorems by section.
9821 be used in a module.
9822 Modules have their own way of excluding other modules (see
9823 \begin_inset CommandInset ref
9825 reference "subsec:Layout-modules"
9832 \begin_layout Description
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9842 Defines a new float.
9844 \begin_inset CommandInset ref
9846 reference "subsec:Floats"
9852 \begin_inset Quotes eld
9856 \begin_inset Flex Code
9859 \begin_layout Plain Layout
9866 \begin_inset Quotes erd
9872 \begin_layout Description
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9882 Sets the information that will be output in the
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9892 block when this document class is output to XHTML.
9893 Note that this will completely override any prior
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9915 \begin_inset Newline newline
9919 \begin_inset Flex Code
9922 \begin_layout Plain Layout
9928 if you just want to add material to the preamble.) Must end with
9929 \begin_inset Quotes eld
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9943 \begin_inset Quotes erd
9949 \begin_layout Description
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9969 ] The style to use for the table of contents, bibliography, and so forth,
9970 when the document is output to HTML.
9971 For articles, this should normally be
9972 \begin_inset Flex Code
9975 \begin_layout Plain Layout
9982 \begin_inset Flex Code
9985 \begin_layout Plain Layout
9992 If it is not given, then \SpecialChar LyX
9993 will attempt to figure out which layout to use.
9996 \begin_layout Description
9997 \begin_inset Flex Code
10000 \begin_layout Plain Layout
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10016 ] Modifies the properties of the given counter.
10017 If the counter does not exist, the statement is ignored.
10019 \begin_inset Quotes eld
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10033 \begin_inset Quotes erd
10037 \begin_inset Newline newline
10041 \begin_inset CommandInset ref
10043 reference "subsec:Counters"
10047 for details on counters.
10050 \begin_layout Description
10051 \begin_inset Flex Code
10054 \begin_layout Plain Layout
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10070 ] This allows you to include another layout definition file within yours
10071 to avoid duplicating commands.
10072 Common examples are the standard layout files, for example,
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 , which contains most of the basic layouts.
10085 \begin_layout Description
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10105 ] This section (re-)defines the layout of an inset.
10106 It can be applied to an existing inset or to a new, user-defined inset,
10107 e.g., a new character style.
10109 \begin_inset Quotes eld
10113 \begin_inset Flex Code
10116 \begin_layout Plain Layout
10123 \begin_inset Quotes erd
10127 \begin_inset Newline newline
10131 \begin_inset CommandInset ref
10133 reference "subsec:Flex-insets-and"
10137 for more information.
10141 \begin_layout Description
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10161 ] A string that indicates the width of the left margin on the screen, for
10163 \begin_inset Quotes eld
10167 \begin_inset Flex Code
10170 \begin_layout Plain Layout
10177 \begin_inset Quotes erd
10181 (Note that this is not a `length', like
10182 \begin_inset Quotes eld
10186 \begin_inset Quotes erd
10192 \begin_layout Description
10193 \begin_inset Flex Code
10196 \begin_layout Plain Layout
10203 \begin_inset Flex Code
10206 \begin_layout Plain Layout
10212 ] An integer that determines the maximal number of names displayed in an
10213 author-year citation before the citation switches to
10214 \begin_inset Quotes eld
10218 \begin_inset Quotes erd
10222 Primarily used in cite engine files (see
10223 \begin_inset CommandInset ref
10225 reference "subsec:Cite-Engine-Files"
10235 \begin_layout Description
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10246 \begin_inset Flex Code
10249 \begin_layout Plain Layout
10255 ] Modifies the properties of the given paragraph style.
10256 If the style does not exist, this section is ignored.
10258 \begin_inset Quotes eld
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10272 \begin_inset Quotes erd
10278 \begin_layout Description
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10298 ] Deletes an existing counter, usually one defined in an included file.
10301 \begin_layout Description
10302 \begin_inset Flex Code
10305 \begin_layout Plain Layout
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10321 ] Deletes an existing float.
10322 This is particularly useful when you want to suppress a float that has
10323 been defined in an input file.
10326 \begin_layout Description
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10337 \begin_inset Flex Code
10340 \begin_layout Plain Layout
10346 ] Deletes an existing style.
10349 \begin_layout Description
10350 \begin_inset Flex Code
10353 \begin_layout Plain Layout
10360 \begin_inset Flex Code
10363 \begin_layout Plain Layout
10370 \begin_inset Flex Code
10373 \begin_layout Plain Layout
10379 ] Define a new table of contents with type
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10390 \begin_inset Flex Code
10393 \begin_layout Plain Layout
10400 See also the AddToToc commands.
10403 \begin_layout Description
10404 \begin_inset Flex Code
10407 \begin_layout Plain Layout
10414 \begin_inset Flex Code
10417 \begin_layout Plain Layout
10423 ] The file format (as defined in the \SpecialChar LyX
10424 preferences) produced by this document
10426 It is mainly useful when
10427 \begin_inset Flex Code
10430 \begin_layout Plain Layout
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10446 and one wants to define a new type of literate document.
10447 The format is reset to
10448 \change_deleted 5863208 1594239413
10450 \begin_inset Quotes eld
10454 \begin_inset Flex Code
10457 \begin_layout Plain Layout
10464 \begin_inset Quotes erd
10470 \begin_inset Quotes eld
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10484 \begin_inset Quotes erd
10487 when the corresponding
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10497 parameter is encountered.
10500 \begin_layout Description
10501 \begin_inset Flex Code
10504 \begin_layout Plain Layout
10511 \begin_inset Flex Code
10514 \begin_layout Plain Layout
10525 \change_deleted 5863208 1594239430
10527 \begin_inset Flex Code
10530 \begin_layout Plain Layout
10539 \begin_inset Flex Code
10542 \begin_layout Plain Layout
10548 ] Specifies what sort of output documents using this class will produce.
10551 \begin_layout Description
10552 \begin_inset Flex Code
10555 \begin_layout Plain Layout
10562 \begin_inset Flex Code
10565 \begin_layout Plain Layout
10572 \begin_inset Flex Code
10575 \begin_layout Plain Layout
10581 ] Specifies options, given in the second string, for the package named by
10584 \begin_inset Quotes eld
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10592 PackageOptions natbib square
10598 \begin_inset Quotes erd
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10611 to be loaded with the
10612 \begin_inset Flex Code
10615 \begin_layout Plain Layout
10622 (For \SpecialChar TeX
10623 perts, this causes \SpecialChar LyX
10625 \begin_inset Flex Code
10628 \begin_layout Plain Layout
10631 PassOptionsToPackage{natbib}{square}
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10647 \change_inserted -712698321 1565102364
10651 \begin_layout Description
10653 \change_inserted -712698321 1565102470
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10659 \change_inserted -712698321 1565102365
10666 \begin_inset Flex Code
10669 \begin_layout Plain Layout
10671 \change_inserted -712698321 1565105222
10676 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10677 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10682 ] The default page size.
10683 This is used by some converters.
10688 \begin_layout Description
10689 \begin_inset Flex Code
10692 \begin_layout Plain Layout
10699 \begin_inset Flex Code
10702 \begin_layout Plain Layout
10711 \begin_inset Flex Code
10714 \begin_layout Plain Layout
10721 \begin_inset Flex Code
10724 \begin_layout Plain Layout
10730 ] The default pagestyle.
10731 Can be changed in the
10732 \begin_inset Flex Noun
10735 \begin_layout Plain Layout
10736 Document\SpecialChar menuseparator
10745 \begin_layout Description
10746 \begin_inset Flex Code
10749 \begin_layout Plain Layout
10755 Sets the preamble for the \SpecialChar LaTeX
10757 Note that this will completely override any prior
10758 \begin_inset Flex Code
10761 \begin_layout Plain Layout
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10788 if you just want to add material to the preamble.) Must end with
10789 \begin_inset Quotes eld
10793 \begin_inset Flex Code
10796 \begin_layout Plain Layout
10803 \begin_inset Quotes erd
10809 \begin_layout Description
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10830 \begin_inset Flex Code
10833 \begin_layout Plain Layout
10842 \begin_inset space \thinspace{}
10846 \begin_inset Flex Code
10849 \begin_layout Plain Layout
10855 ] Whether the class already provides the feature
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10866 A feature is in general the name of a package (e.
10867 \begin_inset space \thinspace{}
10871 \begin_inset space \space{}
10875 \begin_inset Flex Code
10878 \begin_layout Plain Layout
10885 \begin_inset Flex Code
10888 \begin_layout Plain Layout
10895 \begin_inset space \thinspace{}
10899 \begin_inset space \space{}
10903 \begin_inset Flex Code
10906 \begin_layout Plain Layout
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10924 \begin_inset CommandInset ref
10926 reference "chap:List-of-functions"
10930 for the list of features.
10933 \begin_layout Description
10934 \begin_inset Flex Code
10937 \begin_layout Plain Layout
10944 \begin_inset Flex Code
10947 \begin_layout Plain Layout
10953 ] Indicates that this layout provides the functionality of the module mentioned,
10954 which should be specified by the filename without the
10955 \begin_inset Flex Code
10958 \begin_layout Plain Layout
10965 This will typically be used if the layout includes the module directly,
10966 rather than using the
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 tag to indicate that it ought to be used.
10977 It could also be used in a module that provided an alternate implementation
10978 of the same functionality.
10981 \begin_layout Description
10982 \begin_inset Flex Code
10985 \begin_layout Plain Layout
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
11001 ] Creates a new paragraph style if it does not already exist.
11002 If the style does exist, this section is ignored.
11004 \begin_inset Quotes eld
11008 \begin_inset Flex Code
11011 \begin_layout Plain Layout
11018 \begin_inset Quotes erd
11024 \begin_layout Description
11025 \begin_inset Flex Code
11028 \begin_layout Plain Layout
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11044 ] Whether the class requires the feature
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11055 Multiple features must be separated by commas.
11056 Note that you can only request supported features.
11058 \begin_inset CommandInset ref
11060 reference "chap:List-of-functions"
11064 for the list of features.).
11065 If you require a package with specific options, you can additionally use
11067 \begin_inset Flex Code
11070 \begin_layout Plain Layout
11079 \begin_layout Description
11080 \begin_inset Flex Code
11083 \begin_layout Plain Layout
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11099 ] A string that indicates the width of the right margin on the screen, for
11101 \begin_inset Quotes eld
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11115 \begin_inset Quotes erd
11121 \begin_layout Description
11122 \begin_inset Flex Code
11125 \begin_layout Plain Layout
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11141 ] Sets which divisions get numbered.
11143 \begin_inset Newline newline
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11156 counter in \SpecialChar LaTeX
11160 \begin_layout Description
11161 \begin_inset Flex Code
11164 \begin_layout Plain Layout
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11183 \begin_inset space \thinspace{}
11187 \begin_inset Flex Code
11190 \begin_layout Plain Layout
11196 ] Whether the class-default should be printing on one or both sides of the
11198 Can be changed in the
11199 \begin_inset Flex Noun
11202 \begin_layout Plain Layout
11203 Document\SpecialChar menuseparator
11212 \begin_layout Description
11213 \begin_inset Flex Code
11216 \begin_layout Plain Layout
11223 \begin_inset Flex Code
11226 \begin_layout Plain Layout
11232 ] This sequence defines a paragraph style.
11233 If the style does not yet exist, it is created; if it does exist, its parameter
11236 \begin_inset Quotes eld
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 \begin_inset Quotes erd
11254 \begin_inset Newline newline
11258 \begin_inset CommandInset ref
11260 reference "subsec:Paragraph-Styles"
11264 for details on paragraph styles.
11265 \change_inserted -712698321 1553617804
11269 \begin_layout Description
11271 \change_inserted -712698321 1553617862
11272 \begin_inset Flex Code
11275 \begin_layout Plain Layout
11277 \change_inserted -712698321 1553617809
11284 \begin_inset Flex Code
11287 \begin_layout Plain Layout
11289 \change_inserted -712698321 1553617805
11295 ] defines the default table style that is used when inserting a table.
11296 The following styles are available:
11300 \begin_layout Itemize
11302 \change_inserted -712698321 1554308039
11303 \begin_inset Flex Code
11306 \begin_layout Plain Layout
11308 \change_inserted -712698321 1554307928
11309 Formal_with_Footline
11317 \begin_inset Quotes eld
11321 \begin_inset Quotes erd
11324 ) style with horizontal lines only, using a bold top and bottom line, the
11325 first and last row are additionally separated from the table body with
11326 a thin middle line.
11329 \begin_layout Itemize
11331 \change_inserted -712698321 1554308087
11332 \begin_inset Flex Code
11335 \begin_layout Plain Layout
11337 \change_inserted -712698321 1554308042
11338 Formal_without_Footline
11343 : same as the above, but the last row is not separated with a middle line
11347 \begin_layout Itemize
11349 \change_inserted -712698321 1553618031
11350 \begin_inset Flex Code
11353 \begin_layout Plain Layout
11355 \change_inserted -712698321 1553618006
11361 : Simple table lines.
11364 \begin_layout Itemize
11366 \change_inserted -712698321 1553618309
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11372 \change_inserted -712698321 1553618031
11379 \begin_inset Flex Code
11382 \begin_layout Plain Layout
11384 \change_inserted -712698321 1553618043
11390 , but with the header column offset with a second horizontal line.
11391 This is also the default style of \SpecialChar LyX
11395 \begin_layout Itemize
11397 \change_inserted -712698321 1553618280
11398 \begin_inset Flex Code
11401 \begin_layout Plain Layout
11403 \change_inserted -712698321 1553618261
11409 : Table without lines.
11415 \begin_layout Description
11416 \begin_inset Flex Code
11419 \begin_layout Plain Layout
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11435 ] The name of the command or environment to be used with
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11448 \begin_layout Description
11449 \begin_inset Flex Code
11452 \begin_layout Plain Layout
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11480 ] Indicates what kind of markup is used to define the title of a document.
11482 \begin_inset Flex Code
11485 \begin_layout Plain Layout
11491 means that the macro with name
11492 \begin_inset Flex Code
11495 \begin_layout Plain Layout
11501 will be inserted after the last layout which has
11502 \begin_inset Quotes eld
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11511 \begin_inset space ~
11520 \begin_inset Quotes erd
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11534 corresponds to the case where all layouts which have
11535 \begin_inset Quotes eld
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11544 \begin_inset space ~
11553 \begin_inset Quotes erd
11556 should be enclosed into the
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11569 \begin_layout Description
11570 \begin_inset Flex Code
11573 \begin_layout Plain Layout
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11589 ] Sets which divisions are included in the table of contents.
11591 \begin_inset Flex Code
11594 \begin_layout Plain Layout
11600 counter in \SpecialChar LaTeX
11604 \begin_layout Subsection
11605 \begin_inset Flex Code
11608 \begin_layout Plain Layout
11615 \begin_inset CommandInset label
11617 name "subsec:ClassOptions"
11624 \begin_layout Standard
11626 \begin_inset Flex Code
11629 \begin_layout Plain Layout
11635 section can contain the following entries:
11638 \begin_layout Description
11639 \begin_inset Flex Code
11642 \begin_layout Plain Layout
11649 \begin_inset Flex Code
11652 \begin_layout Plain Layout
11658 ] The list of available font sizes for the document's main font, separated
11660 \begin_inset Quotes eld
11664 \begin_inset Flex Code
11667 \begin_layout Plain Layout
11674 \begin_inset Quotes erd
11679 \change_inserted -712698321 1565110196
11680 Any number is possible.
11683 \begin_layout Description
11685 \change_inserted -712698321 1565110259
11686 \begin_inset Flex Code
11689 \begin_layout Plain Layout
11691 \change_inserted -712698321 1565110199
11698 \begin_inset Flex Code
11701 \begin_layout Plain Layout
11703 \change_inserted -712698321 1565110196
11709 ] The format for the font size option.
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11716 \change_inserted -712698321 1565110238
11726 \begin_inset Flex Code
11729 \begin_layout Plain Layout
11731 \change_inserted -712698321 1565110248
11737 is a placeholder for the font size.
11742 \begin_layout Description
11744 \change_deleted 5863208 1594239483
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11754 Used to set the DTD line with XML-based output classes.
11756 \begin_inset space \thinspace{}
11760 \begin_inset Quotes eld
11763 -//OASIS//DTD DocBook V4.2//EN
11764 \begin_inset Quotes erd
11768 \change_inserted -712698321 1565101761
11772 \begin_layout Description
11774 \change_inserted -712698321 1565180598
11775 \begin_inset Flex Code
11778 \begin_layout Plain Layout
11780 \change_inserted -712698321 1565101918
11787 \begin_inset Flex Code
11790 \begin_layout Plain Layout
11792 \change_inserted -712698321 1565105399
11793 string="letter|\SpecialChar allowbreak
11794 legal|\SpecialChar allowbreak
11795 executive|\SpecialChar allowbreak
11796 a0|\SpecialChar allowbreak
11797 a1|\SpecialChar allowbreak
11798 a2|\SpecialChar allowbreak
11799 a3|\SpecialChar allowbreak
11800 a4|\SpecialChar allowbreak
11801 a5|\SpecialChar allowbreak
11802 a6|\SpecialChar allowbreak
11803 b0|\SpecialChar allowbreak
11804 b1|\SpecialChar allowbreak
11805 b2|\SpecialChar allowbreak
11806 b3|\SpecialChar allowbreak
11807 b4|\SpecialChar allowbreak
11808 b5|\SpecialChar allowbreak
11809 b6|\SpecialChar allowbreak
11810 c0|\SpecialChar allowbreak
11811 c1|\SpecialChar allowbreak
11813 2|\SpecialChar allowbreak
11814 c3|\SpecialChar allowbreak
11815 c4|\SpecialChar allowbreak
11816 c5|\SpecialChar allowbreak
11817 c6|\SpecialChar allowbreak
11818 b0j|\SpecialChar allowbreak
11819 b1j|\SpecialChar allowbreak
11820 b2j|\SpecialChar allowbreak
11821 b3j|\SpecialChar allowbreak
11822 b4j|\SpecialChar allowbreak
11823 b5j|\SpecialChar allowbreak
11829 ] The list of available page sizes, separated by
11830 \begin_inset Quotes eld
11834 \begin_inset Flex Code
11837 \begin_layout Plain Layout
11839 \change_inserted -712698321 1565101779
11846 \begin_inset Quotes erd
11850 Currently, only the listed sizes are supported.
11851 Other sizes might be entered as custom class option.
11854 \begin_layout Description
11856 \change_inserted -712698321 1565180623
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11862 \change_inserted -712698321 1565180605
11869 \begin_inset Flex Code
11872 \begin_layout Plain Layout
11874 \change_inserted -712698321 1565180601
11880 ] The format for the page size option.
11882 \begin_inset Flex Code
11885 \begin_layout Plain Layout
11887 \change_inserted -712698321 1565180618
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11900 \change_inserted -712698321 1565180601
11906 is a placeholder for the paper size.
11911 \begin_layout Description
11912 \begin_inset Flex Code
11915 \begin_layout Plain Layout
11922 \begin_inset Flex Code
11925 \begin_layout Plain Layout
11926 string="empty|plain|headings|fancy"
11931 ] The list of available page sty\SpecialChar softhyphen
11933 \begin_inset Quotes eld
11937 \begin_inset Flex Code
11940 \begin_layout Plain Layout
11947 \begin_inset Quotes erd
11953 \begin_layout Description
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11973 ] Some document class options, separated by a comma, that will be added
11974 to the optional part of the
11975 \begin_inset Flex Code
11978 \begin_layout Plain Layout
11989 \begin_layout Standard
11991 \begin_inset Flex Code
11994 \begin_layout Plain Layout
12000 section must end with
12001 \begin_inset Quotes eld
12005 \begin_inset Flex Code
12008 \begin_layout Plain Layout
12015 \begin_inset Quotes erd
12021 \begin_layout Subsection
12023 \begin_inset CommandInset label
12025 name "subsec:Paragraph-Styles"
12032 \begin_layout Standard
12033 A paragraph style description looks like this:
12037 \begin_layout Plain Layout
12038 Note that this will either define a new style or modify an existing one.
12046 \begin_layout LyX-Code
12053 \begin_layout LyX-Code
12057 \begin_layout LyX-Code
12061 \begin_layout Standard
12062 where the following commands are allowed:
12065 \begin_layout Description
12066 \begin_inset Flex Code
12069 \begin_layout Plain Layout
12076 \begin_inset Flex Code
12079 \begin_layout Plain Layout
12085 =""] This paragraph will appear in the table of contents of the given type.
12086 An empty string disables.
12087 See also the OutlinerName and the IsTocCaption commands.
12091 \begin_layout Description
12092 \begin_inset Flex Code
12095 \begin_layout Plain Layout
12102 \begin_inset Flex Code
12105 \begin_layout Plain Layout
12110 , left, right, center
12115 ] Paragraph alignment.
12118 \begin_layout Description
12119 \begin_inset Flex Code
12122 \begin_layout Plain Layout
12129 \begin_inset Flex Code
12132 \begin_layout Plain Layout
12137 , left, right, center
12142 ] A comma separated list of permitted alignments.
12143 (Some \SpecialChar LaTeX
12144 styles prohibit certain alignments, since those wouldn't make sense.
12145 For example a right-aligned or centered enumeration isn't possible.)
12148 \begin_layout Description
12149 \begin_inset Flex Code
12152 \begin_layout Plain Layout
12159 \begin_inset Flex Code
12162 \begin_layout Plain Layout
12168 ] Defines argument number <int> of a command\SpecialChar breakableslash
12169 environment associated with
12171 This is useful for things like section headings, and only makes sense with
12174 Every (optional or required) argument of a command or environment – except
12175 for the required argument that is associated with the content of the paragraph
12176 itself – has a separate definition, where the number specifies the order
12178 The definition must end with
12179 \begin_inset Flex Code
12182 \begin_layout Plain Layout
12189 So a command with two optional arguments has:
12193 \begin_layout Quote
12199 \begin_layout Quote
12205 \begin_layout Quote
12211 \begin_layout Quote
12217 \begin_layout Quote
12223 \begin_layout Quote
12229 \begin_layout Standard
12231 \begin_inset Flex Code
12234 \begin_layout Plain Layout
12240 definition, the following specifications are possible:
12243 \begin_layout Itemize
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12263 The string that will appear both in the menu (to insert this argument)
12264 and on the argument inset button (unless you also specify a separate
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12275 For the menu, you can define an accelerator by appending the respective
12276 character to the string, divided by
12277 \begin_inset Quotes eld
12281 \begin_inset Quotes erd
12285 \begin_inset space \thinspace{}
12289 \begin_inset space \space{}
12293 \begin_inset Quotes eld
12297 \begin_inset Flex Code
12300 \begin_layout Plain Layout
12307 \begin_inset Quotes erd
12313 \begin_layout Itemize
12314 \begin_inset Flex Code
12317 \begin_layout Plain Layout
12324 \begin_inset Flex Code
12327 \begin_layout Plain Layout
12333 A separate string for the menu.
12334 You can define an accelerator by appending the respective character to
12335 the string, divided by
12336 \begin_inset Quotes eld
12340 \begin_inset Quotes erd
12344 \begin_inset space \thinspace{}
12348 \begin_inset space \space{}
12352 \begin_inset Quotes eld
12356 \begin_inset Flex Code
12359 \begin_layout Plain Layout
12366 \begin_inset Quotes erd
12370 This specification is optional.
12371 If it is not given the
12372 \begin_inset Flex Code
12375 \begin_layout Plain Layout
12381 will be used instead for the menu.
12384 \begin_layout Itemize
12385 \begin_inset Flex Code
12388 \begin_layout Plain Layout
12395 \begin_inset Flex Code
12398 \begin_layout Plain Layout
12404 A longer explanatory text that appears in the tooltip when hovering over
12405 the argument inset.
12408 \begin_layout Itemize
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12419 \begin_inset Flex Code
12422 \begin_layout Plain Layout
12431 \begin_inset space \thinspace{}
12435 \begin_inset Flex Code
12438 \begin_layout Plain Layout
12444 ] Declare if this is a mandatory (1) or an optional (0) argument.
12445 Mandatory arguments will be output empty if not given, while optional arguments
12446 will not be output at all.
12447 By default, mandatory arguments are delimited by
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12457 , while optional arguments are delimited by
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12468 \change_inserted -712698321 1555579782
12472 \begin_layout Itemize
12474 \change_inserted -712698321 1555579780
12475 \begin_inset Flex Code
12478 \begin_layout Plain Layout
12480 \change_inserted -712698321 1555579780
12487 \begin_inset Flex Code
12490 \begin_layout Plain Layout
12492 \change_inserted -712698321 1555579780
12498 Option to define a different command (from the default
12499 \begin_inset Flex Code
12502 \begin_layout Plain Layout
12504 \change_inserted -712698321 1555579780
12514 ) to be used for line breaks.
12515 The initial backslash must not be specified.
12520 \begin_layout Itemize
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12540 defines another argument (by its number) which this argument requires to
12541 be output if it is itself output.
12543 \begin_inset space \thinspace{}
12546 g., in \SpecialChar LaTeX
12547 commands, optional arguments often require previous optional arguments
12548 to be output (at least empty), as in
12549 \begin_inset Flex Code
12552 \begin_layout Plain Layout
12555 command[][argument]{text}
12561 This can be achieved by the statement
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12584 \begin_layout Itemize
12585 \begin_inset Flex Code
12588 \begin_layout Plain Layout
12595 \begin_inset Flex Code
12598 \begin_layout Plain Layout
12604 defines a custom left delimiter (instead of
12605 \begin_inset Flex Code
12608 \begin_layout Plain Layout
12615 \begin_inset Flex Code
12618 \begin_layout Plain Layout
12625 A line break in the output can be indicated by
12626 \begin_inset Flex Code
12629 \begin_layout Plain Layout
12638 \begin_layout Itemize
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12649 \begin_inset Flex Code
12652 \begin_layout Plain Layout
12658 defines a custom right delimiter (instead of
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12679 A line break in the output can be indicated by
12680 \begin_inset Flex Code
12683 \begin_layout Plain Layout
12692 \begin_layout Itemize
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12712 defines an argument that is inserted if and only if no user-specified arguments
12714 \begin_inset space \thinspace{}
12718 \begin_inset space \space{}
12721 if no argument inset has been inserted (note that also an empty argument
12722 inset omits the DefaultArg).
12723 Multiple arguments need to be separated by comma.
12726 \begin_layout Itemize
12727 \begin_inset Flex Code
12730 \begin_layout Plain Layout
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12746 defines an argument that is inserted in any case (alone or in addition
12747 to user-specified arguments).
12748 Multiple arguments need to be separated by comma.
12751 \begin_layout Itemize
12752 \begin_inset Flex Code
12755 \begin_layout Plain Layout
12761 The font used for the argument content, see
12762 \begin_inset CommandInset ref
12764 reference "subsec:Font-description"
12769 \change_inserted -712698321 1559484228
12773 \begin_layout Itemize
12775 \change_inserted -712698321 1559484228
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12781 \change_inserted -712698321 1559484228
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12793 \change_inserted -712698321 1559484228
12802 \begin_inset space \thinspace{}
12806 \begin_inset Flex Code
12809 \begin_layout Plain Layout
12811 \change_inserted -712698321 1559484228
12817 ] As with paragraph styles, see
12818 \begin_inset CommandInset ref
12820 reference "subsec:Paragraph-Styles"
12829 \begin_layout Itemize
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12839 The font used for the label; see
12840 \begin_inset CommandInset ref
12842 reference "subsec:Font-description"
12849 \begin_layout Itemize
12850 \begin_inset Flex Code
12853 \begin_layout Plain Layout
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12868 , Minimalistic, Conglomerate
12873 ] describes the rendering style used for the inset's frame and buttons.
12876 \begin_layout Itemize
12877 \begin_inset Flex Code
12880 \begin_layout Plain Layout
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12897 \begin_inset Flex Code
12900 \begin_layout Plain Layout
12906 , this argument is automatically inserted when the respective style is selected.
12908 \change_deleted -712698321 1559484200
12909 Currently, only one argument per style\SpecialChar breakableslash
12910 layout can be automatically inserted.
12915 \begin_layout Itemize
12917 \change_inserted -712698321 1559491402
12918 \begin_inset Flex Code
12921 \begin_layout Plain Layout
12923 \change_inserted -712698321 1559490711
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12935 \change_inserted -712698321 1559490703
12942 \begin_inset Flex Code
12945 \begin_layout Plain Layout
12947 \change_inserted -712698321 1559490703
12953 , this argument will be inserted on a new line with
12954 \begin_inset Flex Code
12957 \begin_layout Plain Layout
12959 \change_inserted -712698321 1559491402
12965 (only available within Flex insets).
12968 \begin_layout Itemize
12969 \begin_inset Flex Code
12972 \begin_layout Plain Layout
12979 \begin_inset Flex Code
12982 \begin_layout Plain Layout
12989 \begin_inset Flex Code
12992 \begin_layout Plain Layout
12998 , this argument will be inserted with a copy of the co-text (either selected
12999 text or the whole paragraph) as content.
13002 \begin_layout Itemize
13003 \begin_inset Flex Code
13006 \begin_layout Plain Layout
13013 \begin_inset Flex Code
13016 \begin_layout Plain Layout
13026 ] Whether the contents of this argument should be output in raw form, meaning
13027 without special translations that \SpecialChar LaTeX
13030 \begin_inset Flex Code
13033 \begin_layout Plain Layout
13039 status is inherited by the inset or paragraph layout the argument belongs
13040 to, true and false change the status for the given argument only.
13043 \begin_layout Itemize
13044 \begin_inset Flex Code
13047 \begin_layout Plain Layout
13054 \begin_inset Flex Code
13057 \begin_layout Plain Layout
13058 string of characters
13067 Defines individual characters
13068 \begin_inset Newline linebreak
13071 that should be output in raw form, meaning without special translations
13072 that \SpecialChar LaTeX
13074 Note that, contrary to PassThru, this needs to be explicitly defined for
13076 That is, arguments do not inherit PassThruChars from their parent inset
13080 \begin_layout Itemize
13081 \begin_inset Flex Code
13084 \begin_layout Plain Layout
13091 \begin_inset Flex Code
13094 \begin_layout Plain Layout
13103 \begin_inset space \thinspace{}
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13116 ] If this is set to 1, the argument will output its content in the corresponding
13117 item in the table of contents.
13121 \begin_layout Standard
13122 By default, the text entered in the \SpecialChar LyX
13123 workarea in the respective layout is
13124 the last (mandatory) argument of a command if the
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13145 However, arguments with the prefix
13146 \begin_inset Flex Code
13149 \begin_layout Plain Layout
13155 are output after this workarea argument.
13156 Note that post-argument numbering restarts at 1, so the first argument
13157 following the workarea argument is
13158 \begin_inset Flex Code
13161 \begin_layout Plain Layout
13168 Post-arguments are ignored in any other
13169 \begin_inset Flex Code
13172 \begin_layout Plain Layout
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13191 \begin_layout Standard
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13226 followed by the number (e.
13227 \begin_inset space \thinspace{}
13231 \begin_inset space \space{}
13235 \begin_inset Flex Code
13238 \begin_layout Plain Layout
13245 \change_inserted -712698321 1534487781
13249 \begin_layout Standard
13251 \change_inserted -712698321 1534488561
13252 Finally, there is a special argument type with the prefix
13253 \begin_inset Flex Code
13256 \begin_layout Plain Layout
13258 \change_inserted -712698321 1534487844
13267 It is not really an argument, but uses the argument interface (thus, the
13268 prefix is also followed by a number, e.
13269 \begin_inset space \thinspace{}
13274 \begin_inset Flex Code
13277 \begin_layout Plain Layout
13279 \change_inserted -712698321 1534488412
13280 Argument listpreamble:1
13286 As the name implies, it is targeted at lists such as
13303 Its content will be output at the list start, before the first
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13309 \change_inserted -712698321 1534488058
13319 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13321 This way, users can insert redefinitions (of lengths etc.) to individual
13323 By default, these arguments do not have a delimiter.
13329 \begin_layout Description
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13339 Includes a comma-separated list of layouts that should be nested in and
13340 after the current layout.
13341 Only makes sense for nestable layouts (such as environments).
13343 \begin_inset Quotes eld
13347 \begin_inset Flex Code
13350 \begin_layout Plain Layout
13357 \begin_inset Quotes erd
13362 \begin_inset Flex Code
13365 \begin_layout Plain Layout
13374 \begin_layout Description
13375 \begin_inset Flex Code
13378 \begin_layout Plain Layout
13384 Note that this will completely override any prior
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13394 declaration for this style.
13396 \begin_inset Quotes eld
13400 \begin_inset Flex Code
13403 \begin_layout Plain Layout
13410 \begin_inset Quotes erd
13415 \begin_inset CommandInset ref
13417 reference "subsec:I18n"
13421 for details on its use.
13424 \begin_layout Description
13425 \begin_inset Flex Code
13428 \begin_layout Plain Layout
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13448 \begin_layout Plain Layout
13449 Note that a `float' here is a real number, such as: 1.5.
13454 The vertical space with which the last of a chain of paragraphs with this
13455 style is separated from the following paragraph.
13456 If the next paragraph has another style, the separations are not simply
13457 added, but the maximum is taken.
13460 \begin_layout Description
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13480 ] The category for this style.
13481 This is used to group related styles in the style combobox on the toolbar.
13482 Any string can be used, but you may want to use existing categories with
13487 \begin_layout Description
13488 \begin_inset Flex Code
13491 \begin_layout Plain Layout
13497 Depth of XML command.
13498 Used only with XML-type formats.
13501 \begin_layout Description
13502 \begin_inset Flex Code
13505 \begin_layout Plain Layout
13512 \begin_inset Flex Code
13515 \begin_layout Plain Layout
13521 ] Copies all the features of an existing style into the current one.
13525 \begin_layout Description
13526 \begin_inset Flex Code
13529 \begin_layout Plain Layout
13536 \begin_inset Flex Code
13539 \begin_layout Plain Layout
13545 ] The name of a style whose preamble should be output
13550 This allows to ensure some ordering of the preamble snippets when macros
13551 definitions depend on one another.
13555 \begin_layout Plain Layout
13556 Note that, besides that functionality, there is no way to ensure any ordering
13558 The ordering that you see in a given version of \SpecialChar LyX
13559 may change without warning
13568 \begin_layout Description
13569 \begin_inset Flex Code
13572 \begin_layout Plain Layout
13579 \begin_inset Flex Code
13582 \begin_layout Plain Layout
13587 , Box, Filled_Box, Static
13592 ] The type of label that stands at the end of the paragraph (or sequence
13594 \begin_inset Flex Code
13597 \begin_layout Plain Layout
13604 \begin_inset Newline newline
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13618 \begin_inset Flex Code
13621 \begin_layout Plain Layout
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13639 \begin_inset Flex Code
13642 \begin_layout Plain Layout
13649 \begin_inset Quotes eld
13653 \begin_inset Quotes erd
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13667 \begin_inset space \space{}
13671 \begin_inset Flex Code
13674 \begin_layout Plain Layout
13680 ) is a white (resp.
13681 \begin_inset space ~
13684 black) square suitable for end of proof markers,
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13694 is an explicit text string.
13697 \begin_layout Description
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13717 ] The string used for a label with a
13718 \begin_inset Flex Code
13721 \begin_layout Plain Layout
13728 \begin_inset Newline newline
13732 \begin_inset Flex Code
13735 \begin_layout Plain Layout
13745 \begin_layout Description
13746 \begin_inset Flex Code
13749 \begin_layout Plain Layout
13755 The font used for both the text body
13761 \begin_inset CommandInset ref
13763 reference "subsec:Font-description"
13768 Note that defining this font automatically defines the
13769 \begin_inset Flex Code
13772 \begin_layout Plain Layout
13779 So you should define this one first if you also want to define
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13792 \begin_layout Description
13793 \begin_inset Flex Code
13796 \begin_layout Plain Layout
13803 \begin_inset Flex Code
13806 \begin_layout Plain Layout
13812 ] Used for backporting new styles to stable \SpecialChar LyX
13814 The first stable version that supports this tag is \SpecialChar LyX
13816 The argument is a number which may either be 0, -1 or any value greater
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13828 flag of a style is greater than zero, it will always be written to the
13830 If a .lyx file is read, the style definitions from the document header are
13831 added to the document class.
13832 Therefore even older \SpecialChar LyX
13833 versions can handle the style.
13835 \begin_inset Flex Code
13838 \begin_layout Plain Layout
13844 is a version number: if the style is read, and the version number is less
13845 than the version number of the already existing style in the document class,
13846 the new style is ignored.
13847 If the version number is greater, the new style replaces the existing style.
13848 A value of -1 means an infinite version number, i.
13849 \begin_inset space \thinspace{}
13853 \begin_inset space \space{}
13856 the style is always used.
13859 \begin_layout Description
13860 \begin_inset Flex Code
13863 \begin_layout Plain Layout
13870 \begin_inset Flex Code
13873 \begin_layout Plain Layout
13882 \begin_inset space \thinspace{}
13886 \begin_inset Flex Code
13889 \begin_layout Plain Layout
13895 ] Usually \SpecialChar LyX
13896 does not allow you to insert more than one space between words,
13897 since a space is considered as the separation between two words, not a
13898 character or symbol of its own.
13899 This is a very fine thing but sometimes annoying, for example, when typing
13900 program code or plain \SpecialChar LaTeX
13903 \begin_inset Flex Code
13906 \begin_layout Plain Layout
13914 \change_deleted -495245474 1550490105
13918 will create protected blanks for the additional blanks when in
13919 \change_inserted -495245474 1550490096
13921 \begin_inset Flex Code
13924 \begin_layout Plain Layout
13926 \change_inserted -495245474 1550490089
13933 \change_deleted -495245474 1550490116
13934 another mode than \SpecialChar LaTeX
13937 \change_inserted -495245474 1550247760
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13944 \change_inserted -495245474 1550247736
13951 \begin_inset Flex Code
13954 \begin_layout Plain Layout
13956 \change_inserted -495245474 1550247755
13967 \begin_layout Description
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13977 These tags are used with XHTML output.
13979 \begin_inset CommandInset ref
13981 reference "subsec:Paragraph-Style-XHTML"
13988 \begin_layout Description
13989 \begin_inset Flex Code
13992 \begin_layout Plain Layout
13998 [FIXME] (Used only with XML-type formats.)
14001 \begin_layout Description
14002 \begin_inset Flex Code
14005 \begin_layout Plain Layout
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14024 \begin_inset space \thinspace{}
14028 \begin_inset Flex Code
14031 \begin_layout Plain Layout
14038 \begin_inset Flex Code
14041 \begin_layout Plain Layout
14047 , marks the style as to be included in the document preamble and not in
14049 This is useful for document classes that want such information as the title
14050 and author to appear in the preamble.
14051 Note that this works only for styles for which the
14052 \begin_inset Flex Code
14055 \begin_layout Plain Layout
14062 \begin_inset Flex Code
14065 \begin_layout Plain Layout
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14084 \begin_layout Description
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14095 \begin_inset Flex Code
14098 \begin_layout Plain Layout
14107 \begin_inset space \thinspace{}
14111 \begin_inset Flex Code
14114 \begin_layout Plain Layout
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14130 , marks the style as being part of a title block (see also the
14131 \begin_inset Flex Code
14134 \begin_layout Plain Layout
14141 \begin_inset Flex Code
14144 \begin_layout Plain Layout
14153 \begin_layout Description
14154 \begin_inset Flex Code
14157 \begin_layout Plain Layout
14163 Includes a comma-separated list of layouts after which this one should
14165 Only makes sense with regard to nestable layouts (such as environments).
14167 \begin_inset Quotes eld
14171 \begin_inset Flex Code
14174 \begin_layout Plain Layout
14181 \begin_inset Quotes erd
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14198 \begin_layout Description
14199 \begin_inset Flex Code
14202 \begin_layout Plain Layout
14209 \begin_inset Flex Code
14212 \begin_layout Plain Layout
14221 \begin_inset space \thinspace{}
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14234 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14235 of its contents in its item in the table of contents.
14236 Otherwise, only the label, if it exists, appears.
14239 \begin_layout Description
14240 \begin_inset Flex Code
14243 \begin_layout Plain Layout
14250 \begin_inset Flex Code
14253 \begin_layout Plain Layout
14259 ] The \SpecialChar LaTeX
14260 command sequence declaring an item in a list.
14261 The command is to be defined without the preceding backslash (the default
14263 \begin_inset Quotes eld
14267 \begin_inset Quotes erd
14271 \begin_inset Flex Code
14274 \begin_layout Plain Layout
14282 in the \SpecialChar LaTeX
14286 \begin_layout Description
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14297 \begin_inset Flex Code
14300 \begin_layout Plain Layout
14306 ] This provides extra space between paragraphs that have the same style.
14307 If you put other styles into an environment, each is separated with the
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14319 But the whole items of the environment are additionally separated with
14321 \begin_inset Flex Code
14324 \begin_layout Plain Layout
14331 Note that this is a
14336 \begin_layout Description
14337 \begin_inset Flex Code
14340 \begin_layout Plain Layout
14346 [FIXME] (Used only with XML-type formats.)
14349 \begin_layout Description
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14360 \begin_inset Flex Code
14363 \begin_layout Plain Layout
14372 \begin_inset space \thinspace{}
14376 \begin_inset Flex Code
14379 \begin_layout Plain Layout
14385 ] Usually \SpecialChar LyX
14386 does not allow you to leave a paragraph empty, since it would
14387 lead to empty \SpecialChar LaTeX
14389 There are some cases where this could be desirable however: in a letter
14390 template, the required fields can be provided as empty fields, so that
14391 people do not forget them; in some special classes, a style can be used
14392 as some kind of break, which does not contain actual text.
14395 \begin_layout Description
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14415 ] The vertical space between the label and the text body.
14416 Only used for labels that are above the text body (
14417 \begin_inset Flex Code
14420 \begin_layout Plain Layout
14427 \begin_inset Newline newline
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14435 Centered_Top_Environment
14443 \begin_layout Description
14444 \begin_inset Flex Code
14447 \begin_layout Plain Layout
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14463 ] The name of the counter for automatic numbering.
14464 In order to have the counter appear with your label, you will need to reference
14466 \begin_inset Flex Code
14469 \begin_layout Plain Layout
14478 This will work with
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14499 \begin_inset Flex Code
14502 \begin_layout Plain Layout
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14519 \begin_inset Newline newline
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14546 , though this case is a bit complicated.
14547 Suppose you declare
14548 \begin_inset Quotes eld
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14556 LabelCounter myenum
14562 \begin_inset Quotes erd
14566 Then the actual counters used are
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14577 \begin_inset Flex Code
14580 \begin_layout Plain Layout
14587 \begin_inset Flex Code
14590 \begin_layout Plain Layout
14597 \begin_inset Flex Code
14600 \begin_layout Plain Layout
14606 , much as in \SpecialChar LaTeX
14608 These counters must all be declared separately.
14609 \begin_inset Newline newline
14613 \begin_inset CommandInset ref
14615 reference "subsec:Counters"
14619 for details on counters.
14622 \begin_layout Description
14623 \begin_inset Flex Code
14626 \begin_layout Plain Layout
14632 The font used for the label.
14634 \begin_inset CommandInset ref
14636 reference "subsec:Font-description"
14643 \begin_layout Description
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14663 ] Text that indicates how far a label should be indented.
14666 \begin_layout Description
14667 \begin_inset Flex Code
14670 \begin_layout Plain Layout
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14686 ] Text that indicates the amount of horizontal space between the label and
14688 Only used for labels that are not above the text body.
14691 \begin_layout Description
14692 \begin_inset Flex Code
14695 \begin_layout Plain Layout
14702 \begin_inset Flex Code
14705 \begin_layout Plain Layout
14711 ] The string used for the label.
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14722 is set, this string can be contain the special formatting commands described
14724 \begin_inset CommandInset ref
14726 reference "subsec:Counters"
14733 \begin_layout Description
14734 \begin_inset Flex Code
14737 \begin_layout Plain Layout
14738 LabelStringAppendix
14744 \begin_inset Flex Code
14747 \begin_layout Plain Layout
14753 ] This is used inside the appendix instead of
14754 \begin_inset Newline newline
14758 \begin_inset Flex Code
14761 \begin_layout Plain Layout
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14779 \begin_inset Newline newline
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14787 LabelStringAppendix
14795 \begin_layout Description
14796 \begin_inset Flex Code
14799 \begin_layout Plain Layout
14805 [FIXME] (Used only with XML-type formats.)
14808 \begin_layout Description
14809 \begin_inset Flex Code
14812 \begin_layout Plain Layout
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14827 , Manual, Static, Above,
14828 \begin_inset Newline newline
14831 Centered, Sensitive, Enumerate,
14832 \begin_inset Newline newline
14835 Itemize, Bibliography
14844 \begin_layout Description
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14854 means the label is the very first word (up to the first real blank).
14855 Use protected spaces if you want more than one word as the label.
14859 \begin_layout Description
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14869 means the label is simply what is declared as
14870 \begin_inset Flex Code
14873 \begin_layout Plain Layout
14880 This will be displayed
14881 \begin_inset Quotes eld
14885 \begin_inset Quotes erd
14888 , at the beginning of the paragraph.
14890 \begin_inset Flex Code
14893 \begin_layout Plain Layout
14900 \begin_inset Flex Code
14903 \begin_layout Plain Layout
14909 , then it will be displayed only in the first paragraph of any sequence
14910 of paragraphs with the same
14911 \begin_inset Flex Code
14914 \begin_layout Plain Layout
14923 \begin_layout Description
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14934 \begin_inset space ~
14938 \begin_inset space ~
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 are special cases of
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14962 The label will be printed above the paragraph either at the beginning of
14963 the line or centered.
14966 \begin_layout Description
14967 \begin_inset Flex Code
14970 \begin_layout Plain Layout
14976 is a special case for the caption-labels
14977 \begin_inset Quotes eld
14981 \begin_inset Quotes erd
14985 \begin_inset Quotes eld
14989 \begin_inset Quotes erd
14993 \begin_inset Newline newline
14997 \begin_inset Flex Code
15000 \begin_layout Plain Layout
15006 means the (hardcoded) label string depends on the kind of float: It is
15007 hardcoded to be `FloatType N', where N is the value of the counter associated
15009 For the case that a caption is inserted outside of a float the
15010 \begin_inset Flex Code
15013 \begin_layout Plain Layout
15020 \begin_inset Quotes eld
15024 \begin_inset Quotes erd
15030 \begin_layout Description
15031 \begin_inset Flex Code
15034 \begin_layout Plain Layout
15040 produces the usual sort of enumeration labels.
15041 The number type needs to be set in the
15046 \begin_inset CommandInset ref
15048 reference "subsec:Counters"
15055 \begin_layout Description
15056 \begin_inset Flex Code
15059 \begin_layout Plain Layout
15065 produces various bullets at the different levels.
15066 The bullet types displayed can be set via
15067 \begin_inset Flex Noun
15070 \begin_layout Plain Layout
15071 Document\SpecialChar menuseparator
15072 Settings\SpecialChar menuseparator
15081 \begin_layout Description
15082 \begin_inset Flex Code
15085 \begin_layout Plain Layout
15091 should be used only with
15092 \begin_inset Flex Code
15095 \begin_layout Plain Layout
15096 LatexType BibEnvironment
15105 \begin_layout Description
15106 \begin_inset Flex Code
15109 \begin_layout Plain Layout
15115 Note that this will completely override any prior
15116 \begin_inset Flex Code
15119 \begin_layout Plain Layout
15125 declaration for this style.
15127 \begin_inset Quotes eld
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15141 \begin_inset Quotes erd
15146 \begin_inset CommandInset ref
15148 reference "subsec:I18n"
15152 for details on its use.
15155 \begin_layout Description
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15175 ] The name of the corresponding \SpecialChar LaTeX
15177 Either the environment or command name.
15180 \begin_layout Description
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15191 \begin_inset Flex Code
15194 \begin_layout Plain Layout
15200 ] An optional parameter for the corresponding
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15211 This parameter cannot be changed from within \SpecialChar LyX
15213 \begin_inset Flex Code
15216 \begin_layout Plain Layout
15222 for customizable parameters).
15223 This will be output as is after all \SpecialChar LaTeX
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15237 \begin_layout Description
15238 \begin_inset Flex Code
15241 \begin_layout Plain Layout
15248 \begin_inset Flex Code
15251 \begin_layout Plain Layout
15256 , Command, Environment, Item_Environment,
15257 \begin_inset Newline newline
15260 List_Environment, Bib_Environment
15265 ] How the style should be translated into \SpecialChar LaTeX
15270 \begin_layout Plain Layout
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15280 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15281 Visit the SGML class files for specific examples.
15290 \begin_layout Description
15291 \begin_inset Flex Code
15294 \begin_layout Plain Layout
15300 means nothing special.
15303 \begin_layout Description
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15314 \begin_inset Flex Code
15317 \begin_layout Plain Layout
15324 {\SpecialChar ldots
15333 \begin_layout Description
15334 \begin_inset Flex Code
15337 \begin_layout Plain Layout
15344 \begin_inset Flex Code
15347 \begin_layout Plain Layout
15354 }\SpecialChar ldots
15370 \begin_layout Description
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15391 \begin_inset Flex Code
15394 \begin_layout Plain Layout
15402 is generated for each paragraph of this environment.
15406 \begin_layout Description
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15427 \begin_inset Newline newline
15431 \begin_inset Flex Code
15434 \begin_layout Plain Layout
15440 is passed as an argument to the environment.
15441 \begin_inset Newline newline
15445 \begin_inset Flex Code
15448 \begin_layout Plain Layout
15454 can be defined in the
15455 \begin_inset Flex Noun
15458 \begin_layout Plain Layout
15459 Edit\SpecialChar menuseparator
15461 \begin_inset space ~
15472 \begin_layout Description
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15492 but adds the necessary mandatory argument (the longest label) to the begin
15493 statement of the bibliography environment:
15494 \begin_inset Newline newline
15498 \begin_inset Flex Code
15501 \begin_layout Plain Layout
15504 begin{thebibliography}{99}
15510 It is therefore only useful for bibliography environments.
15511 The default longest label
15512 \begin_inset Quotes eld
15516 \begin_inset Quotes erd
15519 can be changed by the user in the paragraph settings of a bibliography
15523 \begin_layout Standard
15524 Putting the last few things together, the \SpecialChar LaTeX
15525 output will be either:
15528 \begin_layout LyX-Code
15531 LatexName[LatexParam]{\SpecialChar ldots
15535 \begin_layout Standard
15539 \begin_layout LyX-Code
15542 begin{LatexName}[LatexParam] \SpecialChar ldots
15548 \begin_layout Standard
15549 depending upon the \SpecialChar LaTeX
15554 \begin_layout Description
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15565 \begin_inset Flex Code
15568 \begin_layout Plain Layout
15574 ] A string that is put at the beginning of the style content.
15575 A line break in the output can be indicated by
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15588 \begin_layout Description
15589 \begin_inset Flex Code
15592 \begin_layout Plain Layout
15599 \begin_inset Flex Code
15602 \begin_layout Plain Layout
15608 ] If you put styles into environments, the different
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15618 are not simply added, but added with a factor
15619 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15623 Note that this parameter is also used when
15624 \begin_inset Flex Code
15627 \begin_layout Plain Layout
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15644 \begin_inset Flex Code
15647 \begin_layout Plain Layout
15654 Then it is added to the manual or dynamic margin.
15655 \begin_inset Newline newline
15659 \begin_inset Quotes eld
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15673 \begin_inset Quotes erd
15676 means that the paragraph is indented with the width of
15677 \begin_inset Quotes eld
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15691 \begin_inset Quotes erd
15694 in the normal font.
15695 You can get a negative width by prefixing the string with
15696 \begin_inset Quotes eld
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15710 \begin_inset Quotes erd
15714 This way was chosen so that the look is the same with each used screen
15718 \begin_layout Description
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15737 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15743 \begin_inset Newline newline
15746 The kind of margin that the style has on the left side.
15750 \begin_layout Description
15751 \begin_inset Flex Code
15754 \begin_layout Plain Layout
15760 just means a fixed margin.
15763 \begin_layout Description
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15773 means that the left margin depends on the string entered in the
15774 \begin_inset Flex Noun
15777 \begin_layout Plain Layout
15778 Edit\SpecialChar menuseparator
15780 \begin_inset space ~
15789 This is used to typeset nice lists without tabulators.
15792 \begin_layout Description
15793 \begin_inset Flex Code
15796 \begin_layout Plain Layout
15802 means that the margin depends on the size of the label.
15803 This is used for automatic enumerated headlines.
15804 It is obvious that the headline
15805 \begin_inset Quotes eld
15808 5.4.3.2.1 Very long headline
15809 \begin_inset Quotes erd
15812 must have a wider left margin (as wide as
15813 \begin_inset Quotes eld
15817 \begin_inset Quotes erd
15820 plus the space) than
15821 \begin_inset Quotes eld
15824 3.2 Very long headline
15825 \begin_inset Quotes erd
15829 \begin_inset Quotes eld
15833 \begin_inset Quotes erd
15836 are not able to do this.
15839 \begin_layout Description
15840 \begin_inset Flex Code
15843 \begin_layout Plain Layout
15849 is similar, but only the very first row of the paragraph is dynamic, while
15850 the others are static; this is used, for example, for descriptions.
15853 \begin_layout Description
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15863 means the margin is chosen in a way that the longest row of this paragraph
15864 fits to the right margin.
15865 This is used to typeset an address on the right edge of the page.
15869 \begin_layout Description
15870 \begin_inset Flex Code
15873 \begin_layout Plain Layout
15880 \begin_inset Flex Code
15883 \begin_layout Plain Layout
15892 \begin_inset space \thinspace{}
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15905 ] Whether fragile commands in this style should be
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15922 whether this command should itself be protected.)
15923 \change_inserted -712698321 1523696949
15927 \begin_layout Description
15929 \change_inserted -712698321 1552395557
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15935 \change_inserted -712698321 1523696950
15942 \begin_inset Flex Code
15945 \begin_layout Plain Layout
15947 \change_inserted -712698321 1523696950
15956 \begin_inset space \thinspace{}
15960 \begin_inset Flex Code
15963 \begin_layout Plain Layout
15965 \change_inserted -712698321 1523696950
15971 ] This causes macros that contain this layout to be protected with
15972 \begin_inset Flex Code
15975 \begin_layout Plain Layout
15977 \change_inserted -712698321 1523696950
15990 ) if necessary and thus allows (some) verbatim stuff in macros.
15993 \begin_layout Description
15995 \change_inserted -712698321 1552395844
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16001 \change_inserted -712698321 1552395561
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16013 \change_inserted -712698321 1552395557
16022 \begin_inset space \thinspace{}
16026 \begin_inset Flex Code
16029 \begin_layout Plain Layout
16031 \change_inserted -712698321 1552395557
16037 ] Whether specific commands in this style (such as
16038 \begin_inset Flex Code
16041 \begin_layout Plain Layout
16043 \change_inserted -712698321 1552395655
16054 \begin_inset Flex Code
16057 \begin_layout Plain Layout
16059 \change_inserted -712698321 1552395661
16069 ) should be protected in an
16070 \begin_inset Flex Code
16073 \begin_layout Plain Layout
16075 \change_inserted -712698321 1552395631
16086 This is particularly needed for styles that draw on
16094 commands which parse their content in complex ways.
16099 \begin_layout Description
16100 \begin_inset Flex Code
16103 \begin_layout Plain Layout
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16120 \begin_inset space \thinspace{}
16124 \begin_inset Flex Code
16127 \begin_layout Plain Layout
16135 ] Whether newlines are translated into \SpecialChar LaTeX
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16151 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16153 inside \SpecialChar LyX
16157 \begin_layout Description
16158 \begin_inset Flex Code
16161 \begin_layout Plain Layout
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16180 \begin_inset space \thinspace{}
16184 \begin_inset Flex Code
16187 \begin_layout Plain Layout
16193 ] If set to true, and if
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 ) paragraphs are being indented, then the indentation of such a paragraph
16214 following one of this type will be suppressed.
16215 (So this will not affect the display of non-default paragraphs.)
16218 \begin_layout Description
16219 \begin_inset Flex Code
16222 \begin_layout Plain Layout
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16238 ] Name of a style that has replaced this style.
16239 This is used to rename a style, while keeping backward compatibility.
16242 \begin_layout Description
16243 \begin_inset Flex Code
16246 \begin_layout Plain Layout
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16263 \begin_inset space \thinspace{}
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16276 ] Determines whether consecutive paragraphs of the same type are treated
16277 as belonging together.
16278 This has the effect that the
16279 \begin_inset Flex Code
16282 \begin_layout Plain Layout
16288 is only printed once before such a group.
16289 By default, this is true for
16290 \begin_inset Flex Code
16293 \begin_layout Plain Layout
16300 \begin_inset Flex Code
16303 \begin_layout Plain Layout
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16319 and false for all other types.
16322 \begin_layout Description
16323 \begin_inset Flex Code
16326 \begin_layout Plain Layout
16333 \begin_inset Flex Code
16336 \begin_layout Plain Layout
16345 \begin_inset space \thinspace{}
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16358 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16360 but only by a line break; together with
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 , this allows to emulate a plain text editor (like the ERT inset).
16373 \begin_layout Description
16374 \begin_inset Flex Code
16377 \begin_layout Plain Layout
16384 \begin_inset Flex Code
16387 \begin_layout Plain Layout
16393 ] The indent of the very first line of a paragraph.
16395 \begin_inset Newline newline
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16408 will be fixed for a certain style.
16409 The exception is the default style, since the indentation for these paragraphs
16410 can be prohibited with
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16422 \begin_inset Flex Code
16425 \begin_layout Plain Layout
16431 style paragraphs inside environments use the
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16441 of the environment, not their native one.
16443 \begin_inset Flex Code
16446 \begin_layout Plain Layout
16452 paragraphs inside an enumeration are not indented.
16455 \begin_layout Description
16456 \begin_inset Flex Code
16459 \begin_layout Plain Layout
16466 \begin_inset Flex Code
16469 \begin_layout Plain Layout
16475 ] The vertical space between two paragraphs of this style.
16478 \begin_layout Description
16479 \begin_inset Flex Code
16482 \begin_layout Plain Layout
16489 \begin_inset Flex Code
16492 \begin_layout Plain Layout
16499 allows the user to choose either
16500 \begin_inset Quotes eld
16504 \begin_inset Quotes erd
16508 \begin_inset Quotes eld
16512 \begin_inset Quotes erd
16515 to separate paragraphs.
16517 \begin_inset Quotes eld
16521 \begin_inset Quotes erd
16525 \begin_inset Flex Code
16528 \begin_layout Plain Layout
16536 \begin_inset Quotes eld
16540 \begin_inset Quotes erd
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16553 is ignored and all paragraphs are separated by the
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16564 The vertical space is calculated with
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16570 \begin_inset space ~
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 is the height of a row with the normal font.
16589 This way, the look stays the same with different screen fonts.
16592 \begin_layout Description
16593 \begin_inset Flex Code
16596 \begin_layout Plain Layout
16603 \begin_inset Flex Code
16606 \begin_layout Plain Layout
16615 \begin_inset space \thinspace{}
16619 \begin_inset Flex Code
16622 \begin_layout Plain Layout
16628 ] Whether the contents of this paragraph should be output in raw form, meaning
16629 without special translations that \SpecialChar LaTeX
16633 \begin_layout Description
16634 \begin_inset Flex Code
16637 \begin_layout Plain Layout
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16657 Defines individual characters that should be output in raw form, meaning
16658 without special translations that \SpecialChar LaTeX
16662 \begin_layout Description
16663 \begin_inset Flex Code
16666 \begin_layout Plain Layout
16672 Information to be included in the \SpecialChar LaTeX
16673 preamble when this style is used.
16674 Used to define macros, load packages, etc., required by this particular
16677 \begin_inset Quotes eld
16681 \begin_inset Flex Code
16684 \begin_layout Plain Layout
16691 \begin_inset Quotes erd
16697 \begin_layout Description
16698 \begin_inset Flex Code
16701 \begin_layout Plain Layout
16708 \begin_inset Flex Code
16711 \begin_layout Plain Layout
16717 ] The prefix to use when creating labels referring to paragraphs of this
16719 This allows the use of formatted references.
16722 \begin_layout Description
16723 \begin_inset Flex Code
16726 \begin_layout Plain Layout
16733 \begin_inset Flex Code
16736 \begin_layout Plain Layout
16742 ] Whether the style requires the feature
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16753 \begin_inset CommandInset ref
16755 reference "chap:List-of-functions"
16759 for the list of features).
16760 If you require a package with specific options, you can additionally use
16762 \begin_inset Flex Code
16765 \begin_layout Plain Layout
16771 as a general text class parameter (see
16772 \begin_inset CommandInset ref
16774 reference "subsec:General-text-class"
16781 \begin_layout Description
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16792 \begin_inset Flex Code
16795 \begin_layout Plain Layout
16804 \begin_inset Flex Code
16807 \begin_layout Plain Layout
16813 ] Resets the \SpecialChar LaTeX
16814 arguments of this style (as defined via the
16815 \begin_inset Flex Code
16818 \begin_layout Plain Layout
16825 This is useful if you have copied a style via
16826 \begin_inset Flex Code
16829 \begin_layout Plain Layout
16835 , but you do not want to inherit its (required and optional) arguments.
16838 \begin_layout Description
16839 \begin_inset Flex Code
16842 \begin_layout Plain Layout
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16861 \begin_inset Flex Code
16864 \begin_layout Plain Layout
16870 ] Resumes a counter that is usually reset at each new sequence of layouts.
16871 This is currently only useful when
16872 \begin_inset Flex Code
16875 \begin_layout Plain Layout
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16894 \begin_layout Description
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16905 \begin_inset Flex Code
16908 \begin_layout Plain Layout
16914 ] A string that is put at the end of the layout content.
16915 A line break in the output can be indicated by
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16928 \begin_layout Description
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 \begin_inset Flex Code
16942 \begin_layout Plain Layout
16949 \begin_inset Flex Code
16952 \begin_layout Plain Layout
16961 \begin_layout Description
16962 \begin_inset Flex Code
16965 \begin_layout Plain Layout
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16994 \begin_inset Flex Code
16997 \begin_layout Plain Layout
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17009 \begin_inset space ~
17017 ] This defines what the default spacing should be in the style.
17019 \begin_inset Flex Code
17022 \begin_layout Plain Layout
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17039 \begin_inset Flex Code
17042 \begin_layout Plain Layout
17048 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17049 If you specify the argument
17050 \begin_inset Flex Code
17053 \begin_layout Plain Layout
17059 , then you must also provide a value argument which will be the actual multiplie
17061 Note that, contrary to other parameters,
17062 \begin_inset Flex Code
17065 \begin_layout Plain Layout
17071 implies the generation of specific \SpecialChar LaTeX
17072 code, using the \SpecialChar LaTeX
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17088 \begin_layout Description
17089 \begin_inset Flex Code
17092 \begin_layout Plain Layout
17099 \begin_inset Flex Code
17102 \begin_layout Plain Layout
17109 \begin_inset space \thinspace{}
17113 \begin_inset Flex Code
17116 \begin_layout Plain Layout
17124 ] Allow spell-checking paragraphs of this style.
17128 \begin_layout Description
17129 \begin_inset Flex Code
17132 \begin_layout Plain Layout
17139 \begin_inset Flex Code
17142 \begin_layout Plain Layout
17151 \begin_inset Flex Code
17154 \begin_layout Plain Layout
17160 ] Steps the master counter of a given counter at the beginning of a new
17161 sequence of layouts.
17162 This is currently only useful when
17163 \begin_inset Flex Code
17166 \begin_layout Plain Layout
17173 \begin_inset Flex Code
17176 \begin_layout Plain Layout
17185 \begin_layout Description
17186 \begin_inset Flex Code
17189 \begin_layout Plain Layout
17195 The font used for the text body .
17197 \begin_inset CommandInset ref
17199 reference "subsec:Font-description"
17206 \begin_layout Description
17207 \begin_inset Flex Code
17210 \begin_layout Plain Layout
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17232 The level of the style in the table of contents.
17233 This is used for automatic numbering of section headings.
17236 \begin_layout Description
17237 \begin_inset Flex Code
17240 \begin_layout Plain Layout
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17282 ] This tag determines whether the first line indentation of this paragraph
17283 can be toggled via the Paragraph settings dialog.
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17300 is set, indentation can be toggled if the document settings use
17301 \begin_inset Quotes eld
17305 \begin_inset Quotes erd
17308 paragraph style, with
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17318 , indentation can always be toggled, notwithstanding the document settings,
17320 \begin_inset Flex Code
17323 \begin_layout Plain Layout
17329 , indentation can never be toggled.
17332 \begin_layout Description
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17352 ] The vertical space with which the very first of a chain of paragraphs
17353 with this style is separated from the previous paragraph.
17354 If the previous paragraph has another style, the separations are not simply
17355 added, but the maximum is taken.
17358 \begin_layout Subsection
17359 \begin_inset CommandInset label
17365 Internationalization of Paragraph Styles
17368 \begin_layout Standard
17370 has long supported internationalization of layout information, but, until
17371 version 2.0, this applied only to the user interface and not to, say, PDF
17373 Thus, French authors were forced to resort to ugly hacks if they wanted
17378 1' instead of `Theorem 1'.
17379 Thanks to Georg Baum, that is no longer the case.
17382 \begin_layout Standard
17384 \begin_inset Flex Code
17387 \begin_layout Plain Layout
17393 defines text that is to appear in the typeset document, it may use
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17413 to support non-English and even multi-language documents correctly.
17414 The following excerpt (from the
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17424 file) shows how this works:
17427 \begin_layout LyX-Code
17432 \begin_layout LyX-Code
17435 theoremstyle{remark}
17438 \begin_layout LyX-Code
17441 newtheorem{claim}[thm]{
17448 \begin_layout LyX-Code
17452 \begin_layout LyX-Code
17456 \begin_layout LyX-Code
17461 claimname}{_(Claim)}
17464 \begin_layout LyX-Code
17468 \begin_layout LyX-Code
17472 \begin_layout LyX-Code
17481 claimname}{_(Claim)}}
17484 \begin_layout LyX-Code
17489 \begin_layout Standard
17490 In principle, any legal \SpecialChar LaTeX
17492 \begin_inset Flex Code
17495 \begin_layout Plain Layout
17502 \begin_inset Flex Code
17505 \begin_layout Plain Layout
17511 tags, but in practice they will typically look as they do here.
17512 The key to correct translation of the typeset text is the definition of
17513 the \SpecialChar LaTeX
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17527 \begin_inset Flex Code
17530 \begin_layout Plain Layout
17542 \begin_layout Standard
17544 \begin_inset Flex Code
17547 \begin_layout Plain Layout
17553 tag provides for internationalization based upon the overall language of
17555 The contents of the tag will be included in the preamble, just as with
17557 \begin_inset Flex Code
17560 \begin_layout Plain Layout
17567 What makes it special is the use of the
17568 \begin_inset Quotes eld
17572 \begin_inset Quotes erd
17576 \begin_inset Flex Code
17579 \begin_layout Plain Layout
17585 , which will be replaced, when \SpecialChar LyX
17586 produces \SpecialChar LaTeX
17587 output, with the translation of
17588 its argument into the document language.
17591 \begin_layout Standard
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17602 tag is more complex, since it is meant to provide support for multi-language
17603 documents and so offers an interface to the
17604 \begin_inset Flex Code
17607 \begin_layout Plain Layout
17614 Its contents will be added to the preamble once for each language that
17615 appears in the document.
17616 In this case, the argument to
17617 \begin_inset Flex Code
17620 \begin_layout Plain Layout
17626 will be replaced with its translation into the language in question; the
17628 \begin_inset Flex Code
17631 \begin_layout Plain Layout
17637 is replaced by the language name (as used by the babel package).
17640 \begin_layout Standard
17641 A German document that also included a French section would thus have the
17642 following in the preamble:
17645 \begin_layout LyX-Code
17654 claimname}{Affirmation}}
17655 \begin_inset Newline newline
17666 claimname}{Behauptung}}
17667 \begin_inset Newline newline
17674 claimname}{Behauptung}
17677 \begin_layout Standard
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17689 will then conspire to produce the correct text in the output.
17692 \begin_layout Standard
17693 One important point to note here is that the translations are provided by
17695 itself, through the file
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17706 This means, in effect, that
17707 \begin_inset Flex Code
17710 \begin_layout Plain Layout
17717 \begin_inset Flex Code
17720 \begin_layout Plain Layout
17726 are really only of use in layout files that are provided with \SpecialChar LyX
17728 entered in user-created layout files will not be seen by \SpecialChar LyX
17729 's internationalizatio
17730 n routines unless the
17731 \begin_inset Flex Code
17734 \begin_layout Plain Layout
17740 file is modified accordingly.
17741 That said, however, any layout created with the intention that it will
17742 be included with \SpecialChar LyX
17743 should use these tags where appropriate.
17744 Please note that the paragraph style translations provided by \SpecialChar LyX
17746 change with a minor update (e.
17747 \begin_inset space \thinspace{}
17751 \begin_inset space \space{}
17754 from version 2.1.x to 2.1.y).
17755 It is however quite likely that a major update (e.
17756 \begin_inset space \thinspace{}
17760 \begin_inset space \space{}
17763 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17766 \begin_layout Subsection
17768 \begin_inset CommandInset label
17770 name "subsec:Floats"
17777 \begin_layout Standard
17778 It is necessary to define the floats (
17779 \begin_inset Flex Noun
17782 \begin_layout Plain Layout
17789 \begin_inset Flex Noun
17792 \begin_layout Plain Layout
17798 , \SpecialChar ldots
17799 ) in the text class itself.
17800 Standard floats are included in the file
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17810 , so you may have to do no more than add
17813 \begin_layout LyX-Code
17814 Input stdfloats.inc
17817 \begin_layout Standard
17818 to your layout file.
17819 If you want to implement a text class that proposes some other float types
17820 (like the AGU class bundled with \SpecialChar LyX
17821 ), the information below will hopefully
17825 \begin_layout Description
17826 \begin_inset Flex Code
17829 \begin_layout Plain Layout
17836 \begin_inset Flex Code
17839 \begin_layout Plain Layout
17845 =!htbpH] Allowed placement options for this float type.
17846 The value is a string of placement characters.
17847 Possible characters include:
17852 \begin_inset Quotes eld
17856 \begin_inset Quotes erd
17864 \begin_inset Quotes eld
17868 \begin_inset Quotes erd
17876 \begin_inset Quotes eld
17880 \begin_inset Quotes erd
17888 \begin_inset Quotes eld
17892 \begin_inset Quotes erd
17900 \begin_inset Quotes eld
17904 \begin_inset Quotes erd
17912 \begin_inset Quotes eld
17916 \begin_inset Quotes erd
17920 The order of the characters in the string does not matter.
17921 If no placement options are allowed, use the string
17928 \begin_layout Description
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17951 \begin_inset space \thinspace{}
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17970 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17977 \begin_inset Flex Code
17980 \begin_layout Plain Layout
17986 if the float does not support this feature.
17989 \begin_layout Description
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18000 \begin_inset Flex Code
18003 \begin_layout Plain Layout
18012 \begin_inset space \thinspace{}
18018 \begin_inset Flex Code
18021 \begin_layout Plain Layout
18031 ] Defines whether the float has a starred variant that spans columns in
18032 a two column paragraph.
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18043 if the float does not support this feature.
18046 \begin_layout Description
18047 \begin_inset Flex Code
18050 \begin_layout Plain Layout
18057 \begin_inset Flex Code
18060 \begin_layout Plain Layout
18067 \begin_inset Quotes erd
18071 \begin_inset Quotes erd
18074 ] The file name extension of an auxiliary file for the list of figures (or
18077 writes the captions to this file.
18080 \begin_layout Description
18081 \begin_inset Flex Code
18084 \begin_layout Plain Layout
18091 \begin_inset Flex Code
18094 \begin_layout Plain Layout
18101 \begin_inset Quotes erd
18105 \begin_inset Quotes erd
18108 ] The string that will be used in the menus and also for the caption.
18109 This is translated to the current language if babel is used.
18112 \begin_layout Description
18113 \begin_inset Flex Code
18116 \begin_layout Plain Layout
18122 These tags control the XHTML output.
18124 \begin_inset CommandInset ref
18126 reference "sec:Tags-for-XHTML"
18133 \begin_layout Description
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18158 \begin_inset space \thinspace{}
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18171 ] Indicates whether the float is already defined in the document class or
18172 if instead the \SpecialChar LaTeX
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18183 needs to be loaded to define it on-the-fly.
18185 \begin_inset Flex Code
18188 \begin_layout Plain Layout
18195 \begin_inset Flex Code
18198 \begin_layout Plain Layout
18205 It should be set to
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18215 if the float is already defined by the \SpecialChar LaTeX
18219 \begin_layout Description
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18230 \begin_inset Flex Code
18233 \begin_layout Plain Layout
18240 \begin_inset Quotes erd
18244 \begin_inset Quotes erd
18247 ] The command used to generate a list of floats of this type; the leading
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18265 is false, since there is no standard way to generate this command.
18267 \begin_inset Flex Code
18270 \begin_layout Plain Layout
18276 is true, since in that case there is a standard way to define the command.
18279 \begin_layout Description
18280 \begin_inset Flex Code
18283 \begin_layout Plain Layout
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18300 \begin_inset Quotes erd
18304 \begin_inset Quotes erd
18307 ] A title for a list of floats of this kind (list of figures, tables, or
18309 It is used for the screen label within \SpecialChar LyX
18310 , it is used by \SpecialChar LaTeX
18312 it is used as the title in the XHTML output.
18313 It will be translated to the document language.
18316 \begin_layout Description
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18337 \begin_inset Quotes erd
18341 \begin_inset Quotes erd
18344 ] This (optional) argument determines whether floats of this class will
18345 be numbered within some sectional unit of the document.
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18357 \begin_inset Quotes eld
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18371 \begin_inset Quotes erd
18374 , the floats will be numbered within chapters.
18378 \begin_layout Description
18379 \begin_inset Flex Code
18382 \begin_layout Plain Layout
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18399 \begin_inset Quotes erd
18403 \begin_inset Quotes erd
18406 ] The default placement for the given class of floats.
18407 The string should be as in standard \SpecialChar LaTeX
18409 \begin_inset Flex Code
18412 \begin_layout Plain Layout
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18448 for top, bottom, page, and here, respectively.
18452 \begin_layout Plain Layout
18453 Note that the order of these letters in the string is irrelevant, like in
18460 On top of that there is a new type,
18461 \begin_inset Flex Code
18464 \begin_layout Plain Layout
18470 , which does not really correspond to a float, since it means: put it
18471 \begin_inset Quotes eld
18475 \begin_inset Quotes erd
18479 Note however that the
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18489 specifier is special and, because of implementation details, cannot be
18490 used in non-built in float types.
18491 If you do not understand what this means, just use
18492 \begin_inset Quotes eld
18496 \begin_inset Flex Code
18499 \begin_layout Plain Layout
18506 \begin_inset Quotes erd
18512 \begin_layout Description
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18532 ] The prefix to use when creating labels referring to floats of this type.
18533 This allows the use of formatted references.
18534 Note that you can remove any
18535 \begin_inset Flex Code
18538 \begin_layout Plain Layout
18544 set by a copied style by using the special value
18545 \begin_inset Quotes eld
18549 \begin_inset Quotes erd
18552 , which must be all caps.
18553 \change_inserted -712698321 1565605014
18557 \begin_layout Description
18559 \change_inserted -712698321 1565605014
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18565 \change_inserted -712698321 1565605014
18572 \begin_inset Flex Code
18575 \begin_layout Plain Layout
18577 \change_inserted -712698321 1565605014
18583 ] As with paragraph styles, see
18584 \begin_inset CommandInset ref
18586 reference "subsec:Paragraph-Styles"
18595 \begin_layout Description
18596 \begin_inset Flex Code
18599 \begin_layout Plain Layout
18606 \begin_inset Flex Code
18609 \begin_layout Plain Layout
18616 \begin_inset Quotes erd
18620 \begin_inset Quotes erd
18623 ] The style used when defining the float using
18624 \begin_inset Flex Code
18627 \begin_layout Plain Layout
18638 \begin_layout Description
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18659 \begin_inset Quotes erd
18663 \begin_inset Quotes erd
18667 \begin_inset Quotes eld
18671 \begin_inset Quotes erd
18674 of the new class of floats, like program or algorithm.
18675 After the appropriate
18676 \begin_inset Flex Code
18679 \begin_layout Plain Layout
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18700 \begin_inset Flex Code
18703 \begin_layout Plain Layout
18714 \begin_layout Description
18715 \begin_inset Flex Code
18718 \begin_layout Plain Layout
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18735 \begin_inset space \thinspace{}
18739 \begin_inset Flex Code
18742 \begin_layout Plain Layout
18750 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18761 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18765 \begin_layout Standard
18766 Note that defining a float with type
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18778 automatically defines the corresponding counter with name
18779 \begin_inset Flex Code
18782 \begin_layout Plain Layout
18793 \begin_layout Subsection
18794 Flex insets and InsetLayout
18795 \begin_inset CommandInset label
18797 name "subsec:Flex-insets-and"
18804 \begin_layout Standard
18805 Flex insets come in
18806 \change_deleted 5863208 1594239511
18808 \change_inserted 5863208 1594239512
18814 \begin_layout Itemize
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18825 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18827 \begin_inset Flex Code
18830 \begin_layout Plain Layout
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18853 \begin_layout Itemize
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18864 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18866 footnote, and the like.
18867 An obvious example is an endnote inset, which is defined in the
18868 \begin_inset Flex Code
18871 \begin_layout Plain Layout
18880 \begin_layout Itemize
18882 \change_deleted 5863208 1594239528
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18893 ): For use with DocBook classes.
18898 \begin_layout Standard
18899 Flex insets are defined using the
18900 \begin_inset Flex Code
18903 \begin_layout Plain Layout
18909 tag, which shall be explained in a moment.
18912 \begin_layout Standard
18914 \begin_inset Flex Code
18917 \begin_layout Plain Layout
18923 tag also serves another function: It can be used to customize the general
18924 layout of many different types of insets.
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 can be used to customize the layout parameters for footnotes, marginal
18936 notes, note insets, \SpecialChar TeX
18937 code (ERT) insets, branches, listings, indexes, boxes,
18938 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18941 \begin_layout Standard
18943 \begin_inset Flex Code
18946 \begin_layout Plain Layout
18952 definition must begin with a line of the form:
18955 \begin_layout LyX-Code
18959 \begin_layout Standard
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18970 indicates the inset whose layout is being defined, and here there are four
18974 \begin_layout Enumerate
18975 The layout for a pre-existing inset is being modified.
18976 In this case, can be
18977 \begin_inset Flex Code
18980 \begin_layout Plain Layout
18986 any one of the following:
18987 \begin_inset Flex Code
18990 \begin_layout Plain Layout
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19017 \begin_inset Flex Code
19020 \begin_layout Plain Layout
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19047 \begin_inset Flex Code
19050 \begin_layout Plain Layout
19057 \begin_inset Flex Code
19060 \begin_layout Plain Layout
19067 \begin_inset Flex Code
19070 \begin_layout Plain Layout
19077 \begin_inset Flex Code
19080 \begin_layout Plain Layout
19087 \begin_inset Flex Code
19090 \begin_layout Plain Layout
19097 \begin_inset Flex Code
19100 \begin_layout Plain Layout
19107 \begin_inset Flex Code
19110 \begin_layout Plain Layout
19117 \begin_inset Flex Code
19120 \begin_layout Plain Layout
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19147 \begin_inset Flex Code
19150 \begin_layout Plain Layout
19157 \begin_inset Flex Code
19160 \begin_layout Plain Layout
19167 \begin_inset Flex Code
19170 \begin_layout Plain Layout
19177 \begin_inset Flex Code
19180 \begin_layout Plain Layout
19189 \begin_layout Enumerate
19190 The layout for a Flex inset is being defined.
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 must be of the form
19202 \begin_inset Quotes eld
19206 \begin_inset Flex Code
19209 \begin_layout Plain Layout
19216 \begin_inset Quotes erd
19220 \begin_inset Flex Code
19223 \begin_layout Plain Layout
19229 may be be any valid identifier not used by a pre-existing Flex inset.
19230 The identifier may include spaces, but in that case the whole thing must
19231 be wrapped in quotes.
19232 Note that the definition of a flex inset
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19246 entry, declaring which type of inset it defines.
19249 \begin_layout Enumerate
19250 The layout for user specific branch is being defined.
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19261 must be of the form
19262 \begin_inset Quotes eld
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19276 \begin_inset Quotes erd
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 may be be any valid identifier of branch defined in user's document.
19290 The identifier may include spaces, but in that case the whole thing must
19291 be wrapped in quotes.
19292 The main purpose of this feature is to allow \SpecialChar LaTeX
19293 wrapping around specific
19294 branches as user needs.
19297 \begin_layout Enumerate
19298 The layout of a user (or class) specific caption is being defined.
19300 \begin_inset Flex Code
19303 \begin_layout Plain Layout
19309 must be of the form
19310 \begin_inset Quotes eld
19314 \begin_inset Flex Code
19317 \begin_layout Plain Layout
19324 \begin_inset Quotes erd
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19337 specifies the name of the caption as it appears in the menu.
19338 Have a look at the standard caption (
19339 \begin_inset Flex Code
19342 \begin_layout Plain Layout
19348 ), the specific captions of the KOMA-Script classes (
19349 \begin_inset Flex Code
19352 \begin_layout Plain Layout
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19371 \begin_inset space ~
19375 \begin_inset Newline linebreak
19381 \begin_inset Flex Code
19384 \begin_layout Plain Layout
19390 ) for applications.
19393 \begin_layout Standard
19395 \begin_inset Flex Code
19398 \begin_layout Plain Layout
19404 definition can contain the following entries:
19407 \begin_layout Description
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19427 =""] This inset will appear in the table of contents of the given type.
19428 An empty string disables.
19429 See also the OutlinerName and the IsTocCaption commands.
19430 This is only implemented for Flex insets.
19434 \begin_layout Description
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19454 ] Defines argument number of a command\SpecialChar breakableslash
19455 environment associated with the current
19457 The definition must end with
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19469 \begin_inset CommandInset ref
19471 reference "subsec:Paragraph-Styles"
19478 \begin_layout Description
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19488 Preamble for changing language commands; see
19489 \begin_inset CommandInset ref
19491 reference "subsec:I18n"
19498 \begin_layout Description
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19518 ] The color for the inset's background.
19520 \begin_inset CommandInset ref
19522 reference "chap:Names-of-colors"
19526 for a list of the available color names.
19529 \begin_layout Description
19530 \begin_inset Flex Code
19533 \begin_layout Plain Layout
19540 \begin_inset Flex Code
19543 \begin_layout Plain Layout
19552 \begin_inset space \thinspace{}
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19565 ] Whether to use the content of the inset as the label, when the inset is
19570 \begin_layout Description
19571 \begin_inset Flex Code
19574 \begin_layout Plain Layout
19581 \begin_inset Flex Code
19584 \begin_layout Plain Layout
19590 ] As with paragraph styles, see
19591 \begin_inset CommandInset ref
19593 reference "subsec:Paragraph-Styles"
19598 Note that you need to specify the complete type, e.
19599 \begin_inset space \thinspace{}
19603 \begin_inset space ~
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19611 CopyStyle Flex:<name>
19619 \begin_layout Description
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19642 \begin_inset space \thinspace{}
19646 \begin_inset Flex Code
19649 \begin_layout Plain Layout
19655 ] Indicates whether the user may employ the Paragraph Settings dialog to
19656 customize the paragraph.
19659 \begin_layout Description
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19680 \begin_inset Flex Code
19683 \begin_layout Plain Layout
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19699 , describing the rendering style used for the inset's frame and buttons.
19700 Footnotes generally use
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19710 , ERT insets generally
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19720 , and character styles
19721 \begin_inset Flex Code
19724 \begin_layout Plain Layout
19733 \begin_layout Description
19734 \begin_inset Flex Code
19737 \begin_layout Plain Layout
19744 \begin_inset Flex Code
19747 \begin_layout Plain Layout
19756 \begin_inset space \thinspace{}
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19794 Indicates whether the environment will stand on its own in the output or
19795 will appear inline with the surrounding text.
19796 If set to false, it is supposed that the \SpecialChar LaTeX
19797 environment ignores white space
19798 (including one newline character) after the
19799 \begin_inset Flex Code
19802 \begin_layout Plain Layout
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19832 \change_inserted 731793113 1538674858
19836 \begin_layout Description
19838 \change_inserted 731793113 1538674891
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19844 \change_inserted 731793113 1538674863
19856 ,1] Allow the contents of the inset to be edited externally (using whatever
19857 editor is defined for the document's output format).
19862 \begin_layout Description
19863 \begin_inset Flex Code
19866 \begin_layout Plain Layout
19872 Required at the end of the
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19885 \begin_layout Description
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19895 The font used for both the text body
19901 \begin_inset CommandInset ref
19903 reference "subsec:Font-description"
19908 Note that defining this font automatically defines the
19909 \begin_inset Flex Code
19912 \begin_layout Plain Layout
19918 to the same value, so define this first and define
19919 \begin_inset Flex Code
19922 \begin_layout Plain Layout
19928 later if you want them to be different.
19931 \begin_layout Description
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19936 FixedWidthPreambleEncoding
19942 \begin_inset Flex Code
19945 \begin_layout Plain Layout
19954 \begin_inset space \thinspace{}
19958 \begin_inset Flex Code
19961 \begin_layout Plain Layout
19967 ] Force a fixed width encoding for the translated contents of
19968 \begin_inset Flex Code
19971 \begin_layout Plain Layout
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19987 code generated by this layout.
19988 This is needed for special \SpecialChar LaTeX
19993 that do not work with variable width encodings such as
19998 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19999 backends such as Xe\SpecialChar TeX
20001 Lua\SpecialChar TeX
20005 \begin_layout Description
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20010 ForceLocalFontSwitch
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20028 \begin_inset space \thinspace{}
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 ] When using babel, always use a local font switch (
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20053 ), never a global one (such as
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20068 \begin_layout Description
20069 \begin_inset Flex Code
20072 \begin_layout Plain Layout
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20091 \begin_inset space \thinspace{}
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20105 \begin_inset Quotes eld
20109 \begin_inset Quotes erd
20112 language, leading to Left-to-Right (Latin) output, e.
20113 \begin_inset space \thinspace{}
20117 \begin_inset space \space{}
20120 in \SpecialChar TeX
20125 \begin_layout Description
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20148 \begin_inset space \thinspace{}
20152 \begin_inset Flex Code
20155 \begin_layout Plain Layout
20161 ] Force a a line break in the \SpecialChar LaTeX
20162 output before the inset starts and after
20164 This assures the inset itself is output on its own lines, for parsing purposes.
20167 \begin_layout Description
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20190 \begin_inset space \thinspace{}
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20203 ] Indicates whether the
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20213 should be used or, instead, the user can change the paragraph style used
20218 \begin_layout Description
20219 \begin_inset Flex Code
20222 \begin_layout Plain Layout
20229 \begin_inset Flex Code
20232 \begin_layout Plain Layout
20241 \begin_inset space \thinspace{}
20245 \begin_inset Flex Code
20248 \begin_layout Plain Layout
20254 ] As with paragraph styles, see
20255 \begin_inset CommandInset ref
20257 reference "subsec:Paragraph-Styles"
20264 \begin_layout Description
20265 \begin_inset Flex Code
20268 \begin_layout Plain Layout
20274 These tags control the XHTML output.
20276 \begin_inset CommandInset ref
20278 reference "sec:Tags-for-XHTML"
20285 \begin_layout Description
20286 \begin_inset Flex Code
20289 \begin_layout Plain Layout
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20308 \begin_inset space \thinspace{}
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20321 ] Whether to include the contents of this inset in the strings generated
20322 for the `Outline' pane for all table of contents, regardless of the AddToToc
20324 One would not, for example, want the content of a footnote in a section
20325 header to be included in the TOC displayed in the outline, but one would
20326 normally want the content of a character style displayed.
20327 Default is false: not to include.
20330 \begin_layout Description
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20341 \begin_inset Flex Code
20344 \begin_layout Plain Layout
20353 \begin_inset space \thinspace{}
20357 \begin_inset Flex Code
20360 \begin_layout Plain Layout
20366 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20367 of its contents in its item in the table of contents.
20368 Otherwise, only the label appears.
20371 \begin_layout Description
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20396 \begin_inset space \thinspace{}
20400 \begin_inset Flex Code
20403 \begin_layout Plain Layout
20409 ] As with paragraph styles, see
20410 \begin_inset CommandInset ref
20412 reference "subsec:Paragraph-Styles"
20419 \begin_layout Description
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20429 The font used for the label.
20431 \begin_inset CommandInset ref
20433 reference "subsec:Font-description"
20438 Note that this definition can never appear before
20439 \begin_inset Flex Code
20442 \begin_layout Plain Layout
20448 , lest it be ineffective.
20451 \begin_layout Description
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20472 \begin_inset Quotes erd
20476 \begin_inset Quotes erd
20479 ] What will be displayed on the button or elsewhere as the inset label.
20481 \begin_inset Flex Code
20484 \begin_layout Plain Layout
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20501 ) modify this label on the fly.
20504 \begin_layout Description
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20514 Language dependent preamble; see
20515 \begin_inset CommandInset ref
20517 reference "subsec:I18n"
20524 \begin_layout Description
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20544 ] The name of the corresponding \SpecialChar LaTeX
20546 Either the environment or command name.
20549 \begin_layout Description
20550 \begin_inset Flex Code
20553 \begin_layout Plain Layout
20560 \begin_inset Flex Code
20563 \begin_layout Plain Layout
20569 ] The optional parameter for the corresponding
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20579 stuff, including possible bracket pairs like
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20590 This parameter cannot be changed from within \SpecialChar LyX
20592 \begin_inset Flex Code
20595 \begin_layout Plain Layout
20601 for customizable parameters).
20602 It will be output as is after all \SpecialChar LaTeX
20604 \begin_inset Flex Code
20607 \begin_layout Plain Layout
20616 \begin_layout Description
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20631 Command, Environment, None
20636 ] How the style should be translated into \SpecialChar LaTeX
20641 \begin_layout Plain Layout
20642 \begin_inset Flex Code
20645 \begin_layout Plain Layout
20651 is perhaps a bit misleading, since these rules apply to SGML classes too.
20652 Visit the SGML class files for specific examples.
20661 \begin_layout Description
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20671 means nothing special
20674 \begin_layout Description
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20695 {\SpecialChar ldots
20704 \begin_layout Description
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20725 }\SpecialChar ldots
20740 \begin_layout Standard
20741 Putting the last few things together, the \SpecialChar LaTeX
20742 output will be either:
20745 \begin_layout LyX-Code
20748 LatexName[LatexParam]{\SpecialChar ldots
20752 \begin_layout Standard
20756 \begin_layout LyX-Code
20759 begin{LatexName}[LatexParam] \SpecialChar ldots
20765 \begin_layout Standard
20766 depending upon the \SpecialChar LaTeX
20771 \begin_layout Description
20772 \begin_inset Flex Code
20775 \begin_layout Plain Layout
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20791 ] A string that is put at the beginning of the layout content.
20792 A line break in the output can be indicated by
20793 \begin_inset Flex Code
20796 \begin_layout Plain Layout
20805 \begin_layout Description
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20826 \begin_inset Flex Code
20829 \begin_layout Plain Layout
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20846 \begin_inset Flex Code
20849 \begin_layout Plain Layout
20855 (indicating a dummy definition ending definitions of charstyles, etc).
20856 This entry is required in and is only meaningful for Flex insets.
20857 Among other things, it determines on which menu this inset will appear.
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20878 will automatically set
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20909 can be set to true, or
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20929 insets by setting it
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20944 \change_inserted -712698321 1555575738
20948 \begin_layout Description
20950 \change_inserted -712698321 1555575844
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20956 \change_inserted -712698321 1555575740
20963 \begin_inset Flex Code
20966 \begin_layout Plain Layout
20968 \change_inserted -712698321 1555575740
20974 A dedicated string for the menu.
20975 You can define an accelerator by appending the respective character to
20976 the string, divided by
20977 \begin_inset Quotes eld
20981 \begin_inset Quotes erd
20985 \begin_inset space \thinspace{}
20989 \begin_inset space \space{}
20993 \begin_inset Quotes eld
20997 \begin_inset Flex Code
21000 \begin_layout Plain Layout
21002 \change_inserted -712698321 1555575781
21009 \begin_inset Quotes erd
21013 This specification is optional.
21014 If it is not given the inset name as specified in the type declaration
21015 will be used instead for the menu.
21020 \begin_layout Description
21021 \begin_inset Flex Code
21024 \begin_layout Plain Layout
21031 \begin_inset Flex Code
21034 \begin_layout Plain Layout
21043 \begin_inset space \thinspace{}
21047 \begin_inset Flex Code
21050 \begin_layout Plain Layout
21056 ] Whether multiple paragraphs are permitted in this inset.
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21067 to the same value and
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21077 to the opposite value.
21078 These can be reset to other values, if they are used
21083 \begin_inset Flex Code
21086 \begin_layout Plain Layout
21096 \begin_layout Description
21097 \begin_inset Flex Code
21100 \begin_layout Plain Layout
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21119 \begin_inset space \thinspace{}
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21132 ] Whether fragile commands in this inset should be
21133 \begin_inset Flex Code
21136 \begin_layout Plain Layout
21149 whether the command should itself be protected.) Default is false.
21150 \change_inserted -712698321 1523633958
21154 \begin_layout Description
21156 \change_inserted -712698321 1552395786
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21162 \change_inserted -712698321 1523633961
21169 \begin_inset Flex Code
21172 \begin_layout Plain Layout
21174 \change_inserted -712698321 1523633958
21183 \begin_inset space \thinspace{}
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21192 \change_inserted -712698321 1523633958
21198 ] This causes macros that contain this inset to be protected with
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21204 \change_inserted -712698321 1523634038
21219 ) if necessary and thus allows (some) verbatim stuff in macros.
21223 \begin_layout Description
21225 \change_inserted -712698321 1555579651
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21231 \change_inserted -712698321 1552395787
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21243 \change_inserted -712698321 1552395787
21252 \begin_inset space \thinspace{}
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21261 \change_inserted -712698321 1552395787
21267 ] Whether specific commands in this inset (such as
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21273 \change_inserted -712698321 1552395787
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21287 \change_inserted -712698321 1552395787
21295 ) should be protected in an
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21301 \change_inserted -712698321 1552395787
21310 This is particularly needed for insets that draw on
21318 commands which parse their content in complex ways.
21322 \begin_layout Description
21324 \change_inserted -712698321 1555579742
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21330 \change_inserted -712698321 1555579658
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21342 \change_inserted -712698321 1555579651
21348 Option to define a different command (from the default
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21354 \change_inserted -712698321 1555579742
21366 ) to be used for line breaks.
21367 The initial backslash must not be specified.
21372 \begin_layout Description
21373 \begin_inset Flex Code
21376 \begin_layout Plain Layout
21383 \begin_inset Flex Code
21386 \begin_layout Plain Layout
21392 ] Deletes an existing
21393 \begin_inset Flex Code
21396 \begin_layout Plain Layout
21405 \begin_layout Description
21406 \begin_inset Flex Code
21409 \begin_layout Plain Layout
21416 \begin_inset Flex Code
21419 \begin_layout Plain Layout
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21435 that has replaced this
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21446 This is used to rename an
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21456 , while keeping backward compatibility.
21457 \change_inserted -712698321 1559491850
21461 \begin_layout Description
21463 \change_inserted -712698321 1559492002
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21469 \change_inserted -712698321 1559491854
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21481 \change_inserted -712698321 1559491850
21490 \begin_inset space \thinspace{}
21494 \begin_inset Flex Code
21497 \begin_layout Plain Layout
21499 \change_inserted -712698321 1559491850
21505 ] If this is set to
21506 \begin_inset Flex Code
21509 \begin_layout Plain Layout
21511 \change_inserted -712698321 1559491881
21519 , paragraph breaks will be ignored in the output.
21520 This might be useful for insets where the content should be alignable on
21521 different lines only in the \SpecialChar LyX
21522 workarea, without any effect in the output.
21527 \begin_layout Description
21528 \begin_inset Flex Code
21531 \begin_layout Plain Layout
21538 \begin_inset Flex Code
21541 \begin_layout Plain Layout
21550 \begin_inset space \thinspace{}
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21563 ] As with paragraph styles, see
21564 \begin_inset CommandInset ref
21566 reference "subsec:Paragraph-Styles"
21574 \begin_layout Description
21575 \begin_inset Flex Code
21578 \begin_layout Plain Layout
21585 \begin_inset Flex Code
21588 \begin_layout Plain Layout
21597 \begin_inset space \thinspace{}
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21610 ] As with paragraph styles, see
21611 \begin_inset CommandInset ref
21613 reference "subsec:Paragraph-Styles"
21621 \begin_layout Description
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21631 As with paragraph styles, see
21632 \begin_inset CommandInset ref
21634 reference "subsec:Paragraph-Styles"
21641 \begin_layout Description
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21661 ] The prefix to use when creating labels referring to insets of this type.
21662 This allows the use of formatted references.
21665 \begin_layout Description
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21685 ] As with paragraph styles, see
21686 \begin_inset CommandInset ref
21688 reference "subsec:Paragraph-Styles"
21695 \begin_layout Description
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21706 \begin_inset Flex Code
21709 \begin_layout Plain Layout
21718 \begin_inset space \thinspace{}
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21731 ] Resets the \SpecialChar LaTeX
21732 arguments of this layout (as defined via the
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21743 This is useful if you have copied a style via
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21753 , but you do not want to inherit its (required and optional) arguments.
21756 \begin_layout Description
21757 \begin_inset Flex Code
21760 \begin_layout Plain Layout
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21777 \begin_inset space \thinspace{}
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21792 ] Whether this inset should use the font of its surrounding environment
21794 Default is false: use the font of the surrounding environment.
21797 \begin_layout Description
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21808 \begin_inset Flex Code
21811 \begin_layout Plain Layout
21817 ] A string that is put at the end of the layout content.
21818 A line break in the output can be indicated by
21819 \begin_inset Flex Code
21822 \begin_layout Plain Layout
21831 \begin_layout Description
21832 \begin_inset Flex Code
21835 \begin_layout Plain Layout
21842 \begin_inset Flex Code
21845 \begin_layout Plain Layout
21852 \begin_inset space \thinspace{}
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21867 ] Allow spell-checking the contents of this inset.
21871 \begin_layout Subsection
21873 \begin_inset CommandInset label
21875 name "subsec:Counters"
21882 \begin_layout Standard
21883 It is necessary to define the counters (
21884 \begin_inset Flex Noun
21887 \begin_layout Plain Layout
21894 \begin_inset Flex Noun
21897 \begin_layout Plain Layout
21903 , \SpecialChar ldots
21904 ) in the text class itself.
21905 The standard counters are defined in the file
21906 \begin_inset Flex Code
21909 \begin_layout Plain Layout
21915 , so you may have to do no more than add
21918 \begin_layout LyX-Code
21919 Input stdcounters.inc
21922 \begin_layout Standard
21923 to your layout file to get them to work.
21924 But if you want to define custom counters, then you can do so.
21925 The counter declaration must begin with:
21928 \begin_layout LyX-Code
21929 Counter CounterName
21932 \begin_layout Standard
21934 \begin_inset Flex Code
21937 \begin_layout Plain Layout
21943 ' is replaced by the name of the counter.
21944 And it must end with
21945 \begin_inset Quotes eld
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21959 \begin_inset Quotes erd
21963 The following parameters can also be used:
21966 \begin_layout Description
21967 \begin_inset Flex Code
21970 \begin_layout Plain Layout
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21986 ] Sets the initial value for the counter, to which it will be reset whenever
21988 Normally, one will want the default, 1.
21991 \begin_layout Description
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22012 \begin_inset Quotes erd
22016 \begin_inset Quotes erd
22019 ] When defined, this string defines how the counter is displayed.
22020 Setting this value sets
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22025 LabelStringAppendix
22031 The following special constructs can be used in the string:
22035 \begin_layout Itemize
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22047 will be replaced by the expansion of the
22048 \begin_inset Flex Code
22051 \begin_layout Plain Layout
22058 \begin_inset Flex Code
22061 \begin_layout Plain Layout
22062 LabelStringAppendix
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22081 \begin_layout Itemize
22082 counter values can be expressed using \SpecialChar LaTeX
22084 \begin_inset Newline newline
22088 \begin_inset Flex Code
22091 \begin_layout Plain Layout
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22123 \begin_layout Plain Layout
22133 Actually, the situation is a bit more complicated: any
22152 other than those described below will produce arabic numerals.
22153 It would not be surprising to see this change in the future.
22159 \begin_inset Flex Code
22162 \begin_layout Plain Layout
22168 : 1, 2, 3,\SpecialChar ldots
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22179 for lower-case letters: a, b, c, \SpecialChar ldots
22181 \begin_inset Flex Code
22184 \begin_layout Plain Layout
22190 for upper-case letters: A, B, C, \SpecialChar ldots
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22201 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22203 \begin_inset Flex Code
22206 \begin_layout Plain Layout
22212 for upper-case roman numerals: I, II, III\SpecialChar ldots
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22223 for hebrew numerals.
22227 \begin_layout Standard
22228 If LabelString is not defined, a default value is constructed as follows:
22229 if the counter has a master counter
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22240 \begin_inset Flex Code
22243 \begin_layout Plain Layout
22250 \begin_inset Newline newline
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22267 is used; otherwise the string
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22282 \begin_layout Description
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22287 LabelStringAppendix
22293 \begin_inset Flex Code
22296 \begin_layout Plain Layout
22303 \begin_inset Quotes erd
22307 \begin_inset Quotes erd
22311 \begin_inset Flex Code
22314 \begin_layout Plain Layout
22320 , but for use in the Appendix.
22323 \begin_layout Description
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22344 \begin_inset Quotes erd
22348 \begin_inset Quotes erd
22351 ] A format for use with formatted references to this counter.
22352 For example, one might want to have references to section numbers appear
22354 \begin_inset Quotes eld
22358 \begin_inset Quotes erd
22362 The string should contain
22363 \begin_inset Quotes eld
22367 \begin_inset Quotes erd
22371 This will be replaced by the counter number itself.
22372 So, for sections, it would be: Section ##.
22375 \begin_layout Description
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22386 \begin_inset Flex Code
22389 \begin_layout Plain Layout
22396 \begin_inset Quotes erd
22400 \begin_inset Quotes erd
22403 ] If this is set to the name of another counter, the present counter will
22404 be reset every time the other one is increased.
22406 \begin_inset Flex Code
22409 \begin_layout Plain Layout
22416 \begin_inset Flex Code
22419 \begin_layout Plain Layout
22428 \begin_layout Subsection
22430 \begin_inset CommandInset label
22432 name "subsec:Font-description"
22439 \begin_layout Standard
22440 A font description looks like this:
22443 \begin_layout LyX-Code
22460 \begin_layout LyX-Code
22464 \begin_layout LyX-Code
22468 \begin_layout Standard
22469 The following commands are available:
22472 \begin_layout Description
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22495 \begin_inset Flex Code
22498 \begin_layout Plain Layout
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22515 \begin_inset Flex Code
22518 \begin_layout Plain Layout
22525 \begin_inset Flex Code
22528 \begin_layout Plain Layout
22535 \begin_inset Flex Code
22538 \begin_layout Plain Layout
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22585 \begin_inset Flex Code
22588 \begin_layout Plain Layout
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22645 \begin_inset Flex Code
22648 \begin_layout Plain Layout
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22687 \begin_layout Description
22688 \begin_inset Flex Code
22691 \begin_layout Plain Layout
22698 \begin_inset Flex Code
22701 \begin_layout Plain Layout
22710 \begin_inset Flex Code
22713 \begin_layout Plain Layout
22720 \begin_inset Flex Code
22723 \begin_layout Plain Layout
22732 \begin_layout Description
22733 \begin_inset Flex Code
22736 \begin_layout Plain Layout
22743 \begin_inset Flex Code
22746 \begin_layout Plain Layout
22752 ] Valid arguments are:
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22793 \begin_inset Flex Code
22796 \begin_layout Plain Layout
22803 \begin_inset Flex Code
22806 \begin_layout Plain Layout
22813 \begin_inset Flex Code
22816 \begin_layout Plain Layout
22823 \begin_inset Flex Code
22826 \begin_layout Plain Layout
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22853 \begin_inset Flex Code
22856 \begin_layout Plain Layout
22863 \begin_inset Flex Code
22866 \begin_layout Plain Layout
22873 Each of these turns on or off the corresponding attribute.
22875 \begin_inset Flex Code
22878 \begin_layout Plain Layout
22884 turns on emphasis, and
22885 \begin_inset Flex Code
22888 \begin_layout Plain Layout
22896 \begin_inset Newline newline
22899 If the latter seems puzzling, remember that the font settings for the present
22900 context are generally inherited from the surrounding context.
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22911 would turn off the emphasis that was anyway in effect, say, in a theorem
22915 \begin_layout Description
22916 \begin_inset Flex Code
22919 \begin_layout Plain Layout
22926 \begin_inset Flex Code
22929 \begin_layout Plain Layout
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22950 \begin_layout Description
22951 \begin_inset Flex Code
22954 \begin_layout Plain Layout
22961 \begin_inset Flex Code
22964 \begin_layout Plain Layout
22973 \begin_inset Flex Code
22976 \begin_layout Plain Layout
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22993 \begin_inset Flex Code
22996 \begin_layout Plain Layout
23005 \begin_layout Description
23006 \begin_inset Flex Code
23009 \begin_layout Plain Layout
23016 \begin_inset Flex Code
23019 \begin_layout Plain Layout
23026 \begin_inset Flex Code
23029 \begin_layout Plain Layout
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23100 \begin_layout Subsection
23101 \begin_inset CommandInset label
23103 name "subsec:Citation-engine-description"
23107 Cite engine description
23110 \begin_layout Standard
23112 \begin_inset Flex Code
23115 \begin_layout Plain Layout
23121 blocks, as used mainly in cite engine files (see
23122 \begin_inset CommandInset ref
23124 reference "subsec:Cite-Engine-Files"
23131 ), define the citation commands provided by a specific
23132 \begin_inset Quotes eld
23136 \begin_inset Quotes erd
23140 A cite engine, in \SpecialChar LyX
23141 terms, is way specific way to format citations, using
23142 numbers, author names and/or years.
23143 Currently, \SpecialChar LyX
23144 supports three such engine types, namely:
23147 \begin_layout Enumerate
23148 \begin_inset Flex Code
23151 \begin_layout Plain Layout
23157 : the default Bib\SpecialChar TeX
23158 way to format citations, a simple numeric style (e.
23159 \begin_inset space \thinspace{}
23163 \begin_inset Quotes eld
23167 \begin_inset Quotes erd
23173 \begin_layout Enumerate
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23183 : Harvard-styled citations using author names and publication year (e.
23184 \begin_inset space \thinspace{}
23188 \begin_inset Quotes eld
23191 Smith and Miller (2017b)
23192 \begin_inset Quotes erd
23198 \begin_layout Enumerate
23199 \begin_inset Flex Code
23202 \begin_layout Plain Layout
23208 : extended numerical citations that also allow for author or title next
23210 \begin_inset space \thinspace{}
23214 \begin_inset Quotes eld
23217 Smith and Miller [1]
23218 \begin_inset Quotes erd
23224 \begin_layout Standard
23225 \begin_inset Flex Code
23228 \begin_layout Plain Layout
23234 blocks look like this:
23237 \begin_layout LyX-Code
23241 \begin_layout LyX-Code
23245 \begin_layout LyX-Code
23249 \begin_layout LyX-Code
23250 citeyearpar[][]=parencite*
23253 \begin_layout LyX-Code
23257 \begin_layout LyX-Code
23261 \begin_layout Standard
23263 \begin_inset Flex Code
23266 \begin_layout Plain Layout
23272 denotes the engine.
23273 The individual lines respectively define a cite command or cite command
23274 paradigm supported by this engine.
23275 The line can be as simple as a cite command that is used both to name the
23276 respective \SpecialChar LyX
23277 command and the \SpecialChar LaTeX
23278 output or more complex in order to differentiate
23280 The full syntax is:
23283 \begin_layout LyX-Code
23284 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23287 \begin_layout Itemize
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23297 : The name as used in the
23298 \begin_inset Flex Code
23301 \begin_layout Plain Layout
23311 \begin_layout Standard
23312 For portability reasons, we try to use the same name for same-formatted
23313 commands in different cite packages (thus many names stem from natbib,
23314 and thus we need to differentiate a
23315 \begin_inset Flex Code
23318 \begin_layout Plain Layout
23324 sometimes, if the \SpecialChar LaTeX
23325 command names differ).
23329 \begin_layout Itemize
23330 \begin_inset Flex Code
23333 \begin_layout Plain Layout
23339 : a (comma-separated) list of commands that fall back to the given
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23349 in the current engine.
23350 This eases the switch of citation packages and engines.
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23362 \begin_inset Flex Code
23365 \begin_layout Plain Layout
23371 in layout definitions.
23374 \begin_layout Itemize
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23384 : The actual \SpecialChar LaTeX
23385 command that is output.
23389 \begin_layout Standard
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23411 \begin_inset Flex Code
23414 \begin_layout Plain Layout
23421 \begin_inset Flex Code
23424 \begin_layout Plain Layout
23430 will be output to \SpecialChar LaTeX
23434 \begin_layout Standard
23438 \begin_layout Itemize
23439 Capitalization indicates that the command also has a capitalized form (
23440 \begin_inset Flex Code
23443 \begin_layout Plain Layout
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23465 These usually enforce up-casing of name prefixes (
23470 \begin_inset Formula $\Rightarrow$
23480 \begin_layout Itemize
23482 \begin_inset Flex Code
23485 \begin_layout Plain Layout
23491 indicate the number of optional arguments (there can be 0–2).
23494 \begin_layout Itemize
23496 \begin_inset Flex Code
23499 \begin_layout Plain Layout
23505 indicates there is a starred version of the command (
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23535 \begin_layout Standard
23536 By default, the starred version means: Output all authors even if it should
23538 \begin_inset Quotes eld
23542 \begin_inset Quotes erd
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23558 \begin_layout Standard
23559 If the star has a different meaning for a given command, it can be specified
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23565 <!_stardesc!_stardesctooltip>
23571 Maximal two translatable macro keywords, marked by the prefix
23572 \begin_inset Flex Code
23575 \begin_layout Plain Layout
23582 The first points to the string that replaces the
23583 \begin_inset Quotes eld
23587 \begin_inset Quotes erd
23590 checkbox label in the citation dialog, the second one to an optional tool
23591 tip for this checkbox.
23595 \begin_layout Standard
23596 Note that these two macros have to be defined in a
23597 \begin_inset Flex Code
23600 \begin_layout Plain Layout
23606 (see next section), dropping the
23607 \begin_inset Flex Code
23610 \begin_layout Plain Layout
23616 from the prefix, like this:
23619 \begin_layout LyX-Code
23620 _stardesc Sta&rred command label
23623 \begin_layout LyX-Code
23624 _stardesctooltip Tooltip for the starred command checkbox.
23628 \begin_layout Itemize
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23639 indicates that this command features
23640 \begin_inset Quotes eld
23643 qualified citation lists
23644 \begin_inset Quotes erd
23652 -specific feature for multi-reference citations where an individual pre-
23653 and postnote can be given to each reference in the list.
23654 Please refer to the
23658 manual for details.
23659 \change_inserted -712698321 1526898670
23663 \begin_layout Standard
23665 \change_inserted -712698321 1526899524
23666 If you want to add a cite command to a cite engine (e.
23667 \begin_inset space \thinspace{}
23670 g., add a specific command provided by a class), you can use
23671 \begin_inset Flex Code
23674 \begin_layout Plain Layout
23676 \change_inserted -712698321 1526898768
23677 AddToCiteEngine <engine type> \SpecialChar ldots
23686 Note that only cite commands that do not exist yet are added.
23691 \begin_layout Subsection
23692 \begin_inset CommandInset label
23694 name "subsec:Citation-format-description"
23698 Cite format description
23701 \begin_layout Standard
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23712 blocks are used to describe how bibliographic information should be displayed,
23713 both within \SpecialChar LyX
23714 itself (in the citation dialog and in tooltips, for example)
23715 and in XHTML output.
23716 Such a block might look like this:
23719 \begin_layout LyX-Code
23723 \begin_layout LyX-Code
23727 \begin_layout LyX-Code
23731 \begin_layout LyX-Code
23735 \begin_layout Standard
23739 \begin_layout LyX-Code
23743 \begin_layout LyX-Code
23747 \begin_layout LyX-Code
23751 \begin_layout LyX-Code
23755 \begin_layout Standard
23756 In the first case, the individual lines define how the bibliographic information
23757 associated with an article or book, respectively, is to be displayed, and
23758 such a definition can be given for any
23759 \begin_inset Quotes els
23763 \begin_inset Quotes ers
23766 that might be present in a Bib\SpecialChar TeX
23769 defines a default format in the source code that will be used if no specific
23770 definition has been given.
23772 predefines several formats in the file
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23782 , which is included in most of \SpecialChar LyX
23783 's document classes.
23786 \begin_layout Standard
23787 In the second case, the lines define how a specific citation command (in
23789 \begin_inset Flex Code
23792 \begin_layout Plain Layout
23801 \begin_inset Flex Code
23804 \begin_layout Plain Layout
23812 ) is to be displayed on the citation inset label, in the citation dialog,
23813 menu or XHTML output.
23815 defines such formats for the citation style variants it supports via
23817 Document\SpecialChar menuseparator
23818 Setting\SpecialChar menuseparator
23819 Bibliography\SpecialChar ldots
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23832 files that are shipped with \SpecialChar LyX
23834 \begin_inset CommandInset ref
23836 reference "subsec:Cite-Engine-Files"
23846 \begin_layout Standard
23847 The definitions use a simple language that allows Bib\SpecialChar TeX
23848 keys to be replaced
23850 Keys should be enclosed in
23851 \begin_inset Flex Code
23854 \begin_layout Plain Layout
23861 \begin_inset Flex Code
23864 \begin_layout Plain Layout
23871 So a simple definition might look like this:
23874 \begin_layout LyX-Code
23876 \begin_inset Quotes eld
23880 \begin_inset Quotes erd
23886 \begin_layout Standard
23887 This would print the author, followed by a comma, followed by the title,
23888 in quotes, followed by a period.
23891 \begin_layout Standard
23892 Of course, sometimes you may want to print a key only if it exists.
23893 This can be done by using a conditional construction, such as:
23894 \begin_inset Flex Code
23897 \begin_layout Plain Layout
23899 \begin_inset space ~
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23918 key exists, then print
23919 \begin_inset Quotes eld
23923 \begin_inset space ~
23927 \begin_inset Quotes erd
23930 followed by the volume key.
23931 It is also possible to have an else clause in the conditional, such as:
23932 \begin_inset Newline newline
23936 \begin_inset Flex Code
23939 \begin_layout Plain Layout
23940 {%author%[[%author%]][[%editor%, ed.]]}
23946 \begin_inset Newline newline
23950 \begin_inset Flex Code
23953 \begin_layout Plain Layout
23959 key is printed if it exists; otherwise, the editor key is printed, followed
23961 \begin_inset Quotes eld
23965 \begin_inset space ~
23969 \begin_inset Quotes erd
23972 Note that the key is again enclosed in
23973 \begin_inset Flex Code
23976 \begin_layout Plain Layout
23982 signs; the entire conditional is enclosed in braces; and the if and else
23983 clauses are enclosed in double brackets,
23984 \begin_inset Quotes eld
23988 \begin_inset Flex Code
23991 \begin_layout Plain Layout
23998 \begin_inset Quotes eld
24002 \begin_inset Quotes eld
24006 \begin_inset Flex Code
24009 \begin_layout Plain Layout
24016 \begin_inset Quotes erd
24020 There must be no space between any of these.
24023 \begin_layout Standard
24024 Next to the entry keys, there are some special keys that can be used for
24025 these conditionals:
24028 \begin_layout Itemize
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24033 {%dialog%[[true]][[false]]}
24039 \begin_inset Quotes eld
24043 \begin_inset Quotes erd
24046 part for dialogs and menus, the
24047 \begin_inset Quotes eld
24051 \begin_inset Quotes erd
24054 part for other contexts (workarea, export)
24057 \begin_layout Itemize
24058 \begin_inset Flex Code
24061 \begin_layout Plain Layout
24062 {%export%[[true]][[false]]}
24068 \begin_inset Quotes eld
24072 \begin_inset Quotes erd
24075 part for export and menus, the
24076 \begin_inset Quotes eld
24080 \begin_inset Quotes erd
24083 part for other contexts (workarea, dialog)
24086 \begin_layout Itemize
24087 \begin_inset Flex Code
24090 \begin_layout Plain Layout
24097 \begin_inset Quotes eld
24101 \begin_inset Quotes erd
24104 part if another item follows (e.
24105 \begin_inset space \thinspace{}
24108 g., in a citation with multiple keys)
24111 \begin_layout Itemize
24112 \begin_inset Flex Code
24115 \begin_layout Plain Layout
24116 {%second%[[true]][[false]]}
24122 \begin_inset Quotes eld
24126 \begin_inset Quotes erd
24129 if this is the second of multiple items, else the
24130 \begin_inset Quotes eld
24134 \begin_inset Quotes erd
24140 \begin_layout Itemize
24141 \begin_inset Flex Code
24144 \begin_layout Plain Layout
24145 {%ifstar%[[true]][[false]]}
24151 \begin_inset Quotes eld
24155 \begin_inset Quotes erd
24158 part for starred citation commands (such as
24159 \begin_inset Flex Code
24162 \begin_layout Plain Layout
24170 ), the false part for unstarred
24173 \begin_layout Itemize
24174 \begin_inset Flex Code
24177 \begin_layout Plain Layout
24178 {%ifentrytype:<type>%[[true]][[false]]}
24184 \begin_inset Quotes eld
24188 \begin_inset Quotes erd
24191 if the current entry type matches
24192 \begin_inset Flex Code
24195 \begin_layout Plain Layout
24201 , else the false part (e.g., in a citation definition:
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24206 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24214 \begin_layout Itemize
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24219 {%ifmultiple:<authortype>%[[true]][[false]]}
24225 \begin_inset Quotes eld
24229 \begin_inset Quotes erd
24232 if the current author type (author, editor etc.) has multiple authors, else
24233 the false part (e.g., in a bibliography definition:
24234 \begin_inset Flex Code
24237 \begin_layout Plain Layout
24238 {%ifmultiple:editor%[[eds.]][[ed.]]}
24246 \begin_layout Itemize
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24251 {%ifqualified%[[true]][[false]]}
24257 \begin_inset Quotes eld
24261 \begin_inset Quotes erd
24264 part if the current citation is a qualified citation list (a specific
24268 format for multi-reference citations), the false part if this is not the
24272 \begin_layout Standard
24274 \begin_inset Flex Code
24277 \begin_layout Plain Layout
24283 prints the author key as it is recorded in the bibliography file.
24284 This might not be what you want, since it will result in a string such
24286 \begin_inset Quotes eld
24289 Miller, Peter and Smith, Mary and White, Jane
24290 \begin_inset Quotes erd
24294 \begin_inset Quotes eld
24298 \begin_inset Quotes erd
24301 is used by Bib\SpecialChar TeX
24302 to delimit authors).
24304 therefore provides some methods to get properly formatted name lists (which
24305 will also get translated).
24306 The following keys are provided:
24309 \begin_layout Enumerate
24310 For name lists with pre- and surname, suitable for the main authors/editors
24311 of a bibliography item.
24313 \begin_inset Flex Code
24316 \begin_layout Plain Layout
24322 part denotes the kind of list that is requested (e.g.
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24337 \begin_layout Itemize
24338 \begin_inset Flex Code
24341 \begin_layout Plain Layout
24342 %abbrvnames:<nametype>%
24347 : Provides a name list which is abbreviated (with
24348 \begin_inset Quotes eld
24352 \begin_inset Quotes erd
24356 \begin_inset Flex Code
24359 \begin_layout Plain Layout
24368 \begin_layout Itemize
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24373 %fullnames:<nametype>%
24378 : Provides a full name list (never abbreviated with
24379 \begin_inset Quotes eld
24383 \begin_inset Quotes erd
24389 \begin_layout Itemize
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24394 %forceabbrvnames:<nametype>%
24399 : Provides a name list which is always abbreviated (with
24400 \begin_inset Quotes eld
24404 \begin_inset Quotes erd
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24421 \begin_layout Enumerate
24422 Alternative name lists with pre- and surname, if the order of pre- and surname
24423 inside the bibliography item differs (as in:
24424 \begin_inset Quotes eld
24427 Miller, John: Some text, in: Mary Smith, ed.: A volume
24428 \begin_inset Quotes erd
24435 \begin_layout Itemize
24436 \begin_inset Flex Code
24439 \begin_layout Plain Layout
24440 %abbrvbynames:<nametype>%
24445 : Provides a name list which is abbreviated (with
24446 \begin_inset Quotes eld
24450 \begin_inset Quotes erd
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24466 \begin_layout Itemize
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24471 %fullbynames:<nametype>%
24476 : Provides a full name list (never abbreviated with
24477 \begin_inset Quotes eld
24481 \begin_inset Quotes erd
24487 \begin_layout Itemize
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24492 %forceabbrvbynames:<nametype>%
24497 : Provides a name list which is always abbreviated (with
24498 \begin_inset Quotes eld
24502 \begin_inset Quotes erd
24506 \begin_inset Flex Code
24509 \begin_layout Plain Layout
24519 \begin_layout Enumerate
24520 And finally name lists which consist of family names only, as used in author-yea
24522 These do not take a
24523 \begin_inset Flex Code
24526 \begin_layout Plain Layout
24532 part, but always return either an author list or, if this does not exist,
24533 an editor list (as common in author-year labels):
24537 \begin_layout Itemize
24538 \begin_inset Flex Code
24541 \begin_layout Plain Layout
24547 : Provides a name list which is abbreviated (with
24548 \begin_inset Quotes eld
24552 \begin_inset Quotes erd
24556 \begin_inset Flex Code
24559 \begin_layout Plain Layout
24568 \begin_layout Itemize
24569 \begin_inset Flex Code
24572 \begin_layout Plain Layout
24578 : Provides a full name list (never abbreviated with
24579 \begin_inset Quotes eld
24583 \begin_inset Quotes erd
24589 \begin_layout Itemize
24590 \begin_inset Flex Code
24593 \begin_layout Plain Layout
24594 %forceabbrvciteauthor%
24599 : Provides a name list which is always abbreviated (with
24600 \begin_inset Quotes eld
24604 \begin_inset Quotes erd
24608 \begin_inset Flex Code
24611 \begin_layout Plain Layout
24621 \begin_layout Standard
24622 The order of pre- and surname in the former two lists can be adjusted by
24626 \begin_layout Itemize
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24631 !firstnameform %surname%, %prename%
24636 (first author in lists of type 1)
24639 \begin_layout Itemize
24640 \begin_inset Flex Code
24643 \begin_layout Plain Layout
24644 !othernameform %surname%, %prename%
24649 (other authors in lists of type 1)
24652 \begin_layout Itemize
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24657 !firstbynameform %prename% %surname%
24662 (first author in lists of type 2)
24665 \begin_layout Itemize
24666 \begin_inset Flex Code
24669 \begin_layout Plain Layout
24670 !otherbynameform %prename% %surname%
24675 (other authors in lists of type 2)
24678 \begin_layout Standard
24679 This allows you to configure namings like
24680 \begin_inset Quotes eld
24683 Miller, Peter and Mary Smith: \SpecialChar ldots
24684 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24686 \begin_inset Quotes erd
24692 \begin_layout Standard
24693 There is one other piece of syntax available in definitions, which looks
24695 \begin_inset Flex Code
24698 \begin_layout Plain Layout
24705 This defines a piece of formatting information that is to be used when
24707 \begin_inset Quotes eld
24711 \begin_inset Quotes erd
24715 Obviously, we do not want to output HTML tags when writing plain text,
24716 so they should be wrapped in
24717 \begin_inset Quotes eld
24721 \begin_inset Quotes erd
24725 \begin_inset Quotes eld
24729 \begin_inset Quotes erd
24735 \begin_layout Standard
24736 Two special sorts of definitions are also possible in a
24737 \begin_inset Flex Code
24740 \begin_layout Plain Layout
24747 An example of the first would be:
24750 \begin_layout LyX-Code
24752 \begin_inset Quotes eld
24756 \begin_inset Quotes erd
24762 \begin_layout Standard
24763 This is an abbreviation, or macro, and it can be used by treating it as
24765 \begin_inset Flex Code
24768 \begin_layout Plain Layout
24777 \begin_inset Flex Code
24780 \begin_layout Plain Layout
24786 exactly as it would treat its definition.
24787 So, let us issue the obvious
24795 \begin_layout LyX-Code
24799 \begin_layout Standard
24800 or anything like it.
24802 shouldn't go into an infinite loop, but it may go into a long one before
24806 \begin_layout Standard
24807 The second sort of special definition might look like this:
24810 \begin_layout LyX-Code
24814 \begin_layout Standard
24815 This defines a translatable piece of text, which allows relevant parts of
24816 the bibliography or citation to be translated.
24817 It can be included in a definition by treating it as a key:
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24828 Note that there are two different translation paths: All definitions starting
24830 \begin_inset Flex Code
24833 \begin_layout Plain Layout
24839 , such as in the example above, will be translated to the currently active
24840 buffer language (so the translation will match the generated document).
24841 All definitions starting with underscore only will be translated to the
24843 This is the proper translation for strings that only occur in the dialogs
24844 or on buttons, such as this one:
24847 \begin_layout LyX-Code
24848 _addtobib Add to bibliography only.
24851 \begin_layout Standard
24852 Several of these translatable strings are predefined in
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24863 \begin_inset Flex Code
24866 \begin_layout Plain Layout
24873 Note that these are not macros, in the sense just defined.
24874 They will not be expanded.
24877 \begin_layout Standard
24878 So here then is an example that uses several of these features:
24879 \begin_inset VSpace defskip
24885 \begin_layout Standard
24889 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24892 \begin_layout Standard
24893 \begin_inset VSpace defskip
24896 This defines a macro that prints the author, followed by a comma, if the
24898 \begin_inset Flex Code
24901 \begin_layout Plain Layout
24907 key is defined, or else prints the name of the editor, followed by the
24909 \begin_inset Flex Code
24912 \begin_layout Plain Layout
24918 or its translation (it is by default
24919 \begin_inset Quotes eld
24923 \begin_inset Quotes erd
24927 \begin_inset Flex Code
24930 \begin_layout Plain Layout
24937 Note that this is in fact defined in
24938 \begin_inset Flex Code
24941 \begin_layout Plain Layout
24947 , so you can use it in your own definitions, or re-definitions, if you load
24951 \begin_layout Section
24952 \begin_inset CommandInset label
24954 name "sec:Tags-for-XHTML"
24958 Tags for XHTML output
24961 \begin_layout Standard
24962 As with \SpecialChar LaTeX
24963 or DocBook, the format of \SpecialChar LyX
24964 's XHTML output is also controlled by
24965 layout information.
24966 In general, \SpecialChar LyX
24967 provides sensible defaults and, as mentioned earlier, it will
24968 even construct default CSS style rules from the other layout tags.
24969 For example, \SpecialChar LyX
24970 will attempt to use the information provided in the
24971 \begin_inset Flex Code
24974 \begin_layout Plain Layout
24980 declaration for the Chapter style to write CSS that will appropriately
24981 format chapter headings.
24984 \begin_layout Standard
24985 In many cases, then, you may not have to do anything at all to get acceptable
24986 XHTML output for your own environments, custom insets, and so forth.
24987 But in some cases you will, and so \SpecialChar LyX
24988 provides a number of layout tags that
24989 can be used to customize the XHTML and CSS that are generated.
24992 \begin_layout Standard
24993 Note that there are two tags,
24994 \begin_inset Flex Code
24997 \begin_layout Plain Layout
25004 \begin_inset Flex Code
25007 \begin_layout Plain Layout
25013 that may appear outside style and inset declarations.
25015 \begin_inset CommandInset ref
25017 reference "subsec:General-text-class"
25021 for details on these.
25024 \begin_layout Subsection
25025 \begin_inset CommandInset label
25027 name "subsec:Paragraph-Style-XHTML"
25034 \begin_layout Standard
25035 The sort of XHTML \SpecialChar LyX
25036 outputs for a paragraph depends upon whether we are dealing
25037 with a normal paragraph, a command, or an environment, where this is itself
25038 determined by the contents of the corresponding
25039 \begin_inset Flex Code
25042 \begin_layout Plain Layout
25053 \begin_layout Standard
25054 For a command or normal paragraph, the output XHTML has the following form:
25057 \begin_layout LyX-Code
25061 \begin_inset Quotes erd
25065 \begin_inset Quotes erd
25071 \begin_layout LyX-Code
25075 \begin_inset Quotes erd
25079 \begin_inset Quotes erd
25085 \begin_layout LyX-Code
25088 Contents of the paragraph.
25091 \begin_layout LyX-Code
25097 \begin_layout Standard
25098 The label tags are of course omitted if the paragraph does not have a label.
25101 \begin_layout Standard
25102 For an environment that is not some sort of list, the XHTML takes this form:
25105 \begin_layout LyX-Code
25109 \begin_inset Quotes erd
25113 \begin_inset Quotes erd
25119 \begin_layout LyX-Code
25123 \begin_inset Quotes erd
25127 \begin_inset Quotes erd
25131 \begin_inset Quotes erd
25135 \begin_inset Quotes erd
25138 >Environment Label</labeltag>First paragraph.</itemtag>
25141 \begin_layout LyX-Code
25144 <itemtag>Second paragraph.</itemtag>
25147 \begin_layout LyX-Code
25153 \begin_layout Standard
25154 Note that the label is output only for the first paragraph, as it should
25155 be for a theorem, for example.
25159 \begin_layout Standard
25160 For a list, we have one of these forms:
25163 \begin_layout LyX-Code
25167 \begin_inset Quotes erd
25171 \begin_inset Quotes erd
25177 \begin_layout LyX-Code
25181 \begin_inset Quotes erd
25185 \begin_inset Quotes erd
25189 \begin_inset Quotes erd
25193 \begin_inset Quotes erd
25196 >List Label</labeltag>First item.</itemtag>
25199 \begin_layout LyX-Code
25203 \begin_inset Quotes erd
25207 \begin_inset Quotes erd
25211 \begin_inset Quotes erd
25215 \begin_inset Quotes erd
25218 >List Label</labeltag>Second item.</itemtag>
25221 \begin_layout LyX-Code
25227 \begin_layout LyX-Code
25231 \begin_layout LyX-Code
25235 \begin_inset Quotes erd
25239 \begin_inset Quotes erd
25245 \begin_layout LyX-Code
25249 \begin_inset Quotes erd
25253 \begin_inset Quotes erd
25256 >List Label</labeltag><itemtag attr=
25257 \begin_inset Quotes erd
25261 \begin_inset Quotes erd
25264 >First item.</itemtag>
25267 \begin_layout LyX-Code
25271 \begin_inset Quotes erd
25275 \begin_inset Quotes erd
25278 >List Label</labeltag><itemtag attr=
25279 \begin_inset Quotes erd
25283 \begin_inset Quotes erd
25286 >Second item.</itemtag>
25289 \begin_layout LyX-Code
25295 \begin_layout Standard
25296 Note the different orders of
25297 \begin_inset Flex Code
25300 \begin_layout Plain Layout
25307 \begin_inset Flex Code
25310 \begin_layout Plain Layout
25317 Which order we get depends upon the setting of
25318 \begin_inset Flex Code
25321 \begin_layout Plain Layout
25328 \begin_inset Flex Code
25331 \begin_layout Plain Layout
25337 is false (the default), you get the first of these, with the label within
25338 the item; if true, you get the second, with the label outside the item.
25341 \begin_layout Standard
25342 The specific tags and attributes output for each paragraph type can be controlle
25343 d by means of the layout tags we are about to describe.
25344 As mentioned earlier, however, \SpecialChar LyX
25345 uses sensible defaults for many of these,
25346 so you often may not need to do very much to get good XHTML output.
25347 Think of the available tags as there so you can tweak things to your liking.
25350 \begin_layout Description
25351 \begin_inset Flex Code
25354 \begin_layout Plain Layout
25361 \begin_inset Flex Code
25364 \begin_layout Plain Layout
25370 ] Specifies attribute information to be output with the main tag.
25372 \begin_inset Quotes eld
25376 \begin_inset Flex Code
25379 \begin_layout Plain Layout
25386 \begin_inset Quotes erd
25390 By default, \SpecialChar LyX
25392 \begin_inset Quotes eld
25396 \begin_inset Flex Code
25399 \begin_layout Plain Layout
25406 \begin_inset Quotes erd
25410 \begin_inset Flex Code
25413 \begin_layout Plain Layout
25419 is the \SpecialChar LyX
25420 name of the layout, made lowercase, for example: chapter.
25425 contain any style information.
25427 \begin_inset Flex Code
25430 \begin_layout Plain Layout
25439 \begin_layout Description
25440 \begin_inset Flex Code
25443 \begin_layout Plain Layout
25450 \begin_inset Flex Code
25453 \begin_layout Plain Layout
25463 ] Whether to output the default CSS information \SpecialChar LyX
25464 generates for this layout,
25465 even if additional information is explicitly provided via
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25477 \begin_inset Flex Code
25480 \begin_layout Plain Layout
25486 allows you to alter or augment the generated CSS, rather than to override
25489 \begin_inset Flex Code
25492 \begin_layout Plain Layout
25501 \begin_layout Description
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25512 \begin_inset Flex Code
25515 \begin_layout Plain Layout
25521 ] The tag to be used for individual paragraphs of environments, replacing
25523 \begin_inset Flex Code
25526 \begin_layout Plain Layout
25532 in the examples above.
25534 \begin_inset Flex Code
25537 \begin_layout Plain Layout
25546 \begin_layout Description
25547 \begin_inset Flex Code
25550 \begin_layout Plain Layout
25557 \begin_inset Flex Code
25560 \begin_layout Plain Layout
25566 ] Attributes for the item tag.
25568 \begin_inset Newline newline
25572 \begin_inset Quotes eld
25576 \begin_inset Flex Code
25579 \begin_layout Plain Layout
25580 class=`layoutname_item'
25586 \begin_inset Quotes erd
25594 contain any style information.
25596 \begin_inset Flex Code
25599 \begin_layout Plain Layout
25608 \begin_layout Description
25609 \begin_inset Flex Code
25612 \begin_layout Plain Layout
25619 \begin_inset Flex Code
25622 \begin_layout Plain Layout
25628 ] The tag to be used for paragraph and item labels, replacing
25629 \begin_inset Flex Code
25632 \begin_layout Plain Layout
25638 in the examples above.
25640 \begin_inset Flex Code
25643 \begin_layout Plain Layout
25650 \begin_inset Flex Code
25653 \begin_layout Plain Layout
25660 \begin_inset Flex Code
25663 \begin_layout Plain Layout
25670 \begin_inset Flex Code
25673 \begin_layout Plain Layout
25674 Centered_Top_Environment
25679 , in which case it defaults to
25680 \begin_inset Flex Code
25683 \begin_layout Plain Layout
25692 \begin_layout Description
25693 \begin_inset Flex Code
25696 \begin_layout Plain Layout
25703 \begin_inset Flex Code
25706 \begin_layout Plain Layout
25712 ] Attributes for the label tag.
25714 \begin_inset Newline newline
25718 \begin_inset Quotes eld
25722 \begin_inset Flex Code
25725 \begin_layout Plain Layout
25726 class=`layoutname_label'
25732 \begin_inset Quotes erd
25740 contain any style information.
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25754 \begin_layout Description
25755 \begin_inset Flex Code
25758 \begin_layout Plain Layout
25765 \begin_inset Flex Code
25768 \begin_layout Plain Layout
25778 ] Meaningful only for list-like environments, this tag controls whether
25779 the label tag is output before or inside the item tag.
25780 This is used, for example, in the description environment, where we want
25782 \begin_inset Flex Code
25785 \begin_layout Plain Layout
25786 <dt>\SpecialChar ldots
25787 </dt><dd>\SpecialChar ldots
25795 \begin_inset Flex Code
25798 \begin_layout Plain Layout
25804 : The label tag is output inside the item tag.
25807 \begin_layout Description
25808 \begin_inset Flex Code
25811 \begin_layout Plain Layout
25817 Information to be output in the
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25827 section when this style is used.
25828 This might, for example, be used to include a
25829 \begin_inset Flex Code
25832 \begin_layout Plain Layout
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25851 \begin_layout Description
25852 \begin_inset Flex Code
25855 \begin_layout Plain Layout
25861 CSS style information to be included when this style is used.
25862 Note that this will automatically be wrapped in a layout-generated
25863 \begin_inset Flex Code
25866 \begin_layout Plain Layout
25872 block, so only the CSS itself need be included.
25874 \begin_inset Flex Code
25877 \begin_layout Plain Layout
25886 \begin_layout Description
25887 \begin_inset Flex Code
25890 \begin_layout Plain Layout
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25906 ] The tag to be used for the main label, replacing
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25916 in the examples above.
25918 \begin_inset Flex Code
25921 \begin_layout Plain Layout
25930 \begin_layout Description
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25954 ] Marks this style as the one to be used to generate the
25955 \begin_inset Flex Code
25958 \begin_layout Plain Layout
25964 tag for the XHTML file.
25965 By default, it is false.
25967 \begin_inset Flex Code
25970 \begin_layout Plain Layout
25976 file sets it to true for the
25977 \begin_inset Flex Code
25980 \begin_layout Plain Layout
25990 \begin_layout Subsection
25994 \begin_layout Standard
25995 The XHTML output of insets can also be controlled by information in layout
26000 \begin_layout Plain Layout
26001 At present, this is true only for
26002 \begin_inset Quotes eld
26006 \begin_inset Quotes erd
26009 insets (insets you can type into) and is not true for
26010 \begin_inset Quotes eld
26014 \begin_inset Quotes erd
26017 insets (insets that are associated with dialog boxes).
26022 Here, too, \SpecialChar LyX
26023 tries to provide sensible defaults, and it constructs default
26025 But everything can be customized.
26028 \begin_layout Standard
26029 The XHTML \SpecialChar LyX
26030 outputs for an inset has the following form:
26033 \begin_layout LyX-Code
26035 \begin_inset Quotes erd
26039 \begin_inset Quotes erd
26045 \begin_layout LyX-Code
26046 <labeltag>Label</labeltag>
26049 \begin_layout LyX-Code
26051 \begin_inset Quotes erd
26055 \begin_inset Quotes erd
26058 >Contents of the inset.</innertag>
26061 \begin_layout LyX-Code
26065 \begin_layout Standard
26066 If the inset permits multiple paragraphs—that is, if
26067 \begin_inset Flex Code
26070 \begin_layout Plain Layout
26076 is true—then the contents of the inset will itself be output as paragraphs
26077 formatted according to the styles used for those paragraphs (standard,
26078 quote, and the like).
26079 The label tag is of course omitted if the paragraph does not have a label
26080 and, at present, is always
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26091 The inner tag is optional and, by default, does not appear.
26094 \begin_layout Standard
26095 The specific tags and attributes output for each inset can be controlled
26096 by means of the following layout tags.
26099 \begin_layout Description
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26110 \begin_inset Flex Code
26113 \begin_layout Plain Layout
26119 ] Specifies attribute information to be output with the main tag.
26121 \begin_inset Quotes eld
26125 \begin_inset Flex Code
26128 \begin_layout Plain Layout
26129 class=`myinset' onclick=`\SpecialChar ldots
26136 \begin_inset Quotes erd
26140 By default, \SpecialChar LyX
26142 \begin_inset Quotes eld
26146 \begin_inset Flex Code
26149 \begin_layout Plain Layout
26156 \begin_inset Quotes erd
26160 \begin_inset Flex Code
26163 \begin_layout Plain Layout
26169 is the \SpecialChar LyX
26170 name of the inset, made lowercase and with non-alphanumeric characters
26171 converted to underscores, for example: footnote.
26174 \begin_layout Description
26175 \begin_inset Flex Code
26178 \begin_layout Plain Layout
26185 \begin_inset Flex Code
26188 \begin_layout Plain Layout
26198 ] Whether to output the default CSS information \SpecialChar LyX
26199 generates for this layout,
26200 even if additional information is explicitly provided via
26201 \begin_inset Flex Code
26204 \begin_layout Plain Layout
26212 \begin_inset Flex Code
26215 \begin_layout Plain Layout
26221 allows you to alter or augment the generated CSS, rather than to override
26226 \begin_layout Description
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26237 \begin_inset Flex Code
26240 \begin_layout Plain Layout
26246 ] Attributes for the inner tag.
26248 \begin_inset Newline newline
26252 \begin_inset Quotes eld
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26260 class=`insetname_inner'
26266 \begin_inset Quotes erd
26272 \begin_layout Description
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26283 \begin_inset Flex Code
26286 \begin_layout Plain Layout
26292 ] The inner tag, replacing
26293 \begin_inset Flex Code
26296 \begin_layout Plain Layout
26302 in the examples above.
26303 By default, there is none.
26306 \begin_layout Description
26307 \begin_inset Flex Code
26310 \begin_layout Plain Layout
26317 \begin_inset Flex Code
26320 \begin_layout Plain Layout
26328 ] Whether this inset represents a standalone block of text (such as a footnote)
26329 or instead represents material that is included in the surrounding text
26330 (such as a branch).
26334 \begin_layout Description
26335 \begin_inset Flex Code
26338 \begin_layout Plain Layout
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26354 ] A label for this inset, possibly including a reference to a counter.
26355 For example, for footnote, it might be:
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26368 This is optional, and there is no default.
26371 \begin_layout Description
26372 \begin_inset Flex Code
26375 \begin_layout Plain Layout
26381 Information to be output in the
26382 \begin_inset Flex Code
26385 \begin_layout Plain Layout
26391 section when this style is used.
26392 This might, for example, be used to include a
26393 \begin_inset Flex Code
26396 \begin_layout Plain Layout
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26415 \begin_layout Description
26416 \begin_inset Flex Code
26419 \begin_layout Plain Layout
26425 CSS style information to be included when this style is used.
26426 Note that this will automatically be wrapped in a layout-generated
26427 \begin_inset Flex Code
26430 \begin_layout Plain Layout
26436 block, so only the CSS itself need be included.
26439 \begin_layout Description
26440 \begin_inset Flex Code
26443 \begin_layout Plain Layout
26450 \begin_inset Flex Code
26453 \begin_layout Plain Layout
26459 ] The tag to be used for the main label, replacing
26460 \begin_inset Flex Code
26463 \begin_layout Plain Layout
26469 in the examples above.
26470 The default depends upon the setting of
26471 \begin_inset Flex Code
26474 \begin_layout Plain Layout
26481 \begin_inset Flex Code
26484 \begin_layout Plain Layout
26490 is true, the default is
26491 \begin_inset Flex Code
26494 \begin_layout Plain Layout
26500 ; if it is false, the default is
26501 \begin_inset Flex Code
26504 \begin_layout Plain Layout
26513 \begin_layout Subsection
26517 \begin_layout Standard
26518 The XHTML output for floats too can be controlled by layout information.
26519 The output has the following form:
26522 \begin_layout LyX-Code
26524 \begin_inset Quotes erd
26528 \begin_inset Quotes erd
26534 \begin_layout LyX-Code
26535 Contents of the float.
26538 \begin_layout LyX-Code
26542 \begin_layout Standard
26543 The caption, if there is one, is a separate inset and will be output as
26545 Its appearance can be controlled via the InsetLayout for caption insets.
26549 \begin_layout Description
26550 \begin_inset Flex Code
26553 \begin_layout Plain Layout
26560 \begin_inset Flex Code
26563 \begin_layout Plain Layout
26569 ] Specifies attribute information to be output with the main tag.
26571 \begin_inset Quotes eld
26575 \begin_inset Flex Code
26578 \begin_layout Plain Layout
26579 class=`myfloat' onclick=`\SpecialChar ldots
26586 \begin_inset Quotes erd
26590 By default, \SpecialChar LyX
26592 \begin_inset Quotes eld
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26600 class=`float float-floattype'
26606 \begin_inset Quotes erd
26610 \begin_inset Flex Code
26613 \begin_layout Plain Layout
26619 is \SpecialChar LyX
26620 's name for this type of float, as determined by the float declaration
26622 \begin_inset CommandInset ref
26624 reference "subsec:Floats"
26628 ), though made lowercase and with non-alphanumeric characters converted
26629 to underscores, for example: float-table.
26632 \begin_layout Description
26633 \begin_inset Flex Code
26636 \begin_layout Plain Layout
26642 CSS style information to be included when this float is used.
26643 Note that this will automatically be wrapped in a layout-generated
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26653 block, so only the CSS itself need be included.
26656 \begin_layout Description
26657 \begin_inset Flex Code
26660 \begin_layout Plain Layout
26667 \begin_inset Flex Code
26670 \begin_layout Plain Layout
26676 ] The tag to be used for this float, replacing
26677 \begin_inset Quotes eld
26681 \begin_inset Flex Code
26684 \begin_layout Plain Layout
26691 \begin_inset Quotes erd
26694 in the example above.
26696 \begin_inset Flex Code
26699 \begin_layout Plain Layout
26705 and will rarely need changing.
26708 \begin_layout Subsection
26709 Bibliography formatting
26712 \begin_layout Standard
26713 The bibliography can be formatted using
26714 \begin_inset Flex Code
26717 \begin_layout Plain Layout
26725 \begin_inset CommandInset ref
26727 reference "subsec:Citation-format-description"
26734 \begin_layout Subsection
26739 \begin_layout Standard
26740 We have several times mentioned that \SpecialChar LyX
26741 will generate default CSS style rules
26742 for both insets and paragraph styles, based upon the other layout information
26744 In this section, we shall say a word about which layout information \SpecialChar LyX
26749 \begin_layout Standard
26750 At present, \SpecialChar LyX
26751 auto-generates CSS only for font information, making use of
26753 \begin_inset Flex Code
26756 \begin_layout Plain Layout
26763 \begin_inset Flex Code
26766 \begin_layout Plain Layout
26773 \begin_inset Flex Code
26776 \begin_layout Plain Layout
26783 \begin_inset Flex Code
26786 \begin_layout Plain Layout
26793 \begin_inset Flex Code
26796 \begin_layout Plain Layout
26803 \begin_inset CommandInset ref
26805 reference "subsec:Font-description"
26810 The translation is mostly straightforward and obvious.
26812 \begin_inset Quotes eld
26816 \begin_inset Flex Code
26819 \begin_layout Plain Layout
26826 \begin_inset Quotes erd
26830 \begin_inset Quotes eld
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26838 font-family: sans-serif;
26844 \begin_inset Quotes erd
26848 The correspondence of \SpecialChar LyX
26849 sizes and CSS sizes is a little less obvious but
26850 nonetheless intuitive.
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26862 \begin_inset Flex URL
26865 \begin_layout Plain Layout
26873 \change_inserted -970929547 1496610908
26877 \begin_layout Section
26879 \change_inserted -970929547 1496610966
26880 \begin_inset CommandInset label
26882 name "sec:Tags-for-DocBook"
26886 Tags for DocBook output
26889 \begin_layout Standard
26891 \change_inserted -970929547 1496611615
26892 As with \SpecialChar LaTeX
26893 or XHTML, the format of \SpecialChar LyX
26894 's DocBook output is also controlled by
26895 layout information.
26896 In general, \SpecialChar LyX
26897 provides sensible defaults; however, much of the styling is
26898 lost during the conversion, as DocBook is strictly semantic and does not
26900 When possible, information from \SpecialChar LyX
26901 will be rendered in
26909 \begin_layout Standard
26911 \change_inserted -970929547 1496612080
26912 In many cases, then, you may not have to do anything at all to get acceptable
26913 DocBook output for your own environments, custom insets, and so forth.
26914 But in some cases you will, and so \SpecialChar LyX
26915 provides a number of layout tags that
26916 can be used to customize the DocBook that is generated.
26919 \begin_layout Standard
26921 \change_inserted -970929547 1515109912
26922 Labels are rarely output, as they are redundant in DocBook: this information
26923 is carried by the tags themselves, and whether labels appear in the final
26924 documents (after processing of DocBook files) is controlled by the stylesheets.
26925 However, sometimes, labels are not redundant content, such as definition
26926 lists: in this case, the term being defined will be the label.
26930 \begin_layout Subsection
26932 \change_inserted -970929547 1496610966
26933 \begin_inset CommandInset label
26935 name "subsec:Paragraph-Style-XHTML-1"
26942 \begin_layout Standard
26944 \change_inserted -970929547 1496612059
26945 The sort of DocBook \SpecialChar LyX
26946 outputs for a paragraph depends upon whether we are
26947 dealing with a normal paragraph, a command, or an environment, where this
26948 is itself determined by the contents of the corresponding
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26954 \change_inserted -970929547 1496610966
26965 \begin_layout Standard
26967 \change_inserted -970929547 1496612107
26968 For a command or normal paragraph, the output DocBook has the following
26972 \begin_layout LyX-Code
26974 \change_inserted -970929547 1515109666
26978 \begin_layout LyX-Code
26980 \change_inserted -970929547 1496610966
26981 Contents of the paragraph.
26984 \begin_layout LyX-Code
26986 \change_inserted -970929547 1496610966
26990 \begin_layout Standard
26992 \change_inserted -970929547 1515109821
26993 For an environment that is not some sort of list, the generated DocBook
26997 \begin_layout LyX-Code
26999 \change_inserted -970929547 1515109671
27003 \begin_layout LyX-Code
27005 \change_inserted -970929547 1496612114
27006 <itemtag>First paragraph.</itemtag>
27009 \begin_layout LyX-Code
27011 \change_inserted -970929547 1496610966
27012 <itemtag>Second paragraph.</itemtag>
27015 \begin_layout LyX-Code
27017 \change_inserted -970929547 1496610966
27021 \begin_layout Standard
27023 \change_inserted -970929547 1515109825
27024 For a list, the resulting DocBook takes this form:
27027 \begin_layout LyX-Code
27029 \change_inserted -970929547 1515109672
27033 \begin_layout LyX-Code
27035 \change_inserted -970929547 1515109676
27036 <itemtag attr>First item.</itemtag>
27039 \begin_layout LyX-Code
27041 \change_inserted -970929547 1515109678
27042 <itemtag attr>Second item.</itemtag>
27045 \begin_layout LyX-Code
27047 \change_inserted -970929547 1496610966
27051 \begin_layout Standard
27053 \change_inserted -970929547 1496612243
27054 The specific tags and roles output for each paragraph type can be controlled
27055 by means of the layout tags we are about to describe.
27056 Please note that, due to the very nature of DocBook, no sensible defaults
27057 really exist, and the values must always be carefully chosen.
27061 \begin_layout Description
27063 \change_inserted -970929547 1515110057
27064 \begin_inset Flex Code
27067 \begin_layout Plain Layout
27069 \change_inserted -970929547 1515109656
27076 \begin_inset Flex Code
27079 \begin_layout Plain Layout
27081 \change_inserted -970929547 1496610966
27087 ] Specifies attribute information to be output with the main tag, replacing
27089 \begin_inset Quotes eld
27093 \begin_inset Flex Code
27096 \begin_layout Plain Layout
27098 \change_inserted -970929547 1515110057
27105 \begin_inset Quotes erd
27108 in the example above.
27109 This information can be used in further processing of the DocBook files.
27115 \begin_layout Description
27117 \change_inserted -970929547 1496612296
27118 \begin_inset Flex Code
27121 \begin_layout Plain Layout
27123 \change_inserted -970929547 1496612269
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27135 \change_inserted -970929547 1496610966
27141 ] The tag to be used for this inset, replacing
27142 \begin_inset Quotes eld
27146 \begin_inset Flex Code
27149 \begin_layout Plain Layout
27151 \change_inserted -970929547 1496612296
27158 \begin_inset Quotes erd
27161 in the example above.
27162 The default is the name of the float and always needs to be changed, as
27163 DocBook provides no generic tag.
27168 \begin_layout Subsection
27170 \change_inserted -970929547 1515111533
27171 InsetLayout DocBook
27176 \begin_layout Standard
27178 \change_inserted -970929547 1496611894
27179 The DocBook output of insets can also be controlled by information in layout
27183 \begin_layout Standard
27185 \change_inserted -970929547 1496612045
27186 The DocBook \SpecialChar LyX
27187 outputs for an inset has the following form:
27190 \begin_layout LyX-Code
27192 \change_inserted -970929547 1515110861
27193 <wrappertag wrapperattr>
27196 \begin_layout LyX-Code
27198 \change_inserted -970929547 1515110868
27202 \begin_layout LyX-Code
27204 \change_inserted -970929547 1515110869
27205 <innertag innerattr>
27208 \begin_layout LyX-Code
27210 \change_inserted -970929547 1515110869
27211 Contents of the inset.
27214 \begin_layout LyX-Code
27216 \change_inserted -970929547 1515110870
27220 \begin_layout LyX-Code
27222 \change_inserted -970929547 1515110871
27226 \begin_layout LyX-Code
27228 \change_inserted -970929547 1515111172
27232 \begin_layout Standard
27234 \change_inserted -970929547 1515111186
27235 For an itemising inset, it rather looks like this:
27238 \begin_layout LyX-Code
27240 \change_inserted -970929547 1515111186
27241 <wrappertag wrapperattr>
27244 \begin_layout LyX-Code
27246 \change_inserted -970929547 1515111186
27250 \begin_layout LyX-Code
27252 \change_inserted -970929547 1515111186
27253 <innertag innerattr>
27256 \begin_layout LyX-Code
27258 \change_inserted -970929547 1515111362
27259 <itemwrappertag itemwrapperattr>
27262 \begin_layout LyX-Code
27264 \change_inserted -970929547 1515111364
27265 <itemlabeltag itemattr>
27268 \begin_layout LyX-Code
27270 \change_inserted -970929547 1515111367
27271 Label of the first item.
27274 \begin_layout LyX-Code
27276 \change_inserted -970929547 1515111362
27282 \begin_layout LyX-Code
27284 \change_inserted -970929547 1515111517
27288 \begin_layout LyX-Code
27290 \change_inserted -970929547 1515111517
27296 \begin_layout LyX-Code
27298 \change_inserted -970929547 1515111516
27299 Contents of the first item.
27302 \begin_layout LyX-Code
27304 \change_inserted -970929547 1515111514
27310 \begin_layout LyX-Code
27312 \change_inserted -970929547 1515111247
27318 \begin_layout LyX-Code
27320 \change_inserted -970929547 1515111221
27324 \begin_layout LyX-Code
27326 \change_inserted -970929547 1515111370
27327 <itemwrappertag itemwrapperattr>
27330 \begin_layout LyX-Code
27332 \change_inserted -970929547 1515111370
27333 <itemlabeltag itemattr>
27336 \begin_layout LyX-Code
27338 \change_inserted -970929547 1515111372
27339 Label of the second item.
27342 \begin_layout LyX-Code
27344 \change_inserted -970929547 1515111370
27350 \begin_layout LyX-Code
27352 \change_inserted -970929547 1515111504
27356 \begin_layout LyX-Code
27358 \change_inserted -970929547 1515111505
27364 \begin_layout LyX-Code
27366 \change_inserted -970929547 1515111507
27367 Contents of the second item.
27370 \begin_layout LyX-Code
27372 \change_inserted -970929547 1515111509
27378 \begin_layout LyX-Code
27380 \change_inserted -970929547 1515111251
27386 \begin_layout LyX-Code
27388 \change_inserted -970929547 1515111221
27394 \begin_layout LyX-Code
27396 \change_inserted -970929547 1515111219
27402 \begin_layout LyX-Code
27404 \change_inserted -970929547 1515111186
27408 \begin_layout LyX-Code
27410 \change_inserted -970929547 1515111186
27414 \begin_layout LyX-Code
27416 \change_inserted -970929547 1515111186
27420 \begin_layout Standard
27422 \change_inserted -970929547 1515111183
27423 If the inset permits multiple paragraphs—that is, if
27424 \begin_inset Flex Code
27427 \begin_layout Plain Layout
27429 \change_inserted -970929547 1496610966
27435 is true—then the contents of the inset will itself be output as paragraphs
27436 formatted according to the styles used for those paragraphs (standard,
27437 quote, and the like).
27438 The inner tag is optional and, by default, does not appear.
27441 \begin_layout Standard
27443 \change_inserted -970929547 1496610966
27444 The specific tags and attributes output for each inset can be controlled
27445 by means of the following layout tags.
27448 \begin_layout Description
27450 \change_inserted -970929547 1515110317
27451 \begin_inset Flex Code
27454 \begin_layout Plain Layout
27456 \change_inserted -970929547 1515109695
27463 \begin_inset Flex Code
27466 \begin_layout Plain Layout
27468 \change_inserted -970929547 1496611854
27474 ] Specifies attribute information to be output with the main tag, replacing
27476 \begin_inset Quotes eld
27480 \begin_inset Flex Code
27483 \begin_layout Plain Layout
27485 \change_inserted -970929547 1515110044
27492 \begin_inset Quotes erd
27495 in the example above.
27496 This information can be used in further processing of the DocBook files.
27500 \begin_layout Description
27502 \change_inserted -970929547 1515110973
27503 \begin_inset Flex Code
27506 \begin_layout Plain Layout
27508 \change_inserted -970929547 1515110319
27515 \begin_inset Flex Code
27518 \begin_layout Plain Layout
27520 \change_inserted -970929547 1515110384
27521 never, always, maybe
27526 ] Specifies whether this tag goes into the
27527 \begin_inset Flex Code
27530 \begin_layout Plain Layout
27532 \change_inserted -970929547 1515110412
27538 tag at the beginning of the parent layout.
27540 \begin_inset Flex Code
27543 \begin_layout Plain Layout
27545 \change_inserted -970929547 1515110437
27551 indicates that the tag never goes into
27552 \begin_inset Flex Code
27555 \begin_layout Plain Layout
27557 \change_inserted -970929547 1515110497
27563 (this is default value, and corresponds to usual content).
27565 \begin_inset Flex Code
27568 \begin_layout Plain Layout
27570 \change_inserted -970929547 1515110517
27576 indicates that the tag always goes into
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27582 \change_inserted -970929547 1515110514
27588 (this corresponds to usual metadata): if there is no
27589 \begin_inset Flex Code
27592 \begin_layout Plain Layout
27594 \change_inserted -970929547 1515110550
27600 tag for the parent, one
27606 \begin_inset Flex Code
27609 \begin_layout Plain Layout
27611 \change_inserted -970929547 1515110540
27617 indicates that the tag may go into
27618 \begin_inset Flex Code
27621 \begin_layout Plain Layout
27623 \change_inserted -970929547 1515110538
27629 (this is only the case for titles): if there is no
27630 \begin_inset Flex Code
27633 \begin_layout Plain Layout
27635 \change_inserted -970929547 1515110585
27641 tag for the parent,
27645 will be generated, the corresponding tag will be output directly as content.
27649 \begin_layout Description
27651 \change_inserted -970929547 1515111461
27652 \begin_inset Flex Code
27655 \begin_layout Plain Layout
27657 \change_inserted -970929547 1515110974
27664 \begin_inset Flex Code
27667 \begin_layout Plain Layout
27669 \change_inserted -970929547 1515110973
27675 ] Specifies attribute information to be output with the item tag, replacing
27677 \begin_inset Quotes eld
27681 \begin_inset Flex Code
27684 \begin_layout Plain Layout
27686 \change_inserted -970929547 1515110984
27693 \begin_inset Quotes erd
27696 in the example above.
27697 This information can be used in further processing of the DocBook files.
27701 \begin_layout Description
27703 \change_inserted -970929547 1515111471
27704 \begin_inset Flex Code
27707 \begin_layout Plain Layout
27709 \change_inserted -970929547 1515111465
27710 DocBookItemInnerAttr
27716 \begin_inset Flex Code
27719 \begin_layout Plain Layout
27721 \change_inserted -970929547 1515111461
27727 ] Specifies attribute information to be output with the item inner tag,
27729 \begin_inset Quotes eld
27733 \begin_inset Flex Code
27736 \begin_layout Plain Layout
27738 \change_inserted -970929547 1515111476
27745 \begin_inset Quotes erd
27748 in the example above.
27749 This information can be used in further processing of the DocBook files.
27753 \begin_layout Description
27755 \change_inserted -970929547 1515111494
27756 \begin_inset Flex Code
27759 \begin_layout Plain Layout
27761 \change_inserted -970929547 1515111467
27762 DocBookItemInnerTag
27768 \begin_inset Flex Code
27771 \begin_layout Plain Layout
27773 \change_inserted -970929547 1515111461
27779 ] The tag to be used for the item inner tag within the inset, replacing
27781 \begin_inset Quotes eld
27785 \begin_inset Flex Code
27788 \begin_layout Plain Layout
27790 \change_inserted -970929547 1515111486
27797 \begin_inset Quotes erd
27800 in the example above.
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27807 \change_inserted -970929547 1515111461
27813 , indicating that there is no item inner tag: content is directly output
27814 without it for each itemised element.
27815 This parameter only makes sense when itemising layouts are used, such as
27822 \begin_layout Description
27824 \change_inserted -970929547 1515111290
27825 \begin_inset Flex Code
27828 \begin_layout Plain Layout
27830 \change_inserted -970929547 1515111283
27831 DocBookItemLabelAttr
27837 \begin_inset Flex Code
27840 \begin_layout Plain Layout
27842 \change_inserted -970929547 1515111279
27848 ] Specifies attribute information to be output with the item label tag,
27850 \begin_inset Quotes eld
27854 \begin_inset Flex Code
27857 \begin_layout Plain Layout
27859 \change_inserted -970929547 1515111304
27866 \begin_inset Quotes erd
27869 in the example above.
27870 This information can be used in further processing of the DocBook files.
27874 \begin_layout Description
27876 \change_inserted -970929547 1515111337
27877 \begin_inset Flex Code
27880 \begin_layout Plain Layout
27882 \change_inserted -970929547 1515111285
27883 DocBookItemLabelTag
27889 \begin_inset Flex Code
27892 \begin_layout Plain Layout
27894 \change_inserted -970929547 1515111279
27900 ] The tag to be used for the item label tag within the inset, replacing
27902 \begin_inset Quotes eld
27906 \begin_inset Flex Code
27909 \begin_layout Plain Layout
27911 \change_inserted -970929547 1515111311
27918 \begin_inset Quotes erd
27921 in the example above.
27922 This parameter only makes sense when itemising layouts are used with a
27923 notion of labels, such as definition lists.
27929 \begin_layout Description
27931 \change_inserted -970929547 1515111124
27932 \begin_inset Flex Code
27935 \begin_layout Plain Layout
27937 \change_inserted -970929547 1515111060
27944 \begin_inset Flex Code
27947 \begin_layout Plain Layout
27949 \change_inserted -970929547 1515111060
27955 ] The tag to be used for the item tag within the inset, replacing
27956 \begin_inset Quotes eld
27960 \begin_inset Flex Code
27963 \begin_layout Plain Layout
27965 \change_inserted -970929547 1515111060
27972 \begin_inset Quotes erd
27975 in the example above.
27977 \begin_inset Flex Code
27980 \begin_layout Plain Layout
27982 \change_inserted -970929547 1515111060
27988 , indicating that there is no item tag.
27989 This parameter only makes sense when itemising layouts are used, such as
27994 \begin_layout Description
27996 \change_inserted -970929547 1515111298
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28002 \change_inserted -970929547 1515111124
28003 DocBookItemWrapperAttr
28009 \begin_inset Flex Code
28012 \begin_layout Plain Layout
28014 \change_inserted -970929547 1515111124
28020 ] Specifies attribute information to be output with the item wrapper tag,
28022 \begin_inset Quotes eld
28026 \begin_inset Flex Code
28029 \begin_layout Plain Layout
28031 \change_inserted -970929547 1515111150
28038 \begin_inset Quotes erd
28041 in the example above.
28042 This information can be used in further processing of the DocBook files.
28048 \begin_layout Description
28050 \change_inserted -970929547 1515111113
28051 \begin_inset Flex Code
28054 \begin_layout Plain Layout
28056 \change_inserted -970929547 1515111073
28057 DocBookItemWrapperTag
28063 \begin_inset Flex Code
28066 \begin_layout Plain Layout
28068 \change_inserted -970929547 1515111073
28074 ] The tag to be used for the item wrapper tag within the inset, replacing
28076 \begin_inset Quotes eld
28080 \begin_inset Flex Code
28083 \begin_layout Plain Layout
28085 \change_inserted -970929547 1515111083
28092 \begin_inset Quotes erd
28095 in the example above.
28097 \begin_inset Flex Code
28100 \begin_layout Plain Layout
28102 \change_inserted -970929547 1515111073
28108 , indicating that there is no item wrapper tag: tag and content are directly
28109 output without it for each itemised element.
28110 This parameter only makes sense when itemising layouts are used, such as
28117 \begin_layout Description
28119 \change_inserted -970929547 1515110104
28120 \begin_inset Flex Code
28123 \begin_layout Plain Layout
28125 \change_inserted -970929547 1515110104
28132 \begin_inset Flex Code
28135 \begin_layout Plain Layout
28137 \change_inserted -970929547 1515110104
28143 ] Specifies attribute information to be output with the inner tag, replacing
28145 \begin_inset Quotes eld
28149 \begin_inset Flex Code
28152 \begin_layout Plain Layout
28154 \change_inserted -970929547 1515110104
28161 \begin_inset Quotes erd
28164 in the example above.
28165 This information can be used in further processing of the DocBook files.
28169 \begin_layout Description
28171 \change_inserted -970929547 1515110906
28172 \begin_inset Flex Code
28175 \begin_layout Plain Layout
28177 \change_inserted -970929547 1515110104
28184 \begin_inset Flex Code
28187 \begin_layout Plain Layout
28189 \change_inserted -970929547 1515110104
28195 ] The tag to be used for the inner tag within the inset, replacing
28196 \begin_inset Quotes eld
28200 \begin_inset Flex Code
28203 \begin_layout Plain Layout
28205 \change_inserted -970929547 1515110104
28212 \begin_inset Quotes erd
28215 in the example above.
28217 \begin_inset Flex Code
28220 \begin_layout Plain Layout
28222 \change_inserted -970929547 1515110791
28228 , indicating that there is no inner tag: content is directly output without
28232 \begin_layout Description
28234 \change_inserted -970929547 1515110753
28235 \begin_inset Flex Code
28238 \begin_layout Plain Layout
28240 \change_inserted -970929547 1515110665
28247 \begin_inset Flex Code
28250 \begin_layout Plain Layout
28252 \change_inserted -970929547 1515110661
28258 ] Specifies the tag that corresponds to this kind of section.
28259 This parameter only makes sense for sectioning elements (part, chapter,
28261 The default value is
28262 \begin_inset Flex Code
28265 \begin_layout Plain Layout
28267 \change_inserted -970929547 1515110721
28273 , and is only overridden when DocBook uses something else for sectioning
28274 (parts and chapters of a book).
28280 \begin_layout Description
28282 \change_inserted -970929547 1515110811
28283 \begin_inset Flex Code
28286 \begin_layout Plain Layout
28288 \change_inserted -970929547 1496612023
28295 \begin_inset Flex Code
28298 \begin_layout Plain Layout
28300 \change_inserted -970929547 1496610966
28306 ] The tag to be used for this inset, replacing
28307 \begin_inset Quotes eld
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28316 \change_inserted -970929547 1496612033
28323 \begin_inset Quotes erd
28326 in the example above.
28327 The default is the name of the float and always needs to be changed, as
28328 DocBook provides no generic inset tag.
28331 \begin_layout Description
28333 \change_inserted -970929547 1515110832
28334 \begin_inset Flex Code
28337 \begin_layout Plain Layout
28339 \change_inserted -970929547 1515110822
28346 \begin_inset Flex Code
28349 \begin_layout Plain Layout
28351 \change_inserted -970929547 1515110811
28357 ] Specifies attribute information to be output with the outer tag, replacing
28359 \begin_inset Quotes eld
28363 \begin_inset Flex Code
28366 \begin_layout Plain Layout
28368 \change_inserted -970929547 1515110845
28375 \begin_inset Quotes erd
28378 in the example above.
28379 This information can be used in further processing of the DocBook files.
28383 \begin_layout Description
28385 \change_inserted -970929547 1515110917
28386 \begin_inset Flex Code
28389 \begin_layout Plain Layout
28391 \change_inserted -970929547 1515110826
28398 \begin_inset Flex Code
28401 \begin_layout Plain Layout
28403 \change_inserted -970929547 1515110811
28409 ] The tag to be used for the wrapper tag around the inset, replacing
28410 \begin_inset Quotes eld
28414 \begin_inset Flex Code
28417 \begin_layout Plain Layout
28419 \change_inserted -970929547 1515110842
28426 \begin_inset Quotes erd
28429 in the example above.
28431 \begin_inset Flex Code
28434 \begin_layout Plain Layout
28436 \change_inserted -970929547 1515110811
28442 , indicating that there is no wrapper tag: tag and content are directly
28444 \change_deleted -970929547 1515111523
28448 \begin_layout Subsection
28450 \change_inserted -970929547 1515110040
28454 \begin_layout Standard
28456 \change_inserted -970929547 1496611700
28457 The DocBook output for floats too can be controlled by layout information.
28458 The output has the following form:
28461 \begin_layout LyX-Code
28463 \change_inserted -970929547 1515109700
28467 \begin_layout LyX-Code
28469 \change_inserted -970929547 1515110138
28470 Contents of the float as DocBook.
28473 \begin_layout LyX-Code
28475 \change_inserted -970929547 1496610966
28479 \begin_layout Standard
28481 \change_inserted -970929547 1496611715
28482 The caption, if there is one, is a separate inset and will be output as
28487 \begin_layout Description
28489 \change_inserted -970929547 1515110033
28490 \begin_inset Flex Code
28493 \begin_layout Plain Layout
28495 \change_inserted -970929547 1515109702
28502 \begin_inset Flex Code
28505 \begin_layout Plain Layout
28507 \change_inserted -970929547 1496610966
28513 ] Specifies attribute information to be output with the main tag, replacing
28515 \begin_inset Quotes eld
28519 \begin_inset Flex Code
28522 \begin_layout Plain Layout
28524 \change_inserted -970929547 1515110035
28531 \begin_inset Quotes erd
28534 in the example above.
28535 This information can be used in further processing of the DocBook files.
28539 \begin_layout Description
28541 \change_inserted -970929547 1515110157
28542 \begin_inset Flex Code
28545 \begin_layout Plain Layout
28547 \change_inserted -970929547 1496611782
28554 \begin_inset Flex Code
28557 \begin_layout Plain Layout
28559 \change_inserted -970929547 1496610966
28565 ] The tag to be used for this float, replacing
28566 \begin_inset Quotes eld
28570 \begin_inset Flex Code
28573 \begin_layout Plain Layout
28575 \change_inserted -970929547 1496610966
28582 \begin_inset Quotes erd
28585 in the example above.
28586 The default is the name of the float and always needs to be changed, as
28587 DocBook provides no generic float tag.
28590 \begin_layout Subsection
28592 \change_inserted -970929547 1515110157
28593 Bibliography formatting
28596 \begin_layout Standard
28598 \change_inserted -970929547 1515110187
28599 The bibliography cannot be formatted: all fields are always output in the
28600 database-like DocBook format (equivalent to a BibTeX file).
28605 \begin_layout Chapter
28606 Including External Material
28607 \begin_inset CommandInset label
28609 name "chap:Including-External-Material"
28616 \begin_layout Standard
28617 \begin_inset Box Shadowbox
28627 height_special "totalheight"
28632 backgroundcolor "none"
28635 \begin_layout Plain Layout
28636 WARNING: This portion of the documentation has not been updated for some
28638 We certainly hope that it is still accurate, but there are no guarantees.
28646 \begin_layout Standard
28647 The use of material from sources external to \SpecialChar LyX
28648 is covered in detail in the
28654 This part of the manual covers what needs to happen behind the scenes for
28655 new sorts of material to be included.
28658 \begin_layout Section
28662 \begin_layout Standard
28663 The external material feature is based on the concept of a
28668 A template is a specification of how \SpecialChar LyX
28669 should interface with a certain kind
28671 As bundled, \SpecialChar LyX
28672 comes with predefined templates for Xfig figures, various
28673 raster format images, chess diagrams, and LilyPond music notation.
28674 You can check the actual list by using the menu
28675 \begin_inset Flex Noun
28678 \begin_layout Plain Layout
28679 Insert\SpecialChar menuseparator
28680 File\SpecialChar menuseparator
28687 Furthermore, it is possible to roll your own template to support a specific
28689 Later we'll describe in more detail what is involved, and hopefully you
28690 will submit all the templates you create so we can include them in a later
28695 \begin_layout Standard
28696 Another basic idea of the external material feature is to distinguish between
28697 the original file that serves as a base for final material and the produced
28698 file that is included in your exported or printed document.
28699 For example, consider the case of a figure produced with
28700 \begin_inset Flex Code
28703 \begin_layout Plain Layout
28710 The Xfig application itself works on an original file with the
28711 \begin_inset Flex Code
28714 \begin_layout Plain Layout
28721 Within Xfig, you create and change your figure, and when you are done,
28723 \begin_inset Flex Code
28726 \begin_layout Plain Layout
28733 When you want to include the figure in your document, you invoke
28734 \begin_inset Flex Code
28737 \begin_layout Plain Layout
28743 in order to create a PostScript file that can readily be included in your
28747 \begin_inset Flex Code
28750 \begin_layout Plain Layout
28756 file is the original file, and the PostScript file is the produced file.
28759 \begin_layout Standard
28760 This distinction is important in order to allow updating of the material
28761 while you are in the process of writing the document.
28762 Furthermore, it provides us with the flexibility that is needed to support
28763 multiple export formats.
28764 For instance, in the case of a plain text file, it is not exactly an award-winn
28765 ing idea to include the figure as raw PostScript.
28766 Instead, you would either prefer to just include a reference to the figure
28767 or try to invoke some graphics to ASCII converter to make the final result
28768 look similar to the real graphics.
28769 The external material management allows you to do this, because it is parametri
28770 zed on the different export formats that \SpecialChar LyX
28774 \begin_layout Standard
28775 Besides supporting the production of different products according to the
28776 exported format, it supports tight integration with editing and viewing
28778 In the case of an Xfig figure, you are able to invoke Xfig on the original
28779 file with a single click from within the external material dialog in \SpecialChar LyX
28781 and also preview the produced PostScript file with Ghostview with another
28783 No more fiddling around with the command line and/or file browsers to locate
28784 and manipulate the original or produced files.
28785 In this way, you are finally able to take full advantage of the many different
28786 applications that are relevant to use when you write your documents, and
28787 ultimately be more productive.
28790 \begin_layout Section
28791 The external template configuration files
28794 \begin_layout Standard
28795 It is relatively easy to add custom external template definitions to \SpecialChar LyX
28797 However, be aware that doing this in an careless manner most probably
28801 introduce an easily exploitable security hole.
28802 So before you do this, please read the discussion about security in
28803 \begin_inset CommandInset ref
28805 reference "sec:Security-discussion"
28812 \begin_layout Standard
28813 Having said that, we encourage you to submit any interesting templates that
28818 \begin_layout Standard
28819 The external templates are defined in the
28820 \begin_inset Flex Code
28823 \begin_layout Plain Layout
28829 files that are stored in the
28830 \begin_inset Flex Code
28833 \begin_layout Plain Layout
28834 LyXDir/lib/xtemplates/
28840 Each template is defined in a file of its own.
28841 You can place your own templates in
28842 \begin_inset Flex Code
28845 \begin_layout Plain Layout
28846 UserDir/xtemplates/
28851 or copy existing templates to that directory in order to modify them.
28854 \begin_layout Standard
28855 A typical template looks like this:
28858 \begin_layout LyX-Code
28862 \begin_layout LyX-Code
28863 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
28866 \begin_layout LyX-Code
28870 \begin_layout LyX-Code
28874 \begin_layout LyX-Code
28878 \begin_layout LyX-Code
28882 \begin_layout LyX-Code
28886 \begin_layout LyX-Code
28887 AutomaticProduction true
28890 \begin_layout LyX-Code
28894 \begin_layout LyX-Code
28898 \begin_layout LyX-Code
28902 \begin_layout LyX-Code
28903 TransformCommand Rotate RotationLatexCommand
28906 \begin_layout LyX-Code
28907 TransformCommand Resize ResizeLatexCommand
28910 \begin_layout LyX-Code
28911 Product "$$RotateFront$$ResizeFront
28914 \begin_layout LyX-Code
28919 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
28922 \begin_layout LyX-Code
28923 $$ResizeBack$$RotateBack"
28926 \begin_layout LyX-Code
28930 \begin_layout LyX-Code
28931 UpdateResult "$$AbsPath$$Basename.pstex_t"
28934 \begin_layout LyX-Code
28935 Requirement "graphicx"
28938 \begin_layout LyX-Code
28939 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28942 \begin_layout LyX-Code
28943 ReferencedFile latex "$$AbsPath$$Basename.eps"
28946 \begin_layout LyX-Code
28947 ReferencedFile dvi "$$AbsPath$$Basename.eps"
28950 \begin_layout LyX-Code
28954 \begin_layout LyX-Code
28958 \begin_layout LyX-Code
28959 TransformCommand Rotate RotationLatexCommand
28962 \begin_layout LyX-Code
28963 TransformCommand Resize ResizeLatexCommand
28966 \begin_layout LyX-Code
28967 Product "$$RotateFront$$ResizeFront
28970 \begin_layout LyX-Code
28975 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
28978 \begin_layout LyX-Code
28979 $$ResizeBack$$RotateBack"
28982 \begin_layout LyX-Code
28983 UpdateFormat pdftex
28986 \begin_layout LyX-Code
28987 UpdateResult "$$AbsPath$$Basename.pdftex_t"
28990 \begin_layout LyX-Code
28991 Requirement "graphicx"
28994 \begin_layout LyX-Code
28995 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
28998 \begin_layout LyX-Code
28999 ReferencedFile latex "$$AbsPath$$Basename.pdf"
29002 \begin_layout LyX-Code
29006 \begin_layout LyX-Code
29010 \begin_layout LyX-Code
29011 Product "[XFig: $$FName]"
29014 \begin_layout LyX-Code
29018 \begin_layout LyX-Code
29022 \begin_layout LyX-Code
29023 Product "<graphic fileref=
29025 "$$AbsOrRelPathMaster$$Basename.eps
29030 \begin_layout LyX-Code
29034 \begin_layout LyX-Code
29038 \begin_layout LyX-Code
29039 UpdateResult "$$AbsPath$$Basename.eps"
29042 \begin_layout LyX-Code
29043 ReferencedFile docbook "$$AbsPath$$Basename.eps"
29046 \begin_layout LyX-Code
29047 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
29050 \begin_layout LyX-Code
29054 \begin_layout LyX-Code
29058 \begin_layout Standard
29059 As you can see, the template is enclosed in
29060 \begin_inset Flex Code
29063 \begin_layout Plain Layout
29071 \begin_inset Flex Code
29074 \begin_layout Plain Layout
29081 It contains a header specifying some general settings and, for each supported
29082 primary document file format, a section
29083 \begin_inset Flex Code
29086 \begin_layout Plain Layout
29094 \begin_inset Flex Code
29097 \begin_layout Plain Layout
29106 \begin_layout Subsection
29107 The template header
29110 \begin_layout Description
29111 \begin_inset Flex Code
29114 \begin_layout Plain Layout
29115 AutomaticProduction
29116 \begin_inset space ~
29124 Whether the file represented by the template must be generated by \SpecialChar LyX
29126 This command must occur exactly once.
29129 \begin_layout Description
29130 \begin_inset Flex Code
29133 \begin_layout Plain Layout
29135 \begin_inset space ~
29143 A glob pattern that is used in the file dialog to filter out the desired
29145 If there is more than one possible file extension (e.
29146 \begin_inset space \thinspace{}
29150 \begin_inset space \space{}
29154 \begin_inset Flex Code
29157 \begin_layout Plain Layout
29164 \begin_inset Flex Code
29167 \begin_layout Plain Layout
29173 ), use something like
29174 \begin_inset Flex Code
29177 \begin_layout Plain Layout
29184 This command must occur exactly once.
29187 \begin_layout Description
29188 \begin_inset Flex Code
29191 \begin_layout Plain Layout
29193 \begin_inset space ~
29201 The text that is displayed on the button.
29202 This command must occur exactly once.
29205 \begin_layout Description
29206 \begin_inset Flex Code
29209 \begin_layout Plain Layout
29211 \begin_inset space ~
29215 \begin_inset space ~
29223 The help text that is used in the External dialog.
29224 Provide enough information to explain to the user just what the template
29225 can provide him with.
29226 This command must occur exactly once.
29229 \begin_layout Description
29230 \begin_inset Flex Code
29233 \begin_layout Plain Layout
29235 \begin_inset space ~
29243 The file format of the original file.
29244 This must be the name of a format that is known to \SpecialChar LyX
29246 \begin_inset CommandInset ref
29248 reference "sec:Formats"
29254 \begin_inset Quotes eld
29258 \begin_inset Flex Code
29261 \begin_layout Plain Layout
29268 \begin_inset Quotes erd
29271 if the template can handle original files of more than one format.
29273 will attempt to interrogate the file itself in order to deduce its format
29275 This command must occur exactly once.
29278 \begin_layout Description
29279 \begin_inset Flex Code
29282 \begin_layout Plain Layout
29284 \begin_inset space ~
29292 A unique name for the template.
29293 It must not contain substitution macros (see below).
29296 \begin_layout Description
29297 \begin_inset Flex Code
29300 \begin_layout Plain Layout
29302 \begin_inset space ~
29305 Rotate|Resize|Clip|Extra
29310 This command specifies which transformations are supported by this template.
29311 It may occur zero or more times.
29312 This command enables the corresponding tabs in the external dialog.
29314 \begin_inset Flex Code
29317 \begin_layout Plain Layout
29323 command must have either a corresponding
29324 \begin_inset Flex Code
29327 \begin_layout Plain Layout
29334 \begin_inset Flex Code
29337 \begin_layout Plain Layout
29344 \begin_inset Flex Code
29347 \begin_layout Plain Layout
29354 Otherwise the transformation will not be supported by that format.
29357 \begin_layout Subsection
29361 \begin_layout Description
29362 \begin_inset Flex Code
29365 \begin_layout Plain Layout
29367 \begin_inset space ~
29370 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
29375 The primary document file format that this format definition is for.
29376 Not every template has a sensible representation in all document file formats.
29377 Please define nevertheless a
29378 \begin_inset Flex Code
29381 \begin_layout Plain Layout
29387 section for all templates.
29388 Use a dummy text when no representation is available.
29389 Then you can at least see a reference to the external material in the exported
29393 \begin_layout Description
29394 \begin_inset Flex Code
29397 \begin_layout Plain Layout
29399 \begin_inset space ~
29403 \begin_inset space ~
29411 This command defines an additional macro
29412 \begin_inset Flex Code
29415 \begin_layout Plain Layout
29421 for substitution in
29422 \begin_inset Flex Code
29425 \begin_layout Plain Layout
29433 \begin_inset Flex Code
29436 \begin_layout Plain Layout
29442 itself may contain substitution macros.
29443 The advantage over using
29444 \begin_inset Flex Code
29447 \begin_layout Plain Layout
29454 \begin_inset Flex Code
29457 \begin_layout Plain Layout
29463 is that the substituted value of
29464 \begin_inset Flex Code
29467 \begin_layout Plain Layout
29473 is sanitized so that it is a valid optional argument in the document format.
29474 This command may occur zero or more times.
29477 \begin_layout Description
29478 \begin_inset Flex Code
29481 \begin_layout Plain Layout
29483 \begin_inset space ~
29491 The text that is inserted in the exported document.
29492 This is actually the most important command and can be quite complex.
29493 This command must occur exactly once.
29496 \begin_layout Description
29497 \begin_inset Flex Code
29500 \begin_layout Plain Layout
29502 \begin_inset space ~
29510 This command specifies a preamble snippet that will be included in the
29513 It has to be defined using
29514 \begin_inset Flex Code
29517 \begin_layout Plain Layout
29525 \begin_inset Flex Code
29528 \begin_layout Plain Layout
29535 This command may occur zero or more times.
29538 \begin_layout Description
29539 \begin_inset Flex Code
29542 \begin_layout Plain Layout
29544 \begin_inset space ~
29548 \begin_inset space ~
29556 This command denotes files that are created by the conversion process and
29557 are needed for a particular export format.
29558 If the filename is relative, it is interpreted relative to the master document.
29559 This command may be given zero or more times.
29562 \begin_layout Description
29563 \begin_inset Flex Code
29566 \begin_layout Plain Layout
29568 \begin_inset space ~
29576 The name of a required \SpecialChar LaTeX
29578 The package is included via
29579 \begin_inset Flex Code
29582 \begin_layout Plain Layout
29590 in the \SpecialChar LaTeX
29592 This command may occur zero or more times.
29595 \begin_layout Description
29596 \begin_inset Flex Code
29599 \begin_layout Plain Layout
29601 \begin_inset space ~
29605 \begin_inset space ~
29608 RotationLatexCommand
29613 This command specifies that the built in \SpecialChar LaTeX
29614 command should be used for rotation.
29615 This command may occur once or not at all.
29618 \begin_layout Description
29619 \begin_inset Flex Code
29622 \begin_layout Plain Layout
29624 \begin_inset space ~
29628 \begin_inset space ~
29636 This command specifies that the built in \SpecialChar LaTeX
29637 command should be used for resizing.
29638 This command may occur once or not at all.
29641 \begin_layout Description
29642 \begin_inset Flex Code
29645 \begin_layout Plain Layout
29647 \begin_inset space ~
29651 \begin_inset space ~
29654 RotationLatexOption
29659 This command specifies that rotation is done via an optional argument.
29660 This command may occur once or not at all.
29663 \begin_layout Description
29664 \begin_inset Flex Code
29667 \begin_layout Plain Layout
29669 \begin_inset space ~
29673 \begin_inset space ~
29681 This command specifies that resizing is done via an optional argument.
29682 This command may occur once or not at all.
29685 \begin_layout Description
29686 \begin_inset Flex Code
29689 \begin_layout Plain Layout
29691 \begin_inset space ~
29695 \begin_inset space ~
29703 This command specifies that clipping is done via an optional argument.
29704 This command may occur once or not at all.
29707 \begin_layout Description
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29713 \begin_inset space ~
29717 \begin_inset space ~
29725 This command specifies that an extra optional argument is used.
29726 This command may occur once or not at all.
29729 \begin_layout Description
29730 \begin_inset Flex Code
29733 \begin_layout Plain Layout
29735 \begin_inset space ~
29743 The file format of the converted file.
29744 This must be the name of a format that is known to \SpecialChar LyX
29746 \begin_inset Flex Noun
29749 \begin_layout Plain Layout
29750 Tools\SpecialChar menuseparator
29751 Preferences\SpecialChar menuseparator
29752 File Handling\SpecialChar menuseparator
29759 This command must occur exactly once.
29760 If the resulting file format is PDF, you need to specify the format
29761 \begin_inset Flex Code
29764 \begin_layout Plain Layout
29771 This is the PDF format used for including graphics.
29772 The other defined PDF formats are for document export.
29775 \begin_layout Description
29776 \begin_inset Flex Code
29779 \begin_layout Plain Layout
29781 \begin_inset space ~
29789 The file name of the converted file.
29790 The file name must be absolute.
29791 This command must occur exactly once.
29794 \begin_layout Subsection
29795 Preamble definitions
29798 \begin_layout Standard
29799 The external template configuration file may contain additional preamble
29800 definitions enclosed by
29801 \begin_inset Flex Code
29804 \begin_layout Plain Layout
29812 \begin_inset Flex Code
29815 \begin_layout Plain Layout
29822 They can be used by the templates in the
29823 \begin_inset Flex Code
29826 \begin_layout Plain Layout
29835 \begin_layout Section
29836 The substitution mechanism
29839 \begin_layout Standard
29840 When the external material facility invokes an external program, it is done
29841 on the basis of a command defined in the template configuration file.
29842 These commands can contain various macros that are expanded before execution.
29843 Execution always take place in the directory of the containing document.
29846 \begin_layout Standard
29847 Also, whenever external material is to be displayed, the name will be produced
29848 by the substitution mechanism, and most other commands in the template
29849 definition support substitution as well.
29852 \begin_layout Standard
29853 The available macros are the following:
29856 \begin_layout Description
29857 \begin_inset Flex Code
29860 \begin_layout Plain Layout
29861 $$AbsOrRelPathMaster
29866 The file path, absolute or relative to the master \SpecialChar LyX
29870 \begin_layout Description
29871 \begin_inset Flex Code
29874 \begin_layout Plain Layout
29875 $$AbsOrRelPathParent
29880 The file path, absolute or relative to the \SpecialChar LyX
29884 \begin_layout Description
29885 \begin_inset Flex Code
29888 \begin_layout Plain Layout
29894 The absolute file path.
29897 \begin_layout Description
29898 \begin_inset Flex Code
29901 \begin_layout Plain Layout
29907 The filename without path and without the extension.
29910 \begin_layout Description
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \begin_inset Quotes eld
29920 \begin_inset Quotes erd
29928 This macro will expand to the contents of the file with the name
29929 \begin_inset Flex Code
29932 \begin_layout Plain Layout
29941 \begin_layout Description
29942 \begin_inset Flex Code
29945 \begin_layout Plain Layout
29951 The file extension (including the dot).
29954 \begin_layout Description
29955 \begin_inset Flex Code
29958 \begin_layout Plain Layout
29964 This will be the string
29965 \begin_inset Quotes eld
29969 \begin_inset Quotes erd
29972 if the file is in JPEG format, otherwise it will be the string
29973 \begin_inset Quotes eld
29977 \begin_inset Quotes erd
29981 This is useful to avoid uneeded conversions for output formats that support
29982 both PNG and JPEG fomats.
29983 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
29988 \begin_layout Description
29989 \begin_inset Flex Code
29992 \begin_layout Plain Layout
29998 The filename of the file specified in the external material dialog.
29999 This is either an absolute name, or it is relative to the \SpecialChar LyX
30003 \begin_layout Description
30004 \begin_inset Flex Code
30007 \begin_layout Plain Layout
30014 \begin_inset Flex Code
30017 \begin_layout Plain Layout
30023 (absolute name or relative to the \SpecialChar LyX
30027 \begin_layout Description
30028 \begin_inset Flex Code
30031 \begin_layout Plain Layout
30037 The file path, relative to the master \SpecialChar LyX
30041 \begin_layout Description
30042 \begin_inset Flex Code
30045 \begin_layout Plain Layout
30051 The file path, relative to the \SpecialChar LyX
30055 \begin_layout Description
30056 \begin_inset Flex Code
30059 \begin_layout Plain Layout
30065 This macro will expand to the absolute path of the system directory.
30066 This is typically used to point to the various helper scripts that are
30067 bundled with \SpecialChar LyX
30071 \begin_layout Description
30072 \begin_inset Flex Code
30075 \begin_layout Plain Layout
30081 A name and full path to a temporary file which will be automatically deleted
30082 whenever the containing document is closed, or the external material insertion
30086 \begin_layout Standard
30087 All path macros contain a trailing directory separator, so you can construct
30089 \begin_inset space \thinspace{}
30093 \begin_inset space \space{}
30096 the absolute filename with
30097 \begin_inset Flex Code
30100 \begin_layout Plain Layout
30101 $$AbsPath$$Basename$$Extension
30109 \begin_layout Standard
30110 The macros above are substituted in all commands unless otherwise noted.
30112 \begin_inset Flex Code
30115 \begin_layout Plain Layout
30121 supports additionally the following substitutions if they are enabled by
30123 \begin_inset Flex Code
30126 \begin_layout Plain Layout
30133 \begin_inset Flex Code
30136 \begin_layout Plain Layout
30145 \begin_layout Description
30146 \begin_inset Flex Code
30149 \begin_layout Plain Layout
30155 The front part of the resize command.
30158 \begin_layout Description
30159 \begin_inset Flex Code
30162 \begin_layout Plain Layout
30168 The back part of the resize command.
30171 \begin_layout Description
30172 \begin_inset Flex Code
30175 \begin_layout Plain Layout
30181 The front part of the rotation command.
30184 \begin_layout Description
30185 \begin_inset Flex Code
30188 \begin_layout Plain Layout
30194 The back part of the rotation command.
30197 \begin_layout Standard
30198 The value string of the
30199 \begin_inset Flex Code
30202 \begin_layout Plain Layout
30208 command supports additionally the following substitutions if they are enabled
30210 \begin_inset Flex Code
30213 \begin_layout Plain Layout
30220 \begin_inset Flex Code
30223 \begin_layout Plain Layout
30232 \begin_layout Description
30233 \begin_inset Flex Code
30236 \begin_layout Plain Layout
30245 \begin_layout Description
30246 \begin_inset Flex Code
30249 \begin_layout Plain Layout
30258 \begin_layout Description
30259 \begin_inset Flex Code
30262 \begin_layout Plain Layout
30271 \begin_layout Description
30272 \begin_inset Flex Code
30275 \begin_layout Plain Layout
30281 The rotation option.
30284 \begin_layout Standard
30285 You may ask why there are so many path macros.
30286 There are mainly two reasons:
30289 \begin_layout Enumerate
30290 Relative and absolute file names should remain relative or absolute, respectivel
30292 Users may have reasons to prefer either form.
30293 Relative names are useful for portable documents that should work on different
30294 machines, for example.
30295 Absolute names may be required by some programs.
30298 \begin_layout Enumerate
30300 treats relative file names differently than \SpecialChar LyX
30301 and other programs in nested
30303 For \SpecialChar LyX
30304 , a relative file name is always relative to the document that contains
30306 For \SpecialChar LaTeX
30307 , it is always relative to the master document.
30308 These two definitions are identical if you have only one document, but
30309 differ if you have a master document that includes part documents.
30310 That means that relative filenames must be transformed when presented to
30313 Fortunately \SpecialChar LyX
30314 does this automatically for you if you choose the right macros.
30317 \begin_layout Standard
30318 So which path macro should be used in new template definitions? The rule
30322 \begin_layout Itemize
30324 \begin_inset Flex Code
30327 \begin_layout Plain Layout
30333 if an absolute path is required.
30336 \begin_layout Itemize
30338 \begin_inset Flex Code
30341 \begin_layout Plain Layout
30342 $$AbsOrRelPathMaster
30347 if the substituted string is some kind of \SpecialChar LaTeX
30351 \begin_layout Itemize
30353 \begin_inset Flex Code
30356 \begin_layout Plain Layout
30357 $$AbsOrRelPathParent
30362 in order to preserve the user's choice.
30365 \begin_layout Standard
30366 There are special cases where this rule does not work and e.
30367 \begin_inset space \thinspace{}
30371 \begin_inset space \space{}
30374 relative names are needed, but normally it will work just fine.
30375 One example for such a case is the command
30376 \begin_inset Flex Code
30379 \begin_layout Plain Layout
30380 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30385 in the XFig template above: We can't use the absolute name because the
30387 \begin_inset Flex Code
30390 \begin_layout Plain Layout
30396 files needs the relative name in order to rewrite the file content.
30399 \begin_layout Section
30400 Security discussion
30401 \begin_inset CommandInset label
30403 name "sec:Security-discussion"
30410 \begin_layout Standard
30411 The external material feature interfaces with a lot of external programs
30412 and does so automatically, so we have to consider the security implications
30414 In particular, since you have the option of including your own filenames
30415 and/or parameter strings and those are expanded into a command, it seems
30416 that it would be possible to create a malicious document which executes
30417 arbitrary commands when a user views or prints the document.
30418 This is something we definitely want to avoid.
30421 \begin_layout Standard
30422 However, since the external program commands are specified in the template
30423 configuration file only, there are no security issues if \SpecialChar LyX
30424 is properly configure
30425 d with safe templates only.
30426 This is so because the external programs are invoked with the
30427 \begin_inset Flex Code
30430 \begin_layout Plain Layout
30436 -system call rather than the
30437 \begin_inset Flex Code
30440 \begin_layout Plain Layout
30446 system-call, so it's not possible to execute arbitrary commands from the
30447 filename or parameter section via the shell.
30450 \begin_layout Standard
30451 This also implies that you are restricted in what command strings you can
30452 use in the external material templates.
30453 In particular, pipes and redirection are not readily available.
30454 This has to be so if \SpecialChar LyX
30455 should remain safe.
30456 If you want to use some of the shell features, you should write a safe
30457 script to do this in a controlled manner, and then invoke the script from
30458 the command string.
30462 \begin_layout Standard
30463 It is possible to design a template that interacts directly with the shell,
30464 but since this would allow a malicious user to execute arbitrary commands
30465 by writing clever filenames and/or parameters, we generally recommend that
30466 you only use safe scripts that work with the
30467 \begin_inset Flex Code
30470 \begin_layout Plain Layout
30476 system call in a controlled manner.
30477 Of course, for use in a controlled environment, it can be tempting to just
30478 fall back to use ordinary shell scripts.
30479 If you do so, be aware that you
30483 provide an easily exploitable security hole in your system.
30484 Of course it stands to reason that such unsafe templates will never be
30485 included in the standard \SpecialChar LyX
30486 distribution, although we do encourage people
30487 to submit new templates in the open source tradition.
30488 But \SpecialChar LyX
30489 as shipped from the official distribution channels will never have
30493 \begin_layout Standard
30494 Including external material provides a lot of power, and you have to be
30495 careful not to introduce security hazards with this power.
30496 A subtle error in a single line in an innocent looking script can open
30497 the door to huge security problems.
30498 So if you do not fully understand the issues, we recommend that you consult
30499 a knowledgeable security professional or the \SpecialChar LyX
30500 development team if you have
30501 any questions about whether a given template is safe or not.
30502 And do this before you use it in an uncontrolled environment.
30505 \begin_layout Chapter
30507 List of supported \SpecialChar LyX
30508 functions to be used in layouts
30509 \begin_inset CommandInset label
30511 name "chap:List-of-functions"
30518 \begin_layout Standard
30520 \begin_inset Tabular
30521 <lyxtabular version="3" rows="11" columns="8">
30522 <features tabularvalignment="middle">
30523 <column alignment="left" valignment="top">
30524 <column alignment="left" valignment="top">
30525 <column alignment="left" valignment="top">
30526 <column alignment="left" valignment="top">
30527 <column alignment="left" valignment="top">
30528 <column alignment="left" valignment="top">
30529 <column alignment="left" valignment="top">
30530 <column alignment="left" valignment="top">
30532 <cell alignment="left" valignment="top" usebox="none">
30535 \begin_layout Plain Layout
30541 <cell alignment="left" valignment="top" usebox="none">
30544 \begin_layout Plain Layout
30550 <cell alignment="left" valignment="top" usebox="none">
30553 \begin_layout Plain Layout
30559 <cell alignment="left" valignment="top" usebox="none">
30562 \begin_layout Plain Layout
30568 <cell alignment="center" valignment="top" usebox="none">
30571 \begin_layout Plain Layout
30577 <cell alignment="center" valignment="top" usebox="none">
30580 \begin_layout Plain Layout
30586 <cell alignment="center" valignment="top" usebox="none">
30589 \begin_layout Plain Layout
30595 <cell alignment="center" valignment="top" usebox="none">
30598 \begin_layout Plain Layout
30606 <cell alignment="left" valignment="top" usebox="none">
30609 \begin_layout Plain Layout
30615 <cell alignment="left" valignment="top" usebox="none">
30618 \begin_layout Plain Layout
30624 <cell alignment="left" valignment="top" usebox="none">
30627 \begin_layout Plain Layout
30633 <cell alignment="left" valignment="top" usebox="none">
30636 \begin_layout Plain Layout
30642 <cell alignment="center" valignment="top" usebox="none">
30645 \begin_layout Plain Layout
30651 <cell alignment="center" valignment="top" usebox="none">
30654 \begin_layout Plain Layout
30660 <cell alignment="center" valignment="top" usebox="none">
30663 \begin_layout Plain Layout
30669 <cell alignment="center" valignment="top" usebox="none">
30672 \begin_layout Plain Layout
30680 <cell alignment="left" valignment="top" usebox="none">
30683 \begin_layout Plain Layout
30689 <cell alignment="left" valignment="top" usebox="none">
30692 \begin_layout Plain Layout
30698 <cell alignment="left" valignment="top" usebox="none">
30701 \begin_layout Plain Layout
30707 <cell alignment="left" valignment="top" usebox="none">
30710 \begin_layout Plain Layout
30716 <cell alignment="center" valignment="top" usebox="none">
30719 \begin_layout Plain Layout
30725 <cell alignment="center" valignment="top" usebox="none">
30728 \begin_layout Plain Layout
30734 <cell alignment="center" valignment="top" usebox="none">
30737 \begin_layout Plain Layout
30743 <cell alignment="center" valignment="top" usebox="none">
30746 \begin_layout Plain Layout
30754 <cell alignment="left" valignment="top" usebox="none">
30757 \begin_layout Plain Layout
30763 <cell alignment="left" valignment="top" usebox="none">
30766 \begin_layout Plain Layout
30772 <cell alignment="left" valignment="top" usebox="none">
30775 \begin_layout Plain Layout
30781 <cell alignment="left" valignment="top" usebox="none">
30784 \begin_layout Plain Layout
30790 <cell alignment="center" valignment="top" usebox="none">
30793 \begin_layout Plain Layout
30799 <cell alignment="center" valignment="top" usebox="none">
30802 \begin_layout Plain Layout
30808 <cell alignment="center" valignment="top" usebox="none">
30811 \begin_layout Plain Layout
30817 <cell alignment="center" valignment="top" usebox="none">
30820 \begin_layout Plain Layout
30828 <cell alignment="left" valignment="top" usebox="none">
30831 \begin_layout Plain Layout
30837 <cell alignment="left" valignment="top" usebox="none">
30840 \begin_layout Plain Layout
30846 <cell alignment="left" valignment="top" usebox="none">
30849 \begin_layout Plain Layout
30855 <cell alignment="left" valignment="top" usebox="none">
30858 \begin_layout Plain Layout
30864 <cell alignment="center" valignment="top" usebox="none">
30867 \begin_layout Plain Layout
30873 <cell alignment="center" valignment="top" usebox="none">
30876 \begin_layout Plain Layout
30882 <cell alignment="center" valignment="top" usebox="none">
30885 \begin_layout Plain Layout
30891 <cell alignment="center" valignment="top" usebox="none">
30894 \begin_layout Plain Layout
30902 <cell alignment="left" valignment="top" usebox="none">
30905 \begin_layout Plain Layout
30911 <cell alignment="left" valignment="top" usebox="none">
30914 \begin_layout Plain Layout
30920 <cell alignment="left" valignment="top" usebox="none">
30923 \begin_layout Plain Layout
30929 <cell alignment="left" valignment="top" usebox="none">
30932 \begin_layout Plain Layout
30938 <cell alignment="center" valignment="top" usebox="none">
30941 \begin_layout Plain Layout
30947 <cell alignment="center" valignment="top" usebox="none">
30950 \begin_layout Plain Layout
30956 <cell alignment="center" valignment="top" usebox="none">
30959 \begin_layout Plain Layout
30965 <cell alignment="center" valignment="top" usebox="none">
30968 \begin_layout Plain Layout
30976 <cell alignment="left" valignment="top" usebox="none">
30979 \begin_layout Plain Layout
30985 <cell alignment="left" valignment="top" usebox="none">
30988 \begin_layout Plain Layout
30994 <cell alignment="left" valignment="top" usebox="none">
30997 \begin_layout Plain Layout
31003 <cell alignment="left" valignment="top" usebox="none">
31006 \begin_layout Plain Layout
31012 <cell alignment="center" valignment="top" usebox="none">
31015 \begin_layout Plain Layout
31021 <cell alignment="center" valignment="top" usebox="none">
31024 \begin_layout Plain Layout
31030 <cell alignment="center" valignment="top" usebox="none">
31033 \begin_layout Plain Layout
31039 <cell alignment="center" valignment="top" usebox="none">
31042 \begin_layout Plain Layout
31050 <cell alignment="left" valignment="top" usebox="none">
31053 \begin_layout Plain Layout
31059 <cell alignment="left" valignment="top" usebox="none">
31062 \begin_layout Plain Layout
31068 <cell alignment="left" valignment="top" usebox="none">
31071 \begin_layout Plain Layout
31077 <cell alignment="left" valignment="top" usebox="none">
31080 \begin_layout Plain Layout
31086 <cell alignment="center" valignment="top" usebox="none">
31089 \begin_layout Plain Layout
31095 <cell alignment="center" valignment="top" usebox="none">
31098 \begin_layout Plain Layout
31104 <cell alignment="center" valignment="top" usebox="none">
31107 \begin_layout Plain Layout
31113 <cell alignment="center" valignment="top" usebox="none">
31116 \begin_layout Plain Layout
31124 <cell alignment="left" valignment="top" usebox="none">
31127 \begin_layout Plain Layout
31133 <cell alignment="left" valignment="top" usebox="none">
31136 \begin_layout Plain Layout
31142 <cell alignment="left" valignment="top" usebox="none">
31145 \begin_layout Plain Layout
31151 <cell alignment="left" valignment="top" usebox="none">
31154 \begin_layout Plain Layout
31160 <cell alignment="center" valignment="top" usebox="none">
31163 \begin_layout Plain Layout
31169 <cell alignment="center" valignment="top" usebox="none">
31172 \begin_layout Plain Layout
31178 <cell alignment="center" valignment="top" usebox="none">
31181 \begin_layout Plain Layout
31187 <cell alignment="center" valignment="top" usebox="none">
31190 \begin_layout Plain Layout
31198 <cell alignment="left" valignment="top" usebox="none">
31201 \begin_layout Plain Layout
31207 <cell alignment="left" valignment="top" usebox="none">
31210 \begin_layout Plain Layout
31216 <cell alignment="left" valignment="top" usebox="none">
31219 \begin_layout Plain Layout
31225 <cell alignment="left" valignment="top" usebox="none">
31228 \begin_layout Plain Layout
31234 <cell alignment="center" valignment="top" usebox="none">
31237 \begin_layout Plain Layout
31243 <cell alignment="center" valignment="top" usebox="none">
31246 \begin_layout Plain Layout
31252 <cell alignment="center" valignment="top" usebox="none">
31255 \begin_layout Plain Layout
31261 <cell alignment="center" valignment="top" usebox="none">
31264 \begin_layout Plain Layout
31272 <cell alignment="center" valignment="top" usebox="none">
31275 \begin_layout Plain Layout
31281 <cell alignment="center" valignment="top" usebox="none">
31284 \begin_layout Plain Layout
31290 <cell alignment="center" valignment="top" usebox="none">
31293 \begin_layout Plain Layout
31299 <cell alignment="center" valignment="top" usebox="none">
31302 \begin_layout Plain Layout
31308 <cell alignment="center" valignment="top" usebox="none">
31311 \begin_layout Plain Layout
31317 <cell alignment="center" valignment="top" usebox="none">
31320 \begin_layout Plain Layout
31326 <cell alignment="center" valignment="top" usebox="none">
31329 \begin_layout Plain Layout
31335 <cell alignment="center" valignment="top" usebox="none">
31338 \begin_layout Plain Layout
31352 \begin_layout Chapter
31353 Names of available colors to be used in layouts
31354 \begin_inset CommandInset label
31356 name "chap:Names-of-colors"
31363 \begin_layout Standard
31364 The colors listed below are the standard colors and those that you can adjust
31365 in the \SpecialChar LyX
31369 \begin_layout Section
31373 \begin_layout Standard
31374 The following are no real colors, but rather act on color definitions:
31377 \begin_layout Description
31378 ignore The color is ignored
31381 \begin_layout Description
31382 inherit The color is inherited
31385 \begin_layout Description
31398 No particular color – clear or default
31401 \begin_layout Section
31405 \begin_layout Standard
31406 These are fixed colors that cannot be customized:
31409 \begin_layout Description
31413 \begin_layout Description
31417 \begin_layout Description
31421 \begin_layout Description
31425 \begin_layout Description
31429 \begin_layout Description
31433 \begin_layout Description
31437 \begin_layout Description
31441 \begin_layout Description
31445 \begin_layout Description
31449 \begin_layout Description
31453 \begin_layout Description
31457 \begin_layout Description
31461 \begin_layout Description
31465 \begin_layout Description
31469 \begin_layout Description
31473 \begin_layout Description
31477 \begin_layout Description
31481 \begin_layout Description
31485 \begin_layout Section
31489 \begin_layout Standard
31490 These are the colors allocated to specific elements in
31493 arg "dialog-show prefs"
31499 \begin_layout Description
31500 added_space Added space color
31503 \begin_layout Description
31504 addedtext Added text color
31507 \begin_layout Description
31508 appendix Appendix marker color
31511 \begin_layout Description
31512 background Background color
31515 \begin_layout Description
31516 bottomarea Bottom area color
31519 \begin_layout Description
31520 branchlabel Label color for branches
31523 \begin_layout Description
31524 buttonbg Color used for button background
31527 \begin_layout Description
31528 buttonframe Color for inset button frames
31531 \begin_layout Description
31532 buttonhoverbg Color used for button background under focus
31535 \begin_layout Description
31536 changebar Changebar color
31539 \begin_layout Description
31540 changedtextauthor1 Changed text color author 1
31543 \begin_layout Description
31544 changedtextauthor2 Changed text color author 2
31547 \begin_layout Description
31548 changedtextauthor3 Changed text color author 3
31551 \begin_layout Description
31552 changedtextauthor4 Changed text color author 4
31555 \begin_layout Description
31556 changedtextauthor5 Changed text color author 5
31559 \begin_layout Description
31560 collapsible Collapsible insets text color
31563 \begin_layout Description
31564 collapsibleframe Collapsible insets framecolor
31567 \begin_layout Description
31568 command Text color for command insets
31571 \begin_layout Description
31572 commandbg Background color for command insets
31575 \begin_layout Description
31576 commandframe Frame color for command insets
31579 \begin_layout Description
31580 comment Label color for comments
31583 \begin_layout Description
31584 commentbg Background color of comments
31587 \begin_layout Description
31588 cursor Cursor color
31591 \begin_layout Description
31592 deletedtext Deleted text color
31595 \begin_layout Description
31596 deletedtextmodifier Deleted text modifying color
31599 \begin_layout Description
31600 depthbar Color for the depth bars in the margin
31603 \begin_layout Description
31604 eolmarker End of line marker color
31607 \begin_layout Description
31608 error Color of the \SpecialChar LaTeX
31612 \begin_layout Description
31613 footlabel Label color for footnotes
31616 \begin_layout Description
31617 foreground Foreground color
31620 \begin_layout Description
31621 graphicsbg Graphics inset background color
31624 \begin_layout Description
31625 greyedoutbg Background color of greyedout inset
31628 \begin_layout Description
31629 greyedoutlabel Label color for greyedout insets
31632 \begin_layout Description
31633 greyedouttext Color for greyedout inset text
31636 \begin_layout Description
31637 indexlabel Label color for index insets
31640 \begin_layout Description
31641 inlinecompletion Inline completion color
31644 \begin_layout Description
31645 insetbg Inset marker background color
31648 \begin_layout Description
31649 insetframe Inset marker frame color
31652 \begin_layout Description
31653 language Color for marking foreign language words
31656 \begin_layout Description
31657 latex Text color in \SpecialChar LaTeX
31661 \begin_layout Description
31662 listingsbg Background color of listings inset
31665 \begin_layout Description
31666 marginlabel Label color for margin notes
31669 \begin_layout Description
31670 math Math inset text color
31673 \begin_layout Description
31674 mathbg Math inset background color
31677 \begin_layout Description
31678 mathcorners Math inset frame color not under focus
31681 \begin_layout Description
31682 mathframe Math inset frame color under focus
31685 \begin_layout Description
31686 mathline Math line color
31689 \begin_layout Description
31690 mathmacrobg Macro math inset background color
31693 \begin_layout Description
31694 mathmacroblend Macro math blended color
31697 \begin_layout Description
31698 mathmacroframe Macro math frame color
31701 \begin_layout Description
31702 mathmacrohoverbg Macro math inset background color hovered
31705 \begin_layout Description
31706 mathmacrolabel Macro math label color
31709 \begin_layout Description
31710 mathmacronewarg Macro template color for new parameters
31713 \begin_layout Description
31714 mathmacrooldarg Macro template color for old parameters
31717 \begin_layout Description
31718 newpage New page color
31721 \begin_layout Description
31722 nonunique_inlinecompletion Inline completion color for the non-unique part
31725 \begin_layout Description
31726 note Label color for notes
31729 \begin_layout Description
31730 notebg Background color of notes
31733 \begin_layout Description
31734 pagebreak Page break/line break color
31737 \begin_layout Description
31738 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
31741 \begin_layout Description
31742 phantomtext Text color for phantom insets
31745 \begin_layout Description
31746 preview The color used for previews
31749 \begin_layout Description
31750 previewframe Preview frame color
31753 \begin_layout Description
31754 regexpframe Color for regexp frame
31757 \begin_layout Description
31758 scroll Color that indicates when a row can be scrolled
31761 \begin_layout Description
31762 selection Background color of selected text
31765 \begin_layout Description
31766 selectiontext Foreground color of selected text
31769 \begin_layout Description
31770 shadedbg Background color of shaded box
31773 \begin_layout Description
31774 special Special chars text color
31777 \begin_layout Description
31778 tabularline Table line color
31781 \begin_layout Description
31782 tabularonoffline Table line color
31785 \begin_layout Description
31786 urllabel Label color for URL insets
31789 \begin_layout Description
31790 urltext Color for URL inset text