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 -712698321 "Jürgen Spitzmüller"
139 \author -495245474 "Jean-Marc Lasgouttes"
141 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
147 Customizing \SpecialChar LyX
148 : Features for the Advanced User
152 by the \SpecialChar LyX
157 \begin_layout Plain Layout
159 If you have comments or error corrections, please send them to the \SpecialChar LyX
162 \begin_inset CommandInset href
164 target "lyx-docs@lists.lyx.org"
172 \begin_inset Quotes eld
176 \begin_inset Quotes erd
179 in the subject header, and please cc the current maintainer of this file,
180 Richard Heck <rgheck@comcast.net>.
186 \begin_inset Newline newline
190 \begin_inset Newline newline
196 \begin_layout Standard
197 \begin_inset CommandInset toc
198 LatexCommand tableofcontents
205 \begin_layout Standard
206 \begin_inset Note Note
209 \begin_layout Plain Layout
210 Please use change tracking when modifying this document.
211 This makes it easier for our translators to recognize things that have
212 been changed, and it helps the maintainer keep up-to-date with what's been
221 \begin_layout Chapter
225 \begin_layout Standard
226 This manual covers the customization features present in \SpecialChar LyX
228 In it, we discuss issues like keyboard shortcuts, screen previewing options,
229 printer options, sending commands to \SpecialChar LyX
230 via the \SpecialChar LyX
231 Server, internationalization,
232 installing new \SpecialChar LaTeX
233 classes and \SpecialChar LyX
235 We can't possibly hope to touch on everything you can change—our developers
236 add new features faster than we can document them—but we will explain the
237 most common customizations and hopefully point you in the right direction
238 for some of the more obscure ones.
241 \begin_layout Standard
242 \begin_inset Branch OutDated
246 \begin_layout Standard
247 Information from previous versions of this document that now seems to be
248 outdated is contained in the OutDated branch of this document.
249 By default, this information will not appear in the \SpecialChar LaTeX
258 \begin_layout Chapter
263 \begin_layout Standard
264 This chapter aims to help you to find your way through the \SpecialChar LyX
267 Before continuing to read this chapter, you should find out where your
269 library and user directories are by using
270 \begin_inset Flex Noun
273 \begin_layout Plain Layout
274 Help\SpecialChar menuseparator
285 The library directory is the place where \SpecialChar LyX
286 places its system-wide configuration
287 files; the user directory is where you can place your modified versions.
288 We will call the former
289 \begin_inset Flex Code
292 \begin_layout Plain Layout
299 \begin_inset Flex Noun
302 \begin_layout Plain Layout
308 in the remainder of this document.
312 \begin_layout Section
314 \begin_inset Flex Code
317 \begin_layout Plain Layout
326 \begin_layout Standard
327 \begin_inset Flex Code
330 \begin_layout Plain Layout
336 and its sub-directories contain a number of files and that can be used
337 to customize \SpecialChar LyX
339 You can change many of these files from within \SpecialChar LyX
341 \begin_inset Flex Noun
344 \begin_layout Plain Layout
345 Tools\SpecialChar menuseparator
352 Most customization that you will want to do in \SpecialChar LyX
353 is possible through this
355 However, many other inner aspects of \SpecialChar LyX
356 can be customized by modifying the
358 \begin_inset Flex Code
361 \begin_layout Plain Layout
368 These files fall in different categories, described in the following subsection
372 \begin_layout Subsection
373 Automatically generated files
376 \begin_layout Standard
377 The files, which are to be found in
378 \begin_inset Flex Noun
381 \begin_layout Plain Layout
387 , are generated when you configure \SpecialChar LyX
389 They contain various default values that are guessed by inspection.
390 In general, it is not a good idea to modify them, since they might be overwritt
394 \begin_layout Labeling
395 \labelwidthstring 00.00.0000
396 \begin_inset Flex Code
399 \begin_layout Plain Layout
405 contains defaults for various commands.
408 \begin_layout Labeling
409 \labelwidthstring 00.00.0000
410 \begin_inset Flex Code
413 \begin_layout Plain Layout
419 contains the list of packages that have been recognized by \SpecialChar LyX
421 It is currently unused by the \SpecialChar LyX
422 program itself, but the information extracted,
423 and more, is made available with
424 \begin_inset Flex Noun
427 \begin_layout Plain Layout
428 Help\SpecialChar menuseparator
442 \begin_layout Labeling
443 \labelwidthstring 00.00.0000
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
453 the list of text classes that have been found in your
454 \begin_inset Flex Code
457 \begin_layout Plain Layout
463 directories, along with the associated \SpecialChar LaTeX
464 document class and their description.
467 \begin_layout Labeling
468 \labelwidthstring 00.00.0000
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
478 the list of layout modules found in your
479 \begin_inset Flex Code
482 \begin_layout Plain Layout
491 \begin_layout Labeling
492 \labelwidthstring 00.00.0000
493 \begin_inset Flex Code
496 \begin_layout Plain Layout
502 lists of various sorts of \SpecialChar LaTeX
503 -related files found on your system
506 \begin_layout Labeling
507 \labelwidthstring 00.00.0000
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
512 doc/\SpecialChar LaTeX
518 is automatically generated during configuration from the file
519 \begin_inset Flex Code
522 \begin_layout Plain Layout
530 It contains information on your \SpecialChar LaTeX
534 \begin_layout Subsection
538 \begin_layout Standard
539 These directories are duplicated between
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 \begin_inset Flex Code
553 \begin_layout Plain Layout
560 If a particular files exists in both places, the one in
561 \begin_inset Flex Code
564 \begin_layout Plain Layout
573 \begin_layout Labeling
574 \labelwidthstring 00.00.0000
575 \begin_inset Flex Code
578 \begin_layout Plain Layout
584 this directory contains files with the extension
585 \begin_inset Flex Code
588 \begin_layout Plain Layout
594 that define the keybindings used in \SpecialChar LyX
596 If there exists an internationalized version of the bind file named
597 \begin_inset Flex Code
600 \begin_layout Plain Layout
606 , that will be used first.
609 \begin_layout Labeling
610 \labelwidthstring 00.00.0000
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
620 contains files with the extension
621 \begin_inset Flex Code
624 \begin_layout Plain Layout
630 which define the diverse citation possibilities (natbib, biblatex etc.).
632 \begin_inset CommandInset ref
634 reference "subsec:Cite-Engine-Files"
644 \begin_layout Labeling
645 \labelwidthstring 00.00.0000
646 \begin_inset Flex Code
649 \begin_layout Plain Layout
655 contains graphics files that can be included in documents.
659 \begin_layout Labeling
660 \labelwidthstring 00.00.0000
661 \begin_inset Flex Code
664 \begin_layout Plain Layout
670 contains \SpecialChar LyX
671 documentation files (including the one you are currently reading).
673 \begin_inset Flex Code
676 \begin_layout Plain Layout
683 deserves special attention, as noted above.
684 The internationalized help docs are in subdirectories
685 \begin_inset Flex Code
688 \begin_layout Plain Layout
695 \begin_inset Quotes eld
699 \begin_inset Quotes erd
702 is the ISO language code.
704 \begin_inset CommandInset ref
706 reference "cha:Internationalizing-LyX"
713 \begin_layout Labeling
714 \labelwidthstring 00.00.0000
715 \begin_inset Flex Code
718 \begin_layout Plain Layout
724 contains example files that explain how to use some features.
725 In the file browser, press the
726 \begin_inset Flex Noun
729 \begin_layout Plain Layout
738 \begin_layout Labeling
739 \labelwidthstring 00.00.0000
740 \begin_inset Flex Code
743 \begin_layout Plain Layout
749 contains image files that are used by the
750 \begin_inset Flex Noun
753 \begin_layout Plain Layout
760 In addition, it also contains the individual icons used in the toolbar
761 and the banners that can be shown when \SpecialChar LyX
765 \begin_layout Labeling
766 \labelwidthstring 00.00.0000
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 contains keyboard keymapping files.
778 \begin_inset CommandInset ref
780 reference "sec:International-Keymap-Stuff"
787 \begin_layout Labeling
788 \labelwidthstring 00.00.0000
789 \begin_inset Flex Code
792 \begin_layout Plain Layout
798 contains the text class and module files described in
799 \begin_inset CommandInset ref
801 reference "cha:Installing-New-Document"
808 \begin_layout Labeling
809 \labelwidthstring 00.00.0000
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
820 \begin_inset Flex Code
823 \begin_layout Plain Layout
829 Python scripts used to convert between \SpecialChar LyX
831 These can be run from the command line if, say, you want to batch-convert
835 \begin_layout Labeling
836 \labelwidthstring 00.00.0000
837 \begin_inset Flex Code
840 \begin_layout Plain Layout
846 contains some files that demonstrate the capabilities of the
847 \begin_inset Flex Noun
850 \begin_layout Plain Layout
861 Also contains some scripts used by \SpecialChar LyX
865 \begin_layout Labeling
866 \labelwidthstring 00.00.0000
867 \begin_inset Flex Code
870 \begin_layout Plain Layout
876 contains the standard \SpecialChar LyX
877 template files described in
878 \begin_inset CommandInset ref
880 reference "subsec:Creating-Templates"
887 \begin_layout Labeling
888 \labelwidthstring 00.00.0000
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
898 contains files with the extension
899 \begin_inset Flex Code
902 \begin_layout Plain Layout
908 that define the user interface to \SpecialChar LyX
910 That is, the files define which items appear in which menus and the items
911 appearing on the toolbar.
914 \begin_layout Labeling
915 \labelwidthstring 00.00.0000
916 \begin_inset Flex Code
919 \begin_layout Plain Layout
925 contains files with the extension
926 \begin_inset Flex Code
929 \begin_layout Plain Layout
935 which define the templates for the insertion of external material to a
938 \begin_inset CommandInset ref
940 reference "chap:Including-External-Material"
947 \begin_layout Subsection
948 Files you don't want to modify
951 \begin_layout Standard
952 These files are used internally by \SpecialChar LyX
953 and you generally do not need to modify
954 them unless you are a developer.
957 \begin_layout Labeling
958 \labelwidthstring 00.00.0000
959 \begin_inset Flex Code
962 \begin_layout Plain Layout
968 this file contains the list of \SpecialChar LyX
970 The contents are displayed with the menu entry
971 \begin_inset Flex Noun
974 \begin_layout Plain Layout
975 Help\SpecialChar menuseparator
988 \begin_layout Labeling
989 \labelwidthstring 00.00.0000
990 \begin_inset Flex Code
993 \begin_layout Plain Layout
999 this is a \SpecialChar LaTeX
1000 script used during the configuration process.
1001 Do not run directly.
1004 \begin_layout Labeling
1005 \labelwidthstring 00.00.0000
1006 \begin_inset Flex Code
1009 \begin_layout Plain Layout
1015 this is a Python script that is used to re-configure \SpecialChar LyX
1017 It creates configuration files in the directory it was run from.
1020 \begin_layout Subsection
1021 Other files needing a line or two
1024 \begin_layout Labeling
1025 \labelwidthstring 00.00.0000
1026 \begin_inset Flex Code
1029 \begin_layout Plain Layout
1035 this contains tables describing how different character encodings can be
1039 \begin_layout Labeling
1040 \labelwidthstring 00.00.0000
1041 \begin_inset Flex Code
1044 \begin_layout Plain Layout
1050 this file contains a list of all the languages currently supported by \SpecialChar LyX
1054 \begin_layout Labeling
1055 \labelwidthstring 00.00.0000
1056 \begin_inset Flex Code
1059 \begin_layout Plain Layout
1065 contains information about the supported fonts.
1068 \begin_layout Labeling
1069 \labelwidthstring 00.00.0000
1070 \begin_inset Flex Code
1073 \begin_layout Plain Layout
1079 this file contains translations for internationalized paragraph styles
1081 \begin_inset CommandInset ref
1083 reference "subsec:I18n"
1090 \begin_layout Labeling
1091 \labelwidthstring 00.00.0000
1092 \begin_inset Flex Code
1095 \begin_layout Plain Layout
1101 this file contains information about Unicode-encoded glyphs and the way
1102 they are supported by \SpecialChar LyX
1103 via \SpecialChar LaTeX
1107 \begin_layout Section
1108 Your local configuration directory
1111 \begin_layout Standard
1112 Even if you are using \SpecialChar LyX
1113 as an unprivileged user, you might want to change
1115 configuration for your own use.
1117 \begin_inset Flex Code
1120 \begin_layout Plain Layout
1126 directory contains all your personal configuration files.
1127 This is the directory described as
1128 \begin_inset Quotes eld
1132 \begin_inset Quotes erd
1136 \begin_inset Flex Noun
1139 \begin_layout Plain Layout
1140 Help\SpecialChar menuseparator
1142 \begin_inset space ~
1151 This directory is used as a mirror of
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1161 , which means that every file in
1162 \begin_inset Flex Code
1165 \begin_layout Plain Layout
1171 is a replacement for the corresponding file in
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1182 Any configuration file described in the above sections can be placed either
1183 in the system-wide directory, in which case it will affect all users, or
1184 in your local directory for your own use.
1187 \begin_layout Standard
1188 To make things clearer, let's provide a few examples:
1191 \begin_layout Itemize
1192 The preferences set in the
1193 \begin_inset Flex Noun
1196 \begin_layout Plain Layout
1197 Tools\SpecialChar menuseparator
1203 dialog are saved to a file
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1214 \begin_inset Flex Code
1217 \begin_layout Plain Layout
1226 \begin_layout Itemize
1227 When you reconfigure using
1228 \begin_inset Flex Noun
1231 \begin_layout Plain Layout
1232 Tools\SpecialChar menuseparator
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1249 script, and the resulting files are written in your local configuration
1251 This means that any additional text class file that you might have added
1253 \begin_inset Flex Code
1256 \begin_layout Plain Layout
1262 will be added to the list of classes in the
1263 \begin_inset Flex Noun
1266 \begin_layout Plain Layout
1267 Document\SpecialChar menuseparator
1276 \begin_layout Itemize
1277 If you get some updated documentation from \SpecialChar LyX
1278 ftp site and cannot install
1279 it because you do not have sysadmin rights on your system, you can just
1281 \begin_inset Flex Code
1284 \begin_layout Plain Layout
1290 and the items in the
1291 \begin_inset Flex Noun
1294 \begin_layout Plain Layout
1300 menu will open them!
1303 \begin_layout Section
1304 Running \SpecialChar LyX
1305 with multiple configurations
1308 \begin_layout Standard
1309 The configuration freedom of the local configuration directory may not suffice
1310 if you want to have more than one configuration at your disposal.
1311 For example, you may want to be use different key bindings or printer settings
1313 You can achieve this by having several such directories.
1314 You then specify which directory to use at run-time.
1317 \begin_layout Standard
1318 Invoking \SpecialChar LyX
1319 with the command line switch
1320 \begin_inset Flex Code
1323 \begin_layout Plain Layout
1333 instructs the program to read the configuration from that directory, and
1334 not from the default directory.
1335 (You can determine the default directory by running \SpecialChar LyX
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1346 switch.) If the specified directory does not exist, \SpecialChar LyX
1348 for you, just like it does for the default directory on the first time
1349 you run the program.
1350 You can modify the configuration options in this additional user directory
1351 exactly as you would for the default directory.
1352 These directories are completely independent (but read on).
1353 Note that setting the environment variable
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1363 to some value has exactly the same effect.
1366 \begin_layout Standard
1367 Having several configurations also requires more maintenance: if you want
1368 to add a new layout to
1369 \begin_inset Flex Code
1372 \begin_layout Plain Layout
1378 which you want available from all your configurations, you must add it
1379 to each directory separately.
1380 You can avoid this with the following trick: after \SpecialChar LyX
1381 creates the additional
1382 directory, most of the subdirectories (see above) are empty.
1383 If you want the new configuration to mirror an existing one, replace the
1384 empty subdirectory with a symbolic link to the matching subdirectory in
1385 the existing configuration.
1387 \begin_inset Flex Code
1390 \begin_layout Plain Layout
1396 subdirectory, however, since it contains a file written by the configuration
1397 script (also accessible through
1398 \begin_inset Flex Noun
1401 \begin_layout Plain Layout
1402 Tools\SpecialChar menuseparator
1408 ) which is configuration-specific.
1411 \begin_layout Chapter
1412 The Preferences dialog
1415 \begin_layout Standard
1416 All options of the preferences dialog are described in the Appendix
1418 The Preferences Dialog
1425 For some options you might find here more details.
1428 \begin_layout Section
1430 \begin_inset CommandInset label
1439 \begin_layout Standard
1440 The first step is to define your file formats if they are not already defined.
1442 \begin_inset Flex Noun
1445 \begin_layout Plain Layout
1446 Tools\SpecialChar menuseparator
1454 \begin_inset Flex Noun
1457 \begin_layout Plain Layout
1458 File Handling\SpecialChar menuseparator
1465 \begin_inset Flex Noun
1468 \begin_layout Plain Layout
1474 button to define your new format.
1476 \begin_inset Flex Noun
1479 \begin_layout Plain Layout
1485 field contains the name used to identify the format in the GUI.
1487 \begin_inset Flex Noun
1490 \begin_layout Plain Layout
1496 is used to identify the format internally.
1497 You will also need to enter a file extension.
1498 These are all required.
1500 \begin_inset Flex Noun
1503 \begin_layout Plain Layout
1509 field is used to provide a keyboard shortcut on the menus.
1510 (For example, pressing
1511 \begin_inset Flex Noun
1514 \begin_layout Plain Layout
1521 \begin_inset Flex Noun
1524 \begin_layout Plain Layout
1525 Document\SpecialChar menuseparator
1526 View (Other Formats)\SpecialChar menuseparator
1535 \begin_layout Standard
1537 \begin_inset Flex Noun
1540 \begin_layout Plain Layout
1547 \begin_inset Flex Noun
1550 \begin_layout Plain Layout
1557 For example, you might want to use
1558 \begin_inset Flex Noun
1561 \begin_layout Plain Layout
1567 to view PostScript files.
1568 You can enter the command needed to start the program in the corresponding
1570 In defining this command, you can use the four variables listed in the
1572 The viewer is launched when you view an image in \SpecialChar LyX
1574 \begin_inset Flex Noun
1577 \begin_layout Plain Layout
1578 Document\SpecialChar menuseparator
1585 The editor is for example launched when you right-click on an image and
1587 \begin_inset Flex Noun
1590 \begin_layout Plain Layout
1596 in the appearing context menu.
1599 \begin_layout Standard
1601 \begin_inset Flex Noun
1604 \begin_layout Plain Layout
1610 type of a format is optional, but if it is specified, it must be unique
1612 It is used to detect files of this format from the file contents.
1613 For some important file formats there is no MIME type officially registered
1615 \begin_inset CommandInset href
1618 target "http://www.iana.org/assignments/media-types/"
1624 Therefore \SpecialChar LyX
1625 uses the extended list of MIME types as specified by
1626 \begin_inset CommandInset href
1628 name "freedesktop.org"
1629 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1637 \begin_layout Standard
1639 \begin_inset Flex Noun
1642 \begin_layout Plain Layout
1648 option tells \SpecialChar LyX
1649 that a format is suitable for document export.
1650 If this is set and if a suitable conversion route exists (see
1651 \begin_inset CommandInset ref
1653 reference "sec:Converters"
1657 ), the format will appear in the
1658 \begin_inset Flex Noun
1661 \begin_layout Plain Layout
1662 File\SpecialChar menuseparator
1669 The format will also appear in the
1670 \begin_inset Flex Noun
1673 \begin_layout Plain Layout
1674 Document\SpecialChar menuseparator
1680 menu if a viewer is specified for the format.
1681 Pure image formats, such as
1682 \begin_inset Flex Code
1685 \begin_layout Plain Layout
1691 , should not use this option.
1692 Formats that can both represent vector graphics and documents like
1693 \begin_inset Flex Code
1696 \begin_layout Plain Layout
1705 \begin_layout Standard
1707 \begin_inset Flex Noun
1710 \begin_layout Plain Layout
1711 Vector graphics format
1716 tells \SpecialChar LyX
1717 that a format can contain vector graphics.
1718 This information is used to determine the target format of included graphics
1720 \begin_inset Flex Noun
1723 \begin_layout Plain Layout
1730 Included graphics may need to be converted to either
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1751 \begin_inset Flex Noun
1754 \begin_layout Plain Layout
1761 \begin_inset Flex Noun
1764 \begin_layout Plain Layout
1770 cannot handle other image formats.
1771 If an included graphic is not already in
1772 \begin_inset Flex Noun
1775 \begin_layout Plain Layout
1782 \begin_inset Flex Noun
1785 \begin_layout Plain Layout
1792 \begin_inset Flex Noun
1795 \begin_layout Plain Layout
1801 format, it is converted to
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1811 if the vector format option is set, and otherwise to
1812 \begin_inset Flex Noun
1815 \begin_layout Plain Layout
1824 \begin_layout Section
1828 \begin_layout Standard
1829 Since all conversions from one format to another take place in \SpecialChar LyX
1831 directory, it is sometimes necessary to modify a file before copying it
1832 to the temporary directory in order that the conversion may be performed.
1836 \begin_layout Plain Layout
1837 For example, the file may refer to other files—images, for example—using
1838 relative file names, and these may become invalid when the file is copied
1839 to the temporary directory.
1844 This is done by a Copier: It copies a file to (or from) the temporary directory
1845 and may modify it in the process.
1848 \begin_layout Standard
1849 The definitions of the copiers may use eight variables:
1852 \begin_layout Labeling
1853 \labelwidthstring 00.00.0000
1854 \begin_inset Flex Code
1857 \begin_layout Plain Layout
1863 The \SpecialChar LyX
1864 system directory (e.
1865 \begin_inset space \thinspace{}
1869 \begin_inset space \space{}
1873 \begin_inset Flex Noun
1876 \begin_layout Plain Layout
1885 \begin_layout Labeling
1886 \labelwidthstring 00.00.0000
1887 \begin_inset Flex Code
1890 \begin_layout Plain Layout
1899 \begin_layout Labeling
1900 \labelwidthstring 00.00.0000
1901 \begin_inset Flex Code
1904 \begin_layout Plain Layout
1913 \begin_layout Labeling
1914 \labelwidthstring 00.00.0000
1915 \begin_inset Flex Code
1918 \begin_layout Plain Layout
1924 The base name (without filename extension) in the \SpecialChar LyX
1928 \begin_layout Labeling
1929 \labelwidthstring 00.00.0000
1930 \begin_inset Flex Code
1933 \begin_layout Plain Layout
1939 The full directory path of the \SpecialChar LyX
1943 \begin_layout Labeling
1944 \labelwidthstring 00.00.0000
1945 \begin_inset Flex Code
1948 \begin_layout Plain Layout
1954 The full pathname to the original \SpecialChar LyX
1955 file being processed
1958 \begin_layout Labeling
1959 \labelwidthstring 00.00.0000
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1969 The filename (without any directory path) of the \SpecialChar LyX
1973 \begin_layout Labeling
1974 \labelwidthstring 00.00.0000
1975 \begin_inset Flex Code
1978 \begin_layout Plain Layout
1984 The `\SpecialChar LaTeX
1988 \begin_layout Standard
1989 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1997 It is relevant only when exporting files suitable for such inclusion.
2000 \begin_layout Standard
2001 Copiers can be used to do almost anything with output files.
2002 For example, suppose you want generated pdf files to be copied to a special
2004 \begin_inset Flex Code
2007 \begin_layout Plain Layout
2014 Then you could write a shell script such as this one:
2017 \begin_layout Standard
2018 \begin_inset listings
2022 \begin_layout Plain Layout
2027 \begin_layout Plain Layout
2032 \begin_layout Plain Layout
2034 TOFILE=`basename $2`
2037 \begin_layout Plain Layout
2039 cp $FROMFILE /home/you/pdf/$TOFILE
2044 Save it in your local \SpecialChar LyX
2046 \begin_inset Flex Code
2049 \begin_layout Plain Layout
2050 /home/you/.lyx/scripts/pdfcopier.sh
2055 —and make it executable, if you need to do so on your platform.
2057 \begin_inset Flex Noun
2060 \begin_layout Plain Layout
2061 Tools\SpecialChar menuseparator
2067 dialog, select under
2068 \begin_inset Flex Noun
2071 \begin_layout Plain Layout
2072 File Handling\SpecialChar menuseparator
2079 \begin_inset Flex Noun
2082 \begin_layout Plain Layout
2088 format—or one of the other pdf formats—and enter
2089 \begin_inset Flex Code
2092 \begin_layout Plain Layout
2093 pdfcopier.sh $$i $$o
2099 \begin_inset Flex Noun
2102 \begin_layout Plain Layout
2112 \begin_layout Standard
2113 Copiers are used by \SpecialChar LyX
2114 in various of its own conversions.
2115 For example, if appropriate programs are found, \SpecialChar LyX
2116 will automatically install
2118 \begin_inset Flex Noun
2121 \begin_layout Plain Layout
2128 \begin_inset Flex Noun
2131 \begin_layout Plain Layout
2133 \begin_inset space ~
2142 When these formats are exported, the copier sees that not just the main
2143 HTML file but various associated files (style files, images, etc.) are also
2145 All these files are written to a subdirectory of the directory in which
2146 the original \SpecialChar LyX
2151 \begin_layout Plain Layout
2152 This copier can be customized.
2154 \begin_inset Quotes eld
2158 \begin_inset Quotes erd
2161 argument takes a comma-separated list of extensions to be copied; if it
2162 is omitted, all files will be copied.
2164 \begin_inset Quotes eld
2168 \begin_inset Quotes erd
2171 argument determines the extension added to the generated directory.
2173 \begin_inset Quotes eld
2177 \begin_inset Flex Noun
2180 \begin_layout Plain Layout
2187 \begin_inset Quotes erd
2190 , so HTML generated from
2191 \begin_inset Flex Noun
2194 \begin_layout Plain Layout
2195 /path/to/filename.lyx
2201 \begin_inset Flex Noun
2204 \begin_layout Plain Layout
2205 /path/to/filename.html.LyXconv
2219 \begin_layout Section
2221 \begin_inset CommandInset label
2223 name "sec:Converters"
2230 \begin_layout Standard
2231 You can define your own Converters to convert files between different formats.
2233 \begin_inset Flex Noun
2236 \begin_layout Plain Layout
2237 Tools\SpecialChar menuseparator
2238 Preferences\SpecialChar menuseparator
2239 File Handling\SpecialChar menuseparator
2248 \begin_layout Standard
2249 To define a new converter, select the
2250 \begin_inset Flex Noun
2253 \begin_layout Plain Layout
2255 \begin_inset space ~
2264 \begin_inset Flex Noun
2267 \begin_layout Plain Layout
2269 \begin_inset space ~
2277 from the drop-down lists, enter the command needed for the conversion,
2279 \begin_inset Flex Noun
2282 \begin_layout Plain Layout
2289 Several variables can be used in the definition of converters:
2292 \begin_layout Labeling
2293 \labelwidthstring 00.00.0000
2294 \begin_inset Flex Code
2297 \begin_layout Plain Layout
2303 The \SpecialChar LyX
2307 \begin_layout Labeling
2308 \labelwidthstring 00.00.0000
2309 \begin_inset Flex Code
2312 \begin_layout Plain Layout
2321 \begin_layout Labeling
2322 \labelwidthstring 00.00.0000
2323 \begin_inset Flex Code
2326 \begin_layout Plain Layout
2335 \begin_layout Labeling
2336 \labelwidthstring 00.00.0000
2337 \begin_inset Flex Code
2340 \begin_layout Plain Layout
2346 The base filename of the input file (i.
2347 \begin_inset space \thinspace{}
2350 g., without the extension)
2353 \begin_layout Labeling
2354 \labelwidthstring 00.00.0000
2355 \begin_inset Flex Code
2358 \begin_layout Plain Layout
2364 The path to the input file
2367 \begin_layout Labeling
2368 \labelwidthstring 00.00.0000
2369 \begin_inset Flex Code
2372 \begin_layout Plain Layout
2378 The path to the original input file (this is different from $$p when a
2379 chain of converters is called)
2382 \begin_layout Labeling
2383 \labelwidthstring 00.00.0000
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2393 The iconv name for the encoding of the document.
2396 \begin_layout Standard
2398 \begin_inset Flex Noun
2401 \begin_layout Plain Layout
2403 \begin_inset space ~
2411 field you can enter the following flags, separated by commas:
2414 \begin_layout Labeling
2415 \labelwidthstring 00.00.0000
2416 \begin_inset Flex Code
2419 \begin_layout Plain Layout
2421 \change_inserted -712698321 1524656940
2429 This converter runs some form of \SpecialChar LaTeX
2431 This will make \SpecialChar LyX
2432 's \SpecialChar LaTeX
2433 error logs available.
2435 \change_inserted -712698321 1524657018
2437 \begin_inset Flex Code
2440 \begin_layout Plain Layout
2442 \change_inserted -712698321 1524657012
2450 value specifies the form of \SpecialChar LaTeX
2452 \begin_inset Flex Code
2455 \begin_layout Plain Layout
2457 \change_inserted -712698321 1524657005
2458 latex, pdflatex, platex, xetex, luatex
2466 If no value is specified,
2467 \begin_inset Flex Code
2470 \begin_layout Plain Layout
2472 \change_inserted -712698321 1524657018
2485 \begin_layout Labeling
2486 \labelwidthstring 00.00.0000
2487 \begin_inset Flex Code
2490 \begin_layout Plain Layout
2492 \change_inserted -712698321 1524656935
2500 Needs the \SpecialChar LaTeX
2502 \begin_inset Flex Noun
2505 \begin_layout Plain Layout
2511 file for the conversion.
2513 \change_inserted -712698321 1524657047
2515 \begin_inset Flex Code
2518 \begin_layout Plain Layout
2520 \change_inserted -712698321 1524657030
2526 value specifies the form of \SpecialChar LaTeX
2527 that is run in order to generate the
2528 \begin_inset Flex Noun
2531 \begin_layout Plain Layout
2533 \change_inserted -712698321 1524657047
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2545 \change_inserted -712698321 1524657030
2546 latex, pdflatex, platex, xetex, luatex
2552 If no value is specified,
2553 \begin_inset Flex Code
2556 \begin_layout Plain Layout
2558 \change_inserted -712698321 1524657030
2569 \begin_layout Labeling
2570 \labelwidthstring 00.00.0000
2571 \begin_inset Flex Code
2574 \begin_layout Plain Layout
2581 \begin_inset Quotes eld
2585 \begin_inset Quotes erd
2588 file from the backend, which in practice means a \SpecialChar LaTeX
2589 file like the one we
2590 would export, without
2591 \begin_inset Flex Code
2594 \begin_layout Plain Layout
2603 \begin_layout Labeling
2604 \labelwidthstring 00.00.0000
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2617 \begin_layout Standard
2618 The following three flags are not really flags at all because they take
2620 \begin_inset Flex Noun
2623 \begin_layout Plain Layout
2625 \begin_inset space ~
2629 \begin_inset space ~
2640 \begin_layout Labeling
2641 \labelwidthstring 00.00.0000
2643 \change_inserted -712698321 1523206314
2644 \begin_inset Flex Code
2647 \begin_layout Plain Layout
2649 \change_inserted -712698321 1523206193
2655 The name of the driver that needs to be loaded with the
2659 package for this converter.
2660 The loading of the correct driver is necessary to get some PDF-specific
2669 \begin_layout Labeling
2670 \labelwidthstring 00.00.0000
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2680 If set, the converter's standard error will be redirected to a file
2681 \begin_inset Flex Code
2684 \begin_layout Plain Layout
2690 , and the script given as argument will be run as:
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2695 script < infile.out > infile.log
2701 The argument may contain
2702 \begin_inset Flex Code
2705 \begin_layout Plain Layout
2714 \begin_layout Labeling
2715 \labelwidthstring 00.00.0000
2716 \begin_inset Flex Code
2719 \begin_layout Plain Layout
2725 The name of the directory in which the converter will dump the generated
2728 will not create this directory, and it does not copy anything into it,
2729 though it will copy this directory to the destination.
2730 The argument may contain
2731 \begin_inset Flex Code
2734 \begin_layout Plain Layout
2740 , which will be replaced by the base name of the input and output files,
2741 respectively, when the directory is copied.
2742 \begin_inset Newline newline
2745 Note that resultdir and usetempdir make no sense together.
2746 The latter will be ignored if the former is given.
2749 \begin_layout Labeling
2750 \labelwidthstring 00.00.0000
2751 \begin_inset Flex Code
2754 \begin_layout Plain Layout
2760 Determines the output file name and may, contain
2761 \begin_inset Flex Code
2764 \begin_layout Plain Layout
2771 Sensible only with resultdir and optional even then; if not given, it defaults
2775 \begin_layout Standard
2777 \change_inserted -712698321 1523206384
2778 A suitable hyperref-driver is set for some converters that are installed
2779 with \SpecialChar LyX
2782 \change_deleted -712698321 1523206388
2784 \change_inserted -712698321 1523206389
2788 \change_inserted -712698321 1523206400
2792 \change_inserted -712698321 1523206407
2796 \change_inserted -712698321 1523206437
2800 \change_deleted -712698321 1523206442
2801 that are installed with \SpecialChar LyX
2808 \begin_layout Standard
2809 You do not have to define converters for all formats between which you want
2811 For example, you will note that there is no `\SpecialChar LyX
2812 to PostScript' converter,
2813 but \SpecialChar LyX
2814 will export PostScript.
2815 It does so by first creating a \SpecialChar LaTeX
2816 file (no converter needs to be defined
2817 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2819 and finally converting the resulting DVI file to PostScript.
2821 finds such `chains' of converters automatically, and it will always choose
2822 the shortest possible chain.
2823 You can, though, still define multiple conversion methods between file
2825 For example, the standard \SpecialChar LyX
2826 configuration provides five ways to convert
2831 \begin_layout Enumerate
2833 \begin_inset Flex Noun
2836 \begin_layout Plain Layout
2845 \begin_layout Enumerate
2846 via (DVI and) PostScript, using
2847 \begin_inset Flex Noun
2850 \begin_layout Plain Layout
2859 \begin_layout Enumerate
2861 \begin_inset Flex Noun
2864 \begin_layout Plain Layout
2873 \begin_layout Enumerate
2875 \begin_inset Flex Noun
2878 \begin_layout Plain Layout
2888 \begin_layout Enumerate
2890 \begin_inset Flex Noun
2893 \begin_layout Plain Layout
2903 \begin_layout Standard
2904 To define such alternate chains, you must define multiple target `file formats',
2906 \begin_inset CommandInset ref
2908 reference "sec:Formats"
2913 For example, in the standard configuration, the formats named
2914 \begin_inset Flex Noun
2917 \begin_layout Plain Layout
2924 \begin_inset Flex Noun
2927 \begin_layout Plain Layout
2934 \begin_inset Flex Noun
2937 \begin_layout Plain Layout
2944 \begin_inset Flex Noun
2947 \begin_layout Plain Layout
2954 \begin_inset Flex Noun
2957 \begin_layout Plain Layout
2964 \begin_inset Flex Noun
2967 \begin_layout Plain Layout
2974 \begin_inset Flex Noun
2977 \begin_layout Plain Layout
2984 \begin_inset Flex Noun
2987 \begin_layout Plain Layout
2995 \begin_inset Flex Noun
2998 \begin_layout Plain Layout
3005 \begin_inset Flex Noun
3008 \begin_layout Plain Layout
3015 ) are defined, all of which share the extension
3016 \begin_inset Flex Noun
3019 \begin_layout Plain Layout
3025 , and which correspond to the conversion methods just mentioned.
3028 \begin_layout Chapter
3029 Internationalizing \SpecialChar LyX
3031 \begin_inset CommandInset label
3033 name "cha:Internationalizing-LyX"
3040 \begin_layout Standard
3042 supports using a translated interface.
3043 Last time we checked, \SpecialChar LyX
3044 provided text in thirty languages.
3045 The language of choice is called your
3050 (For further reading on locale settings, see also the documentation for
3051 locale that comes with your operating system.
3052 For Linux, the manual page for
3053 \begin_inset Flex Code
3056 \begin_layout Plain Layout
3062 could be a good place to start).
3065 \begin_layout Standard
3066 Notice that these translations will work, but do contain a few flaws.
3067 In particular, all dialogs have been designed with the English text in
3068 mind, which means that some of the translated text will be too large to
3069 fit within the space allocated.
3070 This is only a display problem and will not cause any harm.
3071 Also, you will find that some of the translations do not define shortcut
3072 keys for everything.
3073 Sometimes, there are simply not enough free letters to do it.
3074 Other times, the translator just hasn't got around to doing it yet.
3075 Our localization team, which you may wish to join,
3079 \begin_layout Plain Layout
3080 If you are a fluent speaker of a language other than English, joining these
3081 teams is a great way to give back to the \SpecialChar LyX
3087 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3091 \begin_layout Section
3092 Translating \SpecialChar LyX
3096 \begin_layout Subsection
3097 Translating the graphical user interface (text messages).
3100 \begin_layout Standard
3103 \begin_inset Flex Code
3106 \begin_layout Plain Layout
3112 library to handle the internationalization of the interface.
3113 To have \SpecialChar LyX
3114 speak your favorite language in all menus and dialogs, you need
3116 \begin_inset Flex Code
3119 \begin_layout Plain Layout
3125 -file for that language.
3126 When this is available, you'll have to generate a
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3136 -file from it and install the
3137 \begin_inset Flex Code
3140 \begin_layout Plain Layout
3147 The process of doing all of this is explained in the documentation for
3149 \begin_inset Flex Code
3152 \begin_layout Plain Layout
3159 It is possible to do this just for yourself, but if you're going to do
3160 it, you might as well share the results of your labors with the rest of
3161 the \SpecialChar LyX
3163 Send a message to the \SpecialChar LyX
3164 developers' list for more information about how
3168 \begin_layout Standard
3169 In short, this is what you should do (xx denotes the language code):
3172 \begin_layout Itemize
3173 Check out the \SpecialChar LyX
3176 \begin_inset CommandInset href
3178 name "information on the web"
3179 target "https://www.lyx.org/HowToUseGIT"
3187 \begin_layout Itemize
3189 \begin_inset Flex Code
3192 \begin_layout Plain Layout
3198 to the folder of the
3199 \begin_inset Flex Code
3202 \begin_layout Plain Layout
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3221 \begin_inset Flex Code
3224 \begin_layout Plain Layout
3230 doesn't exist anywhere, it can be remade with the console command
3231 \begin_inset Flex Code
3234 \begin_layout Plain Layout
3240 in that directory, or you can use an existing po-file for some other language
3244 \begin_layout Itemize
3246 \begin_inset Flex Code
3249 \begin_layout Plain Layout
3259 \begin_layout Plain Layout
3260 This is just a text file, so it can be edited in any text editor.
3261 But there are also specialized programs that support such editing, such
3266 (for all platforms) or
3275 contains a `mode' for editing
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3286 \begin_inset Flex URL
3289 \begin_layout Plain Layout
3291 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3301 For some menu- and widget-labels, there are also shortcut keys that should
3303 Those keys are marked after a `|', and should be translated according to
3304 the words and phrases of the language.
3305 You should also fill also out the information at the beginning of the new
3307 \begin_inset Flex Code
3310 \begin_layout Plain Layout
3316 -file with your email-address, etc., so people know where to reach you with
3317 suggestions and entertaining flames.
3320 \begin_layout Standard
3321 If you are just doing this on your own, then:
3324 \begin_layout Itemize
3326 \begin_inset Flex Code
3329 \begin_layout Plain Layout
3336 This can be done with
3337 \begin_inset Flex Code
3340 \begin_layout Plain Layout
3341 msgfmt -o xx.mo < xx.po
3349 \begin_layout Itemize
3351 \begin_inset Flex Code
3354 \begin_layout Plain Layout
3360 -file to your locale-tree, at the correct directory for application messages
3365 xx, and under the name
3366 \begin_inset Flex Code
3369 \begin_layout Plain Layout
3376 \begin_inset space \thinspace{}
3380 \begin_inset space \space{}
3384 \begin_inset Flex Code
3387 \begin_layout Plain Layout
3388 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3398 \begin_layout Standard
3399 As said, however, it would be best if the new
3400 \begin_inset Flex Code
3403 \begin_layout Plain Layout
3409 file could be added to the \SpecialChar LyX
3410 distribution, so others can use it.
3411 Adding it involves making additional changes to \SpecialChar LyX
3413 So send an email to the developers' mailing list if you're interested in
3417 \begin_layout Subsubsection
3421 \begin_layout Standard
3422 Sometimes it turns out that one English message needs to be translated into
3423 different messages in the target language.
3424 One example is the message
3425 \begin_inset Flex Code
3428 \begin_layout Plain Layout
3434 which has the German translation
3442 , depending upon exactly what the English
3443 \begin_inset Quotes eld
3447 \begin_inset Quotes erd
3452 \begin_inset Flex Code
3455 \begin_layout Plain Layout
3461 does not handle such ambiguous translations.
3462 Therefore you have to add some context information to the message: Instead
3464 \begin_inset Flex Code
3467 \begin_layout Plain Layout
3474 \begin_inset Flex Code
3477 \begin_layout Plain Layout
3478 To[[as in 'From format x to format y']]
3484 \begin_inset Flex Code
3487 \begin_layout Plain Layout
3488 To[[as in 'From page x to page y']].
3493 Now the two occurrences of
3494 \begin_inset Flex Code
3497 \begin_layout Plain Layout
3504 \begin_inset Flex Code
3507 \begin_layout Plain Layout
3513 and can be translated correctly to
3524 \begin_layout Standard
3525 Of course the context information needs to be stripped off the original
3526 message when no translation is used.
3527 Therefore you have to put it in double square brackets at the end of the
3528 message (see the example above).
3529 The translation mechanism of \SpecialChar LyX
3530 ensures that everything in double square
3531 brackets at the end of messages is removed before displaying the message.
3534 \begin_layout Subsection
3535 Translating the documentation.
3538 \begin_layout Standard
3539 The online documentation (in the
3540 \begin_inset Flex Noun
3543 \begin_layout Plain Layout
3549 -menu) can (and should!) be translated.
3550 If there are translated versions of the documentation available
3554 \begin_layout Plain Layout
3555 As of March 2008, at least some of the documents have been translated into
3556 fourteen languages, with the Tutorial available in a few more.
3561 and the locale is set accordingly, these will be used automagically by
3565 looks for translated versions as
3566 \begin_inset Flex Code
3569 \begin_layout Plain Layout
3570 LyXDir/doc/xx/DocName.lyx
3576 \begin_inset Flex Code
3579 \begin_layout Plain Layout
3585 is the code for the language currently in use.
3586 If there are no translated documents, the default English versions will
3588 Note that the translated versions must have the same filenames (
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3598 above) as the original.
3599 If you feel up to translating the documentation (an excellent way to proof-read
3600 the original documentation by the way!), there are a few things you should
3604 \begin_layout Itemize
3605 Check out the documentation translation web page at
3606 \begin_inset CommandInset href
3608 name "https://www.lyx.org/Translation"
3609 target "https://www.lyx.org/Translation"
3615 That way, you can find out which (if any) documents have already been translate
3616 d into your language.
3617 You can also find out who (if anyone) is organizing the effort to translate
3618 the documentation into your language.
3619 If no one is organizing the effort, please let us know that you're interested.
3622 \begin_layout Standard
3623 Once you get to actually translating, here's a few hints for you that may
3627 \begin_layout Itemize
3628 Join the documentation team! There is information on how to do that in
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3639 \begin_inset Flex Noun
3642 \begin_layout Plain Layout
3643 Help\SpecialChar menuseparator
3649 ), which by the way is the first document you should translate.
3652 \begin_layout Itemize
3653 Learn the typographic conventions for the language you are translating to.
3654 Typography is an ancient art and over the centuries, a great variety of
3655 conventions have developed throughout different parts of the world.
3656 Also study the professional terminology amongst typographers in your country.
3657 Inventing your own terminology will only confuse the users.
3660 (Warning! Typography is addictive!)
3663 \begin_layout Itemize
3664 Make a copy of the document.
3665 This will be your working copy.
3666 You can use this as your personal translated help-file by placing it in
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3678 \begin_inset Note Greyedout
3681 \begin_layout Plain Layout
3686 For a complex document with external material (images, etc.), if you make
3688 \begin_inset space \thinspace{}
3692 \begin_inset space \space{}
3695 in a temp dir, beware that the links to external material may be broken
3696 when the document is moved to a different place.
3697 The best way is to retrieve the \SpecialChar LyX
3699 \begin_inset Flex URL
3702 \begin_layout Plain Layout
3704 https://www.lyx.org/HowToUseGIT
3709 ) and to edit the doc file in place.
3717 \begin_layout Itemize
3718 Sometimes the original document (from the \SpecialChar LyX
3719 team) will be updated.
3720 Use the source viewer at
3721 \begin_inset CommandInset href
3723 name "https://www.lyx.org/trac/timeline"
3724 target "https://www.lyx.org/trac/timeline"
3729 to see what has been changed.
3730 That way you can easily see which parts of the translated document need
3734 \begin_layout Standard
3735 If you ever find an error in the original document, fix it and notify the
3736 rest of the documentation team of the changes! (You didn't forget to join
3737 the documentation team, did you?)
3740 \begin_layout Standard
3741 \begin_inset Branch OutDated
3745 \begin_layout Section
3746 International Keyboard Support
3749 \begin_layout Standard
3752 [Editor's Note: The following section is by
3760 It needs to be fixed to conform to the new Documentation Style sheet and
3761 to make use of the new v1.0 features.
3762 The whole thing also needs to be merged with the section following it.-jw
3763 It may also be badly out of date.-rh (2008)]
3766 \begin_layout Subsection
3767 Defining Own Keymaps: Keymap File Format
3770 \begin_layout Standard
3771 Let's look at a keyboard definition file a little closer.
3772 It is a plain text file defining
3775 \begin_layout Itemize
3776 key-to-key or key-to-string translations
3779 \begin_layout Itemize
3783 \begin_layout Itemize
3784 dead keys exceptions
3787 \begin_layout Standard
3788 To define key-to-key or key-to-string translation, use this command:
3791 \begin_layout Quotation
3792 \begin_inset Flex Code
3795 \begin_layout Plain Layout
3804 \begin_inset Flex Code
3807 \begin_layout Plain Layout
3816 \begin_layout Standard
3818 \begin_inset Flex Code
3821 \begin_layout Plain Layout
3827 is the key to be translated and
3828 \begin_inset Flex Code
3831 \begin_layout Plain Layout
3837 is the string to be inserted into the document.
3838 To define dead keys, use:
3841 \begin_layout Quotation
3842 \begin_inset Flex Code
3845 \begin_layout Plain Layout
3854 \begin_inset Flex Code
3857 \begin_layout Plain Layout
3866 \begin_layout Standard
3868 \begin_inset Flex Code
3871 \begin_layout Plain Layout
3877 is a keyboard key and
3878 \begin_inset Flex Code
3881 \begin_layout Plain Layout
3888 The following dead keys are supported (shortcut name is in parentheses):
3891 \begin_layout Quotation
3895 \begin_inset space \hfill{}
3901 \begin_layout Quotation
3903 \begin_inset space \hfill{}
3909 \begin_layout Quotation
3911 \begin_inset space \hfill{}
3917 \begin_layout Quotation
3919 \begin_inset space \hfill{}
3925 \begin_layout Quotation
3927 \begin_inset space \hfill{}
3933 \begin_layout Quotation
3935 \begin_inset space \hfill{}
3942 \begin_layout Plain Layout
3954 \begin_layout Quotation
3956 \begin_inset space \hfill{}
3962 \begin_layout Quotation
3964 \begin_inset space \hfill{}
3971 \begin_layout Plain Layout
3983 \begin_layout Quotation
3985 \begin_inset space \hfill{}
3991 \begin_layout Quotation
3993 \begin_inset space \hfill{}
3999 \begin_layout Quotation
4001 \begin_inset space \hfill{}
4008 \begin_layout Plain Layout
4020 \begin_layout Quotation
4022 \begin_inset space \hfill{}
4029 \begin_layout Plain Layout
4041 \begin_layout Quotation
4043 \begin_inset space \hfill{}
4049 \begin_layout Quotation
4050 hungarian umlaut (hug)
4051 \begin_inset space \hfill{}
4057 \begin_layout Quotation
4059 \begin_inset space \hfill{}
4065 \begin_layout Quotation
4067 \begin_inset space \hfill{}
4074 \begin_layout Plain Layout
4086 \begin_layout Standard
4087 Since in many international keyboards there are exceptions to what some
4088 dead keys should do, you can define them using
4091 \begin_layout Quotation
4092 \begin_inset Flex Code
4095 \begin_layout Plain Layout
4103 deadkey key outstring
4106 \begin_layout Standard
4107 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4111 \begin_layout Quotation
4112 \begin_inset Flex Code
4115 \begin_layout Plain Layout
4128 \begin_layout Standard
4129 to make it work correctly.
4130 Also, you have to define as exceptions dead keys over i and j, to remove
4131 the dot from them before inserting an accent mark.
4132 I will change this when the time comes, but so far I haven't had time.
4135 \begin_layout Standard
4136 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4139 \begin_inset Flex Code
4142 \begin_layout Plain Layout
4148 have different meaning.
4150 \begin_inset Flex Code
4153 \begin_layout Plain Layout
4159 marks comments, quotes start and end \SpecialChar LaTeX
4161 To enter quote, you'll need to use
4162 \begin_inset Flex Code
4165 \begin_layout Plain Layout
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4184 \begin_inset Flex Code
4187 \begin_layout Plain Layout
4198 \begin_layout Standard
4199 If you make a keyboard description file that works for your language, please
4200 mail it to me, so I can include it in the next keymap distribution.
4203 \begin_layout Standard
4204 More keywords will be supported in keymap configuration file in future,
4208 \begin_layout Itemize
4209 \begin_inset Flex Code
4212 \begin_layout Plain Layout
4223 \begin_inset space \hfill{}
4227 \begin_inset Flex Code
4230 \begin_layout Plain Layout
4239 \begin_layout Itemize
4240 \begin_inset Flex Code
4243 \begin_layout Plain Layout
4254 \begin_inset space \hfill{}
4258 \begin_inset Flex Code
4261 \begin_layout Plain Layout
4267 an external keymap translation program
4270 \begin_layout Standard
4271 Also, it should look into
4272 \begin_inset Flex Code
4275 \begin_layout Plain Layout
4281 file for defaults, too (for example, a
4282 \begin_inset Flex Code
4285 \begin_layout Plain Layout
4293 option to include default keyboard).
4301 \begin_layout Section
4302 International Keymap Stuff
4303 \begin_inset CommandInset label
4305 name "sec:International-Keymap-Stuff"
4312 \begin_layout Standard
4313 \begin_inset Note Note
4316 \begin_layout Plain Layout
4317 In doing the revisions on this document in March 2008, I did not look over
4318 this stuff, as I do not understand it.
4319 It would be good if someone else could do so.
4328 \begin_layout Standard
4329 The next two sections describe the
4330 \begin_inset Flex Code
4333 \begin_layout Plain Layout
4342 \begin_inset Flex Code
4345 \begin_layout Plain Layout
4353 file syntax in detail.
4354 These sections should help you design your own key map if the ones provided
4355 do not meet your needs.
4358 \begin_layout Subsection
4362 \begin_layout Standard
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4375 file maps keystrokes to characters or strings.
4376 As the name suggests, it sets a keyboard mapping.
4378 \begin_inset Flex Code
4381 \begin_layout Plain Layout
4392 \begin_inset Flex Code
4395 \begin_layout Plain Layout
4410 \begin_inset Flex Code
4413 \begin_layout Plain Layout
4426 \begin_inset Flex Code
4429 \begin_layout Plain Layout
4438 \begin_inset Flex Code
4441 \begin_layout Plain Layout
4449 are described in this section.
4452 \begin_layout Labeling
4453 \labelwidthstring 00.00.0000
4454 \begin_inset Flex Code
4457 \begin_layout Plain Layout
4465 Map a character to a string
4468 \begin_layout LyX-Code
4483 \begin_layout Standard
4516 the double-quote (")
4533 must be escaped with a preceding backslash (
4544 \begin_layout Standard
4546 \begin_inset Flex Noun
4549 \begin_layout Plain Layout
4557 statement to cause the symbol
4558 \begin_inset Flex Noun
4561 \begin_layout Plain Layout
4569 to be output for the keystroke
4570 \begin_inset Flex Noun
4573 \begin_layout Plain Layout
4584 \begin_layout LyX-Code
4590 \begin_layout Labeling
4591 \labelwidthstring 00.00.0000
4592 \begin_inset Flex Code
4595 \begin_layout Plain Layout
4603 Specify an accent character
4606 \begin_layout LyX-Code
4615 \begin_layout Standard
4616 This will make the cha
4654 This is the dead key
4658 \begin_layout Plain Layout
4665 refers to a key that does not produce a character by itself, but when followed
4666 with another key, produces the desired accent character.
4667 For example, a German characte
4669 r with an umlaut like
4679 can be produced in this manner.
4688 \begin_layout Standard
4701 and then another key not in
4718 followed by the other, not allowed key, as output.
4722 \begin_inset Flex Noun
4725 \begin_layout Plain Layout
4733 cancels a dead key, so if
4744 \begin_inset Flex Noun
4747 \begin_layout Plain Layout
4756 , the cursor will not go one position backwards but will instead cancel
4772 might have had on the next keystroke.
4776 \begin_layout Standard
4777 The following example specifies that the character ' is to be an acute accent,
4778 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4781 \begin_layout LyX-Code
4784 kmod ' acute aeiouAEIOU
4787 \begin_layout Labeling
4788 \labelwidthstring 00.00.0000
4789 \begin_inset Flex Code
4792 \begin_layout Plain Layout
4798 Specify an exception to the accent character
4801 \begin_layout LyX-Code
4810 \begin_layout Standard
4811 This defines an exce
4852 have been assigned a keystroke with a previous
4855 \begin_inset Flex Code
4858 \begin_layout Plain Layout
4882 must not belong in the
4929 If such a declaration does not exist in
4937 \begin_inset Flex Code
4940 \begin_layout Plain Layout
4974 \begin_inset Flex Code
4977 \begin_layout Plain Layout
4991 \begin_layout Standard
4992 The following command produces causes äi to be produced when you enter acute-i
4996 \begin_layout LyX-Code
5010 \begin_layout Labeling
5011 \labelwidthstring 00.00.0000
5012 \begin_inset Flex Code
5015 \begin_layout Plain Layout
5021 Combine two accent characters
5024 \begin_layout LyX-Code
5030 accent1 accent2 allowed
5033 \begin_layout Standard
5034 This one is getting pretty esoteric.
5035 It allows you to combine the effect
5091 \begin_inset Flex Code
5094 \begin_layout Plain Layout
5122 \begin_layout Standard
5123 Consider this example from the
5124 \begin_inset Flex Code
5127 \begin_layout Plain Layout
5138 \begin_layout LyX-Code
5141 kmod ; acute aeioyvhAEIOYVH
5145 kcomb acute umlaut iyIY
5148 \begin_layout Standard
5149 This allows you to press
5150 \begin_inset Flex Noun
5153 \begin_layout Plain Layout
5161 and get the effect of
5162 \begin_inset Flex Code
5165 \begin_layout Plain Layout
5184 in this case cancels the last dead key, so if you press
5185 \begin_inset Flex Noun
5188 \begin_layout Plain Layout
5197 \begin_inset Flex Code
5200 \begin_layout Plain Layout
5213 \begin_layout Subsection
5217 \begin_layout Standard
5219 \begin_inset Flex Code
5222 \begin_layout Plain Layout
5230 mapping is performed, a
5231 \begin_inset Flex Code
5234 \begin_layout Plain Layout
5244 file maps the strings that the symbols generate to characters in the current
5246 The \SpecialChar LyX
5247 distribution currently includes at least the
5248 \begin_inset Flex Code
5251 \begin_layout Plain Layout
5260 \begin_inset Flex Code
5263 \begin_layout Plain Layout
5274 \begin_layout Standard
5276 \begin_inset Flex Code
5279 \begin_layout Plain Layout
5287 file is a sequence of declarations of the form
5290 \begin_layout LyX-Code
5303 \begin_layout Standard
5304 For example, in order to map
5305 \begin_inset Flex Noun
5308 \begin_layout Plain Layout
5318 to the corresponding character in the iso-8859-1 set (233), the following
5322 \begin_layout LyX-Code
5330 \begin_layout Standard
5332 \begin_inset Flex Code
5335 \begin_layout Plain Layout
5344 \begin_inset Flex Code
5347 \begin_layout Plain Layout
5365 the same character can apply to more than one string.
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5381 \begin_layout LyX-Code
5393 \begin_inset Newline newline
5409 \begin_layout Standard
5411 cannot find a mapping for the string produced by the keystroke or a
5412 deadkey sequence, it will check if it looks like an accented char and try
5413 to draw an accent over the character on screen.
5416 \begin_layout Subsection
5420 \begin_layout Standard
5421 There is a second way to add support for international characters through
5422 so-called dead-keys.
5423 A dead-key works in combination with a letter to produce an accented character.
5424 Here, we'll explain how to create a really simple dead-key to illustrate
5428 \begin_layout Standard
5429 Suppose you happen to need the circumflex character,
5430 \begin_inset Quotes eld
5434 \begin_inset Quotes erd
5439 \begin_inset Flex Noun
5442 \begin_layout Plain Layout
5449 \begin_inset space ~
5453 \begin_inset Flex Noun
5456 \begin_layout Plain Layout
5462 ] to the \SpecialChar LyX
5464 \begin_inset Flex Code
5467 \begin_layout Plain Layout
5474 \begin_inset Flex Code
5477 \begin_layout Plain Layout
5484 Now, whenever you type the
5485 \begin_inset Flex Noun
5488 \begin_layout Plain Layout
5494 -key followed by a letter, that letter will have a circumflex accent on
5496 For example, the sequence
5497 \begin_inset Quotes eld
5501 \begin_inset Flex Noun
5504 \begin_layout Plain Layout
5511 \begin_inset Quotes erd
5514 produces the letter:
5515 \begin_inset Quotes eld
5519 \begin_inset Quotes erd
5523 If you tried to type
5524 \begin_inset Quotes eld
5528 \begin_inset Flex Noun
5531 \begin_layout Plain Layout
5538 \begin_inset Quotes erd
5541 , however, \SpecialChar LyX
5542 will complain with a beep, since a
5543 \begin_inset Quotes eld
5547 \begin_inset Flex Noun
5550 \begin_layout Plain Layout
5557 \begin_inset Quotes erd
5560 never takes a circumflex accent.
5562 \begin_inset Flex Noun
5565 \begin_layout Plain Layout
5571 after a dead-key produces the bare-accent.
5572 Please note this last point! If you bind a key to a dead-key, you'll need
5573 to rebind the character on that key to yet another key.
5575 \begin_inset Flex Noun
5578 \begin_layout Plain Layout
5584 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5587 \begin_layout Standard
5588 One common way to bind dead-keys is to use
5589 \begin_inset Flex Noun
5592 \begin_layout Plain Layout
5599 \begin_inset Flex Noun
5602 \begin_layout Plain Layout
5609 \begin_inset Flex Noun
5612 \begin_layout Plain Layout
5618 in combination with an accent, like
5619 \begin_inset Quotes eld
5623 \begin_inset Flex Noun
5626 \begin_layout Plain Layout
5633 \begin_inset Quotes erd
5637 \begin_inset Quotes eld
5641 \begin_inset Flex Noun
5644 \begin_layout Plain Layout
5651 \begin_inset Quotes erd
5655 \begin_inset Quotes eld
5659 \begin_inset Flex Noun
5662 \begin_layout Plain Layout
5669 \begin_inset Quotes erd
5673 Another way involves using
5674 \begin_inset Flex Code
5677 \begin_layout Plain Layout
5684 \begin_inset Flex Code
5687 \begin_layout Plain Layout
5693 to set up the special
5694 \begin_inset Flex Code
5697 \begin_layout Plain Layout
5705 \begin_inset Flex Code
5708 \begin_layout Plain Layout
5714 acts in some ways just like
5715 \begin_inset Flex Noun
5718 \begin_layout Plain Layout
5724 and permits you to bind keys to accented characters.
5725 You can also turn keys into dead-keys by binding them to something like
5727 \begin_inset Flex Code
5730 \begin_layout Plain Layout
5736 and then binding this symbolic key to the corresponding \SpecialChar LyX
5741 \begin_layout Plain Layout
5746 : This is exactly what I do in my
5747 \begin_inset Flex Code
5750 \begin_layout Plain Layout
5757 \begin_inset Flex Code
5760 \begin_layout Plain Layout
5768 \begin_inset Flex Noun
5771 \begin_layout Plain Layout
5773 \begin_inset space ~
5782 \begin_inset Flex Code
5785 \begin_layout Plain Layout
5791 and a bunch of these
5792 \begin_inset Quotes eld
5796 \begin_inset Flex Code
5799 \begin_layout Plain Layout
5806 \begin_inset Quotes erd
5809 symbolic keys bound such things as
5810 \begin_inset Flex Noun
5813 \begin_layout Plain Layout
5815 \begin_inset space ~
5824 \begin_inset Flex Noun
5827 \begin_layout Plain Layout
5829 \begin_inset space ~
5838 This is how I produce my accented characters.
5843 You can make just about anything into the
5844 \begin_inset Flex Code
5847 \begin_layout Plain Layout
5854 \begin_inset Flex Noun
5857 \begin_layout Plain Layout
5863 keys, a spare function key, etc.
5864 As for the \SpecialChar LyX
5865 commands that produce accents, check the entry for
5866 \begin_inset Flex Code
5869 \begin_layout Plain Layout
5880 You'll find the complete list there.
5883 \begin_layout Subsection
5884 Saving your Language Configuration
5887 \begin_layout Standard
5888 You can edit your preferences so that your desired language environment
5889 is automatically configured when \SpecialChar LyX
5891 \begin_inset Flex Noun
5894 \begin_layout Plain Layout
5895 Edit\SpecialChar menuseparator
5904 \begin_layout Chapter
5905 Installing New Document Classes, Layouts, and Templates
5906 \begin_inset CommandInset label
5908 name "cha:Installing-New-Document"
5913 \begin_inset Argument 1
5916 \begin_layout Plain Layout
5917 Installing New Document Classes
5925 \begin_layout Standard
5926 In this chapter, we describe the procedures for creating and installing
5927 new \SpecialChar LyX
5928 layout and template files, as well as offer a refresher on correctly
5929 installing new \SpecialChar LaTeX
5934 \begin_layout Standard
5935 First, let us a say a few words about how one ought to think about the relation
5936 between \SpecialChar LyX
5937 and \SpecialChar LaTeX
5939 The thing to understand is that, in a certain sense, \SpecialChar LyX
5940 doesn't know anything
5941 about \SpecialChar LaTeX
5943 Indeed, from \SpecialChar LyX
5944 's point of view, \SpecialChar LaTeX
5945 is just one of several
5946 \begin_inset Quotes eld
5950 \begin_inset Quotes erd
5953 in which it is capable of producing output.
5954 Other such formats are DocBook, plaintext, and XHTML.
5956 is, of course, a particularly important format, but very little of the
5957 information \SpecialChar LyX
5958 has about \SpecialChar LaTeX
5959 is actually contained in the program itself.
5963 \begin_layout Plain Layout
5964 Some commands are sufficiently complex that they are
5965 \begin_inset Quotes eld
5969 \begin_inset Quotes erd
5972 into \SpecialChar LyX
5974 But the developers generally regard this as a Bad Thing.
5979 Rather, that information, even for the standard classes like
5980 \begin_inset Flex Code
5983 \begin_layout Plain Layout
5989 , is contained in `layout files'.
5990 Similarly, \SpecialChar LyX
5991 itself does not know much about DocBook or XHTML.
5992 What it knows is contained in layout files.
5995 \begin_layout Standard
5996 You can think of the layout file for a given document class as a translation
5997 manual between \SpecialChar LyX
5998 constructs—paragraphs with their corresponding styles,
5999 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6002 Almost everything \SpecialChar LyX
6004 \begin_inset Flex Code
6007 \begin_layout Plain Layout
6013 , for example, is contained in the file
6014 \begin_inset Flex Code
6017 \begin_layout Plain Layout
6023 and in various other files it includes.
6024 For this reason, anyone intending to write layout files should plan to
6025 study the existing files.
6026 A good place to start is with
6027 \begin_inset Flex Code
6030 \begin_layout Plain Layout
6036 , which is included in
6037 \begin_inset Flex Code
6040 \begin_layout Plain Layout
6047 \begin_inset Flex Code
6050 \begin_layout Plain Layout
6056 , and many of the other layout files for document classes.
6057 This file is where sections and the like are defined:
6058 \begin_inset Flex Code
6061 \begin_layout Plain Layout
6067 tells \SpecialChar LyX
6068 how paragraphs that are marked with the Section, Subsection, etc,
6069 styles can be translated into corresponding \SpecialChar LaTeX
6070 , DocBook, and XHTML commands
6073 \begin_inset Flex Code
6076 \begin_layout Plain Layout
6082 file basically just includes several of these
6083 \begin_inset Flex Code
6086 \begin_layout Plain Layout
6095 \begin_layout Standard
6096 Defining the \SpecialChar LyX
6098 correspondence is not the only thing layout files do, though.
6099 Their other job is to define how the \SpecialChar LyX
6100 constructs themselves will appear
6102 The fact that layout files have these two jobs is often a source of confusion,
6103 because they are completely separate.
6104 Telling \SpecialChar LyX
6105 how to translate a certain paragraph style into \SpecialChar LaTeX
6108 how to display it; conversely, telling \SpecialChar LyX
6109 how to display a certain paragraph
6110 style does not tell \SpecialChar LyX
6111 how to translate it into \SpecialChar LaTeX
6112 (let alone tell \SpecialChar LaTeX
6115 So, in general, when you define a new \SpecialChar LyX
6116 construct, you must always do two
6117 quite separate things: (i)
6118 \begin_inset space ~
6121 tell \SpecialChar LyX
6122 how to translate it into \SpecialChar LaTeX
6124 \begin_inset space ~
6127 tell \SpecialChar LyX
6131 \begin_layout Standard
6132 Much the same is true, of course, as regards \SpecialChar LyX
6133 's other backend formats, though
6134 XHTML is in some ways different, because in that case \SpecialChar LyX
6139 able, to some extent, to use information about how it should display a
6140 paragraph on the screen to output information (in the form of CSS) about
6141 how the paragraph should be displayed in a browser.
6142 Even in this case, however, the distinction between what \SpecialChar LyX
6144 and how things are rendered externally remains in force, and the two can
6145 be controlled separately.
6147 \begin_inset CommandInset ref
6149 reference "sec:Tags-for-XHTML"
6156 \begin_layout Section
6157 Installing new \SpecialChar LaTeX
6161 \begin_layout Standard
6162 Some installations may not include a \SpecialChar LaTeX
6163 package or class file that you would
6164 like to use within \SpecialChar LyX
6166 For example, you might need Foil\SpecialChar TeX
6167 , a package for preparing slides for overhead
6169 Modern \SpecialChar LaTeX
6170 distributions like \SpecialChar TeX
6171 Live (2008 or newer) or MiK\SpecialChar TeX
6172 provide a user interface
6173 for installing such packages.
6174 For example, with MiK\SpecialChar TeX
6175 , you start the program
6176 \begin_inset Quotes eld
6180 \begin_inset space ~
6184 \begin_inset Quotes erd
6187 to get a list of available packages.
6188 To install one of them, right click on it or use the corresponding toolbar
6192 \begin_layout Standard
6193 If your \SpecialChar LaTeX
6194 distribution does not provide such a `package manager', or if the
6195 package is not available from your distribution, then follow these steps
6196 to install it manually:
6199 \begin_layout Enumerate
6200 Get the package from
6201 \begin_inset CommandInset href
6204 target "http://www.ctan.org/"
6212 \begin_layout Enumerate
6213 If the package contains a file with the ending
6214 \begin_inset Quotes eld
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6228 \begin_inset Quotes erd
6231 (is the case for Foil\SpecialChar TeX
6232 ) then open a console, change to the folder of this
6233 file and execute the command
6234 \begin_inset Flex Code
6237 \begin_layout Plain Layout
6244 You have now unpacked the package and have all files to install it.
6245 Most \SpecialChar LaTeX
6246 -packages are not packed and you can skip this step.
6249 \begin_layout Enumerate
6250 Now you need to decide if the package should be available for all users
6255 \begin_layout Enumerate
6256 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6257 for all users on your system, then install it in your `local' \SpecialChar TeX
6259 install it in your own `user' \SpecialChar TeX
6261 Where these trees should be created, if they do not already exist, depends
6263 To find this out, look in the file
6264 \begin_inset Flex Code
6267 \begin_layout Plain Layout
6277 \begin_layout Plain Layout
6278 This is usually in the directory
6279 \begin_inset Flex Code
6282 \begin_layout Plain Layout
6288 , though you can execute the command
6289 \begin_inset Flex Code
6292 \begin_layout Plain Layout
6303 The location of the `local' \SpecialChar TeX
6304 tree is defined by the
6305 \begin_inset Flex Code
6308 \begin_layout Plain Layout
6314 variable; this is usually somewhere like
6315 \begin_inset Flex Code
6318 \begin_layout Plain Layout
6319 /usr/local/share/texmf
6324 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6327 The location of the `user' \SpecialChar TeX
6329 \begin_inset Flex Code
6332 \begin_layout Plain Layout
6339 \begin_inset Flex Code
6342 \begin_layout Plain Layout
6349 \begin_inset Flex Code
6352 \begin_layout Plain Layout
6361 (If these variables are not predefined, you have to define them.) You'll
6362 probably need root permissions to create or modify the `local' tree, but
6363 not for your `user' tree.
6364 \begin_inset Newline newline
6367 In general, it is recommended to install in the user tree because your user
6368 will not be modified or even overwritten when you upgrade your system.
6369 It will typically also be backed up together with everything else when
6370 you backup your home directory (which, of course, you do on a regular basis).
6373 \begin_layout Enumerate
6374 On Windows, if you want the new package to be available for all users on
6375 your system, change to the folder where \SpecialChar LaTeX
6376 is installed and then change to
6378 \begin_inset Flex Code
6381 \begin_layout Plain Layout
6392 (For MiK\SpecialChar TeX
6393 , this would be by default the folder
6394 \begin_inset Flex Code
6397 \begin_layout Plain Layout
6415 \begin_layout Plain Layout
6416 Note that this will be the correct path only on English installations.
6417 On a German one, it would be
6418 \begin_inset Flex Code
6421 \begin_layout Plain Layout
6435 , and similarly for other languages.
6440 Create there a new folder
6441 \begin_inset Flex Code
6444 \begin_layout Plain Layout
6450 and copy all files of the package into it.
6452 \begin_inset Newline newline
6455 If the package should only available for you or you don't have admin permissions
6456 , do the same, but in the local \SpecialChar LaTeX
6459 \begin_inset space \thinspace{}
6462 g., for MiK\SpecialChar TeX
6464 \begin_inset space ~
6467 2.8 under Windows XP, this would be the folder:
6468 \begin_inset Newline newline
6474 \begin_inset Flex Code
6477 \begin_layout Plain Layout
6480 Documents and Settings
6492 \begin_inset Newline newline
6498 \begin_inset Phantom HPhantom
6501 \begin_layout Plain Layout
6512 \begin_inset Flex Code
6515 \begin_layout Plain Layout
6528 \begin_inset Newline newline
6531 On Vista, it would be:
6532 \begin_inset Newline newline
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6565 \begin_layout Enumerate
6566 Now one only need to tell \SpecialChar LaTeX
6567 that there are new files.
6568 This depends on the used \SpecialChar LaTeX
6573 \begin_layout Enumerate
6574 For \SpecialChar TeX
6575 Live execute the command
6576 \begin_inset Flex Code
6579 \begin_layout Plain Layout
6586 If you installed the package for all users, then you will probably need
6587 to have root permissions for that.
6590 \begin_layout Enumerate
6591 For MiK\SpecialChar TeX
6592 , if you have installed the package for all users, start the program
6594 \begin_inset Quotes eld
6598 \begin_inset space ~
6602 \begin_inset Quotes erd
6605 and press the button marked
6606 \begin_inset Quotes eld
6610 \begin_inset Quotes erd
6614 Otherwise start the program
6615 \begin_inset Quotes eld
6619 \begin_inset Quotes erd
6626 \begin_layout Enumerate
6627 Finally, you need to tell \SpecialChar LyX
6628 that there are new packages available.
6629 So, in \SpecialChar LyX
6631 \begin_inset Flex Noun
6634 \begin_layout Plain Layout
6637 \SpecialChar menuseparator
6643 and then restart \SpecialChar LyX
6647 \begin_layout Standard
6648 Now the package is installed.
6649 In our example, the document class
6650 \begin_inset Flex Code
6653 \begin_layout Plain Layout
6659 will now be available under
6660 \begin_inset Flex Noun
6663 \begin_layout Plain Layout
6664 Document\SpecialChar menuseparator
6665 Settings\SpecialChar menuseparator
6672 \begin_inset Quotes eld
6676 \begin_inset Quotes erd
6683 \begin_layout Standard
6684 If you would like to use a \SpecialChar LaTeX
6685 document class that is not even listed in the
6687 \begin_inset Flex Noun
6690 \begin_layout Plain Layout
6691 Document\SpecialChar menuseparator
6692 Settings\SpecialChar menuseparator
6698 , then you need to create a `layout' file for it.
6699 That is the topic of the next section.
6702 \begin_layout Section
6703 Types of layout files
6706 \begin_layout Standard
6707 This section describes the various sorts of \SpecialChar LyX
6708 files that contain layout informati
6710 These files describe various paragraph and character styles, determining
6711 how \SpecialChar LyX
6712 should display them and how they should be translated into \SpecialChar LaTeX
6714 XHTML, or whatever output format is being used.
6718 \begin_layout Standard
6719 We shall try to provide a thorough description of the process of writing
6721 However, there are so many different types of documents supported even
6722 by just \SpecialChar LaTeX
6723 that we can't hope to cover every different possibility or problem
6724 you might encounter.
6725 The \SpecialChar LyX
6726 users' list is frequented by people with lots of experience with layout
6727 design who are willing to share what they've learned, so please feel free
6728 to ask questions there.
6731 \begin_layout Standard
6732 As you prepare to write a new layout, it is extremely helpful to look at
6733 the layouts distributed with \SpecialChar LyX
6735 If you write a \SpecialChar LyX
6736 layout for a \SpecialChar LaTeX
6737 document class that might also be used by
6738 others, or write a module that might be useful to others, then you should
6739 consider posting your layout to the
6740 \begin_inset CommandInset href
6742 name "layout section on the LyX wiki"
6743 target "https://wiki.lyx.org/Layouts/Layouts"
6748 or even to the \SpecialChar LyX
6749 developers' list, so that it might be included in \SpecialChar LyX
6754 \begin_layout Plain Layout
6755 Note that \SpecialChar LyX
6756 is licensed under the General Public License, so any material
6757 that is contributed to \SpecialChar LyX
6758 must be similarly licensed.
6766 \begin_layout Subsection
6768 \begin_inset CommandInset label
6770 name "subsec:Layout-modules"
6777 \begin_layout Standard
6778 We have spoken to this point about `layout files'.
6779 But there are different sorts of files that contain layout information.
6780 Layout files, strictly so called, have the
6781 \begin_inset Flex Code
6784 \begin_layout Plain Layout
6790 extension and provide \SpecialChar LyX
6791 with information about document classes.
6792 Since \SpecialChar LyX
6793 1.6 layout information can also be contained in layout
6798 \begin_inset Flex Code
6801 \begin_layout Plain Layout
6808 Modules are to \SpecialChar LaTeX
6809 packages much as layouts are to \SpecialChar LaTeX
6810 classes, and some modules—such
6812 \begin_inset Flex Code
6815 \begin_layout Plain Layout
6821 module—specifically provide support for one package.
6822 In a sense, layout modules are similar to included
6826 \begin_layout Plain Layout
6827 These can have any extension, but by convention have the
6828 \begin_inset Flex Code
6831 \begin_layout Plain Layout
6843 \begin_inset Flex Code
6846 \begin_layout Plain Layout
6852 —in that modules are not specific to a given document class but may be used
6853 with many different classes.
6854 The difference is that using an included file with
6855 \begin_inset Flex Code
6858 \begin_layout Plain Layout
6864 requires editing that file.
6865 Modules, by contrast, are selected in the
6866 \begin_inset Flex Noun
6869 \begin_layout Plain Layout
6870 Document\SpecialChar menuseparator
6879 \begin_layout Standard
6880 Building modules is the easiest way to get started with layout editing,
6881 since it can be as simple as adding a single new paragraph style or flex
6883 But modules may, in principle, contain anything a layout file can contain.
6886 \begin_layout Standard
6887 After creating a new module and copying it to the
6888 \begin_inset Flex Code
6891 \begin_layout Plain Layout
6897 folder, you will need to reconfigure and then restart \SpecialChar LyX
6900 However, changes you make to the module will be seen immediately, if you
6902 \begin_inset Flex Noun
6905 \begin_layout Plain Layout
6906 Document\SpecialChar menuseparator
6912 , highlight something, and then hit
6913 \begin_inset Quotes eld
6917 \begin_inset Quotes erd
6923 It is strongly recommended that you save your work before doing this
6928 it is strongly recommended that you not attempt to edit modules while simultaneo
6929 usly working on actual documents
6932 Though of course the developers strive to keep \SpecialChar LyX
6933 stable in such situations,
6934 syntax errors and the like in your module file could cause strange behavior.
6937 \begin_layout Subsubsection
6941 \begin_layout Standard
6942 Modules are to \SpecialChar LyX
6943 as packages are to \SpecialChar LaTeX
6945 Sometimes, however, you find yourself wanting a specific inset or character
6946 style just for one document and writing a module that will also be available
6947 to other documents makes little sense.
6948 What you need is \SpecialChar LyX
6950 \begin_inset Quotes eld
6954 \begin_inset Quotes erd
6960 \begin_layout Standard
6961 You will find it under
6963 Document\SpecialChar menuseparator
6964 Settings\SpecialChar menuseparator
6968 The large text box allows you to enter anything that you might enter in
6969 a layout file or module.
6970 You can think of a document's local layout, in fact, as a module that belongs
6972 So, in particular, you must enter a
6973 \begin_inset Flex Code
6976 \begin_layout Plain Layout
6983 Any format is acceptable, but one would normally use the format current
6985 (In \SpecialChar LyX
6992 , the current layout format is
7001 \begin_layout Standard
7002 When you have entered something in the
7003 \begin_inset Flex Code
7006 \begin_layout Plain Layout
7012 pane, \SpecialChar LyX
7014 \begin_inset Quotes eld
7018 \begin_inset Quotes erd
7021 button at the bottom.
7022 Clicking this button will cause \SpecialChar LyX
7023 to determine whether what you have entered
7024 is valid layout information for the chosen format.
7026 will report the result but, unfortunately, will not tell you what errors
7027 there might have been.
7028 These will be written to the terminal, however, if \SpecialChar LyX
7029 is started from a terminal.
7030 You will not be permitted to save your local layout until you have entered
7034 \begin_layout Standard
7035 The warnings at the end of the previous section apply here, too.
7036 Do not play with local layout while you are actually working, especially
7037 if you have not saved your document.
7038 That said, using local layout with a test document can be a very convenient
7039 way to try out layout ideas, or even to start developing a module.
7042 \begin_layout Subsection
7044 \begin_inset Flex Noun
7047 \begin_layout Plain Layout
7056 \begin_layout Standard
7057 There are two situations you are likely to encounter when wanting to support
7058 a new \SpecialChar LaTeX
7059 document class, involving style (
7060 \begin_inset Flex Code
7063 \begin_layout Plain Layout
7069 ) files and \SpecialChar LaTeX2e
7071 \begin_inset Flex Code
7074 \begin_layout Plain Layout
7081 Supporting a style file is usually fairly easy.
7082 Supporting a new class file is a bit harder.
7083 We'll discuss the former in this section and the latter in the next.
7085 \change_deleted 5863208 1594239023
7086 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7091 \begin_layout Standard
7092 The easier case is the one in which your new document class is provided
7093 as a style file that is to be used in conjunction with an already supported
7095 For the sake of the example, we'll assume that the style file is called
7097 \begin_inset Flex Noun
7100 \begin_layout Plain Layout
7106 and that it is meant to be used with
7107 \begin_inset Flex Noun
7110 \begin_layout Plain Layout
7116 , which is a standard class.
7120 \begin_layout Standard
7121 Start by copying the existing class's layout file into your local directory:
7125 \begin_layout Plain Layout
7126 Of course, which directory is your local directory will vary by platform,
7127 and \SpecialChar LyX
7128 allows you to specify your local directory on startup, too, using
7130 \begin_inset Flex Code
7133 \begin_layout Plain Layout
7147 \begin_layout LyX-Code
7148 cp report.layout ~/.lyx/layouts/myclass.layout
7151 \begin_layout Standard
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7162 and change the line:
7165 \begin_layout LyX-Code
7168 DeclareLaTeXClass{Report (Standard Class)}
7171 \begin_layout Standard
7175 \begin_layout LyX-Code
7178 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7181 \begin_layout Standard
7185 \begin_layout LyX-Code
7187 \begin_inset Newline newline
7193 \begin_inset Newline newline
7199 \begin_layout Standard
7200 near the top of the file.
7203 \begin_layout Standard
7204 Start \SpecialChar LyX
7206 \begin_inset Flex Noun
7209 \begin_layout Plain Layout
7210 Tools\SpecialChar menuseparator
7217 Then restart \SpecialChar LyX
7218 and try creating a new document.
7220 \begin_inset Flex Noun
7223 \begin_layout Plain Layout
7229 " as a document class option in the
7230 \begin_inset Flex Noun
7233 \begin_layout Plain Layout
7234 Document\SpecialChar menuseparator
7241 It is likely that some of the sectioning commands and such in your new
7242 class will work differently from how they worked in the base class—
7243 \begin_inset Flex Code
7246 \begin_layout Plain Layout
7252 in this example—so you can fiddle around with the settings for the different
7253 sections if you wish.
7254 The layout information for sections is contained in
7255 \begin_inset Flex Code
7258 \begin_layout Plain Layout
7264 , but you do not need to copy and change this file.
7265 Instead, you can simply add your changes to your layout file, after the
7267 \begin_inset Flex Code
7270 \begin_layout Plain Layout
7276 , which itself includes
7277 \begin_inset Flex Code
7280 \begin_layout Plain Layout
7287 For example, you might add these lines:
7290 \begin_layout LyX-Code
7294 \begin_layout LyX-Code
7298 \begin_layout LyX-Code
7302 \begin_layout LyX-Code
7306 \begin_layout LyX-Code
7310 \begin_layout Standard
7311 to change the font for chapter headings to sans-serif.
7312 This will override (or, in this case, add to) the existing declaration
7313 for the Chapter style.
7317 \begin_layout Standard
7318 Your new package may also provide commands or environments not present in
7320 In this case, you will want to add these to the layout file.
7322 \begin_inset CommandInset ref
7324 reference "sec:TextClass"
7328 for information on how to do so.
7331 \begin_layout Standard
7333 \begin_inset Flex Noun
7336 \begin_layout Plain Layout
7342 can be used with several different document classes, and even if it cannot,
7343 you might find it easiest just to write a module that you can load with
7345 The simplest possible such module would be:
7348 \begin_layout LyX-Code
7351 DeclareLyXModule{My Class}
7354 \begin_layout LyX-Code
7358 \begin_layout LyX-Code
7359 #Support for myclass.sty.
7362 \begin_layout LyX-Code
7364 \begin_inset Newline newline
7370 \begin_layout LyX-Code
7378 \begin_inset Newline newline
7384 \begin_layout LyX-Code
7386 \begin_inset Newline newline
7392 \begin_inset Newline newline
7398 \begin_layout Standard
7399 A more complex module might modify the behavior of some existing constructs
7400 or define some new ones.
7402 \begin_inset CommandInset ref
7404 reference "sec:TextClass"
7411 \begin_layout Subsection
7413 \begin_inset Flex Noun
7416 \begin_layout Plain Layout
7425 \begin_layout Standard
7426 There are two possibilities here.
7427 One is that the class file is itself based upon an existing document class.
7428 For example, many thesis classes are based upon
7429 \begin_inset Flex Noun
7432 \begin_layout Plain Layout
7439 To see whether yours is, look for a line like
7442 \begin_layout LyX-Code
7448 \begin_layout Standard
7450 If so, then you may proceed largely as in the previous section, though
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7456 Declare\SpecialChar LaTeX
7462 line will be different.
7463 If your new class is
7464 \begin_inset Flex Code
7467 \begin_layout Plain Layout
7473 and it is based upon
7474 \begin_inset Flex Code
7477 \begin_layout Plain Layout
7483 , then the line should read:
7487 \begin_layout Plain Layout
7488 And it will be easiest if you save the file to
7489 \begin_inset Flex Code
7492 \begin_layout Plain Layout
7499 assumes that the document class has the same name as the layout file.
7508 \begin_layout LyX-Code
7511 DeclareLaTeXClass[thesis,book]{thesis}
7514 \begin_layout Standard
7515 If, on the other hand, the new class is not based upon an existing class,
7516 you will probably have to
7517 \begin_inset Quotes eld
7521 \begin_inset Quotes erd
7525 We strongly suggest copying an existing layout file which uses a similar
7527 class and then modifying it, if you can do so.
7528 At least use an existing file as a starting point so you can find out what
7529 items you need to worry about.
7530 Again, the specifics are covered below.
7533 \begin_layout Subsection
7535 \begin_inset CommandInset label
7537 name "subsec:Creating-Templates"
7544 \begin_layout Standard
7545 Once you have written a layout file for a new document class, you might
7546 want to consider writing a
7551 A template acts as a kind of tutorial for your layout, showing how it might
7552 be used, though containing dummy content.
7553 You can of course look at the various templates included with \SpecialChar LyX
7557 \begin_layout Standard
7558 Templates are created just like usual documents: using \SpecialChar LyX
7560 The only difference is that usual documents contain all possible settings,
7561 including the font scheme and the paper size.
7562 Usually a user doesn't want a template to overwrite his preferred settings
7563 for such parameters.
7564 For that reason, the designer of a template should remove the corresponding
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7578 \begin_inset Flex Code
7581 \begin_layout Plain Layout
7589 from the template \SpecialChar LyX
7591 This can be done with any simple text-editor, for example
7592 \begin_inset Flex Code
7595 \begin_layout Plain Layout
7602 \begin_inset Flex Code
7605 \begin_layout Plain Layout
7614 \begin_layout Standard
7615 Put the edited template files you create in
7616 \begin_inset Flex Code
7619 \begin_layout Plain Layout
7625 , copy the ones you use from the global template directory in
7626 \begin_inset Flex Code
7629 \begin_layout Plain Layout
7635 to the same place, and redefine the template path in the
7636 \begin_inset Flex Noun
7639 \begin_layout Plain Layout
7640 Tools\SpecialChar menuseparator
7641 Preferences\SpecialChar menuseparator
7650 \begin_layout Standard
7651 Note, by the way, that there is a template which has a particular meaning:
7652 \begin_inset Newline linebreak
7656 \begin_inset Flex Code
7659 \begin_layout Plain Layout
7666 This template is loaded every time you create a new document with
7667 \begin_inset Flex Noun
7670 \begin_layout Plain Layout
7671 File\SpecialChar menuseparator
7677 in order to provide useful defaults.
7678 To create this template from inside \SpecialChar LyX
7679 , all you have to do is to open a document
7680 with the correct settings, and use the
7681 \begin_inset Flex Noun
7684 \begin_layout Plain Layout
7685 Save as Document Defaults
7693 \begin_layout Subsection
7694 Upgrading old layout files
7697 \begin_layout Standard
7698 The format of layout files changes with each \SpecialChar LyX
7699 release, so old layout files
7700 need to be converted to the new format.
7702 reads a layout file in an older format, it automatically calls the
7704 \begin_inset Flex Code
7707 \begin_layout Plain Layout
7713 to convert it to a temporary file in current format.
7714 The original file is left untouched.
7715 If you use the layout file often, then, you may want to convert it permanently,
7716 so that \SpecialChar LyX
7717 does not have to do so itself every time.
7718 To do this, you can call the converter manually:
7721 \begin_layout Enumerate
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7733 \begin_inset Flex Code
7736 \begin_layout Plain Layout
7745 \begin_layout Enumerate
7747 \begin_inset Newline newline
7751 \begin_inset Flex Code
7754 \begin_layout Plain Layout
7755 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7761 \begin_inset Newline newline
7765 \begin_inset Flex Code
7768 \begin_layout Plain Layout
7774 is the name of your \SpecialChar LyX
7778 \begin_layout Standard
7779 Note that manual conversion does not affect included files, so these will
7780 have to be converted separately.
7783 \begin_layout Subsection
7784 \begin_inset CommandInset label
7786 name "subsec:Cite-Engine-Files"
7793 \begin_layout Standard
7794 A specific form of layout files are the so-called
7795 \begin_inset Flex Code
7798 \begin_layout Plain Layout
7804 files that are located in the
7805 \begin_inset Flex Code
7808 \begin_layout Plain Layout
7815 Their purpose is to define the specifics of \SpecialChar LaTeX
7816 packages aimed at bibliography
7829 , but also the way how normal Bib\SpecialChar TeX
7830 citations (without additional packages)
7831 are handled in \SpecialChar LyX
7832 is defined in such a file.
7836 \begin_layout Standard
7837 More specifically, it is defined which packages \SpecialChar LyX
7838 needs to load, which citation
7839 commands are available, how these are to be displayed in \SpecialChar LyX
7841 the dialogs, the context menus) as well as in the XHTML and plain text
7843 Furthermore, the files specify available style variants (author-year, numerical
7844 , etc.) and their specifics.
7845 The cite engine files are also used to generate the options that are available
7848 Document\SpecialChar menuseparator
7849 Settings\SpecialChar menuseparator
7850 Bibliography\SpecialChar menuseparator
7856 \begin_layout Standard
7857 Even though a cite engine file is essentially a normal layout file that
7858 could theoretically include any layout information, it usually primarily
7859 includes some specific parameters such as
7860 \begin_inset Flex Code
7863 \begin_layout Plain Layout
7870 \begin_inset Flex Code
7873 \begin_layout Plain Layout
7880 \begin_inset Flex Code
7883 \begin_layout Plain Layout
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7900 The syntax of the latter two is described in
7901 \begin_inset CommandInset ref
7903 reference "subsec:Citation-engine-description"
7911 \begin_inset CommandInset ref
7913 reference "subsec:Citation-format-description"
7917 , as well as in the files themselves.
7920 \begin_layout Section
7921 \begin_inset CommandInset label
7923 name "sec:TextClass"
7927 The layout file format
7930 \begin_layout Standard
7931 The following sections describe how layout files are structured and written.
7932 Our advice is to go slowly, save and test often.
7933 It is really not that hard, except that the multitude of options can become
7934 overwhelming, especially if you try to check out too many at once.
7935 It becomes easier if you use existing layouts of \SpecialChar LyX
7936 as examples/reference
7937 or if you modify an existing layout to your needs.
7940 \begin_layout Standard
7941 Note that all the tags used in layout files are case-insensitive.
7943 \begin_inset Flex Code
7946 \begin_layout Plain Layout
7953 \begin_inset Flex Code
7956 \begin_layout Plain Layout
7963 \begin_inset Flex Code
7966 \begin_layout Plain Layout
7972 are really the same tag.
7973 The possible arguments are printed in brackets after the tag's name.
7974 The default argument is typeset
7975 \begin_inset Flex Code
7978 \begin_layout Plain Layout
7987 If the argument has a data type like
7988 \begin_inset Quotes eld
7992 \begin_inset Quotes erd
7996 \begin_inset Quotes eld
8000 \begin_inset Quotes erd
8003 , the default is shown like this:
8004 \begin_inset Flex Code
8007 \begin_layout Plain Layout
8018 \begin_layout Subsection
8019 The document class declaration and classification
8022 \begin_layout Standard
8023 Lines in a layout file which begin with
8024 \begin_inset Flex Code
8027 \begin_layout Plain Layout
8034 There is one exception to this rule.
8036 \begin_inset Flex Code
8039 \begin_layout Plain Layout
8045 files should begin with lines like:
8048 \begin_layout LyX-Code
8051 #% Do not delete the line below; configure depends on this
8054 \begin_layout LyX-Code
8059 DeclareLaTeXClass{Article (Standard Class)}
8062 \begin_layout LyX-Code
8067 DeclareCategory{Articles}
8070 \begin_layout Standard
8071 The second and third lines are used when you (re)configure \SpecialChar LyX
8073 The layout file is read by the \SpecialChar LaTeX
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8084 , in a special mode where
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8095 The first line is just a \SpecialChar LaTeX
8096 comment, the second one contains the mandatory
8097 declaration of the text class and the third line contains the optional
8098 classification of the class.
8099 If these lines appear in a file named
8100 \begin_inset Flex Code
8103 \begin_layout Plain Layout
8109 , then they define a text class of name
8110 \begin_inset Flex Code
8113 \begin_layout Plain Layout
8119 (the name of the layout file) which uses the \SpecialChar LaTeX
8121 \begin_inset Flex Code
8124 \begin_layout Plain Layout
8130 (the default is to use the same name as the layout).
8132 \begin_inset Quotes eld
8135 Article (Standard Class)
8136 \begin_inset Quotes erd
8139 that appears above is used as a description of the text class in the
8140 \begin_inset Flex Noun
8143 \begin_layout Plain Layout
8144 Document\SpecialChar menuseparator
8152 \begin_inset Quotes eld
8156 \begin_inset Quotes erd
8159 in the example) is also used in the
8160 \begin_inset Flex Noun
8163 \begin_layout Plain Layout
8164 Document\SpecialChar menuseparator
8170 dialog: the text classes are grouped by these categories (which are usually
8171 genres, so typical categories are
8172 \begin_inset Quotes eld
8176 \begin_inset Quotes erd
8180 \begin_inset Quotes eld
8184 \begin_inset Quotes erd
8188 \begin_inset Quotes eld
8192 \begin_inset Quotes erd
8196 \begin_inset Quotes eld
8200 \begin_inset Quotes erd
8204 \begin_inset Quotes eld
8208 \begin_inset Quotes erd
8212 \begin_inset Quotes eld
8216 \begin_inset Quotes erd
8220 If no category has been declared, the class will be put in the
8221 \begin_inset Quotes eld
8225 \begin_inset Quotes erd
8231 \begin_layout Standard
8232 Let's assume that you wrote your own text class that uses the
8233 \begin_inset Flex Code
8236 \begin_layout Plain Layout
8242 document class, but where you changed the appearance of the section headings.
8243 If you put it in a file
8244 \begin_inset Flex Code
8247 \begin_layout Plain Layout
8253 , the header of this file should be:
8256 \begin_layout LyX-Code
8259 #% Do not delete the line below; configure depends on this
8262 \begin_layout LyX-Code
8267 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8270 \begin_layout LyX-Code
8275 DeclareCategory{Articles}
8278 \begin_layout Standard
8279 This declares a text class
8280 \begin_inset Flex Code
8283 \begin_layout Plain Layout
8289 , associated with the \SpecialChar LaTeX
8291 \begin_inset Flex Code
8294 \begin_layout Plain Layout
8301 \begin_inset Quotes eld
8304 Article (with My Own Headings)
8305 \begin_inset Quotes erd
8309 If your text class depends on several packages, you can declare it as:
8312 \begin_layout LyX-Code
8315 #% Do not delete the line below; configure depends on this
8318 \begin_layout LyX-Code
8323 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8326 \begin_layout LyX-Code
8331 DeclareCategory{Articles}
8334 \begin_layout Standard
8335 This indicates that your text class uses the
8336 \begin_inset Flex Code
8339 \begin_layout Plain Layout
8347 \change_deleted 5863208 1594239179
8348 Finally, it is also possible to declare classes for DocBook code.
8349 Typical declarations will look like:
8352 \begin_layout LyX-Code
8354 \change_deleted 5863208 1594239179
8357 #% Do not delete the line below; configure depends on this
8360 \begin_layout LyX-Code
8362 \change_deleted 5863208 1594239179
8367 DeclareDocBookClass[article]{SGML (DocBook Article)}
8370 \begin_layout LyX-Code
8372 \change_deleted 5863208 1594239179
8377 DeclareCategory{Articles (DocBook)}
8382 \begin_layout Standard
8383 Note that these declarations can also be given an optional parameter declaring
8384 the name of the document class (but not a list).
8387 \begin_layout Standard
8388 So, to be as explicit as possible, the form of the layout declaration is:
8391 \begin_layout LyX-Code
8396 DeclareLaTeXClass[class,package.sty]{layout description}
8399 \begin_layout LyX-Code
8404 DeclareCategory{category}
8407 \begin_layout Standard
8408 The class need only be specified if the name of the \SpecialChar LaTeX
8410 name of the layout file are different or if there are packages to load.
8411 If the name of the class file is not specified, then \SpecialChar LyX
8413 that it is the same as the name of the layout file.
8416 \begin_layout Standard
8417 When the text class has been modified to your taste, all you have to do
8418 is to copy it either to
8419 \begin_inset Flex Code
8422 \begin_layout Plain Layout
8429 \begin_inset Flex Code
8432 \begin_layout Plain Layout
8439 \begin_inset Flex Noun
8442 \begin_layout Plain Layout
8443 Tools\SpecialChar menuseparator
8449 , exit \SpecialChar LyX
8451 Then your new text class should be available along with the others.
8454 \begin_layout Standard
8455 Once the layout file is installed, you can edit it and see your changes
8456 without having to reconfigure or to restart \SpecialChar LyX
8461 \begin_layout Plain Layout
8462 In versions of \SpecialChar LyX
8463 prior to 1.6, this was not true.
8464 As a result, editing layout files was very time consuming, since you had
8465 constantly to restart \SpecialChar LyX
8471 You can force a reload of the current layout by using the \SpecialChar LyX
8473 \begin_inset Flex Noun
8476 \begin_layout Plain Layout
8483 There is no default binding for this function—though, of course, you can
8484 bind it to a key yourself.
8485 But you will normally use this function simply by entering it in the mini-buffe
8490 \begin_layout Standard
8496 \begin_inset Flex Noun
8499 \begin_layout Plain Layout
8505 is very much an `advanced feature'.
8510 recommended that you save your work before using this function.
8515 recommended that you not attempt to edit layout information while simultaneousl
8516 y working on a document that you care about.
8517 Use a test document.
8518 Syntax errors and the like in your layout file could cause peculiar behavior.
8519 In particular, such errors could cause \SpecialChar LyX
8520 to regard the current layout as
8521 invalid and to attempt to switch to some other layout.
8525 \begin_layout Plain Layout
8526 Really bad syntax errors may even caused \SpecialChar LyX
8528 This is because certain sorts of errors may make \SpecialChar LyX
8539 The \SpecialChar LyX
8540 team strives to keep \SpecialChar LyX
8541 stable in such situations, but safe is better
8546 \begin_layout Plain Layout
8547 While we're giving advice: make regular backups.
8548 And be nice to your mother.
8556 \begin_layout Subsection
8557 The Module declaration
8560 \begin_layout Standard
8561 A module must begin with a line like the following:
8564 \begin_layout LyX-Code
8567 DeclareLyXModule[endnotes.sty]{Endnotes}
8568 \change_inserted -712698321 1554395911
8572 \begin_layout LyX-Code
8574 \change_inserted -712698321 1554395924
8579 DeclareCategory{Foot- and Endnotes}
8580 \change_deleted -712698321 1554395911
8588 \begin_layout Standard
8589 The mandatory argument
8590 \change_inserted -712698321 1554395956
8599 , in curly brackets, is the name of the module, as it should appear in
8600 \begin_inset Flex Noun
8603 \begin_layout Plain Layout
8604 Document\SpecialChar menuseparator
8605 Settings\SpecialChar menuseparator
8612 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8614 on which the module depends.
8615 It is also possible to use the form
8616 \begin_inset Flex Noun
8619 \begin_layout Plain Layout
8625 as an optional argument, which declares that the module can only be used
8626 when there exists a conversion chain between the formats `
8627 \begin_inset Flex Code
8630 \begin_layout Plain Layout
8637 \begin_inset Flex Code
8640 \begin_layout Plain Layout
8648 \change_inserted -712698321 1554396133
8655 declaration is not strictly mandatory, but you should add it, since it
8656 is helpful to find the module.
8657 Please have a look at the existing module categories and if appropriate,
8663 \begin_layout Standard
8665 \change_inserted -712698321 1554395988
8668 declaration should then be followed by lines like the following:
8672 \begin_layout Plain Layout
8673 Preferably in English if the module should be published with \SpecialChar LyX
8675 This description will appear in the list of messages to be translated and
8676 will be thus translated with the next interface update.
8684 \begin_layout LyX-Code
8688 \begin_layout LyX-Code
8689 #Adds an endnote command, in addition to footnotes.
8693 \begin_layout LyX-Code
8694 #You will need to add
8696 theendnotes in TeX code where you
8699 \begin_layout LyX-Code
8700 #want the endnotes to appear.
8704 \begin_layout LyX-Code
8708 \begin_layout LyX-Code
8709 #Requires: somemodule | othermodule
8712 \begin_layout LyX-Code
8713 #Excludes: badmodule
8716 \begin_layout Standard
8717 The description is used in
8718 \begin_inset Flex Noun
8721 \begin_layout Plain Layout
8722 Document\SpecialChar menuseparator
8723 Settings\SpecialChar menuseparator
8729 to provide the user with information about what the module does.
8731 \begin_inset Flex Code
8734 \begin_layout Plain Layout
8740 line is used to identify other modules with which this one must be used;
8742 \begin_inset Flex Code
8745 \begin_layout Plain Layout
8751 line is used to identify modules with which this one may not be used.
8752 Both are optional, and, as shown, multiple modules should be separated
8753 with the pipe symbol: |.
8754 Note that the required modules are treated disjunctively:
8758 of the required modules must be used.
8763 excluded module may be used.
8764 Note that modules are identified here by their filenames without the
8765 \begin_inset Flex Code
8768 \begin_layout Plain Layout
8776 \begin_inset Flex Code
8779 \begin_layout Plain Layout
8786 \begin_inset Flex Code
8789 \begin_layout Plain Layout
8798 \begin_layout Subsection
8799 The CiteEngine file declaration
8802 \begin_layout Standard
8803 A cite engine file must begin with a line like the following:
8806 \begin_layout LyX-Code
8809 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8812 \begin_layout Standard
8813 The mandatory argument, in curly brackets, is the name of the cite style,
8814 as it should appear in
8815 \begin_inset Flex Noun
8818 \begin_layout Plain Layout
8819 Document\SpecialChar menuseparator
8820 Settings\SpecialChar menuseparator
8827 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8829 on which the cite engine depends.
8832 \begin_layout Standard
8833 The cite engine declaration should then be followed by lines like the following:
8837 \begin_layout Plain Layout
8838 Preferably in English if the module should be published with \SpecialChar LyX
8840 This description will appear in the list of messages to be translated and
8841 will be thus translated with the next interface update.
8849 \begin_layout LyX-Code
8853 \begin_layout LyX-Code
8854 # Biblatex supports many author-year and numerical styles.
8857 \begin_layout LyX-Code
8858 # It is mainly aimed at the Humanities.
8862 \begin_layout LyX-Code
8863 # customizable, fully localized and provides many features
8866 \begin_layout LyX-Code
8867 # that are not possible with BibTeX.
8868 The use of 'biber' as
8871 \begin_layout LyX-Code
8872 # bibliography processor is advised.
8875 \begin_layout LyX-Code
8879 \begin_layout Standard
8880 The description is used in
8881 \begin_inset Flex Noun
8884 \begin_layout Plain Layout
8885 Document\SpecialChar menuseparator
8886 Settings\SpecialChar menuseparator
8892 to provide the user with information about the cite engine.
8895 \begin_layout Subsection
8899 \begin_layout Standard
8900 The first non-comment line of any layout file, included file, or module
8905 contain the file format number:
8908 \begin_layout Description
8909 \begin_inset Flex Code
8912 \begin_layout Plain Layout
8919 \begin_inset Flex Code
8922 \begin_layout Plain Layout
8928 ] The format number of the layout file.
8931 \begin_layout Standard
8932 This tag was introduced with \SpecialChar LyX
8934 \begin_inset space ~
8938 Layout files from older \SpecialChar LyX
8939 versions do not have an explicit file format and
8940 are considered to have
8941 \begin_inset Flex Code
8944 \begin_layout Plain Layout
8946 \begin_inset space ~
8955 The format for the present version of \SpecialChar LyX
8957 But each version of \SpecialChar LyX
8958 is capable of reading earlier versions' layout files,
8959 just as they are capable of reading files produced by earlier versions
8962 There is, however, no provision for converting to earlier formats.
8965 \begin_layout Subsection
8966 \begin_inset CommandInset label
8968 name "subsec:General-text-class"
8972 General text class parameters
8975 \begin_layout Standard
8976 These are general parameters that govern the behavior of an entire document
8982 mean that they must appear in
8983 \begin_inset Flex Code
8986 \begin_layout Plain Layout
8992 files rather than in modules.
8993 A module can contain any layout tag.)
8996 \begin_layout Description
8998 \change_inserted -712698321 1526899478
8999 \begin_inset Flex Code
9002 \begin_layout Plain Layout
9004 \change_inserted -712698321 1526898610
9005 AddToCiteEngine <engine>
9010 Extends the possibilities for displaying citation references.
9012 \begin_inset CommandInset ref
9014 reference "subsec:Citation-engine-description"
9023 \begin_inset Flex Code
9026 \begin_layout Plain Layout
9028 \change_inserted -712698321 1526898823
9039 \begin_layout Description
9040 \begin_inset Flex Code
9043 \begin_layout Plain Layout
9049 Adds information that will be output in the
9050 \begin_inset Flex Code
9053 \begin_layout Plain Layout
9059 block when the document is output to XHTML.
9060 Typically, this would be used to output CSS style information, but it can
9061 be used for anything that can appear in
9062 \begin_inset Flex Code
9065 \begin_layout Plain Layout
9073 \begin_inset Quotes eld
9077 \begin_inset Flex Code
9080 \begin_layout Plain Layout
9087 \begin_inset Quotes erd
9093 \begin_layout Description
9094 \begin_inset Flex Code
9097 \begin_layout Plain Layout
9103 Adds information to the document preamble.
9105 \begin_inset Newline newline
9109 \begin_inset Quotes eld
9113 \begin_inset Flex Code
9116 \begin_layout Plain Layout
9123 \begin_inset Quotes erd
9127 \change_inserted -712698321 1562592950
9131 \begin_layout Description
9133 \change_inserted -712698321 1562593040
9134 \begin_inset Flex Code
9137 \begin_layout Plain Layout
9139 \change_inserted -712698321 1562592954
9146 \begin_inset Flex Code
9149 \begin_layout Plain Layout
9151 \change_inserted -712698321 1562592950
9160 \begin_inset space \thinspace{}
9164 \begin_inset Flex Code
9167 \begin_layout Plain Layout
9169 \change_inserted -712698321 1562592950
9175 ] If the document class adds the bibliography to the table of contents,
9176 add this option with value
9177 \begin_inset Flex Code
9180 \begin_layout Plain Layout
9182 \change_inserted -712698321 1562592996
9191 \begin_inset Flex Code
9194 \begin_layout Plain Layout
9196 \change_inserted -712698321 1562593006
9205 This prevents the bibliography from being added twice.
9210 \begin_layout Description
9211 \begin_inset Flex Code
9214 \begin_layout Plain Layout
9220 Defines the possibilities for displaying citation references.
9222 \begin_inset CommandInset ref
9224 reference "subsec:Citation-engine-description"
9233 \begin_inset Quotes eld
9237 \begin_inset Flex Code
9240 \begin_layout Plain Layout
9247 \begin_inset Quotes erd
9251 Primarily used in cite engine files (see
9252 \begin_inset CommandInset ref
9254 reference "subsec:Cite-Engine-Files"
9263 \change_inserted -712698321 1526898530
9264 Note that if you specify this in a layout file or module, any cite engine
9265 definition will be overridden.
9267 \begin_inset Flex Code
9270 \begin_layout Plain Layout
9272 \change_inserted -712698321 1526898530
9285 \begin_layout Description
9286 \begin_inset Flex Code
9289 \begin_layout Plain Layout
9295 Defines formats for use in the display of bibliographic information.
9297 \begin_inset CommandInset ref
9299 reference "subsec:Citation-format-description"
9305 \begin_inset Quotes eld
9309 \begin_inset Flex Code
9312 \begin_layout Plain Layout
9319 \begin_inset Quotes erd
9323 Primarily used in cite engine files (see
9324 \begin_inset CommandInset ref
9326 reference "subsec:Cite-Engine-Files"
9335 \change_inserted -712698321 1526898585
9336 A cite format defined in a layout or module will override the cite engine
9342 \begin_layout Description
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9353 \begin_inset Flex Code
9356 \begin_layout Plain Layout
9365 \begin_inset Flex Code
9368 \begin_layout Plain Layout
9374 ] Determines whether
9378 or Bib\SpecialChar TeX
9379 is used to generate a Bibliography.
9380 Primarily used in cite engine files (see
9381 \begin_inset CommandInset ref
9383 reference "subsec:Cite-Engine-Files"
9393 \begin_layout Description
9394 \begin_inset Flex Code
9397 \begin_layout Plain Layout
9403 Describes various global options supported by the document class.
9405 \begin_inset CommandInset ref
9407 reference "subsec:ClassOptions"
9413 \begin_inset Quotes eld
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9427 \begin_inset Quotes erd
9433 \begin_layout Description
9434 \begin_inset Flex Code
9437 \begin_layout Plain Layout
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9456 \begin_inset space \thinspace{}
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9469 ] Whether the class should
9473 to having one or two columns.
9474 Can be changed in the
9475 \begin_inset Flex Noun
9478 \begin_layout Plain Layout
9479 Document\SpecialChar menuseparator
9488 \begin_layout Description
9489 \begin_inset Flex Code
9492 \begin_layout Plain Layout
9499 \begin_inset Flex Code
9502 \begin_layout Plain Layout
9508 ] This sequence defines the properties for a counter.
9509 If the counter does not yet exist, it is created; if it does exist, it
9512 \begin_inset Quotes eld
9516 \begin_inset Flex Code
9519 \begin_layout Plain Layout
9526 \begin_inset Quotes erd
9530 \begin_inset Newline newline
9534 \begin_inset CommandInset ref
9536 reference "subsec:Counters"
9540 for details on counters.
9543 \begin_layout Description
9544 \begin_inset Flex Code
9547 \begin_layout Plain Layout
9553 Sets the default font used to display the document.
9555 \begin_inset CommandInset ref
9557 reference "subsec:Font-description"
9561 for how to declare fonts.
9563 \begin_inset Quotes eld
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9577 \begin_inset Quotes erd
9583 \begin_layout Description
9584 \begin_inset Flex Code
9587 \begin_layout Plain Layout
9594 \begin_inset Flex Code
9597 \begin_layout Plain Layout
9603 ] Specifies a module to be included by default with this document class.
9604 The module is specified as filename without the
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 The user can still remove the module, but it will be active at the outset.
9616 (This applies only when new files are created, or when this class is chosen
9617 for an existing document.)
9620 \begin_layout Description
9621 \begin_inset Flex Code
9624 \begin_layout Plain Layout
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9640 ] This is the style that will be assigned to new paragraphs, usually
9641 \begin_inset Flex Noun
9644 \begin_layout Plain Layout
9651 This will default to the first defined style if not given, but you are
9652 encouraged to use this directive.
9655 \begin_layout Description
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9666 \begin_inset Flex Code
9669 \begin_layout Plain Layout
9675 ] This tag indicates that the module (which is specified by filename without
9677 \begin_inset Flex Code
9680 \begin_layout Plain Layout
9686 extension) cannot be used with this document class.
9687 This might be used in a journal-specific layout file to prevent, say, the
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9698 module that numbers theorems by section.
9703 be used in a module.
9704 Modules have their own way of excluding other modules (see
9705 \begin_inset CommandInset ref
9707 reference "subsec:Layout-modules"
9714 \begin_layout Description
9715 \begin_inset Flex Code
9718 \begin_layout Plain Layout
9724 Defines a new float.
9726 \begin_inset CommandInset ref
9728 reference "subsec:Floats"
9734 \begin_inset Quotes eld
9738 \begin_inset Flex Code
9741 \begin_layout Plain Layout
9748 \begin_inset Quotes erd
9754 \begin_layout Description
9755 \begin_inset Flex Code
9758 \begin_layout Plain Layout
9764 Sets the information that will be output in the
9765 \begin_inset Flex Code
9768 \begin_layout Plain Layout
9774 block when this document class is output to XHTML.
9775 Note that this will completely override any prior
9776 \begin_inset Flex Code
9779 \begin_layout Plain Layout
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9797 \begin_inset Newline newline
9801 \begin_inset Flex Code
9804 \begin_layout Plain Layout
9810 if you just want to add material to the preamble.) Must end with
9811 \begin_inset Quotes eld
9815 \begin_inset Flex Code
9818 \begin_layout Plain Layout
9825 \begin_inset Quotes erd
9831 \begin_layout Description
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9851 ] The style to use for the table of contents, bibliography, and so forth,
9852 when the document is output to HTML.
9853 For articles, this should normally be
9854 \begin_inset Flex Code
9857 \begin_layout Plain Layout
9864 \begin_inset Flex Code
9867 \begin_layout Plain Layout
9874 If it is not given, then \SpecialChar LyX
9875 will attempt to figure out which layout to use.
9878 \begin_layout Description
9879 \begin_inset Flex Code
9882 \begin_layout Plain Layout
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9898 ] Modifies the properties of the given counter.
9899 If the counter does not exist, the statement is ignored.
9901 \begin_inset Quotes eld
9905 \begin_inset Flex Code
9908 \begin_layout Plain Layout
9915 \begin_inset Quotes erd
9919 \begin_inset Newline newline
9923 \begin_inset CommandInset ref
9925 reference "subsec:Counters"
9929 for details on counters.
9932 \begin_layout Description
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9943 \begin_inset Flex Code
9946 \begin_layout Plain Layout
9952 ] This allows you to include another layout definition file within yours
9953 to avoid duplicating commands.
9954 Common examples are the standard layout files, for example,
9955 \begin_inset Flex Code
9958 \begin_layout Plain Layout
9964 , which contains most of the basic layouts.
9967 \begin_layout Description
9968 \begin_inset Flex Code
9971 \begin_layout Plain Layout
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9987 ] This section (re-)defines the layout of an inset.
9988 It can be applied to an existing inset or to a new, user-defined inset,
9989 e.g., a new character style.
9991 \begin_inset Quotes eld
9995 \begin_inset Flex Code
9998 \begin_layout Plain Layout
10005 \begin_inset Quotes erd
10009 \begin_inset Newline newline
10013 \begin_inset CommandInset ref
10015 reference "subsec:Flex-insets-and"
10019 for more information.
10023 \begin_layout Description
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10034 \begin_inset Flex Code
10037 \begin_layout Plain Layout
10043 ] A string that indicates the width of the left margin on the screen, for
10045 \begin_inset Quotes eld
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10059 \begin_inset Quotes erd
10063 (Note that this is not a `length', like
10064 \begin_inset Quotes eld
10068 \begin_inset Quotes erd
10074 \begin_layout Description
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10094 ] An integer that determines the maximal number of names displayed in an
10095 author-year citation before the citation switches to
10096 \begin_inset Quotes eld
10100 \begin_inset Quotes erd
10104 Primarily used in cite engine files (see
10105 \begin_inset CommandInset ref
10107 reference "subsec:Cite-Engine-Files"
10117 \begin_layout Description
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10137 ] Modifies the properties of the given paragraph style.
10138 If the style does not exist, this section is ignored.
10140 \begin_inset Quotes eld
10144 \begin_inset Flex Code
10147 \begin_layout Plain Layout
10154 \begin_inset Quotes erd
10160 \begin_layout Description
10161 \begin_inset Flex Code
10164 \begin_layout Plain Layout
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10180 ] Deletes an existing counter, usually one defined in an included file.
10183 \begin_layout Description
10184 \begin_inset Flex Code
10187 \begin_layout Plain Layout
10194 \begin_inset Flex Code
10197 \begin_layout Plain Layout
10203 ] Deletes an existing float.
10204 This is particularly useful when you want to suppress a float that has
10205 been defined in an input file.
10208 \begin_layout Description
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10228 ] Deletes an existing style.
10231 \begin_layout Description
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10252 \begin_inset Flex Code
10255 \begin_layout Plain Layout
10261 ] Define a new table of contents with type
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10272 \begin_inset Flex Code
10275 \begin_layout Plain Layout
10282 See also the AddToToc commands.
10285 \begin_layout Description
10286 \begin_inset Flex Code
10289 \begin_layout Plain Layout
10296 \begin_inset Flex Code
10299 \begin_layout Plain Layout
10305 ] The file format (as defined in the \SpecialChar LyX
10306 preferences) produced by this document
10308 It is mainly useful when
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10328 and one wants to define a new type of literate document.
10329 The format is reset to
10330 \change_deleted 5863208 1594239413
10332 \begin_inset Quotes eld
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10346 \begin_inset Quotes erd
10352 \begin_inset Quotes eld
10356 \begin_inset Flex Code
10359 \begin_layout Plain Layout
10366 \begin_inset Quotes erd
10369 when the corresponding
10370 \begin_inset Flex Code
10373 \begin_layout Plain Layout
10379 parameter is encountered.
10382 \begin_layout Description
10383 \begin_inset Flex Code
10386 \begin_layout Plain Layout
10393 \begin_inset Flex Code
10396 \begin_layout Plain Layout
10407 \change_deleted 5863208 1594239430
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10421 \begin_inset Flex Code
10424 \begin_layout Plain Layout
10430 ] Specifies what sort of output documents using this class will produce.
10433 \begin_layout Description
10434 \begin_inset Flex Code
10437 \begin_layout Plain Layout
10444 \begin_inset Flex Code
10447 \begin_layout Plain Layout
10454 \begin_inset Flex Code
10457 \begin_layout Plain Layout
10463 ] Specifies options, given in the second string, for the package named by
10466 \begin_inset Quotes eld
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10474 PackageOptions natbib square
10480 \begin_inset Quotes erd
10484 \begin_inset Flex Code
10487 \begin_layout Plain Layout
10493 to be loaded with the
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10504 (For \SpecialChar TeX
10505 perts, this causes \SpecialChar LyX
10507 \begin_inset Flex Code
10510 \begin_layout Plain Layout
10513 PassOptionsToPackage{natbib}{square}
10519 \begin_inset Flex Code
10522 \begin_layout Plain Layout
10529 \change_inserted -712698321 1565102364
10533 \begin_layout Description
10535 \change_inserted -712698321 1565102470
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10541 \change_inserted -712698321 1565102365
10548 \begin_inset Flex Code
10551 \begin_layout Plain Layout
10553 \change_inserted -712698321 1565105222
10558 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10559 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10564 ] The default page size.
10565 This is used by some converters.
10570 \begin_layout Description
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10612 ] The default pagestyle.
10613 Can be changed in the
10614 \begin_inset Flex Noun
10617 \begin_layout Plain Layout
10618 Document\SpecialChar menuseparator
10627 \begin_layout Description
10628 \begin_inset Flex Code
10631 \begin_layout Plain Layout
10637 Sets the preamble for the \SpecialChar LaTeX
10639 Note that this will completely override any prior
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10661 \begin_inset Flex Code
10664 \begin_layout Plain Layout
10670 if you just want to add material to the preamble.) Must end with
10671 \begin_inset Quotes eld
10675 \begin_inset Flex Code
10678 \begin_layout Plain Layout
10685 \begin_inset Quotes erd
10691 \begin_layout Description
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10712 \begin_inset Flex Code
10715 \begin_layout Plain Layout
10724 \begin_inset space \thinspace{}
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10737 ] Whether the class already provides the feature
10738 \begin_inset Flex Code
10741 \begin_layout Plain Layout
10748 A feature is in general the name of a package (e.
10749 \begin_inset space \thinspace{}
10753 \begin_inset space \space{}
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10777 \begin_inset space \thinspace{}
10781 \begin_inset space \space{}
10785 \begin_inset Flex Code
10788 \begin_layout Plain Layout
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10806 \begin_inset CommandInset ref
10808 reference "chap:List-of-functions"
10812 for the list of features.
10815 \begin_layout Description
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10826 \begin_inset Flex Code
10829 \begin_layout Plain Layout
10835 ] Indicates that this layout provides the functionality of the module mentioned,
10836 which should be specified by the filename without the
10837 \begin_inset Flex Code
10840 \begin_layout Plain Layout
10847 This will typically be used if the layout includes the module directly,
10848 rather than using the
10849 \begin_inset Flex Code
10852 \begin_layout Plain Layout
10858 tag to indicate that it ought to be used.
10859 It could also be used in a module that provided an alternate implementation
10860 of the same functionality.
10863 \begin_layout Description
10864 \begin_inset Flex Code
10867 \begin_layout Plain Layout
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10883 ] Creates a new paragraph style if it does not already exist.
10884 If the style does exist, this section is ignored.
10886 \begin_inset Quotes eld
10890 \begin_inset Flex Code
10893 \begin_layout Plain Layout
10900 \begin_inset Quotes erd
10906 \begin_layout Description
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10917 \begin_inset Flex Code
10920 \begin_layout Plain Layout
10926 ] Whether the class requires the feature
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10937 Multiple features must be separated by commas.
10938 Note that you can only request supported features.
10940 \begin_inset CommandInset ref
10942 reference "chap:List-of-functions"
10946 for the list of features.).
10947 If you require a package with specific options, you can additionally use
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10961 \begin_layout Description
10962 \begin_inset Flex Code
10965 \begin_layout Plain Layout
10972 \begin_inset Flex Code
10975 \begin_layout Plain Layout
10981 ] A string that indicates the width of the right margin on the screen, for
10983 \begin_inset Quotes eld
10987 \begin_inset Flex Code
10990 \begin_layout Plain Layout
10997 \begin_inset Quotes erd
11003 \begin_layout Description
11004 \begin_inset Flex Code
11007 \begin_layout Plain Layout
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11023 ] Sets which divisions get numbered.
11025 \begin_inset Newline newline
11029 \begin_inset Flex Code
11032 \begin_layout Plain Layout
11038 counter in \SpecialChar LaTeX
11042 \begin_layout Description
11043 \begin_inset Flex Code
11046 \begin_layout Plain Layout
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11065 \begin_inset space \thinspace{}
11069 \begin_inset Flex Code
11072 \begin_layout Plain Layout
11078 ] Whether the class-default should be printing on one or both sides of the
11080 Can be changed in the
11081 \begin_inset Flex Noun
11084 \begin_layout Plain Layout
11085 Document\SpecialChar menuseparator
11094 \begin_layout Description
11095 \begin_inset Flex Code
11098 \begin_layout Plain Layout
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11114 ] This sequence defines a paragraph style.
11115 If the style does not yet exist, it is created; if it does exist, its parameter
11118 \begin_inset Quotes eld
11122 \begin_inset Flex Code
11125 \begin_layout Plain Layout
11132 \begin_inset Quotes erd
11136 \begin_inset Newline newline
11140 \begin_inset CommandInset ref
11142 reference "subsec:Paragraph-Styles"
11146 for details on paragraph styles.
11147 \change_inserted -712698321 1553617804
11151 \begin_layout Description
11153 \change_inserted -712698321 1553617862
11154 \begin_inset Flex Code
11157 \begin_layout Plain Layout
11159 \change_inserted -712698321 1553617809
11166 \begin_inset Flex Code
11169 \begin_layout Plain Layout
11171 \change_inserted -712698321 1553617805
11177 ] defines the default table style that is used when inserting a table.
11178 The following styles are available:
11182 \begin_layout Itemize
11184 \change_inserted -712698321 1554308039
11185 \begin_inset Flex Code
11188 \begin_layout Plain Layout
11190 \change_inserted -712698321 1554307928
11191 Formal_with_Footline
11199 \begin_inset Quotes eld
11203 \begin_inset Quotes erd
11206 ) style with horizontal lines only, using a bold top and bottom line, the
11207 first and last row are additionally separated from the table body with
11208 a thin middle line.
11211 \begin_layout Itemize
11213 \change_inserted -712698321 1554308087
11214 \begin_inset Flex Code
11217 \begin_layout Plain Layout
11219 \change_inserted -712698321 1554308042
11220 Formal_without_Footline
11225 : same as the above, but the last row is not separated with a middle line
11229 \begin_layout Itemize
11231 \change_inserted -712698321 1553618031
11232 \begin_inset Flex Code
11235 \begin_layout Plain Layout
11237 \change_inserted -712698321 1553618006
11243 : Simple table lines.
11246 \begin_layout Itemize
11248 \change_inserted -712698321 1553618309
11249 \begin_inset Flex Code
11252 \begin_layout Plain Layout
11254 \change_inserted -712698321 1553618031
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11266 \change_inserted -712698321 1553618043
11272 , but with the header column offset with a second horizontal line.
11273 This is also the default style of \SpecialChar LyX
11277 \begin_layout Itemize
11279 \change_inserted -712698321 1553618280
11280 \begin_inset Flex Code
11283 \begin_layout Plain Layout
11285 \change_inserted -712698321 1553618261
11291 : Table without lines.
11297 \begin_layout Description
11298 \begin_inset Flex Code
11301 \begin_layout Plain Layout
11308 \begin_inset Flex Code
11311 \begin_layout Plain Layout
11317 ] The name of the command or environment to be used with
11318 \begin_inset Flex Code
11321 \begin_layout Plain Layout
11330 \begin_layout Description
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11353 \begin_inset Flex Code
11356 \begin_layout Plain Layout
11362 ] Indicates what kind of markup is used to define the title of a document.
11364 \begin_inset Flex Code
11367 \begin_layout Plain Layout
11373 means that the macro with name
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11383 will be inserted after the last layout which has
11384 \begin_inset Quotes eld
11388 \begin_inset Flex Code
11391 \begin_layout Plain Layout
11393 \begin_inset space ~
11402 \begin_inset Quotes erd
11407 \begin_inset Flex Code
11410 \begin_layout Plain Layout
11416 corresponds to the case where all layouts which have
11417 \begin_inset Quotes eld
11421 \begin_inset Flex Code
11424 \begin_layout Plain Layout
11426 \begin_inset space ~
11435 \begin_inset Quotes erd
11438 should be enclosed into the
11439 \begin_inset Flex Code
11442 \begin_layout Plain Layout
11451 \begin_layout Description
11452 \begin_inset Flex Code
11455 \begin_layout Plain Layout
11462 \begin_inset Flex Code
11465 \begin_layout Plain Layout
11471 ] Sets which divisions are included in the table of contents.
11473 \begin_inset Flex Code
11476 \begin_layout Plain Layout
11482 counter in \SpecialChar LaTeX
11486 \begin_layout Subsection
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11497 \begin_inset CommandInset label
11499 name "subsec:ClassOptions"
11506 \begin_layout Standard
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11517 section can contain the following entries:
11520 \begin_layout Description
11521 \begin_inset Flex Code
11524 \begin_layout Plain Layout
11531 \begin_inset Flex Code
11534 \begin_layout Plain Layout
11540 ] The list of available font sizes for the document's main font, separated
11542 \begin_inset Quotes eld
11546 \begin_inset Flex Code
11549 \begin_layout Plain Layout
11556 \begin_inset Quotes erd
11561 \change_inserted -712698321 1565110196
11562 Any number is possible.
11565 \begin_layout Description
11567 \change_inserted -712698321 1565110259
11568 \begin_inset Flex Code
11571 \begin_layout Plain Layout
11573 \change_inserted -712698321 1565110199
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11585 \change_inserted -712698321 1565110196
11591 ] The format for the font size option.
11593 \begin_inset Flex Code
11596 \begin_layout Plain Layout
11598 \change_inserted -712698321 1565110238
11608 \begin_inset Flex Code
11611 \begin_layout Plain Layout
11613 \change_inserted -712698321 1565110248
11619 is a placeholder for the font size.
11624 \begin_layout Description
11626 \change_deleted 5863208 1594239483
11627 \begin_inset Flex Code
11630 \begin_layout Plain Layout
11636 Used to set the DTD line with XML-based output classes.
11638 \begin_inset space \thinspace{}
11642 \begin_inset Quotes eld
11645 -//OASIS//DTD DocBook V4.2//EN
11646 \begin_inset Quotes erd
11650 \change_inserted -712698321 1565101761
11654 \begin_layout Description
11656 \change_inserted -712698321 1565180598
11657 \begin_inset Flex Code
11660 \begin_layout Plain Layout
11662 \change_inserted -712698321 1565101918
11669 \begin_inset Flex Code
11672 \begin_layout Plain Layout
11674 \change_inserted -712698321 1565105399
11675 string="letter|\SpecialChar allowbreak
11676 legal|\SpecialChar allowbreak
11677 executive|\SpecialChar allowbreak
11678 a0|\SpecialChar allowbreak
11679 a1|\SpecialChar allowbreak
11680 a2|\SpecialChar allowbreak
11681 a3|\SpecialChar allowbreak
11682 a4|\SpecialChar allowbreak
11683 a5|\SpecialChar allowbreak
11684 a6|\SpecialChar allowbreak
11685 b0|\SpecialChar allowbreak
11686 b1|\SpecialChar allowbreak
11687 b2|\SpecialChar allowbreak
11688 b3|\SpecialChar allowbreak
11689 b4|\SpecialChar allowbreak
11690 b5|\SpecialChar allowbreak
11691 b6|\SpecialChar allowbreak
11692 c0|\SpecialChar allowbreak
11693 c1|\SpecialChar allowbreak
11695 2|\SpecialChar allowbreak
11696 c3|\SpecialChar allowbreak
11697 c4|\SpecialChar allowbreak
11698 c5|\SpecialChar allowbreak
11699 c6|\SpecialChar allowbreak
11700 b0j|\SpecialChar allowbreak
11701 b1j|\SpecialChar allowbreak
11702 b2j|\SpecialChar allowbreak
11703 b3j|\SpecialChar allowbreak
11704 b4j|\SpecialChar allowbreak
11705 b5j|\SpecialChar allowbreak
11711 ] The list of available page sizes, separated by
11712 \begin_inset Quotes eld
11716 \begin_inset Flex Code
11719 \begin_layout Plain Layout
11721 \change_inserted -712698321 1565101779
11728 \begin_inset Quotes erd
11732 Currently, only the listed sizes are supported.
11733 Other sizes might be entered as custom class option.
11736 \begin_layout Description
11738 \change_inserted -712698321 1565180623
11739 \begin_inset Flex Code
11742 \begin_layout Plain Layout
11744 \change_inserted -712698321 1565180605
11751 \begin_inset Flex Code
11754 \begin_layout Plain Layout
11756 \change_inserted -712698321 1565180601
11762 ] The format for the page size option.
11764 \begin_inset Flex Code
11767 \begin_layout Plain Layout
11769 \change_inserted -712698321 1565180618
11777 \begin_inset Flex Code
11780 \begin_layout Plain Layout
11782 \change_inserted -712698321 1565180601
11788 is a placeholder for the paper size.
11793 \begin_layout Description
11794 \begin_inset Flex Code
11797 \begin_layout Plain Layout
11804 \begin_inset Flex Code
11807 \begin_layout Plain Layout
11808 string="empty|plain|headings|fancy"
11813 ] The list of available page sty\SpecialChar softhyphen
11815 \begin_inset Quotes eld
11819 \begin_inset Flex Code
11822 \begin_layout Plain Layout
11829 \begin_inset Quotes erd
11835 \begin_layout Description
11836 \begin_inset Flex Code
11839 \begin_layout Plain Layout
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11855 ] Some document class options, separated by a comma, that will be added
11856 to the optional part of the
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11871 \begin_layout Standard
11873 \begin_inset Flex Code
11876 \begin_layout Plain Layout
11882 section must end with
11883 \begin_inset Quotes eld
11887 \begin_inset Flex Code
11890 \begin_layout Plain Layout
11897 \begin_inset Quotes erd
11903 \begin_layout Subsection
11905 \begin_inset CommandInset label
11907 name "subsec:Paragraph-Styles"
11914 \begin_layout Standard
11915 A paragraph style description looks like this:
11919 \begin_layout Plain Layout
11920 Note that this will either define a new style or modify an existing one.
11928 \begin_layout LyX-Code
11935 \begin_layout LyX-Code
11939 \begin_layout LyX-Code
11943 \begin_layout Standard
11944 where the following commands are allowed:
11947 \begin_layout Description
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11958 \begin_inset Flex Code
11961 \begin_layout Plain Layout
11967 =""] This paragraph will appear in the table of contents of the given type.
11968 An empty string disables.
11969 See also the OutlinerName and the IsTocCaption commands.
11973 \begin_layout Description
11974 \begin_inset Flex Code
11977 \begin_layout Plain Layout
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11992 , left, right, center
11997 ] Paragraph alignment.
12000 \begin_layout Description
12001 \begin_inset Flex Code
12004 \begin_layout Plain Layout
12011 \begin_inset Flex Code
12014 \begin_layout Plain Layout
12019 , left, right, center
12024 ] A comma separated list of permitted alignments.
12025 (Some \SpecialChar LaTeX
12026 styles prohibit certain alignments, since those wouldn't make sense.
12027 For example a right-aligned or centered enumeration isn't possible.)
12030 \begin_layout Description
12031 \begin_inset Flex Code
12034 \begin_layout Plain Layout
12041 \begin_inset Flex Code
12044 \begin_layout Plain Layout
12050 ] Defines argument number <int> of a command\SpecialChar breakableslash
12051 environment associated with
12053 This is useful for things like section headings, and only makes sense with
12056 Every (optional or required) argument of a command or environment – except
12057 for the required argument that is associated with the content of the paragraph
12058 itself – has a separate definition, where the number specifies the order
12060 The definition must end with
12061 \begin_inset Flex Code
12064 \begin_layout Plain Layout
12071 So a command with two optional arguments has:
12075 \begin_layout Quote
12081 \begin_layout Quote
12087 \begin_layout Quote
12093 \begin_layout Quote
12099 \begin_layout Quote
12105 \begin_layout Quote
12111 \begin_layout Standard
12113 \begin_inset Flex Code
12116 \begin_layout Plain Layout
12122 definition, the following specifications are possible:
12125 \begin_layout Itemize
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12136 \begin_inset Flex Code
12139 \begin_layout Plain Layout
12145 The string that will appear both in the menu (to insert this argument)
12146 and on the argument inset button (unless you also specify a separate
12147 \begin_inset Flex Code
12150 \begin_layout Plain Layout
12157 For the menu, you can define an accelerator by appending the respective
12158 character to the string, divided by
12159 \begin_inset Quotes eld
12163 \begin_inset Quotes erd
12167 \begin_inset space \thinspace{}
12171 \begin_inset space \space{}
12175 \begin_inset Quotes eld
12179 \begin_inset Flex Code
12182 \begin_layout Plain Layout
12189 \begin_inset Quotes erd
12195 \begin_layout Itemize
12196 \begin_inset Flex Code
12199 \begin_layout Plain Layout
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12215 A separate string for the menu.
12216 You can define an accelerator by appending the respective character to
12217 the string, divided by
12218 \begin_inset Quotes eld
12222 \begin_inset Quotes erd
12226 \begin_inset space \thinspace{}
12230 \begin_inset space \space{}
12234 \begin_inset Quotes eld
12238 \begin_inset Flex Code
12241 \begin_layout Plain Layout
12248 \begin_inset Quotes erd
12252 This specification is optional.
12253 If it is not given the
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12263 will be used instead for the menu.
12266 \begin_layout Itemize
12267 \begin_inset Flex Code
12270 \begin_layout Plain Layout
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12286 A longer explanatory text that appears in the tooltip when hovering over
12287 the argument inset.
12290 \begin_layout Itemize
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12301 \begin_inset Flex Code
12304 \begin_layout Plain Layout
12313 \begin_inset space \thinspace{}
12317 \begin_inset Flex Code
12320 \begin_layout Plain Layout
12326 ] Declare if this is a mandatory (1) or an optional (0) argument.
12327 Mandatory arguments will be output empty if not given, while optional arguments
12328 will not be output at all.
12329 By default, mandatory arguments are delimited by
12330 \begin_inset Flex Code
12333 \begin_layout Plain Layout
12339 , while optional arguments are delimited by
12340 \begin_inset Flex Code
12343 \begin_layout Plain Layout
12350 \change_inserted -712698321 1555579782
12354 \begin_layout Itemize
12356 \change_inserted -712698321 1555579780
12357 \begin_inset Flex Code
12360 \begin_layout Plain Layout
12362 \change_inserted -712698321 1555579780
12369 \begin_inset Flex Code
12372 \begin_layout Plain Layout
12374 \change_inserted -712698321 1555579780
12380 Option to define a different command (from the default
12381 \begin_inset Flex Code
12384 \begin_layout Plain Layout
12386 \change_inserted -712698321 1555579780
12396 ) to be used for line breaks.
12397 The initial backslash must not be specified.
12402 \begin_layout Itemize
12403 \begin_inset Flex Code
12406 \begin_layout Plain Layout
12413 \begin_inset Flex Code
12416 \begin_layout Plain Layout
12422 defines another argument (by its number) which this argument requires to
12423 be output if it is itself output.
12425 \begin_inset space \thinspace{}
12428 g., in \SpecialChar LaTeX
12429 commands, optional arguments often require previous optional arguments
12430 to be output (at least empty), as in
12431 \begin_inset Flex Code
12434 \begin_layout Plain Layout
12437 command[][argument]{text}
12443 This can be achieved by the statement
12444 \begin_inset Flex Code
12447 \begin_layout Plain Layout
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12466 \begin_layout Itemize
12467 \begin_inset Flex Code
12470 \begin_layout Plain Layout
12477 \begin_inset Flex Code
12480 \begin_layout Plain Layout
12486 defines a custom left delimiter (instead of
12487 \begin_inset Flex Code
12490 \begin_layout Plain Layout
12497 \begin_inset Flex Code
12500 \begin_layout Plain Layout
12507 A line break in the output can be indicated by
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
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 a custom right delimiter (instead of
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12551 \begin_inset Flex Code
12554 \begin_layout Plain Layout
12561 A line break in the output can be indicated by
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12574 \begin_layout Itemize
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12585 \begin_inset Flex Code
12588 \begin_layout Plain Layout
12594 defines an argument that is inserted if and only if no user-specified arguments
12596 \begin_inset space \thinspace{}
12600 \begin_inset space \space{}
12603 if no argument inset has been inserted (note that also an empty argument
12604 inset omits the DefaultArg).
12605 Multiple arguments need to be separated by comma.
12608 \begin_layout Itemize
12609 \begin_inset Flex Code
12612 \begin_layout Plain Layout
12619 \begin_inset Flex Code
12622 \begin_layout Plain Layout
12628 defines an argument that is inserted in any case (alone or in addition
12629 to user-specified arguments).
12630 Multiple arguments need to be separated by comma.
12633 \begin_layout Itemize
12634 \begin_inset Flex Code
12637 \begin_layout Plain Layout
12643 The font used for the argument content, see
12644 \begin_inset CommandInset ref
12646 reference "subsec:Font-description"
12651 \change_inserted -712698321 1559484228
12655 \begin_layout Itemize
12657 \change_inserted -712698321 1559484228
12658 \begin_inset Flex Code
12661 \begin_layout Plain Layout
12663 \change_inserted -712698321 1559484228
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12675 \change_inserted -712698321 1559484228
12684 \begin_inset space \thinspace{}
12688 \begin_inset Flex Code
12691 \begin_layout Plain Layout
12693 \change_inserted -712698321 1559484228
12699 ] As with paragraph styles, see
12700 \begin_inset CommandInset ref
12702 reference "subsec:Paragraph-Styles"
12711 \begin_layout Itemize
12712 \begin_inset Flex Code
12715 \begin_layout Plain Layout
12721 The font used for the label; see
12722 \begin_inset CommandInset ref
12724 reference "subsec:Font-description"
12731 \begin_layout Itemize
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12742 \begin_inset Flex Code
12745 \begin_layout Plain Layout
12750 , Minimalistic, Conglomerate
12755 ] describes the rendering style used for the inset's frame and buttons.
12758 \begin_layout Itemize
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12769 \begin_inset Flex Code
12772 \begin_layout Plain Layout
12779 \begin_inset Flex Code
12782 \begin_layout Plain Layout
12788 , this argument is automatically inserted when the respective style is selected.
12790 \change_deleted -712698321 1559484200
12791 Currently, only one argument per style\SpecialChar breakableslash
12792 layout can be automatically inserted.
12797 \begin_layout Itemize
12799 \change_inserted -712698321 1559491402
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12805 \change_inserted -712698321 1559490711
12812 \begin_inset Flex Code
12815 \begin_layout Plain Layout
12817 \change_inserted -712698321 1559490703
12824 \begin_inset Flex Code
12827 \begin_layout Plain Layout
12829 \change_inserted -712698321 1559490703
12835 , this argument will be inserted on a new line with
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12841 \change_inserted -712698321 1559491402
12847 (only available within Flex insets).
12850 \begin_layout Itemize
12851 \begin_inset Flex Code
12854 \begin_layout Plain Layout
12861 \begin_inset Flex Code
12864 \begin_layout Plain Layout
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12880 , this argument will be inserted with a copy of the co-text (either selected
12881 text or the whole paragraph) as content.
12884 \begin_layout Itemize
12885 \begin_inset Flex Code
12888 \begin_layout Plain Layout
12895 \begin_inset Flex Code
12898 \begin_layout Plain Layout
12908 ] Whether the contents of this argument should be output in raw form, meaning
12909 without special translations that \SpecialChar LaTeX
12912 \begin_inset Flex Code
12915 \begin_layout Plain Layout
12921 status is inherited by the inset or paragraph layout the argument belongs
12922 to, true and false change the status for the given argument only.
12925 \begin_layout Itemize
12926 \begin_inset Flex Code
12929 \begin_layout Plain Layout
12936 \begin_inset Flex Code
12939 \begin_layout Plain Layout
12940 string of characters
12949 Defines individual characters
12950 \begin_inset Newline linebreak
12953 that should be output in raw form, meaning without special translations
12954 that \SpecialChar LaTeX
12956 Note that, contrary to PassThru, this needs to be explicitly defined for
12958 That is, arguments do not inherit PassThruChars from their parent inset
12962 \begin_layout Itemize
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12985 \begin_inset space \thinspace{}
12989 \begin_inset Flex Code
12992 \begin_layout Plain Layout
12998 ] If this is set to 1, the argument will output its content in the corresponding
12999 item in the table of contents.
13003 \begin_layout Standard
13004 By default, the text entered in the \SpecialChar LyX
13005 workarea in the respective layout is
13006 the last (mandatory) argument of a command if the
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13017 \begin_inset Flex Code
13020 \begin_layout Plain Layout
13027 However, arguments with the prefix
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13037 are output after this workarea argument.
13038 Note that post-argument numbering restarts at 1, so the first argument
13039 following the workarea argument is
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13050 Post-arguments are ignored in any other
13051 \begin_inset Flex Code
13054 \begin_layout Plain Layout
13061 \begin_inset Flex Code
13064 \begin_layout Plain Layout
13073 \begin_layout Standard
13075 \begin_inset Flex Code
13078 \begin_layout Plain Layout
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13099 \begin_inset Flex Code
13102 \begin_layout Plain Layout
13108 followed by the number (e.
13109 \begin_inset space \thinspace{}
13113 \begin_inset space \space{}
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13127 \change_inserted -712698321 1534487781
13131 \begin_layout Standard
13133 \change_inserted -712698321 1534488561
13134 Finally, there is a special argument type with the prefix
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13140 \change_inserted -712698321 1534487844
13149 It is not really an argument, but uses the argument interface (thus, the
13150 prefix is also followed by a number, e.
13151 \begin_inset space \thinspace{}
13156 \begin_inset Flex Code
13159 \begin_layout Plain Layout
13161 \change_inserted -712698321 1534488412
13162 Argument listpreamble:1
13168 As the name implies, it is targeted at lists such as
13185 Its content will be output at the list start, before the first
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13191 \change_inserted -712698321 1534488058
13201 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13203 This way, users can insert redefinitions (of lengths etc.) to individual
13205 By default, these arguments do not have a delimiter.
13211 \begin_layout Description
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13221 Includes a comma-separated list of layouts that should be nested in and
13222 after the current layout.
13223 Only makes sense for nestable layouts (such as environments).
13225 \begin_inset Quotes eld
13229 \begin_inset Flex Code
13232 \begin_layout Plain Layout
13239 \begin_inset Quotes erd
13244 \begin_inset Flex Code
13247 \begin_layout Plain Layout
13256 \begin_layout Description
13257 \begin_inset Flex Code
13260 \begin_layout Plain Layout
13266 Note that this will completely override any prior
13267 \begin_inset Flex Code
13270 \begin_layout Plain Layout
13276 declaration for this style.
13278 \begin_inset Quotes eld
13282 \begin_inset Flex Code
13285 \begin_layout Plain Layout
13292 \begin_inset Quotes erd
13297 \begin_inset CommandInset ref
13299 reference "subsec:I18n"
13303 for details on its use.
13306 \begin_layout Description
13307 \begin_inset Flex Code
13310 \begin_layout Plain Layout
13317 \begin_inset Flex Code
13320 \begin_layout Plain Layout
13330 \begin_layout Plain Layout
13331 Note that a `float' here is a real number, such as: 1.5.
13336 The vertical space with which the last of a chain of paragraphs with this
13337 style is separated from the following paragraph.
13338 If the next paragraph has another style, the separations are not simply
13339 added, but the maximum is taken.
13342 \begin_layout Description
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13362 ] The category for this style.
13363 This is used to group related styles in the style combobox on the toolbar.
13364 Any string can be used, but you may want to use existing categories with
13369 \begin_layout Description
13370 \begin_inset Flex Code
13373 \begin_layout Plain Layout
13379 Depth of XML command.
13380 Used only with XML-type formats.
13383 \begin_layout Description
13384 \begin_inset Flex Code
13387 \begin_layout Plain Layout
13394 \begin_inset Flex Code
13397 \begin_layout Plain Layout
13403 ] Copies all the features of an existing style into the current one.
13407 \begin_layout Description
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13427 ] The name of a style whose preamble should be output
13432 This allows to ensure some ordering of the preamble snippets when macros
13433 definitions depend on one another.
13437 \begin_layout Plain Layout
13438 Note that, besides that functionality, there is no way to ensure any ordering
13440 The ordering that you see in a given version of \SpecialChar LyX
13441 may change without warning
13450 \begin_layout Description
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13469 , Box, Filled_Box, Static
13474 ] The type of label that stands at the end of the paragraph (or sequence
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13486 \begin_inset Newline newline
13490 \begin_inset Flex Code
13493 \begin_layout Plain Layout
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13510 \begin_inset Flex Code
13513 \begin_layout Plain Layout
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13531 \begin_inset Quotes eld
13535 \begin_inset Quotes erd
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13549 \begin_inset space \space{}
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13562 ) is a white (resp.
13563 \begin_inset space ~
13566 black) square suitable for end of proof markers,
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13576 is an explicit text string.
13579 \begin_layout Description
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13599 ] The string used for a label with a
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13610 \begin_inset Newline newline
13614 \begin_inset Flex Code
13617 \begin_layout Plain Layout
13627 \begin_layout Description
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13637 The font used for both the text body
13643 \begin_inset CommandInset ref
13645 reference "subsec:Font-description"
13650 Note that defining this font automatically defines the
13651 \begin_inset Flex Code
13654 \begin_layout Plain Layout
13661 So you should define this one first if you also want to define
13662 \begin_inset Flex Code
13665 \begin_layout Plain Layout
13674 \begin_layout Description
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13694 ] Used for backporting new styles to stable \SpecialChar LyX
13696 The first stable version that supports this tag is \SpecialChar LyX
13698 The argument is a number which may either be 0, -1 or any value greater
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13710 flag of a style is greater than zero, it will always be written to the
13712 If a .lyx file is read, the style definitions from the document header are
13713 added to the document class.
13714 Therefore even older \SpecialChar LyX
13715 versions can handle the style.
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13726 is a version number: if the style is read, and the version number is less
13727 than the version number of the already existing style in the document class,
13728 the new style is ignored.
13729 If the version number is greater, the new style replaces the existing style.
13730 A value of -1 means an infinite version number, i.
13731 \begin_inset space \thinspace{}
13735 \begin_inset space \space{}
13738 the style is always used.
13741 \begin_layout Description
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13764 \begin_inset space \thinspace{}
13768 \begin_inset Flex Code
13771 \begin_layout Plain Layout
13777 ] Usually \SpecialChar LyX
13778 does not allow you to insert more than one space between words,
13779 since a space is considered as the separation between two words, not a
13780 character or symbol of its own.
13781 This is a very fine thing but sometimes annoying, for example, when typing
13782 program code or plain \SpecialChar LaTeX
13785 \begin_inset Flex Code
13788 \begin_layout Plain Layout
13796 \change_deleted -495245474 1550490105
13800 will create protected blanks for the additional blanks when in
13801 \change_inserted -495245474 1550490096
13803 \begin_inset Flex Code
13806 \begin_layout Plain Layout
13808 \change_inserted -495245474 1550490089
13815 \change_deleted -495245474 1550490116
13816 another mode than \SpecialChar LaTeX
13819 \change_inserted -495245474 1550247760
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13826 \change_inserted -495245474 1550247736
13833 \begin_inset Flex Code
13836 \begin_layout Plain Layout
13838 \change_inserted -495245474 1550247755
13849 \begin_layout Description
13850 \begin_inset Flex Code
13853 \begin_layout Plain Layout
13859 These tags are used with XHTML output.
13861 \begin_inset CommandInset ref
13863 reference "subsec:Paragraph-Style-XHTML"
13870 \begin_layout Description
13871 \begin_inset Flex Code
13874 \begin_layout Plain Layout
13880 [FIXME] (Used only with XML-type formats.)
13883 \begin_layout Description
13884 \begin_inset Flex Code
13887 \begin_layout Plain Layout
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13906 \begin_inset space \thinspace{}
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13920 \begin_inset Flex Code
13923 \begin_layout Plain Layout
13929 , marks the style as to be included in the document preamble and not in
13931 This is useful for document classes that want such information as the title
13932 and author to appear in the preamble.
13933 Note that this works only for styles for which the
13934 \begin_inset Flex Code
13937 \begin_layout Plain Layout
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13966 \begin_layout Description
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13977 \begin_inset Flex Code
13980 \begin_layout Plain Layout
13989 \begin_inset space \thinspace{}
13993 \begin_inset Flex Code
13996 \begin_layout Plain Layout
14003 \begin_inset Flex Code
14006 \begin_layout Plain Layout
14012 , marks the style as being part of a title block (see also the
14013 \begin_inset Flex Code
14016 \begin_layout Plain Layout
14023 \begin_inset Flex Code
14026 \begin_layout Plain Layout
14035 \begin_layout Description
14036 \begin_inset Flex Code
14039 \begin_layout Plain Layout
14045 Includes a comma-separated list of layouts after which this one should
14047 Only makes sense with regard to nestable layouts (such as environments).
14049 \begin_inset Quotes eld
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14063 \begin_inset Quotes erd
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14080 \begin_layout Description
14081 \begin_inset Flex Code
14084 \begin_layout Plain Layout
14091 \begin_inset Flex Code
14094 \begin_layout Plain Layout
14103 \begin_inset space \thinspace{}
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14116 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14117 of its contents in its item in the table of contents.
14118 Otherwise, only the label, if it exists, appears.
14121 \begin_layout Description
14122 \begin_inset Flex Code
14125 \begin_layout Plain Layout
14132 \begin_inset Flex Code
14135 \begin_layout Plain Layout
14141 ] The \SpecialChar LaTeX
14142 command sequence declaring an item in a list.
14143 The command is to be defined without the preceding backslash (the default
14145 \begin_inset Quotes eld
14149 \begin_inset Quotes erd
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14164 in the \SpecialChar LaTeX
14168 \begin_layout Description
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14188 ] This provides extra space between paragraphs that have the same style.
14189 If you put other styles into an environment, each is separated with the
14191 \begin_inset Flex Code
14194 \begin_layout Plain Layout
14201 But the whole items of the environment are additionally separated with
14203 \begin_inset Flex Code
14206 \begin_layout Plain Layout
14213 Note that this is a
14218 \begin_layout Description
14219 \begin_inset Flex Code
14222 \begin_layout Plain Layout
14228 [FIXME] (Used only with XML-type formats.)
14231 \begin_layout Description
14232 \begin_inset Flex Code
14235 \begin_layout Plain Layout
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14254 \begin_inset space \thinspace{}
14258 \begin_inset Flex Code
14261 \begin_layout Plain Layout
14267 ] Usually \SpecialChar LyX
14268 does not allow you to leave a paragraph empty, since it would
14269 lead to empty \SpecialChar LaTeX
14271 There are some cases where this could be desirable however: in a letter
14272 template, the required fields can be provided as empty fields, so that
14273 people do not forget them; in some special classes, a style can be used
14274 as some kind of break, which does not contain actual text.
14277 \begin_layout Description
14278 \begin_inset Flex Code
14281 \begin_layout Plain Layout
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14297 ] The vertical space between the label and the text body.
14298 Only used for labels that are above the text body (
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14309 \begin_inset Newline newline
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14317 Centered_Top_Environment
14325 \begin_layout Description
14326 \begin_inset Flex Code
14329 \begin_layout Plain Layout
14336 \begin_inset Flex Code
14339 \begin_layout Plain Layout
14345 ] The name of the counter for automatic numbering.
14346 In order to have the counter appear with your label, you will need to reference
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14360 This will work with
14361 \begin_inset Flex Code
14364 \begin_layout Plain Layout
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14381 \begin_inset Flex Code
14384 \begin_layout Plain Layout
14391 \begin_inset Flex Code
14394 \begin_layout Plain Layout
14401 \begin_inset Newline newline
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14428 , though this case is a bit complicated.
14429 Suppose you declare
14430 \begin_inset Quotes eld
14434 \begin_inset Flex Code
14437 \begin_layout Plain Layout
14438 LabelCounter myenum
14444 \begin_inset Quotes erd
14448 Then the actual counters used are
14449 \begin_inset Flex Code
14452 \begin_layout Plain Layout
14459 \begin_inset Flex Code
14462 \begin_layout Plain Layout
14469 \begin_inset Flex Code
14472 \begin_layout Plain Layout
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14488 , much as in \SpecialChar LaTeX
14490 These counters must all be declared separately.
14491 \begin_inset Newline newline
14495 \begin_inset CommandInset ref
14497 reference "subsec:Counters"
14501 for details on counters.
14504 \begin_layout Description
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14514 The font used for the label.
14516 \begin_inset CommandInset ref
14518 reference "subsec:Font-description"
14525 \begin_layout Description
14526 \begin_inset Flex Code
14529 \begin_layout Plain Layout
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14545 ] Text that indicates how far a label should be indented.
14548 \begin_layout Description
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14559 \begin_inset Flex Code
14562 \begin_layout Plain Layout
14568 ] Text that indicates the amount of horizontal space between the label and
14570 Only used for labels that are not above the text body.
14573 \begin_layout Description
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14584 \begin_inset Flex Code
14587 \begin_layout Plain Layout
14593 ] The string used for the label.
14595 \begin_inset Flex Code
14598 \begin_layout Plain Layout
14604 is set, this string can be contain the special formatting commands described
14606 \begin_inset CommandInset ref
14608 reference "subsec:Counters"
14615 \begin_layout Description
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14620 LabelStringAppendix
14626 \begin_inset Flex Code
14629 \begin_layout Plain Layout
14635 ] This is used inside the appendix instead of
14636 \begin_inset Newline newline
14640 \begin_inset Flex Code
14643 \begin_layout Plain Layout
14651 \begin_inset Flex Code
14654 \begin_layout Plain Layout
14661 \begin_inset Newline newline
14665 \begin_inset Flex Code
14668 \begin_layout Plain Layout
14669 LabelStringAppendix
14677 \begin_layout Description
14678 \begin_inset Flex Code
14681 \begin_layout Plain Layout
14687 [FIXME] (Used only with XML-type formats.)
14690 \begin_layout Description
14691 \begin_inset Flex Code
14694 \begin_layout Plain Layout
14701 \begin_inset Flex Code
14704 \begin_layout Plain Layout
14709 , Manual, Static, Above,
14710 \begin_inset Newline newline
14713 Centered, Sensitive, Enumerate,
14714 \begin_inset Newline newline
14717 Itemize, Bibliography
14726 \begin_layout Description
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14736 means the label is the very first word (up to the first real blank).
14737 Use protected spaces if you want more than one word as the label.
14741 \begin_layout Description
14742 \begin_inset Flex Code
14745 \begin_layout Plain Layout
14751 means the label is simply what is declared as
14752 \begin_inset Flex Code
14755 \begin_layout Plain Layout
14762 This will be displayed
14763 \begin_inset Quotes eld
14767 \begin_inset Quotes erd
14770 , at the beginning of the paragraph.
14772 \begin_inset Flex Code
14775 \begin_layout Plain Layout
14782 \begin_inset Flex Code
14785 \begin_layout Plain Layout
14791 , then it will be displayed only in the first paragraph of any sequence
14792 of paragraphs with the same
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14805 \begin_layout Description
14806 \begin_inset Flex Code
14809 \begin_layout Plain Layout
14816 \begin_inset space ~
14820 \begin_inset space ~
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14833 are special cases of
14834 \begin_inset Flex Code
14837 \begin_layout Plain Layout
14844 The label will be printed above the paragraph either at the beginning of
14845 the line or centered.
14848 \begin_layout Description
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14858 is a special case for the caption-labels
14859 \begin_inset Quotes eld
14863 \begin_inset Quotes erd
14867 \begin_inset Quotes eld
14871 \begin_inset Quotes erd
14875 \begin_inset Newline newline
14879 \begin_inset Flex Code
14882 \begin_layout Plain Layout
14888 means the (hardcoded) label string depends on the kind of float: It is
14889 hardcoded to be `FloatType N', where N is the value of the counter associated
14891 For the case that a caption is inserted outside of a float the
14892 \begin_inset Flex Code
14895 \begin_layout Plain Layout
14902 \begin_inset Quotes eld
14906 \begin_inset Quotes erd
14912 \begin_layout Description
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14922 produces the usual sort of enumeration labels.
14923 The number type needs to be set in the
14928 \begin_inset CommandInset ref
14930 reference "subsec:Counters"
14937 \begin_layout Description
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14947 produces various bullets at the different levels.
14948 The bullet types displayed can be set via
14949 \begin_inset Flex Noun
14952 \begin_layout Plain Layout
14953 Document\SpecialChar menuseparator
14954 Settings\SpecialChar menuseparator
14963 \begin_layout Description
14964 \begin_inset Flex Code
14967 \begin_layout Plain Layout
14973 should be used only with
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14978 LatexType BibEnvironment
14987 \begin_layout Description
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14997 Note that this will completely override any prior
14998 \begin_inset Flex Code
15001 \begin_layout Plain Layout
15007 declaration for this style.
15009 \begin_inset Quotes eld
15013 \begin_inset Flex Code
15016 \begin_layout Plain Layout
15023 \begin_inset Quotes erd
15028 \begin_inset CommandInset ref
15030 reference "subsec:I18n"
15034 for details on its use.
15037 \begin_layout Description
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15048 \begin_inset Flex Code
15051 \begin_layout Plain Layout
15057 ] The name of the corresponding \SpecialChar LaTeX
15059 Either the environment or command name.
15062 \begin_layout Description
15063 \begin_inset Flex Code
15066 \begin_layout Plain Layout
15073 \begin_inset Flex Code
15076 \begin_layout Plain Layout
15082 ] An optional parameter for the corresponding
15083 \begin_inset Flex Code
15086 \begin_layout Plain Layout
15093 This parameter cannot be changed from within \SpecialChar LyX
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15104 for customizable parameters).
15105 This will be output as is after all \SpecialChar LaTeX
15107 \begin_inset Flex Code
15110 \begin_layout Plain Layout
15119 \begin_layout Description
15120 \begin_inset Flex Code
15123 \begin_layout Plain Layout
15130 \begin_inset Flex Code
15133 \begin_layout Plain Layout
15138 , Command, Environment, Item_Environment,
15139 \begin_inset Newline newline
15142 List_Environment, Bib_Environment
15147 ] How the style should be translated into \SpecialChar LaTeX
15152 \begin_layout Plain Layout
15153 \begin_inset Flex Code
15156 \begin_layout Plain Layout
15162 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15163 Visit the SGML class files for specific examples.
15172 \begin_layout Description
15173 \begin_inset Flex Code
15176 \begin_layout Plain Layout
15182 means nothing special.
15185 \begin_layout Description
15186 \begin_inset Flex Code
15189 \begin_layout Plain Layout
15196 \begin_inset Flex Code
15199 \begin_layout Plain Layout
15206 {\SpecialChar ldots
15215 \begin_layout Description
15216 \begin_inset Flex Code
15219 \begin_layout Plain Layout
15226 \begin_inset Flex Code
15229 \begin_layout Plain Layout
15236 }\SpecialChar ldots
15252 \begin_layout Description
15253 \begin_inset Flex Code
15256 \begin_layout Plain Layout
15263 \begin_inset Flex Code
15266 \begin_layout Plain Layout
15273 \begin_inset Flex Code
15276 \begin_layout Plain Layout
15284 is generated for each paragraph of this environment.
15288 \begin_layout Description
15289 \begin_inset Flex Code
15292 \begin_layout Plain Layout
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15309 \begin_inset Newline newline
15313 \begin_inset Flex Code
15316 \begin_layout Plain Layout
15322 is passed as an argument to the environment.
15323 \begin_inset Newline newline
15327 \begin_inset Flex Code
15330 \begin_layout Plain Layout
15336 can be defined in the
15337 \begin_inset Flex Noun
15340 \begin_layout Plain Layout
15341 Edit\SpecialChar menuseparator
15343 \begin_inset space ~
15354 \begin_layout Description
15355 \begin_inset Flex Code
15358 \begin_layout Plain Layout
15365 \begin_inset Flex Code
15368 \begin_layout Plain Layout
15374 but adds the necessary mandatory argument (the longest label) to the begin
15375 statement of the bibliography environment:
15376 \begin_inset Newline newline
15380 \begin_inset Flex Code
15383 \begin_layout Plain Layout
15386 begin{thebibliography}{99}
15392 It is therefore only useful for bibliography environments.
15393 The default longest label
15394 \begin_inset Quotes eld
15398 \begin_inset Quotes erd
15401 can be changed by the user in the paragraph settings of a bibliography
15405 \begin_layout Standard
15406 Putting the last few things together, the \SpecialChar LaTeX
15407 output will be either:
15410 \begin_layout LyX-Code
15413 LatexName[LatexParam]{\SpecialChar ldots
15417 \begin_layout Standard
15421 \begin_layout LyX-Code
15424 begin{LatexName}[LatexParam] \SpecialChar ldots
15430 \begin_layout Standard
15431 depending upon the \SpecialChar LaTeX
15436 \begin_layout Description
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15447 \begin_inset Flex Code
15450 \begin_layout Plain Layout
15456 ] A string that is put at the beginning of the style content.
15457 A line break in the output can be indicated by
15458 \begin_inset Flex Code
15461 \begin_layout Plain Layout
15470 \begin_layout Description
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15481 \begin_inset Flex Code
15484 \begin_layout Plain Layout
15490 ] If you put styles into environments, the different
15491 \begin_inset Flex Code
15494 \begin_layout Plain Layout
15500 are not simply added, but added with a factor
15501 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15505 Note that this parameter is also used when
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15526 \begin_inset Flex Code
15529 \begin_layout Plain Layout
15536 Then it is added to the manual or dynamic margin.
15537 \begin_inset Newline newline
15541 \begin_inset Quotes eld
15545 \begin_inset Flex Code
15548 \begin_layout Plain Layout
15555 \begin_inset Quotes erd
15558 means that the paragraph is indented with the width of
15559 \begin_inset Quotes eld
15563 \begin_inset Flex Code
15566 \begin_layout Plain Layout
15573 \begin_inset Quotes erd
15576 in the normal font.
15577 You can get a negative width by prefixing the string with
15578 \begin_inset Quotes eld
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15592 \begin_inset Quotes erd
15596 This way was chosen so that the look is the same with each used screen
15600 \begin_layout Description
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15619 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15625 \begin_inset Newline newline
15628 The kind of margin that the style has on the left side.
15632 \begin_layout Description
15633 \begin_inset Flex Code
15636 \begin_layout Plain Layout
15642 just means a fixed margin.
15645 \begin_layout Description
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15655 means that the left margin depends on the string entered in the
15656 \begin_inset Flex Noun
15659 \begin_layout Plain Layout
15660 Edit\SpecialChar menuseparator
15662 \begin_inset space ~
15671 This is used to typeset nice lists without tabulators.
15674 \begin_layout Description
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15684 means that the margin depends on the size of the label.
15685 This is used for automatic enumerated headlines.
15686 It is obvious that the headline
15687 \begin_inset Quotes eld
15690 5.4.3.2.1 Very long headline
15691 \begin_inset Quotes erd
15694 must have a wider left margin (as wide as
15695 \begin_inset Quotes eld
15699 \begin_inset Quotes erd
15702 plus the space) than
15703 \begin_inset Quotes eld
15706 3.2 Very long headline
15707 \begin_inset Quotes erd
15711 \begin_inset Quotes eld
15715 \begin_inset Quotes erd
15718 are not able to do this.
15721 \begin_layout Description
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15731 is similar, but only the very first row of the paragraph is dynamic, while
15732 the others are static; this is used, for example, for descriptions.
15735 \begin_layout Description
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15745 means the margin is chosen in a way that the longest row of this paragraph
15746 fits to the right margin.
15747 This is used to typeset an address on the right edge of the page.
15751 \begin_layout Description
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15762 \begin_inset Flex Code
15765 \begin_layout Plain Layout
15774 \begin_inset space \thinspace{}
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15787 ] Whether fragile commands in this style should be
15788 \begin_inset Flex Code
15791 \begin_layout Plain Layout
15804 whether this command should itself be protected.)
15805 \change_inserted -712698321 1523696949
15809 \begin_layout Description
15811 \change_inserted -712698321 1552395557
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15817 \change_inserted -712698321 1523696950
15824 \begin_inset Flex Code
15827 \begin_layout Plain Layout
15829 \change_inserted -712698321 1523696950
15838 \begin_inset space \thinspace{}
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15847 \change_inserted -712698321 1523696950
15853 ] This causes macros that contain this layout to be protected with
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15859 \change_inserted -712698321 1523696950
15872 ) if necessary and thus allows (some) verbatim stuff in macros.
15875 \begin_layout Description
15877 \change_inserted -712698321 1552395844
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15883 \change_inserted -712698321 1552395561
15890 \begin_inset Flex Code
15893 \begin_layout Plain Layout
15895 \change_inserted -712698321 1552395557
15904 \begin_inset space \thinspace{}
15908 \begin_inset Flex Code
15911 \begin_layout Plain Layout
15913 \change_inserted -712698321 1552395557
15919 ] Whether specific commands in this style (such as
15920 \begin_inset Flex Code
15923 \begin_layout Plain Layout
15925 \change_inserted -712698321 1552395655
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15941 \change_inserted -712698321 1552395661
15951 ) should be protected in an
15952 \begin_inset Flex Code
15955 \begin_layout Plain Layout
15957 \change_inserted -712698321 1552395631
15968 This is particularly needed for styles that draw on
15976 commands which parse their content in complex ways.
15981 \begin_layout Description
15982 \begin_inset Flex Code
15985 \begin_layout Plain Layout
15992 \begin_inset Flex Code
15995 \begin_layout Plain Layout
16002 \begin_inset space \thinspace{}
16006 \begin_inset Flex Code
16009 \begin_layout Plain Layout
16017 ] Whether newlines are translated into \SpecialChar LaTeX
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16033 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16035 inside \SpecialChar LyX
16039 \begin_layout Description
16040 \begin_inset Flex Code
16043 \begin_layout Plain Layout
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16062 \begin_inset space \thinspace{}
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16075 ] If set to true, and if
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16095 ) paragraphs are being indented, then the indentation of such a paragraph
16096 following one of this type will be suppressed.
16097 (So this will not affect the display of non-default paragraphs.)
16100 \begin_layout Description
16101 \begin_inset Flex Code
16104 \begin_layout Plain Layout
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16120 ] Name of a style that has replaced this style.
16121 This is used to rename a style, while keeping backward compatibility.
16124 \begin_layout Description
16125 \begin_inset Flex Code
16128 \begin_layout Plain Layout
16135 \begin_inset Flex Code
16138 \begin_layout Plain Layout
16145 \begin_inset space \thinspace{}
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16158 ] Determines whether consecutive paragraphs of the same type are treated
16159 as belonging together.
16160 This has the effect that the
16161 \begin_inset Flex Code
16164 \begin_layout Plain Layout
16170 is only printed once before such a group.
16171 By default, this is true for
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16182 \begin_inset Flex Code
16185 \begin_layout Plain Layout
16192 \begin_inset Flex Code
16195 \begin_layout Plain Layout
16201 and false for all other types.
16204 \begin_layout Description
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16227 \begin_inset space \thinspace{}
16231 \begin_inset Flex Code
16234 \begin_layout Plain Layout
16240 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16242 but only by a line break; together with
16243 \begin_inset Flex Code
16246 \begin_layout Plain Layout
16252 , this allows to emulate a plain text editor (like the ERT inset).
16255 \begin_layout Description
16256 \begin_inset Flex Code
16259 \begin_layout Plain Layout
16266 \begin_inset Flex Code
16269 \begin_layout Plain Layout
16275 ] The indent of the very first line of a paragraph.
16277 \begin_inset Newline newline
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16290 will be fixed for a certain style.
16291 The exception is the default style, since the indentation for these paragraphs
16292 can be prohibited with
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16313 style paragraphs inside environments use the
16314 \begin_inset Flex Code
16317 \begin_layout Plain Layout
16323 of the environment, not their native one.
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16334 paragraphs inside an enumeration are not indented.
16337 \begin_layout Description
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16357 ] The vertical space between two paragraphs of this style.
16360 \begin_layout Description
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16371 \begin_inset Flex Code
16374 \begin_layout Plain Layout
16381 allows the user to choose either
16382 \begin_inset Quotes eld
16386 \begin_inset Quotes erd
16390 \begin_inset Quotes eld
16394 \begin_inset Quotes erd
16397 to separate paragraphs.
16399 \begin_inset Quotes eld
16403 \begin_inset Quotes erd
16407 \begin_inset Flex Code
16410 \begin_layout Plain Layout
16418 \begin_inset Quotes eld
16422 \begin_inset Quotes erd
16426 \begin_inset Flex Code
16429 \begin_layout Plain Layout
16435 is ignored and all paragraphs are separated by the
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16446 The vertical space is calculated with
16447 \begin_inset Flex Code
16450 \begin_layout Plain Layout
16452 \begin_inset space ~
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16470 is the height of a row with the normal font.
16471 This way, the look stays the same with different screen fonts.
16474 \begin_layout Description
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16485 \begin_inset Flex Code
16488 \begin_layout Plain Layout
16497 \begin_inset space \thinspace{}
16501 \begin_inset Flex Code
16504 \begin_layout Plain Layout
16510 ] Whether the contents of this paragraph should be output in raw form, meaning
16511 without special translations that \SpecialChar LaTeX
16515 \begin_layout Description
16516 \begin_inset Flex Code
16519 \begin_layout Plain Layout
16526 \begin_inset Flex Code
16529 \begin_layout Plain Layout
16539 Defines individual characters that should be output in raw form, meaning
16540 without special translations that \SpecialChar LaTeX
16544 \begin_layout Description
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16554 Information to be included in the \SpecialChar LaTeX
16555 preamble when this style is used.
16556 Used to define macros, load packages, etc., required by this particular
16559 \begin_inset Quotes eld
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16573 \begin_inset Quotes erd
16579 \begin_layout Description
16580 \begin_inset Flex Code
16583 \begin_layout Plain Layout
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16599 ] The prefix to use when creating labels referring to paragraphs of this
16601 This allows the use of formatted references.
16604 \begin_layout Description
16605 \begin_inset Flex Code
16608 \begin_layout Plain Layout
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16624 ] Whether the style requires the feature
16625 \begin_inset Flex Code
16628 \begin_layout Plain Layout
16635 \begin_inset CommandInset ref
16637 reference "chap:List-of-functions"
16641 for the list of features).
16642 If you require a package with specific options, you can additionally use
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16653 as a general text class parameter (see
16654 \begin_inset CommandInset ref
16656 reference "subsec:General-text-class"
16663 \begin_layout Description
16664 \begin_inset Flex Code
16667 \begin_layout Plain Layout
16674 \begin_inset Flex Code
16677 \begin_layout Plain Layout
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16695 ] Resets the \SpecialChar LaTeX
16696 arguments of this style (as defined via the
16697 \begin_inset Flex Code
16700 \begin_layout Plain Layout
16707 This is useful if you have copied a style via
16708 \begin_inset Flex Code
16711 \begin_layout Plain Layout
16717 , but you do not want to inherit its (required and optional) arguments.
16720 \begin_layout Description
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16752 ] Resumes a counter that is usually reset at each new sequence of layouts.
16753 This is currently only useful when
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16764 \begin_inset Flex Code
16767 \begin_layout Plain Layout
16776 \begin_layout Description
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16796 ] A string that is put at the end of the layout content.
16797 A line break in the output can be indicated by
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16810 \begin_layout Description
16811 \begin_inset Flex Code
16814 \begin_layout Plain Layout
16821 \begin_inset Flex Code
16824 \begin_layout Plain Layout
16831 \begin_inset Flex Code
16834 \begin_layout Plain Layout
16843 \begin_layout Description
16844 \begin_inset Flex Code
16847 \begin_layout Plain Layout
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16866 \begin_inset Flex Code
16869 \begin_layout Plain Layout
16876 \begin_inset Flex Code
16879 \begin_layout Plain Layout
16886 \begin_inset Flex Code
16889 \begin_layout Plain Layout
16891 \begin_inset space ~
16899 ] This defines what the default spacing should be in the style.
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16911 \begin_inset Flex Code
16914 \begin_layout Plain Layout
16921 \begin_inset Flex Code
16924 \begin_layout Plain Layout
16930 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16931 If you specify the argument
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 , then you must also provide a value argument which will be the actual multiplie
16943 Note that, contrary to other parameters,
16944 \begin_inset Flex Code
16947 \begin_layout Plain Layout
16953 implies the generation of specific \SpecialChar LaTeX
16954 code, using the \SpecialChar LaTeX
16958 \begin_inset Flex Code
16961 \begin_layout Plain Layout
16970 \begin_layout Description
16971 \begin_inset Flex Code
16974 \begin_layout Plain Layout
16981 \begin_inset Flex Code
16984 \begin_layout Plain Layout
16991 \begin_inset space \thinspace{}
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17006 ] Allow spell-checking paragraphs of this style.
17010 \begin_layout Description
17011 \begin_inset Flex Code
17014 \begin_layout Plain Layout
17021 \begin_inset Flex Code
17024 \begin_layout Plain Layout
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17042 ] Steps the master counter of a given counter at the beginning of a new
17043 sequence of layouts.
17044 This is currently only useful when
17045 \begin_inset Flex Code
17048 \begin_layout Plain Layout
17055 \begin_inset Flex Code
17058 \begin_layout Plain Layout
17067 \begin_layout Description
17068 \begin_inset Flex Code
17071 \begin_layout Plain Layout
17077 The font used for the text body .
17079 \begin_inset CommandInset ref
17081 reference "subsec:Font-description"
17088 \begin_layout Description
17089 \begin_inset Flex Code
17092 \begin_layout Plain Layout
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17114 The level of the style in the table of contents.
17115 This is used for automatic numbering of section headings.
17118 \begin_layout Description
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17131 \begin_inset Flex Code
17134 \begin_layout Plain Layout
17145 \begin_inset Flex Code
17148 \begin_layout Plain Layout
17155 \begin_inset Flex Code
17158 \begin_layout Plain Layout
17164 ] This tag determines whether the first line indentation of this paragraph
17165 can be toggled via the Paragraph settings dialog.
17169 \begin_inset Flex Code
17172 \begin_layout Plain Layout
17182 is set, indentation can be toggled if the document settings use
17183 \begin_inset Quotes eld
17187 \begin_inset Quotes erd
17190 paragraph style, with
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17200 , indentation can always be toggled, notwithstanding the document settings,
17202 \begin_inset Flex Code
17205 \begin_layout Plain Layout
17211 , indentation can never be toggled.
17214 \begin_layout Description
17215 \begin_inset Flex Code
17218 \begin_layout Plain Layout
17225 \begin_inset Flex Code
17228 \begin_layout Plain Layout
17234 ] The vertical space with which the very first of a chain of paragraphs
17235 with this style is separated from the previous paragraph.
17236 If the previous paragraph has another style, the separations are not simply
17237 added, but the maximum is taken.
17240 \begin_layout Subsection
17241 \begin_inset CommandInset label
17247 Internationalization of Paragraph Styles
17250 \begin_layout Standard
17252 has long supported internationalization of layout information, but, until
17253 version 2.0, this applied only to the user interface and not to, say, PDF
17255 Thus, French authors were forced to resort to ugly hacks if they wanted
17260 1' instead of `Theorem 1'.
17261 Thanks to Georg Baum, that is no longer the case.
17264 \begin_layout Standard
17266 \begin_inset Flex Code
17269 \begin_layout Plain Layout
17275 defines text that is to appear in the typeset document, it may use
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17295 to support non-English and even multi-language documents correctly.
17296 The following excerpt (from the
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17306 file) shows how this works:
17309 \begin_layout LyX-Code
17314 \begin_layout LyX-Code
17317 theoremstyle{remark}
17320 \begin_layout LyX-Code
17323 newtheorem{claim}[thm]{
17330 \begin_layout LyX-Code
17334 \begin_layout LyX-Code
17338 \begin_layout LyX-Code
17343 claimname}{_(Claim)}
17346 \begin_layout LyX-Code
17350 \begin_layout LyX-Code
17354 \begin_layout LyX-Code
17363 claimname}{_(Claim)}}
17366 \begin_layout LyX-Code
17371 \begin_layout Standard
17372 In principle, any legal \SpecialChar LaTeX
17374 \begin_inset Flex Code
17377 \begin_layout Plain Layout
17384 \begin_inset Flex Code
17387 \begin_layout Plain Layout
17393 tags, but in practice they will typically look as they do here.
17394 The key to correct translation of the typeset text is the definition of
17395 the \SpecialChar LaTeX
17397 \begin_inset Flex Code
17400 \begin_layout Plain Layout
17409 \begin_inset Flex Code
17412 \begin_layout Plain Layout
17424 \begin_layout Standard
17426 \begin_inset Flex Code
17429 \begin_layout Plain Layout
17435 tag provides for internationalization based upon the overall language of
17437 The contents of the tag will be included in the preamble, just as with
17439 \begin_inset Flex Code
17442 \begin_layout Plain Layout
17449 What makes it special is the use of the
17450 \begin_inset Quotes eld
17454 \begin_inset Quotes erd
17458 \begin_inset Flex Code
17461 \begin_layout Plain Layout
17467 , which will be replaced, when \SpecialChar LyX
17468 produces \SpecialChar LaTeX
17469 output, with the translation of
17470 its argument into the document language.
17473 \begin_layout Standard
17475 \begin_inset Flex Code
17478 \begin_layout Plain Layout
17484 tag is more complex, since it is meant to provide support for multi-language
17485 documents and so offers an interface to the
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17496 Its contents will be added to the preamble once for each language that
17497 appears in the document.
17498 In this case, the argument to
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17508 will be replaced with its translation into the language in question; the
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17519 is replaced by the language name (as used by the babel package).
17522 \begin_layout Standard
17523 A German document that also included a French section would thus have the
17524 following in the preamble:
17527 \begin_layout LyX-Code
17536 claimname}{Affirmation}}
17537 \begin_inset Newline newline
17548 claimname}{Behauptung}}
17549 \begin_inset Newline newline
17556 claimname}{Behauptung}
17559 \begin_layout Standard
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17571 will then conspire to produce the correct text in the output.
17574 \begin_layout Standard
17575 One important point to note here is that the translations are provided by
17577 itself, through the file
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17588 This means, in effect, that
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17608 are really only of use in layout files that are provided with \SpecialChar LyX
17610 entered in user-created layout files will not be seen by \SpecialChar LyX
17611 's internationalizatio
17612 n routines unless the
17613 \begin_inset Flex Code
17616 \begin_layout Plain Layout
17622 file is modified accordingly.
17623 That said, however, any layout created with the intention that it will
17624 be included with \SpecialChar LyX
17625 should use these tags where appropriate.
17626 Please note that the paragraph style translations provided by \SpecialChar LyX
17628 change with a minor update (e.
17629 \begin_inset space \thinspace{}
17633 \begin_inset space \space{}
17636 from version 2.1.x to 2.1.y).
17637 It is however quite likely that a major update (e.
17638 \begin_inset space \thinspace{}
17642 \begin_inset space \space{}
17645 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17648 \begin_layout Subsection
17650 \begin_inset CommandInset label
17652 name "subsec:Floats"
17659 \begin_layout Standard
17660 It is necessary to define the floats (
17661 \begin_inset Flex Noun
17664 \begin_layout Plain Layout
17671 \begin_inset Flex Noun
17674 \begin_layout Plain Layout
17680 , \SpecialChar ldots
17681 ) in the text class itself.
17682 Standard floats are included in the file
17683 \begin_inset Flex Code
17686 \begin_layout Plain Layout
17692 , so you may have to do no more than add
17695 \begin_layout LyX-Code
17696 Input stdfloats.inc
17699 \begin_layout Standard
17700 to your layout file.
17701 If you want to implement a text class that proposes some other float types
17702 (like the AGU class bundled with \SpecialChar LyX
17703 ), the information below will hopefully
17707 \begin_layout Description
17708 \begin_inset Flex Code
17711 \begin_layout Plain Layout
17718 \begin_inset Flex Code
17721 \begin_layout Plain Layout
17727 =!htbpH] Allowed placement options for this float type.
17728 The value is a string of placement characters.
17729 Possible characters include:
17734 \begin_inset Quotes eld
17738 \begin_inset Quotes erd
17746 \begin_inset Quotes eld
17750 \begin_inset Quotes erd
17758 \begin_inset Quotes eld
17762 \begin_inset Quotes erd
17770 \begin_inset Quotes eld
17774 \begin_inset Quotes erd
17782 \begin_inset Quotes eld
17786 \begin_inset Quotes erd
17794 \begin_inset Quotes eld
17798 \begin_inset Quotes erd
17802 The order of the characters in the string does not matter.
17803 If no placement options are allowed, use the string
17810 \begin_layout Description
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17833 \begin_inset space \thinspace{}
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17852 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17868 if the float does not support this feature.
17871 \begin_layout Description
17872 \begin_inset Flex Code
17875 \begin_layout Plain Layout
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17894 \begin_inset space \thinspace{}
17900 \begin_inset Flex Code
17903 \begin_layout Plain Layout
17913 ] Defines whether the float has a starred variant that spans columns in
17914 a two column paragraph.
17916 \begin_inset Flex Code
17919 \begin_layout Plain Layout
17925 if the float does not support this feature.
17928 \begin_layout Description
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17949 \begin_inset Quotes erd
17953 \begin_inset Quotes erd
17956 ] The file name extension of an auxiliary file for the list of figures (or
17959 writes the captions to this file.
17962 \begin_layout Description
17963 \begin_inset Flex Code
17966 \begin_layout Plain Layout
17973 \begin_inset Flex Code
17976 \begin_layout Plain Layout
17983 \begin_inset Quotes erd
17987 \begin_inset Quotes erd
17990 ] The string that will be used in the menus and also for the caption.
17991 This is translated to the current language if babel is used.
17994 \begin_layout Description
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18004 These tags control the XHTML output.
18006 \begin_inset CommandInset ref
18008 reference "sec:Tags-for-XHTML"
18015 \begin_layout Description
18016 \begin_inset Flex Code
18019 \begin_layout Plain Layout
18028 \begin_inset Flex Code
18031 \begin_layout Plain Layout
18040 \begin_inset space \thinspace{}
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18053 ] Indicates whether the float is already defined in the document class or
18054 if instead the \SpecialChar LaTeX
18056 \begin_inset Flex Code
18059 \begin_layout Plain Layout
18065 needs to be loaded to define it on-the-fly.
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18077 \begin_inset Flex Code
18080 \begin_layout Plain Layout
18087 It should be set to
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18097 if the float is already defined by the \SpecialChar LaTeX
18101 \begin_layout Description
18102 \begin_inset Flex Code
18105 \begin_layout Plain Layout
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18122 \begin_inset Quotes erd
18126 \begin_inset Quotes erd
18129 ] The command used to generate a list of floats of this type; the leading
18138 \begin_inset Flex Code
18141 \begin_layout Plain Layout
18147 is false, since there is no standard way to generate this command.
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18158 is true, since in that case there is a standard way to define the command.
18161 \begin_layout Description
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18172 \begin_inset Flex Code
18175 \begin_layout Plain Layout
18182 \begin_inset Quotes erd
18186 \begin_inset Quotes erd
18189 ] A title for a list of floats of this kind (list of figures, tables, or
18191 It is used for the screen label within \SpecialChar LyX
18192 , it is used by \SpecialChar LaTeX
18194 it is used as the title in the XHTML output.
18195 It will be translated to the document language.
18198 \begin_layout Description
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18219 \begin_inset Quotes erd
18223 \begin_inset Quotes erd
18226 ] This (optional) argument determines whether floats of this class will
18227 be numbered within some sectional unit of the document.
18229 \begin_inset Flex Code
18232 \begin_layout Plain Layout
18239 \begin_inset Quotes eld
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18253 \begin_inset Quotes erd
18256 , the floats will be numbered within chapters.
18260 \begin_layout Description
18261 \begin_inset Flex Code
18264 \begin_layout Plain Layout
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18281 \begin_inset Quotes erd
18285 \begin_inset Quotes erd
18288 ] The default placement for the given class of floats.
18289 The string should be as in standard \SpecialChar LaTeX
18291 \begin_inset Flex Code
18294 \begin_layout Plain Layout
18301 \begin_inset Flex Code
18304 \begin_layout Plain Layout
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18330 for top, bottom, page, and here, respectively.
18334 \begin_layout Plain Layout
18335 Note that the order of these letters in the string is irrelevant, like in
18342 On top of that there is a new type,
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18352 , which does not really correspond to a float, since it means: put it
18353 \begin_inset Quotes eld
18357 \begin_inset Quotes erd
18361 Note however that the
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18371 specifier is special and, because of implementation details, cannot be
18372 used in non-built in float types.
18373 If you do not understand what this means, just use
18374 \begin_inset Quotes eld
18378 \begin_inset Flex Code
18381 \begin_layout Plain Layout
18388 \begin_inset Quotes erd
18394 \begin_layout Description
18395 \begin_inset Flex Code
18398 \begin_layout Plain Layout
18405 \begin_inset Flex Code
18408 \begin_layout Plain Layout
18414 ] The prefix to use when creating labels referring to floats of this type.
18415 This allows the use of formatted references.
18416 Note that you can remove any
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18426 set by a copied style by using the special value
18427 \begin_inset Quotes eld
18431 \begin_inset Quotes erd
18434 , which must be all caps.
18435 \change_inserted -712698321 1565605014
18439 \begin_layout Description
18441 \change_inserted -712698321 1565605014
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18447 \change_inserted -712698321 1565605014
18454 \begin_inset Flex Code
18457 \begin_layout Plain Layout
18459 \change_inserted -712698321 1565605014
18465 ] As with paragraph styles, see
18466 \begin_inset CommandInset ref
18468 reference "subsec:Paragraph-Styles"
18477 \begin_layout Description
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18498 \begin_inset Quotes erd
18502 \begin_inset Quotes erd
18505 ] The style used when defining the float using
18506 \begin_inset Flex Code
18509 \begin_layout Plain Layout
18520 \begin_layout Description
18521 \begin_inset Flex Code
18524 \begin_layout Plain Layout
18531 \begin_inset Flex Code
18534 \begin_layout Plain Layout
18541 \begin_inset Quotes erd
18545 \begin_inset Quotes erd
18549 \begin_inset Quotes eld
18553 \begin_inset Quotes erd
18556 of the new class of floats, like program or algorithm.
18557 After the appropriate
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18582 \begin_inset Flex Code
18585 \begin_layout Plain Layout
18596 \begin_layout Description
18597 \begin_inset Flex Code
18600 \begin_layout Plain Layout
18607 \begin_inset Flex Code
18610 \begin_layout Plain Layout
18617 \begin_inset space \thinspace{}
18621 \begin_inset Flex Code
18624 \begin_layout Plain Layout
18632 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18634 \begin_inset Flex Code
18637 \begin_layout Plain Layout
18643 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18647 \begin_layout Standard
18648 Note that defining a float with type
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18660 automatically defines the corresponding counter with name
18661 \begin_inset Flex Code
18664 \begin_layout Plain Layout
18675 \begin_layout Subsection
18676 Flex insets and InsetLayout
18677 \begin_inset CommandInset label
18679 name "subsec:Flex-insets-and"
18686 \begin_layout Standard
18687 Flex insets come in
18688 \change_deleted 5863208 1594239511
18690 \change_inserted 5863208 1594239512
18696 \begin_layout Itemize
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18707 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18721 \begin_inset Flex Code
18724 \begin_layout Plain Layout
18735 \begin_layout Itemize
18737 \begin_inset Flex Code
18740 \begin_layout Plain Layout
18746 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18748 footnote, and the like.
18749 An obvious example is an endnote inset, which is defined in the
18750 \begin_inset Flex Code
18753 \begin_layout Plain Layout
18762 \begin_layout Itemize
18764 \change_deleted 5863208 1594239528
18766 \begin_inset Flex Code
18769 \begin_layout Plain Layout
18775 ): For use with DocBook classes.
18780 \begin_layout Standard
18781 Flex insets are defined using the
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18791 tag, which shall be explained in a moment.
18794 \begin_layout Standard
18796 \begin_inset Flex Code
18799 \begin_layout Plain Layout
18805 tag also serves another function: It can be used to customize the general
18806 layout of many different types of insets.
18808 \begin_inset Flex Code
18811 \begin_layout Plain Layout
18817 can be used to customize the layout parameters for footnotes, marginal
18818 notes, note insets, \SpecialChar TeX
18819 code (ERT) insets, branches, listings, indexes, boxes,
18820 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18823 \begin_layout Standard
18825 \begin_inset Flex Code
18828 \begin_layout Plain Layout
18834 definition must begin with a line of the form:
18837 \begin_layout LyX-Code
18841 \begin_layout Standard
18843 \begin_inset Flex Code
18846 \begin_layout Plain Layout
18852 indicates the inset whose layout is being defined, and here there are four
18856 \begin_layout Enumerate
18857 The layout for a pre-existing inset is being modified.
18858 In this case, can be
18859 \begin_inset Flex Code
18862 \begin_layout Plain Layout
18868 any one of the following:
18869 \begin_inset Flex Code
18872 \begin_layout Plain Layout
18879 \begin_inset Flex Code
18882 \begin_layout Plain Layout
18889 \begin_inset Flex Code
18892 \begin_layout Plain Layout
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18909 \begin_inset Flex Code
18912 \begin_layout Plain Layout
18919 \begin_inset Flex Code
18922 \begin_layout Plain Layout
18929 \begin_inset Flex Code
18932 \begin_layout Plain Layout
18939 \begin_inset Flex Code
18942 \begin_layout Plain Layout
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18979 \begin_inset Flex Code
18982 \begin_layout Plain Layout
18989 \begin_inset Flex Code
18992 \begin_layout Plain Layout
18999 \begin_inset Flex Code
19002 \begin_layout Plain Layout
19009 \begin_inset Flex Code
19012 \begin_layout Plain Layout
19019 \begin_inset Flex Code
19022 \begin_layout Plain Layout
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19039 \begin_inset Flex Code
19042 \begin_layout Plain Layout
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19059 \begin_inset Flex Code
19062 \begin_layout Plain Layout
19071 \begin_layout Enumerate
19072 The layout for a Flex inset is being defined.
19074 \begin_inset Flex Code
19077 \begin_layout Plain Layout
19083 must be of the form
19084 \begin_inset Quotes eld
19088 \begin_inset Flex Code
19091 \begin_layout Plain Layout
19098 \begin_inset Quotes erd
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19111 may be be any valid identifier not used by a pre-existing Flex inset.
19112 The identifier may include spaces, but in that case the whole thing must
19113 be wrapped in quotes.
19114 Note that the definition of a flex inset
19119 \begin_inset Flex Code
19122 \begin_layout Plain Layout
19128 entry, declaring which type of inset it defines.
19131 \begin_layout Enumerate
19132 The layout for user specific branch is being defined.
19134 \begin_inset Flex Code
19137 \begin_layout Plain Layout
19143 must be of the form
19144 \begin_inset Quotes eld
19148 \begin_inset Flex Code
19151 \begin_layout Plain Layout
19158 \begin_inset Quotes erd
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19171 may be be any valid identifier of branch defined in user's document.
19172 The identifier may include spaces, but in that case the whole thing must
19173 be wrapped in quotes.
19174 The main purpose of this feature is to allow \SpecialChar LaTeX
19175 wrapping around specific
19176 branches as user needs.
19179 \begin_layout Enumerate
19180 The layout of a user (or class) specific caption is being defined.
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19191 must be of the form
19192 \begin_inset Quotes eld
19196 \begin_inset Flex Code
19199 \begin_layout Plain Layout
19206 \begin_inset Quotes erd
19210 \begin_inset Flex Code
19213 \begin_layout Plain Layout
19219 specifies the name of the caption as it appears in the menu.
19220 Have a look at the standard caption (
19221 \begin_inset Flex Code
19224 \begin_layout Plain Layout
19230 ), the specific captions of the KOMA-Script classes (
19231 \begin_inset Flex Code
19234 \begin_layout Plain Layout
19241 \begin_inset Flex Code
19244 \begin_layout Plain Layout
19253 \begin_inset space ~
19257 \begin_inset Newline linebreak
19263 \begin_inset Flex Code
19266 \begin_layout Plain Layout
19272 ) for applications.
19275 \begin_layout Standard
19277 \begin_inset Flex Code
19280 \begin_layout Plain Layout
19286 definition can contain the following entries:
19289 \begin_layout Description
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19300 \begin_inset Flex Code
19303 \begin_layout Plain Layout
19309 =""] This inset will appear in the table of contents of the given type.
19310 An empty string disables.
19311 See also the OutlinerName and the IsTocCaption commands.
19312 This is only implemented for Flex insets.
19316 \begin_layout Description
19317 \begin_inset Flex Code
19320 \begin_layout Plain Layout
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19336 ] Defines argument number of a command\SpecialChar breakableslash
19337 environment associated with the current
19339 The definition must end with
19340 \begin_inset Flex Code
19343 \begin_layout Plain Layout
19351 \begin_inset CommandInset ref
19353 reference "subsec:Paragraph-Styles"
19360 \begin_layout Description
19361 \begin_inset Flex Code
19364 \begin_layout Plain Layout
19370 Preamble for changing language commands; see
19371 \begin_inset CommandInset ref
19373 reference "subsec:I18n"
19380 \begin_layout Description
19381 \begin_inset Flex Code
19384 \begin_layout Plain Layout
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19400 ] The color for the inset's background.
19402 \begin_inset CommandInset ref
19404 reference "chap:Names-of-colors"
19408 for a list of the available color names.
19411 \begin_layout Description
19412 \begin_inset Flex Code
19415 \begin_layout Plain Layout
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19434 \begin_inset space \thinspace{}
19438 \begin_inset Flex Code
19441 \begin_layout Plain Layout
19447 ] Whether to use the content of the inset as the label, when the inset is
19452 \begin_layout Description
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19463 \begin_inset Flex Code
19466 \begin_layout Plain Layout
19472 ] As with paragraph styles, see
19473 \begin_inset CommandInset ref
19475 reference "subsec:Paragraph-Styles"
19480 Note that you need to specify the complete type, e.
19481 \begin_inset space \thinspace{}
19485 \begin_inset space ~
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19493 CopyStyle Flex:<name>
19501 \begin_layout Description
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19512 \begin_inset Flex Code
19515 \begin_layout Plain Layout
19524 \begin_inset space \thinspace{}
19528 \begin_inset Flex Code
19531 \begin_layout Plain Layout
19537 ] Indicates whether the user may employ the Paragraph Settings dialog to
19538 customize the paragraph.
19541 \begin_layout Description
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19581 , describing the rendering style used for the inset's frame and buttons.
19582 Footnotes generally use
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19592 , ERT insets generally
19593 \begin_inset Flex Code
19596 \begin_layout Plain Layout
19602 , and character styles
19603 \begin_inset Flex Code
19606 \begin_layout Plain Layout
19615 \begin_layout Description
19616 \begin_inset Flex Code
19619 \begin_layout Plain Layout
19626 \begin_inset Flex Code
19629 \begin_layout Plain Layout
19638 \begin_inset space \thinspace{}
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19676 Indicates whether the environment will stand on its own in the output or
19677 will appear inline with the surrounding text.
19678 If set to false, it is supposed that the \SpecialChar LaTeX
19679 environment ignores white space
19680 (including one newline character) after the
19681 \begin_inset Flex Code
19684 \begin_layout Plain Layout
19697 \begin_inset Flex Code
19700 \begin_layout Plain Layout
19714 \change_inserted 731793113 1538674858
19718 \begin_layout Description
19720 \change_inserted 731793113 1538674891
19721 \begin_inset Flex Code
19724 \begin_layout Plain Layout
19726 \change_inserted 731793113 1538674863
19738 ,1] Allow the contents of the inset to be edited externally (using whatever
19739 editor is defined for the document's output format).
19744 \begin_layout Description
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19754 Required at the end of the
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19767 \begin_layout Description
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19777 The font used for both the text body
19783 \begin_inset CommandInset ref
19785 reference "subsec:Font-description"
19790 Note that defining this font automatically defines the
19791 \begin_inset Flex Code
19794 \begin_layout Plain Layout
19800 to the same value, so define this first and define
19801 \begin_inset Flex Code
19804 \begin_layout Plain Layout
19810 later if you want them to be different.
19813 \begin_layout Description
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19818 FixedWidthPreambleEncoding
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19836 \begin_inset space \thinspace{}
19840 \begin_inset Flex Code
19843 \begin_layout Plain Layout
19849 ] Force a fixed width encoding for the translated contents of
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19860 \begin_inset Flex Code
19863 \begin_layout Plain Layout
19869 code generated by this layout.
19870 This is needed for special \SpecialChar LaTeX
19875 that do not work with variable width encodings such as
19880 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19881 backends such as Xe\SpecialChar TeX
19883 Lua\SpecialChar TeX
19887 \begin_layout Description
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19892 ForceLocalFontSwitch
19898 \begin_inset Flex Code
19901 \begin_layout Plain Layout
19910 \begin_inset space \thinspace{}
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19923 ] When using babel, always use a local font switch (
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19935 ), never a global one (such as
19936 \begin_inset Flex Code
19939 \begin_layout Plain Layout
19950 \begin_layout Description
19951 \begin_inset Flex Code
19954 \begin_layout Plain Layout
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19973 \begin_inset space \thinspace{}
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19987 \begin_inset Quotes eld
19991 \begin_inset Quotes erd
19994 language, leading to Left-to-Right (Latin) output, e.
19995 \begin_inset space \thinspace{}
19999 \begin_inset space \space{}
20002 in \SpecialChar TeX
20007 \begin_layout Description
20008 \begin_inset Flex Code
20011 \begin_layout Plain Layout
20018 \begin_inset Flex Code
20021 \begin_layout Plain Layout
20030 \begin_inset space \thinspace{}
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20043 ] Force a a line break in the \SpecialChar LaTeX
20044 output before the inset starts and after
20046 This assures the inset itself is output on its own lines, for parsing purposes.
20049 \begin_layout Description
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20072 \begin_inset space \thinspace{}
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20085 ] Indicates whether the
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20095 should be used or, instead, the user can change the paragraph style used
20100 \begin_layout Description
20101 \begin_inset Flex Code
20104 \begin_layout Plain Layout
20111 \begin_inset Flex Code
20114 \begin_layout Plain Layout
20123 \begin_inset space \thinspace{}
20127 \begin_inset Flex Code
20130 \begin_layout Plain Layout
20136 ] As with paragraph styles, see
20137 \begin_inset CommandInset ref
20139 reference "subsec:Paragraph-Styles"
20146 \begin_layout Description
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20156 These tags control the XHTML output.
20158 \begin_inset CommandInset ref
20160 reference "sec:Tags-for-XHTML"
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 ] Whether to include the contents of this inset in the strings generated
20204 for the `Outline' pane for all table of contents, regardless of the AddToToc
20206 One would not, for example, want the content of a footnote in a section
20207 header to be included in the TOC displayed in the outline, but one would
20208 normally want the content of a character style displayed.
20209 Default is false: not to include.
20212 \begin_layout Description
20213 \begin_inset Flex Code
20216 \begin_layout Plain Layout
20223 \begin_inset Flex Code
20226 \begin_layout Plain Layout
20235 \begin_inset space \thinspace{}
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20248 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20249 of its contents in its item in the table of contents.
20250 Otherwise, only the label appears.
20253 \begin_layout Description
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20278 \begin_inset space \thinspace{}
20282 \begin_inset Flex Code
20285 \begin_layout Plain Layout
20291 ] As with paragraph styles, see
20292 \begin_inset CommandInset ref
20294 reference "subsec:Paragraph-Styles"
20301 \begin_layout Description
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20311 The font used for the label.
20313 \begin_inset CommandInset ref
20315 reference "subsec:Font-description"
20320 Note that this definition can never appear before
20321 \begin_inset Flex Code
20324 \begin_layout Plain Layout
20330 , lest it be ineffective.
20333 \begin_layout Description
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20354 \begin_inset Quotes erd
20358 \begin_inset Quotes erd
20361 ] What will be displayed on the button or elsewhere as the inset label.
20363 \begin_inset Flex Code
20366 \begin_layout Plain Layout
20374 \begin_inset Flex Code
20377 \begin_layout Plain Layout
20383 ) modify this label on the fly.
20386 \begin_layout Description
20387 \begin_inset Flex Code
20390 \begin_layout Plain Layout
20396 Language dependent preamble; see
20397 \begin_inset CommandInset ref
20399 reference "subsec:I18n"
20406 \begin_layout Description
20407 \begin_inset Flex Code
20410 \begin_layout Plain Layout
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20426 ] The name of the corresponding \SpecialChar LaTeX
20428 Either the environment or command name.
20431 \begin_layout Description
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 \begin_inset Flex Code
20445 \begin_layout Plain Layout
20451 ] The optional parameter for the corresponding
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20461 stuff, including possible bracket pairs like
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20472 This parameter cannot be changed from within \SpecialChar LyX
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20483 for customizable parameters).
20484 It will be output as is after all \SpecialChar LaTeX
20486 \begin_inset Flex Code
20489 \begin_layout Plain Layout
20498 \begin_layout Description
20499 \begin_inset Flex Code
20502 \begin_layout Plain Layout
20509 \begin_inset Flex Code
20512 \begin_layout Plain Layout
20513 Command, Environment, None
20518 ] How the style should be translated into \SpecialChar LaTeX
20523 \begin_layout Plain Layout
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20533 is perhaps a bit misleading, since these rules apply to SGML classes too.
20534 Visit the SGML class files for specific examples.
20543 \begin_layout Description
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20553 means nothing special
20556 \begin_layout Description
20557 \begin_inset Flex Code
20560 \begin_layout Plain Layout
20567 \begin_inset Flex Code
20570 \begin_layout Plain Layout
20577 {\SpecialChar ldots
20586 \begin_layout Description
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20607 }\SpecialChar ldots
20622 \begin_layout Standard
20623 Putting the last few things together, the \SpecialChar LaTeX
20624 output will be either:
20627 \begin_layout LyX-Code
20630 LatexName[LatexParam]{\SpecialChar ldots
20634 \begin_layout Standard
20638 \begin_layout LyX-Code
20641 begin{LatexName}[LatexParam] \SpecialChar ldots
20647 \begin_layout Standard
20648 depending upon the \SpecialChar LaTeX
20653 \begin_layout Description
20654 \begin_inset Flex Code
20657 \begin_layout Plain Layout
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20673 ] A string that is put at the beginning of the layout content.
20674 A line break in the output can be indicated by
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20687 \begin_layout Description
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20737 (indicating a dummy definition ending definitions of charstyles, etc).
20738 This entry is required in and is only meaningful for Flex insets.
20739 Among other things, it determines on which menu this inset will appear.
20741 \begin_inset Flex Code
20744 \begin_layout Plain Layout
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20760 will automatically set
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20791 can be set to true, or
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20811 insets by setting it
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20826 \change_inserted -712698321 1555575738
20830 \begin_layout Description
20832 \change_inserted -712698321 1555575844
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20838 \change_inserted -712698321 1555575740
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20850 \change_inserted -712698321 1555575740
20856 A dedicated string for the menu.
20857 You can define an accelerator by appending the respective character to
20858 the string, divided by
20859 \begin_inset Quotes eld
20863 \begin_inset Quotes erd
20867 \begin_inset space \thinspace{}
20871 \begin_inset space \space{}
20875 \begin_inset Quotes eld
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20884 \change_inserted -712698321 1555575781
20891 \begin_inset Quotes erd
20895 This specification is optional.
20896 If it is not given the inset name as specified in the type declaration
20897 will be used instead for the menu.
20902 \begin_layout Description
20903 \begin_inset Flex Code
20906 \begin_layout Plain Layout
20913 \begin_inset Flex Code
20916 \begin_layout Plain Layout
20925 \begin_inset space \thinspace{}
20929 \begin_inset Flex Code
20932 \begin_layout Plain Layout
20938 ] Whether multiple paragraphs are permitted in this inset.
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20949 to the same value and
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20959 to the opposite value.
20960 These can be reset to other values, if they are used
20965 \begin_inset Flex Code
20968 \begin_layout Plain Layout
20978 \begin_layout Description
20979 \begin_inset Flex Code
20982 \begin_layout Plain Layout
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
21001 \begin_inset space \thinspace{}
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 ] Whether fragile commands in this inset should be
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21031 whether the command should itself be protected.) Default is false.
21032 \change_inserted -712698321 1523633958
21036 \begin_layout Description
21038 \change_inserted -712698321 1552395786
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21044 \change_inserted -712698321 1523633961
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21056 \change_inserted -712698321 1523633958
21065 \begin_inset space \thinspace{}
21069 \begin_inset Flex Code
21072 \begin_layout Plain Layout
21074 \change_inserted -712698321 1523633958
21080 ] This causes macros that contain this inset to be protected with
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21086 \change_inserted -712698321 1523634038
21101 ) if necessary and thus allows (some) verbatim stuff in macros.
21105 \begin_layout Description
21107 \change_inserted -712698321 1555579651
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21113 \change_inserted -712698321 1552395787
21120 \begin_inset Flex Code
21123 \begin_layout Plain Layout
21125 \change_inserted -712698321 1552395787
21134 \begin_inset space \thinspace{}
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21143 \change_inserted -712698321 1552395787
21149 ] Whether specific commands in this inset (such as
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21155 \change_inserted -712698321 1552395787
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21169 \change_inserted -712698321 1552395787
21177 ) should be protected in an
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21183 \change_inserted -712698321 1552395787
21192 This is particularly needed for insets that draw on
21200 commands which parse their content in complex ways.
21204 \begin_layout Description
21206 \change_inserted -712698321 1555579742
21207 \begin_inset Flex Code
21210 \begin_layout Plain Layout
21212 \change_inserted -712698321 1555579658
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21224 \change_inserted -712698321 1555579651
21230 Option to define a different command (from the default
21231 \begin_inset Flex Code
21234 \begin_layout Plain Layout
21236 \change_inserted -712698321 1555579742
21248 ) to be used for line breaks.
21249 The initial backslash must not be specified.
21254 \begin_layout Description
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21274 ] Deletes an existing
21275 \begin_inset Flex Code
21278 \begin_layout Plain Layout
21287 \begin_layout Description
21288 \begin_inset Flex Code
21291 \begin_layout Plain Layout
21298 \begin_inset Flex Code
21301 \begin_layout Plain Layout
21308 \begin_inset Flex Code
21311 \begin_layout Plain Layout
21317 that has replaced this
21318 \begin_inset Flex Code
21321 \begin_layout Plain Layout
21328 This is used to rename an
21329 \begin_inset Flex Code
21332 \begin_layout Plain Layout
21338 , while keeping backward compatibility.
21339 \change_inserted -712698321 1559491850
21343 \begin_layout Description
21345 \change_inserted -712698321 1559492002
21346 \begin_inset Flex Code
21349 \begin_layout Plain Layout
21351 \change_inserted -712698321 1559491854
21358 \begin_inset Flex Code
21361 \begin_layout Plain Layout
21363 \change_inserted -712698321 1559491850
21372 \begin_inset space \thinspace{}
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21381 \change_inserted -712698321 1559491850
21387 ] If this is set to
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21393 \change_inserted -712698321 1559491881
21401 , paragraph breaks will be ignored in the output.
21402 This might be useful for insets where the content should be alignable on
21403 different lines only in the \SpecialChar LyX
21404 workarea, without any effect in the output.
21409 \begin_layout Description
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21420 \begin_inset Flex Code
21423 \begin_layout Plain Layout
21432 \begin_inset space \thinspace{}
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21445 ] As with paragraph styles, see
21446 \begin_inset CommandInset ref
21448 reference "subsec:Paragraph-Styles"
21456 \begin_layout Description
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21479 \begin_inset space \thinspace{}
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21492 ] As with paragraph styles, see
21493 \begin_inset CommandInset ref
21495 reference "subsec:Paragraph-Styles"
21503 \begin_layout Description
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21513 As with paragraph styles, see
21514 \begin_inset CommandInset ref
21516 reference "subsec:Paragraph-Styles"
21523 \begin_layout Description
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21543 ] The prefix to use when creating labels referring to insets of this type.
21544 This allows the use of formatted references.
21547 \begin_layout Description
21548 \begin_inset Flex Code
21551 \begin_layout Plain Layout
21558 \begin_inset Flex Code
21561 \begin_layout Plain Layout
21567 ] As with paragraph styles, see
21568 \begin_inset CommandInset ref
21570 reference "subsec:Paragraph-Styles"
21577 \begin_layout Description
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21600 \begin_inset space \thinspace{}
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21613 ] Resets the \SpecialChar LaTeX
21614 arguments of this layout (as defined via the
21615 \begin_inset Flex Code
21618 \begin_layout Plain Layout
21625 This is useful if you have copied a style via
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21635 , but you do not want to inherit its (required and optional) arguments.
21638 \begin_layout Description
21639 \begin_inset Flex Code
21642 \begin_layout Plain Layout
21649 \begin_inset Flex Code
21652 \begin_layout Plain Layout
21659 \begin_inset space \thinspace{}
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21674 ] Whether this inset should use the font of its surrounding environment
21676 Default is false: use the font of the surrounding environment.
21679 \begin_layout Description
21680 \begin_inset Flex Code
21683 \begin_layout Plain Layout
21690 \begin_inset Flex Code
21693 \begin_layout Plain Layout
21699 ] A string that is put at the end of the layout content.
21700 A line break in the output can be indicated by
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21713 \begin_layout Description
21714 \begin_inset Flex Code
21717 \begin_layout Plain Layout
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21734 \begin_inset space \thinspace{}
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21749 ] Allow spell-checking the contents of this inset.
21753 \begin_layout Subsection
21755 \begin_inset CommandInset label
21757 name "subsec:Counters"
21764 \begin_layout Standard
21765 It is necessary to define the counters (
21766 \begin_inset Flex Noun
21769 \begin_layout Plain Layout
21776 \begin_inset Flex Noun
21779 \begin_layout Plain Layout
21785 , \SpecialChar ldots
21786 ) in the text class itself.
21787 The standard counters are defined in the file
21788 \begin_inset Flex Code
21791 \begin_layout Plain Layout
21797 , so you may have to do no more than add
21800 \begin_layout LyX-Code
21801 Input stdcounters.inc
21804 \begin_layout Standard
21805 to your layout file to get them to work.
21806 But if you want to define custom counters, then you can do so.
21807 The counter declaration must begin with:
21810 \begin_layout LyX-Code
21811 Counter CounterName
21814 \begin_layout Standard
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21825 ' is replaced by the name of the counter.
21826 And it must end with
21827 \begin_inset Quotes eld
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21841 \begin_inset Quotes erd
21845 The following parameters can also be used:
21848 \begin_layout Description
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21859 \begin_inset Flex Code
21862 \begin_layout Plain Layout
21868 ] Sets the initial value for the counter, to which it will be reset whenever
21870 Normally, one will want the default, 1.
21873 \begin_layout Description
21874 \begin_inset Flex Code
21877 \begin_layout Plain Layout
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21894 \begin_inset Quotes erd
21898 \begin_inset Quotes erd
21901 ] When defined, this string defines how the counter is displayed.
21902 Setting this value sets
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21907 LabelStringAppendix
21913 The following special constructs can be used in the string:
21917 \begin_layout Itemize
21918 \begin_inset Flex Code
21921 \begin_layout Plain Layout
21929 will be replaced by the expansion of the
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21944 LabelStringAppendix
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21963 \begin_layout Itemize
21964 counter values can be expressed using \SpecialChar LaTeX
21966 \begin_inset Newline newline
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21990 \begin_inset Flex Code
21993 \begin_layout Plain Layout
22005 \begin_layout Plain Layout
22015 Actually, the situation is a bit more complicated: any
22034 other than those described below will produce arabic numerals.
22035 It would not be surprising to see this change in the future.
22041 \begin_inset Flex Code
22044 \begin_layout Plain Layout
22050 : 1, 2, 3,\SpecialChar ldots
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22061 for lower-case letters: a, b, c, \SpecialChar ldots
22063 \begin_inset Flex Code
22066 \begin_layout Plain Layout
22072 for upper-case letters: A, B, C, \SpecialChar ldots
22074 \begin_inset Flex Code
22077 \begin_layout Plain Layout
22083 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22085 \begin_inset Flex Code
22088 \begin_layout Plain Layout
22094 for upper-case roman numerals: I, II, III\SpecialChar ldots
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22105 for hebrew numerals.
22109 \begin_layout Standard
22110 If LabelString is not defined, a default value is constructed as follows:
22111 if the counter has a master counter
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22122 \begin_inset Flex Code
22125 \begin_layout Plain Layout
22132 \begin_inset Newline newline
22136 \begin_inset Flex Code
22139 \begin_layout Plain Layout
22149 is used; otherwise the string
22150 \begin_inset Flex Code
22153 \begin_layout Plain Layout
22164 \begin_layout Description
22165 \begin_inset Flex Code
22168 \begin_layout Plain Layout
22169 LabelStringAppendix
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22185 \begin_inset Quotes erd
22189 \begin_inset Quotes erd
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22202 , but for use in the Appendix.
22205 \begin_layout Description
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22216 \begin_inset Flex Code
22219 \begin_layout Plain Layout
22226 \begin_inset Quotes erd
22230 \begin_inset Quotes erd
22233 ] A format for use with formatted references to this counter.
22234 For example, one might want to have references to section numbers appear
22236 \begin_inset Quotes eld
22240 \begin_inset Quotes erd
22244 The string should contain
22245 \begin_inset Quotes eld
22249 \begin_inset Quotes erd
22253 This will be replaced by the counter number itself.
22254 So, for sections, it would be: Section ##.
22257 \begin_layout Description
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22278 \begin_inset Quotes erd
22282 \begin_inset Quotes erd
22285 ] If this is set to the name of another counter, the present counter will
22286 be reset every time the other one is increased.
22288 \begin_inset Flex Code
22291 \begin_layout Plain Layout
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22310 \begin_layout Subsection
22312 \begin_inset CommandInset label
22314 name "subsec:Font-description"
22321 \begin_layout Standard
22322 A font description looks like this:
22325 \begin_layout LyX-Code
22342 \begin_layout LyX-Code
22346 \begin_layout LyX-Code
22350 \begin_layout Standard
22351 The following commands are available:
22354 \begin_layout Description
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22387 \begin_inset Flex Code
22390 \begin_layout Plain Layout
22397 \begin_inset Flex Code
22400 \begin_layout Plain Layout
22407 \begin_inset Flex Code
22410 \begin_layout Plain Layout
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22457 \begin_inset Flex Code
22460 \begin_layout Plain Layout
22467 \begin_inset Flex Code
22470 \begin_layout Plain Layout
22477 \begin_inset Flex Code
22480 \begin_layout Plain Layout
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22537 \begin_inset Flex Code
22540 \begin_layout Plain Layout
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22569 \begin_layout Description
22570 \begin_inset Flex Code
22573 \begin_layout Plain Layout
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22592 \begin_inset Flex Code
22595 \begin_layout Plain Layout
22602 \begin_inset Flex Code
22605 \begin_layout Plain Layout
22614 \begin_layout Description
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22634 ] Valid arguments are:
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
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22715 \begin_inset Flex Code
22718 \begin_layout Plain Layout
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22735 \begin_inset Flex Code
22738 \begin_layout Plain Layout
22745 \begin_inset Flex Code
22748 \begin_layout Plain Layout
22755 Each of these turns on or off the corresponding attribute.
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22766 turns on emphasis, and
22767 \begin_inset Flex Code
22770 \begin_layout Plain Layout
22778 \begin_inset Newline newline
22781 If the latter seems puzzling, remember that the font settings for the present
22782 context are generally inherited from the surrounding context.
22784 \begin_inset Flex Code
22787 \begin_layout Plain Layout
22793 would turn off the emphasis that was anyway in effect, say, in a theorem
22797 \begin_layout Description
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22820 \begin_inset Flex Code
22823 \begin_layout Plain Layout
22832 \begin_layout Description
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22855 \begin_inset Flex Code
22858 \begin_layout Plain Layout
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22875 \begin_inset Flex Code
22878 \begin_layout Plain Layout
22887 \begin_layout Description
22888 \begin_inset Flex Code
22891 \begin_layout Plain Layout
22898 \begin_inset Flex Code
22901 \begin_layout Plain Layout
22908 \begin_inset Flex Code
22911 \begin_layout Plain Layout
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22930 \begin_inset Flex Code
22933 \begin_layout Plain Layout
22940 \begin_inset Flex Code
22943 \begin_layout Plain Layout
22950 \begin_inset Flex Code
22953 \begin_layout Plain Layout
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22970 \begin_inset Flex Code
22973 \begin_layout Plain Layout
22982 \begin_layout Subsection
22983 \begin_inset CommandInset label
22985 name "subsec:Citation-engine-description"
22989 Cite engine description
22992 \begin_layout Standard
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
23003 blocks, as used mainly in cite engine files (see
23004 \begin_inset CommandInset ref
23006 reference "subsec:Cite-Engine-Files"
23013 ), define the citation commands provided by a specific
23014 \begin_inset Quotes eld
23018 \begin_inset Quotes erd
23022 A cite engine, in \SpecialChar LyX
23023 terms, is way specific way to format citations, using
23024 numbers, author names and/or years.
23025 Currently, \SpecialChar LyX
23026 supports three such engine types, namely:
23029 \begin_layout Enumerate
23030 \begin_inset Flex Code
23033 \begin_layout Plain Layout
23039 : the default Bib\SpecialChar TeX
23040 way to format citations, a simple numeric style (e.
23041 \begin_inset space \thinspace{}
23045 \begin_inset Quotes eld
23049 \begin_inset Quotes erd
23055 \begin_layout Enumerate
23056 \begin_inset Flex Code
23059 \begin_layout Plain Layout
23065 : Harvard-styled citations using author names and publication year (e.
23066 \begin_inset space \thinspace{}
23070 \begin_inset Quotes eld
23073 Smith and Miller (2017b)
23074 \begin_inset Quotes erd
23080 \begin_layout Enumerate
23081 \begin_inset Flex Code
23084 \begin_layout Plain Layout
23090 : extended numerical citations that also allow for author or title next
23092 \begin_inset space \thinspace{}
23096 \begin_inset Quotes eld
23099 Smith and Miller [1]
23100 \begin_inset Quotes erd
23106 \begin_layout Standard
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23116 blocks look like this:
23119 \begin_layout LyX-Code
23123 \begin_layout LyX-Code
23127 \begin_layout LyX-Code
23131 \begin_layout LyX-Code
23132 citeyearpar[][]=parencite*
23135 \begin_layout LyX-Code
23139 \begin_layout LyX-Code
23143 \begin_layout Standard
23145 \begin_inset Flex Code
23148 \begin_layout Plain Layout
23154 denotes the engine.
23155 The individual lines respectively define a cite command or cite command
23156 paradigm supported by this engine.
23157 The line can be as simple as a cite command that is used both to name the
23158 respective \SpecialChar LyX
23159 command and the \SpecialChar LaTeX
23160 output or more complex in order to differentiate
23162 The full syntax is:
23165 \begin_layout LyX-Code
23166 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23169 \begin_layout Itemize
23170 \begin_inset Flex Code
23173 \begin_layout Plain Layout
23179 : The name as used in the
23180 \begin_inset Flex Code
23183 \begin_layout Plain Layout
23193 \begin_layout Standard
23194 For portability reasons, we try to use the same name for same-formatted
23195 commands in different cite packages (thus many names stem from natbib,
23196 and thus we need to differentiate a
23197 \begin_inset Flex Code
23200 \begin_layout Plain Layout
23206 sometimes, if the \SpecialChar LaTeX
23207 command names differ).
23211 \begin_layout Itemize
23212 \begin_inset Flex Code
23215 \begin_layout Plain Layout
23221 : a (comma-separated) list of commands that fall back to the given
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23231 in the current engine.
23232 This eases the switch of citation packages and engines.
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23244 \begin_inset Flex Code
23247 \begin_layout Plain Layout
23253 in layout definitions.
23256 \begin_layout Itemize
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23266 : The actual \SpecialChar LaTeX
23267 command that is output.
23271 \begin_layout Standard
23272 \begin_inset Flex Code
23275 \begin_layout Plain Layout
23282 \begin_inset Flex Code
23285 \begin_layout Plain Layout
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23303 \begin_inset Flex Code
23306 \begin_layout Plain Layout
23312 will be output to \SpecialChar LaTeX
23316 \begin_layout Standard
23320 \begin_layout Itemize
23321 Capitalization indicates that the command also has a capitalized form (
23322 \begin_inset Flex Code
23325 \begin_layout Plain Layout
23335 \begin_inset Flex Code
23338 \begin_layout Plain Layout
23347 These usually enforce up-casing of name prefixes (
23352 \begin_inset Formula $\Rightarrow$
23362 \begin_layout Itemize
23364 \begin_inset Flex Code
23367 \begin_layout Plain Layout
23373 indicate the number of optional arguments (there can be 0–2).
23376 \begin_layout Itemize
23378 \begin_inset Flex Code
23381 \begin_layout Plain Layout
23387 indicates there is a starred version of the command (
23388 \begin_inset Flex Code
23391 \begin_layout Plain Layout
23401 \begin_inset Flex Code
23404 \begin_layout Plain Layout
23417 \begin_layout Standard
23418 By default, the starred version means: Output all authors even if it should
23420 \begin_inset Quotes eld
23424 \begin_inset Quotes erd
23428 \begin_inset Flex Code
23431 \begin_layout Plain Layout
23440 \begin_layout Standard
23441 If the star has a different meaning for a given command, it can be specified
23443 \begin_inset Flex Code
23446 \begin_layout Plain Layout
23447 <!_stardesc!_stardesctooltip>
23453 Maximal two translatable macro keywords, marked by the prefix
23454 \begin_inset Flex Code
23457 \begin_layout Plain Layout
23464 The first points to the string that replaces the
23465 \begin_inset Quotes eld
23469 \begin_inset Quotes erd
23472 checkbox label in the citation dialog, the second one to an optional tool
23473 tip for this checkbox.
23477 \begin_layout Standard
23478 Note that these two macros have to be defined in a
23479 \begin_inset Flex Code
23482 \begin_layout Plain Layout
23488 (see next section), dropping the
23489 \begin_inset Flex Code
23492 \begin_layout Plain Layout
23498 from the prefix, like this:
23501 \begin_layout LyX-Code
23502 _stardesc Sta&rred command label
23505 \begin_layout LyX-Code
23506 _stardesctooltip Tooltip for the starred command checkbox.
23510 \begin_layout Itemize
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23521 indicates that this command features
23522 \begin_inset Quotes eld
23525 qualified citation lists
23526 \begin_inset Quotes erd
23534 -specific feature for multi-reference citations where an individual pre-
23535 and postnote can be given to each reference in the list.
23536 Please refer to the
23540 manual for details.
23541 \change_inserted -712698321 1526898670
23545 \begin_layout Standard
23547 \change_inserted -712698321 1526899524
23548 If you want to add a cite command to a cite engine (e.
23549 \begin_inset space \thinspace{}
23552 g., add a specific command provided by a class), you can use
23553 \begin_inset Flex Code
23556 \begin_layout Plain Layout
23558 \change_inserted -712698321 1526898768
23559 AddToCiteEngine <engine type> \SpecialChar ldots
23568 Note that only cite commands that do not exist yet are added.
23573 \begin_layout Subsection
23574 \begin_inset CommandInset label
23576 name "subsec:Citation-format-description"
23580 Cite format description
23583 \begin_layout Standard
23585 \begin_inset Flex Code
23588 \begin_layout Plain Layout
23594 blocks are used to describe how bibliographic information should be displayed,
23595 both within \SpecialChar LyX
23596 itself (in the citation dialog and in tooltips, for example)
23597 and in XHTML output.
23598 Such a block might look like this:
23601 \begin_layout LyX-Code
23605 \begin_layout LyX-Code
23609 \begin_layout LyX-Code
23613 \begin_layout LyX-Code
23617 \begin_layout Standard
23621 \begin_layout LyX-Code
23625 \begin_layout LyX-Code
23629 \begin_layout LyX-Code
23633 \begin_layout LyX-Code
23637 \begin_layout Standard
23638 In the first case, the individual lines define how the bibliographic information
23639 associated with an article or book, respectively, is to be displayed, and
23640 such a definition can be given for any
23641 \begin_inset Quotes els
23645 \begin_inset Quotes ers
23648 that might be present in a Bib\SpecialChar TeX
23651 defines a default format in the source code that will be used if no specific
23652 definition has been given.
23654 predefines several formats in the file
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23664 , which is included in most of \SpecialChar LyX
23665 's document classes.
23668 \begin_layout Standard
23669 In the second case, the lines define how a specific citation command (in
23671 \begin_inset Flex Code
23674 \begin_layout Plain Layout
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23694 ) is to be displayed on the citation inset label, in the citation dialog,
23695 menu or XHTML output.
23697 defines such formats for the citation style variants it supports via
23699 Document\SpecialChar menuseparator
23700 Setting\SpecialChar menuseparator
23701 Bibliography\SpecialChar ldots
23705 \begin_inset Flex Code
23708 \begin_layout Plain Layout
23714 files that are shipped with \SpecialChar LyX
23716 \begin_inset CommandInset ref
23718 reference "subsec:Cite-Engine-Files"
23728 \begin_layout Standard
23729 The definitions use a simple language that allows Bib\SpecialChar TeX
23730 keys to be replaced
23732 Keys should be enclosed in
23733 \begin_inset Flex Code
23736 \begin_layout Plain Layout
23743 \begin_inset Flex Code
23746 \begin_layout Plain Layout
23753 So a simple definition might look like this:
23756 \begin_layout LyX-Code
23758 \begin_inset Quotes eld
23762 \begin_inset Quotes erd
23768 \begin_layout Standard
23769 This would print the author, followed by a comma, followed by the title,
23770 in quotes, followed by a period.
23773 \begin_layout Standard
23774 Of course, sometimes you may want to print a key only if it exists.
23775 This can be done by using a conditional construction, such as:
23776 \begin_inset Flex Code
23779 \begin_layout Plain Layout
23781 \begin_inset space ~
23791 \begin_inset Flex Code
23794 \begin_layout Plain Layout
23800 key exists, then print
23801 \begin_inset Quotes eld
23805 \begin_inset space ~
23809 \begin_inset Quotes erd
23812 followed by the volume key.
23813 It is also possible to have an else clause in the conditional, such as:
23814 \begin_inset Newline newline
23818 \begin_inset Flex Code
23821 \begin_layout Plain Layout
23822 {%author%[[%author%]][[%editor%, ed.]]}
23828 \begin_inset Newline newline
23832 \begin_inset Flex Code
23835 \begin_layout Plain Layout
23841 key is printed if it exists; otherwise, the editor key is printed, followed
23843 \begin_inset Quotes eld
23847 \begin_inset space ~
23851 \begin_inset Quotes erd
23854 Note that the key is again enclosed in
23855 \begin_inset Flex Code
23858 \begin_layout Plain Layout
23864 signs; the entire conditional is enclosed in braces; and the if and else
23865 clauses are enclosed in double brackets,
23866 \begin_inset Quotes eld
23870 \begin_inset Flex Code
23873 \begin_layout Plain Layout
23880 \begin_inset Quotes eld
23884 \begin_inset Quotes eld
23888 \begin_inset Flex Code
23891 \begin_layout Plain Layout
23898 \begin_inset Quotes erd
23902 There must be no space between any of these.
23905 \begin_layout Standard
23906 Next to the entry keys, there are some special keys that can be used for
23907 these conditionals:
23910 \begin_layout Itemize
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23915 {%dialog%[[true]][[false]]}
23921 \begin_inset Quotes eld
23925 \begin_inset Quotes erd
23928 part for dialogs and menus, the
23929 \begin_inset Quotes eld
23933 \begin_inset Quotes erd
23936 part for other contexts (workarea, export)
23939 \begin_layout Itemize
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23944 {%export%[[true]][[false]]}
23950 \begin_inset Quotes eld
23954 \begin_inset Quotes erd
23957 part for export and menus, the
23958 \begin_inset Quotes eld
23962 \begin_inset Quotes erd
23965 part for other contexts (workarea, dialog)
23968 \begin_layout Itemize
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23979 \begin_inset Quotes eld
23983 \begin_inset Quotes erd
23986 part if another item follows (e.
23987 \begin_inset space \thinspace{}
23990 g., in a citation with multiple keys)
23993 \begin_layout Itemize
23994 \begin_inset Flex Code
23997 \begin_layout Plain Layout
23998 {%second%[[true]][[false]]}
24004 \begin_inset Quotes eld
24008 \begin_inset Quotes erd
24011 if this is the second of multiple items, else the
24012 \begin_inset Quotes eld
24016 \begin_inset Quotes erd
24022 \begin_layout Itemize
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24027 {%ifstar%[[true]][[false]]}
24033 \begin_inset Quotes eld
24037 \begin_inset Quotes erd
24040 part for starred citation commands (such as
24041 \begin_inset Flex Code
24044 \begin_layout Plain Layout
24052 ), the false part for unstarred
24055 \begin_layout Itemize
24056 \begin_inset Flex Code
24059 \begin_layout Plain Layout
24060 {%ifentrytype:<type>%[[true]][[false]]}
24066 \begin_inset Quotes eld
24070 \begin_inset Quotes erd
24073 if the current entry type matches
24074 \begin_inset Flex Code
24077 \begin_layout Plain Layout
24083 , else the false part (e.g., in a citation definition:
24084 \begin_inset Flex Code
24087 \begin_layout Plain Layout
24088 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24096 \begin_layout Itemize
24097 \begin_inset Flex Code
24100 \begin_layout Plain Layout
24101 {%ifmultiple:<authortype>%[[true]][[false]]}
24107 \begin_inset Quotes eld
24111 \begin_inset Quotes erd
24114 if the current author type (author, editor etc.) has multiple authors, else
24115 the false part (e.g., in a bibliography definition:
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24120 {%ifmultiple:editor%[[eds.]][[ed.]]}
24128 \begin_layout Itemize
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24133 {%ifqualified%[[true]][[false]]}
24139 \begin_inset Quotes eld
24143 \begin_inset Quotes erd
24146 part if the current citation is a qualified citation list (a specific
24150 format for multi-reference citations), the false part if this is not the
24154 \begin_layout Standard
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24165 prints the author key as it is recorded in the bibliography file.
24166 This might not be what you want, since it will result in a string such
24168 \begin_inset Quotes eld
24171 Miller, Peter and Smith, Mary and White, Jane
24172 \begin_inset Quotes erd
24176 \begin_inset Quotes eld
24180 \begin_inset Quotes erd
24183 is used by Bib\SpecialChar TeX
24184 to delimit authors).
24186 therefore provides some methods to get properly formatted name lists (which
24187 will also get translated).
24188 The following keys are provided:
24191 \begin_layout Enumerate
24192 For name lists with pre- and surname, suitable for the main authors/editors
24193 of a bibliography item.
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24204 part denotes the kind of list that is requested (e.g.
24206 \begin_inset Flex Code
24209 \begin_layout Plain Layout
24219 \begin_layout Itemize
24220 \begin_inset Flex Code
24223 \begin_layout Plain Layout
24224 %abbrvnames:<nametype>%
24229 : Provides a name list which is abbreviated (with
24230 \begin_inset Quotes eld
24234 \begin_inset Quotes erd
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24250 \begin_layout Itemize
24251 \begin_inset Flex Code
24254 \begin_layout Plain Layout
24255 %fullnames:<nametype>%
24260 : Provides a full name list (never abbreviated with
24261 \begin_inset Quotes eld
24265 \begin_inset Quotes erd
24271 \begin_layout Itemize
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24276 %forceabbrvnames:<nametype>%
24281 : Provides a name list which is always abbreviated (with
24282 \begin_inset Quotes eld
24286 \begin_inset Quotes erd
24290 \begin_inset Flex Code
24293 \begin_layout Plain Layout
24303 \begin_layout Enumerate
24304 Alternative name lists with pre- and surname, if the order of pre- and surname
24305 inside the bibliography item differs (as in:
24306 \begin_inset Quotes eld
24309 Miller, John: Some text, in: Mary Smith, ed.: A volume
24310 \begin_inset Quotes erd
24317 \begin_layout Itemize
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24322 %abbrvbynames:<nametype>%
24327 : Provides a name list which is abbreviated (with
24328 \begin_inset Quotes eld
24332 \begin_inset Quotes erd
24336 \begin_inset Flex Code
24339 \begin_layout Plain Layout
24348 \begin_layout Itemize
24349 \begin_inset Flex Code
24352 \begin_layout Plain Layout
24353 %fullbynames:<nametype>%
24358 : Provides a full name list (never abbreviated with
24359 \begin_inset Quotes eld
24363 \begin_inset Quotes erd
24369 \begin_layout Itemize
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24374 %forceabbrvbynames:<nametype>%
24379 : Provides a name list which is always abbreviated (with
24380 \begin_inset Quotes eld
24384 \begin_inset Quotes erd
24388 \begin_inset Flex Code
24391 \begin_layout Plain Layout
24401 \begin_layout Enumerate
24402 And finally name lists which consist of family names only, as used in author-yea
24404 These do not take a
24405 \begin_inset Flex Code
24408 \begin_layout Plain Layout
24414 part, but always return either an author list or, if this does not exist,
24415 an editor list (as common in author-year labels):
24419 \begin_layout Itemize
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24429 : Provides a name list which is abbreviated (with
24430 \begin_inset Quotes eld
24434 \begin_inset Quotes erd
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24450 \begin_layout Itemize
24451 \begin_inset Flex Code
24454 \begin_layout Plain Layout
24460 : Provides a full name list (never abbreviated with
24461 \begin_inset Quotes eld
24465 \begin_inset Quotes erd
24471 \begin_layout Itemize
24472 \begin_inset Flex Code
24475 \begin_layout Plain Layout
24476 %forceabbrvciteauthor%
24481 : Provides a name list which is always abbreviated (with
24482 \begin_inset Quotes eld
24486 \begin_inset Quotes erd
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24503 \begin_layout Standard
24504 The order of pre- and surname in the former two lists can be adjusted by
24508 \begin_layout Itemize
24509 \begin_inset Flex Code
24512 \begin_layout Plain Layout
24513 !firstnameform %surname%, %prename%
24518 (first author in lists of type 1)
24521 \begin_layout Itemize
24522 \begin_inset Flex Code
24525 \begin_layout Plain Layout
24526 !othernameform %surname%, %prename%
24531 (other authors in lists of type 1)
24534 \begin_layout Itemize
24535 \begin_inset Flex Code
24538 \begin_layout Plain Layout
24539 !firstbynameform %prename% %surname%
24544 (first author in lists of type 2)
24547 \begin_layout Itemize
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24552 !otherbynameform %prename% %surname%
24557 (other authors in lists of type 2)
24560 \begin_layout Standard
24561 This allows you to configure namings like
24562 \begin_inset Quotes eld
24565 Miller, Peter and Mary Smith: \SpecialChar ldots
24566 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24568 \begin_inset Quotes erd
24574 \begin_layout Standard
24575 There is one other piece of syntax available in definitions, which looks
24577 \begin_inset Flex Code
24580 \begin_layout Plain Layout
24587 This defines a piece of formatting information that is to be used when
24589 \begin_inset Quotes eld
24593 \begin_inset Quotes erd
24597 Obviously, we do not want to output HTML tags when writing plain text,
24598 so they should be wrapped in
24599 \begin_inset Quotes eld
24603 \begin_inset Quotes erd
24607 \begin_inset Quotes eld
24611 \begin_inset Quotes erd
24617 \begin_layout Standard
24618 Two special sorts of definitions are also possible in a
24619 \begin_inset Flex Code
24622 \begin_layout Plain Layout
24629 An example of the first would be:
24632 \begin_layout LyX-Code
24634 \begin_inset Quotes eld
24638 \begin_inset Quotes erd
24644 \begin_layout Standard
24645 This is an abbreviation, or macro, and it can be used by treating it as
24647 \begin_inset Flex Code
24650 \begin_layout Plain Layout
24659 \begin_inset Flex Code
24662 \begin_layout Plain Layout
24668 exactly as it would treat its definition.
24669 So, let us issue the obvious
24677 \begin_layout LyX-Code
24681 \begin_layout Standard
24682 or anything like it.
24684 shouldn't go into an infinite loop, but it may go into a long one before
24688 \begin_layout Standard
24689 The second sort of special definition might look like this:
24692 \begin_layout LyX-Code
24696 \begin_layout Standard
24697 This defines a translatable piece of text, which allows relevant parts of
24698 the bibliography or citation to be translated.
24699 It can be included in a definition by treating it as a key:
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24710 Note that there are two different translation paths: All definitions starting
24712 \begin_inset Flex Code
24715 \begin_layout Plain Layout
24721 , such as in the example above, will be translated to the currently active
24722 buffer language (so the translation will match the generated document).
24723 All definitions starting with underscore only will be translated to the
24725 This is the proper translation for strings that only occur in the dialogs
24726 or on buttons, such as this one:
24729 \begin_layout LyX-Code
24730 _addtobib Add to bibliography only.
24733 \begin_layout Standard
24734 Several of these translatable strings are predefined in
24735 \begin_inset Flex Code
24738 \begin_layout Plain Layout
24745 \begin_inset Flex Code
24748 \begin_layout Plain Layout
24755 Note that these are not macros, in the sense just defined.
24756 They will not be expanded.
24759 \begin_layout Standard
24760 So here then is an example that uses several of these features:
24761 \begin_inset VSpace defskip
24767 \begin_layout Standard
24771 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24774 \begin_layout Standard
24775 \begin_inset VSpace defskip
24778 This defines a macro that prints the author, followed by a comma, if the
24780 \begin_inset Flex Code
24783 \begin_layout Plain Layout
24789 key is defined, or else prints the name of the editor, followed by the
24791 \begin_inset Flex Code
24794 \begin_layout Plain Layout
24800 or its translation (it is by default
24801 \begin_inset Quotes eld
24805 \begin_inset Quotes erd
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24819 Note that this is in fact defined in
24820 \begin_inset Flex Code
24823 \begin_layout Plain Layout
24829 , so you can use it in your own definitions, or re-definitions, if you load
24833 \begin_layout Section
24834 \begin_inset CommandInset label
24836 name "sec:Tags-for-XHTML"
24840 Tags for XHTML output
24843 \begin_layout Standard
24844 As with \SpecialChar LaTeX
24845 or DocBook, the format of \SpecialChar LyX
24846 's XHTML output is also controlled by
24847 layout information.
24848 In general, \SpecialChar LyX
24849 provides sensible defaults and, as mentioned earlier, it will
24850 even construct default CSS style rules from the other layout tags.
24851 For example, \SpecialChar LyX
24852 will attempt to use the information provided in the
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24862 declaration for the Chapter style to write CSS that will appropriately
24863 format chapter headings.
24866 \begin_layout Standard
24867 In many cases, then, you may not have to do anything at all to get acceptable
24868 XHTML output for your own environments, custom insets, and so forth.
24869 But in some cases you will, and so \SpecialChar LyX
24870 provides a number of layout tags that
24871 can be used to customize the XHTML and CSS that are generated.
24874 \begin_layout Standard
24875 Note that there are two tags,
24876 \begin_inset Flex Code
24879 \begin_layout Plain Layout
24886 \begin_inset Flex Code
24889 \begin_layout Plain Layout
24895 that may appear outside style and inset declarations.
24897 \begin_inset CommandInset ref
24899 reference "subsec:General-text-class"
24903 for details on these.
24906 \begin_layout Subsection
24907 \begin_inset CommandInset label
24909 name "subsec:Paragraph-Style-XHTML"
24916 \begin_layout Standard
24917 The sort of XHTML \SpecialChar LyX
24918 outputs for a paragraph depends upon whether we are dealing
24919 with a normal paragraph, a command, or an environment, where this is itself
24920 determined by the contents of the corresponding
24921 \begin_inset Flex Code
24924 \begin_layout Plain Layout
24935 \begin_layout Standard
24936 For a command or normal paragraph, the output XHTML has the following form:
24939 \begin_layout LyX-Code
24943 \begin_inset Quotes erd
24947 \begin_inset Quotes erd
24953 \begin_layout LyX-Code
24957 \begin_inset Quotes erd
24961 \begin_inset Quotes erd
24967 \begin_layout LyX-Code
24970 Contents of the paragraph.
24973 \begin_layout LyX-Code
24979 \begin_layout Standard
24980 The label tags are of course omitted if the paragraph does not have a label.
24983 \begin_layout Standard
24984 For an environment that is not some sort of list, the XHTML takes this form:
24987 \begin_layout LyX-Code
24991 \begin_inset Quotes erd
24995 \begin_inset Quotes erd
25001 \begin_layout LyX-Code
25005 \begin_inset Quotes erd
25009 \begin_inset Quotes erd
25013 \begin_inset Quotes erd
25017 \begin_inset Quotes erd
25020 >Environment Label</labeltag>First paragraph.</itemtag>
25023 \begin_layout LyX-Code
25026 <itemtag>Second paragraph.</itemtag>
25029 \begin_layout LyX-Code
25035 \begin_layout Standard
25036 Note that the label is output only for the first paragraph, as it should
25037 be for a theorem, for example.
25041 \begin_layout Standard
25042 For a list, we have one of these forms:
25045 \begin_layout LyX-Code
25049 \begin_inset Quotes erd
25053 \begin_inset Quotes erd
25059 \begin_layout LyX-Code
25063 \begin_inset Quotes erd
25067 \begin_inset Quotes erd
25071 \begin_inset Quotes erd
25075 \begin_inset Quotes erd
25078 >List Label</labeltag>First item.</itemtag>
25081 \begin_layout LyX-Code
25085 \begin_inset Quotes erd
25089 \begin_inset Quotes erd
25093 \begin_inset Quotes erd
25097 \begin_inset Quotes erd
25100 >List Label</labeltag>Second item.</itemtag>
25103 \begin_layout LyX-Code
25109 \begin_layout LyX-Code
25113 \begin_layout LyX-Code
25117 \begin_inset Quotes erd
25121 \begin_inset Quotes erd
25127 \begin_layout LyX-Code
25131 \begin_inset Quotes erd
25135 \begin_inset Quotes erd
25138 >List Label</labeltag><itemtag attr=
25139 \begin_inset Quotes erd
25143 \begin_inset Quotes erd
25146 >First item.</itemtag>
25149 \begin_layout LyX-Code
25153 \begin_inset Quotes erd
25157 \begin_inset Quotes erd
25160 >List Label</labeltag><itemtag attr=
25161 \begin_inset Quotes erd
25165 \begin_inset Quotes erd
25168 >Second item.</itemtag>
25171 \begin_layout LyX-Code
25177 \begin_layout Standard
25178 Note the different orders of
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25189 \begin_inset Flex Code
25192 \begin_layout Plain Layout
25199 Which order we get depends upon the setting of
25200 \begin_inset Flex Code
25203 \begin_layout Plain Layout
25210 \begin_inset Flex Code
25213 \begin_layout Plain Layout
25219 is false (the default), you get the first of these, with the label within
25220 the item; if true, you get the second, with the label outside the item.
25223 \begin_layout Standard
25224 The specific tags and attributes output for each paragraph type can be controlle
25225 d by means of the layout tags we are about to describe.
25226 As mentioned earlier, however, \SpecialChar LyX
25227 uses sensible defaults for many of these,
25228 so you often may not need to do very much to get good XHTML output.
25229 Think of the available tags as there so you can tweak things to your liking.
25232 \begin_layout Description
25233 \begin_inset Flex Code
25236 \begin_layout Plain Layout
25243 \begin_inset Flex Code
25246 \begin_layout Plain Layout
25252 ] Specifies attribute information to be output with the main tag.
25254 \begin_inset Quotes eld
25258 \begin_inset Flex Code
25261 \begin_layout Plain Layout
25268 \begin_inset Quotes erd
25272 By default, \SpecialChar LyX
25274 \begin_inset Quotes eld
25278 \begin_inset Flex Code
25281 \begin_layout Plain Layout
25288 \begin_inset Quotes erd
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25301 is the \SpecialChar LyX
25302 name of the layout, made lowercase, for example: chapter.
25307 contain any style information.
25309 \begin_inset Flex Code
25312 \begin_layout Plain Layout
25321 \begin_layout Description
25322 \begin_inset Flex Code
25325 \begin_layout Plain Layout
25332 \begin_inset Flex Code
25335 \begin_layout Plain Layout
25345 ] Whether to output the default CSS information \SpecialChar LyX
25346 generates for this layout,
25347 even if additional information is explicitly provided via
25348 \begin_inset Flex Code
25351 \begin_layout Plain Layout
25359 \begin_inset Flex Code
25362 \begin_layout Plain Layout
25368 allows you to alter or augment the generated CSS, rather than to override
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25383 \begin_layout Description
25384 \begin_inset Flex Code
25387 \begin_layout Plain Layout
25394 \begin_inset Flex Code
25397 \begin_layout Plain Layout
25403 ] The tag to be used for individual paragraphs of environments, replacing
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25414 in the examples above.
25416 \begin_inset Flex Code
25419 \begin_layout Plain Layout
25428 \begin_layout Description
25429 \begin_inset Flex Code
25432 \begin_layout Plain Layout
25439 \begin_inset Flex Code
25442 \begin_layout Plain Layout
25448 ] Attributes for the item tag.
25450 \begin_inset Newline newline
25454 \begin_inset Quotes eld
25458 \begin_inset Flex Code
25461 \begin_layout Plain Layout
25462 class=`layoutname_item'
25468 \begin_inset Quotes erd
25476 contain any style information.
25478 \begin_inset Flex Code
25481 \begin_layout Plain Layout
25490 \begin_layout Description
25491 \begin_inset Flex Code
25494 \begin_layout Plain Layout
25501 \begin_inset Flex Code
25504 \begin_layout Plain Layout
25510 ] The tag to be used for paragraph and item labels, replacing
25511 \begin_inset Flex Code
25514 \begin_layout Plain Layout
25520 in the examples above.
25522 \begin_inset Flex Code
25525 \begin_layout Plain Layout
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25542 \begin_inset Flex Code
25545 \begin_layout Plain Layout
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25556 Centered_Top_Environment
25561 , in which case it defaults to
25562 \begin_inset Flex Code
25565 \begin_layout Plain Layout
25574 \begin_layout Description
25575 \begin_inset Flex Code
25578 \begin_layout Plain Layout
25585 \begin_inset Flex Code
25588 \begin_layout Plain Layout
25594 ] Attributes for the label tag.
25596 \begin_inset Newline newline
25600 \begin_inset Quotes eld
25604 \begin_inset Flex Code
25607 \begin_layout Plain Layout
25608 class=`layoutname_label'
25614 \begin_inset Quotes erd
25622 contain any style information.
25624 \begin_inset Flex Code
25627 \begin_layout Plain Layout
25636 \begin_layout Description
25637 \begin_inset Flex Code
25640 \begin_layout Plain Layout
25647 \begin_inset Flex Code
25650 \begin_layout Plain Layout
25660 ] Meaningful only for list-like environments, this tag controls whether
25661 the label tag is output before or inside the item tag.
25662 This is used, for example, in the description environment, where we want
25664 \begin_inset Flex Code
25667 \begin_layout Plain Layout
25668 <dt>\SpecialChar ldots
25669 </dt><dd>\SpecialChar ldots
25677 \begin_inset Flex Code
25680 \begin_layout Plain Layout
25686 : The label tag is output inside the item tag.
25689 \begin_layout Description
25690 \begin_inset Flex Code
25693 \begin_layout Plain Layout
25699 Information to be output in the
25700 \begin_inset Flex Code
25703 \begin_layout Plain Layout
25709 section when this style is used.
25710 This might, for example, be used to include a
25711 \begin_inset Flex Code
25714 \begin_layout Plain Layout
25721 \begin_inset Flex Code
25724 \begin_layout Plain Layout
25733 \begin_layout Description
25734 \begin_inset Flex Code
25737 \begin_layout Plain Layout
25743 CSS style information to be included when this style is used.
25744 Note that this will automatically be wrapped in a layout-generated
25745 \begin_inset Flex Code
25748 \begin_layout Plain Layout
25754 block, so only the CSS itself need be included.
25756 \begin_inset Flex Code
25759 \begin_layout Plain Layout
25768 \begin_layout Description
25769 \begin_inset Flex Code
25772 \begin_layout Plain Layout
25779 \begin_inset Flex Code
25782 \begin_layout Plain Layout
25788 ] The tag to be used for the main label, replacing
25789 \begin_inset Flex Code
25792 \begin_layout Plain Layout
25798 in the examples above.
25800 \begin_inset Flex Code
25803 \begin_layout Plain Layout
25812 \begin_layout Description
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25836 ] Marks this style as the one to be used to generate the
25837 \begin_inset Flex Code
25840 \begin_layout Plain Layout
25846 tag for the XHTML file.
25847 By default, it is false.
25849 \begin_inset Flex Code
25852 \begin_layout Plain Layout
25858 file sets it to true for the
25859 \begin_inset Flex Code
25862 \begin_layout Plain Layout
25872 \begin_layout Subsection
25876 \begin_layout Standard
25877 The XHTML output of insets can also be controlled by information in layout
25882 \begin_layout Plain Layout
25883 At present, this is true only for
25884 \begin_inset Quotes eld
25888 \begin_inset Quotes erd
25891 insets (insets you can type into) and is not true for
25892 \begin_inset Quotes eld
25896 \begin_inset Quotes erd
25899 insets (insets that are associated with dialog boxes).
25904 Here, too, \SpecialChar LyX
25905 tries to provide sensible defaults, and it constructs default
25907 But everything can be customized.
25910 \begin_layout Standard
25911 The XHTML \SpecialChar LyX
25912 outputs for an inset has the following form:
25915 \begin_layout LyX-Code
25917 \begin_inset Quotes erd
25921 \begin_inset Quotes erd
25927 \begin_layout LyX-Code
25928 <labeltag>Label</labeltag>
25931 \begin_layout LyX-Code
25933 \begin_inset Quotes erd
25937 \begin_inset Quotes erd
25940 >Contents of the inset.</innertag>
25943 \begin_layout LyX-Code
25947 \begin_layout Standard
25948 If the inset permits multiple paragraphs—that is, if
25949 \begin_inset Flex Code
25952 \begin_layout Plain Layout
25958 is true—then the contents of the inset will itself be output as paragraphs
25959 formatted according to the styles used for those paragraphs (standard,
25960 quote, and the like).
25961 The label tag is of course omitted if the paragraph does not have a label
25962 and, at present, is always
25963 \begin_inset Flex Code
25966 \begin_layout Plain Layout
25973 The inner tag is optional and, by default, does not appear.
25976 \begin_layout Standard
25977 The specific tags and attributes output for each inset can be controlled
25978 by means of the following layout tags.
25981 \begin_layout Description
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26001 ] Specifies attribute information to be output with the main tag.
26003 \begin_inset Quotes eld
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26011 class=`myinset' onclick=`\SpecialChar ldots
26018 \begin_inset Quotes erd
26022 By default, \SpecialChar LyX
26024 \begin_inset Quotes eld
26028 \begin_inset Flex Code
26031 \begin_layout Plain Layout
26038 \begin_inset Quotes erd
26042 \begin_inset Flex Code
26045 \begin_layout Plain Layout
26051 is the \SpecialChar LyX
26052 name of the inset, made lowercase and with non-alphanumeric characters
26053 converted to underscores, for example: footnote.
26056 \begin_layout Description
26057 \begin_inset Flex Code
26060 \begin_layout Plain Layout
26067 \begin_inset Flex Code
26070 \begin_layout Plain Layout
26080 ] Whether to output the default CSS information \SpecialChar LyX
26081 generates for this layout,
26082 even if additional information is explicitly provided via
26083 \begin_inset Flex Code
26086 \begin_layout Plain Layout
26094 \begin_inset Flex Code
26097 \begin_layout Plain Layout
26103 allows you to alter or augment the generated CSS, rather than to override
26108 \begin_layout Description
26109 \begin_inset Flex Code
26112 \begin_layout Plain Layout
26119 \begin_inset Flex Code
26122 \begin_layout Plain Layout
26128 ] Attributes for the inner tag.
26130 \begin_inset Newline newline
26134 \begin_inset Quotes eld
26138 \begin_inset Flex Code
26141 \begin_layout Plain Layout
26142 class=`insetname_inner'
26148 \begin_inset Quotes erd
26154 \begin_layout Description
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26165 \begin_inset Flex Code
26168 \begin_layout Plain Layout
26174 ] The inner tag, replacing
26175 \begin_inset Flex Code
26178 \begin_layout Plain Layout
26184 in the examples above.
26185 By default, there is none.
26188 \begin_layout Description
26189 \begin_inset Flex Code
26192 \begin_layout Plain Layout
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26210 ] Whether this inset represents a standalone block of text (such as a footnote)
26211 or instead represents material that is included in the surrounding text
26212 (such as a branch).
26216 \begin_layout Description
26217 \begin_inset Flex Code
26220 \begin_layout Plain Layout
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26236 ] A label for this inset, possibly including a reference to a counter.
26237 For example, for footnote, it might be:
26238 \begin_inset Flex Code
26241 \begin_layout Plain Layout
26250 This is optional, and there is no default.
26253 \begin_layout Description
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26263 Information to be output in the
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26273 section when this style is used.
26274 This might, for example, be used to include a
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26285 \begin_inset Flex Code
26288 \begin_layout Plain Layout
26297 \begin_layout Description
26298 \begin_inset Flex Code
26301 \begin_layout Plain Layout
26307 CSS style information to be included when this style is used.
26308 Note that this will automatically be wrapped in a layout-generated
26309 \begin_inset Flex Code
26312 \begin_layout Plain Layout
26318 block, so only the CSS itself need be included.
26321 \begin_layout Description
26322 \begin_inset Flex Code
26325 \begin_layout Plain Layout
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26341 ] The tag to be used for the main label, replacing
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26351 in the examples above.
26352 The default depends upon the setting of
26353 \begin_inset Flex Code
26356 \begin_layout Plain Layout
26363 \begin_inset Flex Code
26366 \begin_layout Plain Layout
26372 is true, the default is
26373 \begin_inset Flex Code
26376 \begin_layout Plain Layout
26382 ; if it is false, the default is
26383 \begin_inset Flex Code
26386 \begin_layout Plain Layout
26395 \begin_layout Subsection
26399 \begin_layout Standard
26400 The XHTML output for floats too can be controlled by layout information.
26401 The output has the following form:
26404 \begin_layout LyX-Code
26406 \begin_inset Quotes erd
26410 \begin_inset Quotes erd
26416 \begin_layout LyX-Code
26417 Contents of the float.
26420 \begin_layout LyX-Code
26424 \begin_layout Standard
26425 The caption, if there is one, is a separate inset and will be output as
26427 Its appearance can be controlled via the InsetLayout for caption insets.
26431 \begin_layout Description
26432 \begin_inset Flex Code
26435 \begin_layout Plain Layout
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26451 ] Specifies attribute information to be output with the main tag.
26453 \begin_inset Quotes eld
26457 \begin_inset Flex Code
26460 \begin_layout Plain Layout
26461 class=`myfloat' onclick=`\SpecialChar ldots
26468 \begin_inset Quotes erd
26472 By default, \SpecialChar LyX
26474 \begin_inset Quotes eld
26478 \begin_inset Flex Code
26481 \begin_layout Plain Layout
26482 class=`float float-floattype'
26488 \begin_inset Quotes erd
26492 \begin_inset Flex Code
26495 \begin_layout Plain Layout
26501 is \SpecialChar LyX
26502 's name for this type of float, as determined by the float declaration
26504 \begin_inset CommandInset ref
26506 reference "subsec:Floats"
26510 ), though made lowercase and with non-alphanumeric characters converted
26511 to underscores, for example: float-table.
26514 \begin_layout Description
26515 \begin_inset Flex Code
26518 \begin_layout Plain Layout
26524 CSS style information to be included when this float is used.
26525 Note that this will automatically be wrapped in a layout-generated
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26535 block, so only the CSS itself need be included.
26538 \begin_layout Description
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26549 \begin_inset Flex Code
26552 \begin_layout Plain Layout
26558 ] The tag to be used for this float, replacing
26559 \begin_inset Quotes eld
26563 \begin_inset Flex Code
26566 \begin_layout Plain Layout
26573 \begin_inset Quotes erd
26576 in the example above.
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26587 and will rarely need changing.
26590 \begin_layout Subsection
26591 Bibliography formatting
26594 \begin_layout Standard
26595 The bibliography can be formatted using
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26607 \begin_inset CommandInset ref
26609 reference "subsec:Citation-format-description"
26616 \begin_layout Subsection
26621 \begin_layout Standard
26622 We have several times mentioned that \SpecialChar LyX
26623 will generate default CSS style rules
26624 for both insets and paragraph styles, based upon the other layout information
26626 In this section, we shall say a word about which layout information \SpecialChar LyX
26631 \begin_layout Standard
26632 At present, \SpecialChar LyX
26633 auto-generates CSS only for font information, making use of
26635 \begin_inset Flex Code
26638 \begin_layout Plain Layout
26645 \begin_inset Flex Code
26648 \begin_layout Plain Layout
26655 \begin_inset Flex Code
26658 \begin_layout Plain Layout
26665 \begin_inset Flex Code
26668 \begin_layout Plain Layout
26675 \begin_inset Flex Code
26678 \begin_layout Plain Layout
26685 \begin_inset CommandInset ref
26687 reference "subsec:Font-description"
26692 The translation is mostly straightforward and obvious.
26694 \begin_inset Quotes eld
26698 \begin_inset Flex Code
26701 \begin_layout Plain Layout
26708 \begin_inset Quotes erd
26712 \begin_inset Quotes eld
26716 \begin_inset Flex Code
26719 \begin_layout Plain Layout
26720 font-family: sans-serif;
26726 \begin_inset Quotes erd
26730 The correspondence of \SpecialChar LyX
26731 sizes and CSS sizes is a little less obvious but
26732 nonetheless intuitive.
26734 \begin_inset Flex Code
26737 \begin_layout Plain Layout
26744 \begin_inset Flex URL
26747 \begin_layout Plain Layout
26757 \begin_layout Chapter
26758 Including External Material
26759 \begin_inset CommandInset label
26761 name "chap:Including-External-Material"
26768 \begin_layout Standard
26769 \begin_inset Box Shadowbox
26779 height_special "totalheight"
26784 backgroundcolor "none"
26787 \begin_layout Plain Layout
26788 WARNING: This portion of the documentation has not been updated for some
26790 We certainly hope that it is still accurate, but there are no guarantees.
26798 \begin_layout Standard
26799 The use of material from sources external to \SpecialChar LyX
26800 is covered in detail in the
26806 This part of the manual covers what needs to happen behind the scenes for
26807 new sorts of material to be included.
26810 \begin_layout Section
26814 \begin_layout Standard
26815 The external material feature is based on the concept of a
26820 A template is a specification of how \SpecialChar LyX
26821 should interface with a certain kind
26823 As bundled, \SpecialChar LyX
26824 comes with predefined templates for Xfig figures, various
26825 raster format images, chess diagrams, and LilyPond music notation.
26826 You can check the actual list by using the menu
26827 \begin_inset Flex Noun
26830 \begin_layout Plain Layout
26831 Insert\SpecialChar menuseparator
26832 File\SpecialChar menuseparator
26839 Furthermore, it is possible to roll your own template to support a specific
26841 Later we'll describe in more detail what is involved, and hopefully you
26842 will submit all the templates you create so we can include them in a later
26847 \begin_layout Standard
26848 Another basic idea of the external material feature is to distinguish between
26849 the original file that serves as a base for final material and the produced
26850 file that is included in your exported or printed document.
26851 For example, consider the case of a figure produced with
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26862 The Xfig application itself works on an original file with the
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26873 Within Xfig, you create and change your figure, and when you are done,
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26885 When you want to include the figure in your document, you invoke
26886 \begin_inset Flex Code
26889 \begin_layout Plain Layout
26895 in order to create a PostScript file that can readily be included in your
26899 \begin_inset Flex Code
26902 \begin_layout Plain Layout
26908 file is the original file, and the PostScript file is the produced file.
26911 \begin_layout Standard
26912 This distinction is important in order to allow updating of the material
26913 while you are in the process of writing the document.
26914 Furthermore, it provides us with the flexibility that is needed to support
26915 multiple export formats.
26916 For instance, in the case of a plain text file, it is not exactly an award-winn
26917 ing idea to include the figure as raw PostScript.
26918 Instead, you would either prefer to just include a reference to the figure
26919 or try to invoke some graphics to ASCII converter to make the final result
26920 look similar to the real graphics.
26921 The external material management allows you to do this, because it is parametri
26922 zed on the different export formats that \SpecialChar LyX
26926 \begin_layout Standard
26927 Besides supporting the production of different products according to the
26928 exported format, it supports tight integration with editing and viewing
26930 In the case of an Xfig figure, you are able to invoke Xfig on the original
26931 file with a single click from within the external material dialog in \SpecialChar LyX
26933 and also preview the produced PostScript file with Ghostview with another
26935 No more fiddling around with the command line and/or file browsers to locate
26936 and manipulate the original or produced files.
26937 In this way, you are finally able to take full advantage of the many different
26938 applications that are relevant to use when you write your documents, and
26939 ultimately be more productive.
26942 \begin_layout Section
26943 The external template configuration files
26946 \begin_layout Standard
26947 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26949 However, be aware that doing this in an careless manner most probably
26953 introduce an easily exploitable security hole.
26954 So before you do this, please read the discussion about security in
26955 \begin_inset CommandInset ref
26957 reference "sec:Security-discussion"
26964 \begin_layout Standard
26965 Having said that, we encourage you to submit any interesting templates that
26970 \begin_layout Standard
26971 The external templates are defined in the
26972 \begin_inset Flex Code
26975 \begin_layout Plain Layout
26981 files that are stored in the
26982 \begin_inset Flex Code
26985 \begin_layout Plain Layout
26986 LyXDir/lib/xtemplates/
26992 Each template is defined in a file of its own.
26993 You can place your own templates in
26994 \begin_inset Flex Code
26997 \begin_layout Plain Layout
26998 UserDir/xtemplates/
27003 or copy existing templates to that directory in order to modify them.
27006 \begin_layout Standard
27007 A typical template looks like this:
27010 \begin_layout LyX-Code
27014 \begin_layout LyX-Code
27015 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
27018 \begin_layout LyX-Code
27022 \begin_layout LyX-Code
27026 \begin_layout LyX-Code
27030 \begin_layout LyX-Code
27034 \begin_layout LyX-Code
27038 \begin_layout LyX-Code
27039 AutomaticProduction true
27042 \begin_layout LyX-Code
27046 \begin_layout LyX-Code
27050 \begin_layout LyX-Code
27054 \begin_layout LyX-Code
27055 TransformCommand Rotate RotationLatexCommand
27058 \begin_layout LyX-Code
27059 TransformCommand Resize ResizeLatexCommand
27062 \begin_layout LyX-Code
27063 Product "$$RotateFront$$ResizeFront
27066 \begin_layout LyX-Code
27071 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
27074 \begin_layout LyX-Code
27075 $$ResizeBack$$RotateBack"
27078 \begin_layout LyX-Code
27082 \begin_layout LyX-Code
27083 UpdateResult "$$AbsPath$$Basename.pstex_t"
27086 \begin_layout LyX-Code
27087 Requirement "graphicx"
27090 \begin_layout LyX-Code
27091 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27094 \begin_layout LyX-Code
27095 ReferencedFile latex "$$AbsPath$$Basename.eps"
27098 \begin_layout LyX-Code
27099 ReferencedFile dvi "$$AbsPath$$Basename.eps"
27102 \begin_layout LyX-Code
27106 \begin_layout LyX-Code
27110 \begin_layout LyX-Code
27111 TransformCommand Rotate RotationLatexCommand
27114 \begin_layout LyX-Code
27115 TransformCommand Resize ResizeLatexCommand
27118 \begin_layout LyX-Code
27119 Product "$$RotateFront$$ResizeFront
27122 \begin_layout LyX-Code
27127 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
27130 \begin_layout LyX-Code
27131 $$ResizeBack$$RotateBack"
27134 \begin_layout LyX-Code
27135 UpdateFormat pdftex
27138 \begin_layout LyX-Code
27139 UpdateResult "$$AbsPath$$Basename.pdftex_t"
27142 \begin_layout LyX-Code
27143 Requirement "graphicx"
27146 \begin_layout LyX-Code
27147 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
27150 \begin_layout LyX-Code
27151 ReferencedFile latex "$$AbsPath$$Basename.pdf"
27154 \begin_layout LyX-Code
27158 \begin_layout LyX-Code
27162 \begin_layout LyX-Code
27163 Product "[XFig: $$FName]"
27166 \begin_layout LyX-Code
27170 \begin_layout LyX-Code
27174 \begin_layout LyX-Code
27175 Product "<graphic fileref=
27177 "$$AbsOrRelPathMaster$$Basename.eps
27182 \begin_layout LyX-Code
27186 \begin_layout LyX-Code
27190 \begin_layout LyX-Code
27191 UpdateResult "$$AbsPath$$Basename.eps"
27194 \begin_layout LyX-Code
27195 ReferencedFile docbook "$$AbsPath$$Basename.eps"
27198 \begin_layout LyX-Code
27199 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
27202 \begin_layout LyX-Code
27206 \begin_layout LyX-Code
27210 \begin_layout Standard
27211 As you can see, the template is enclosed in
27212 \begin_inset Flex Code
27215 \begin_layout Plain Layout
27223 \begin_inset Flex Code
27226 \begin_layout Plain Layout
27233 It contains a header specifying some general settings and, for each supported
27234 primary document file format, a section
27235 \begin_inset Flex Code
27238 \begin_layout Plain Layout
27246 \begin_inset Flex Code
27249 \begin_layout Plain Layout
27258 \begin_layout Subsection
27259 The template header
27262 \begin_layout Description
27263 \begin_inset Flex Code
27266 \begin_layout Plain Layout
27267 AutomaticProduction
27268 \begin_inset space ~
27276 Whether the file represented by the template must be generated by \SpecialChar LyX
27278 This command must occur exactly once.
27281 \begin_layout Description
27282 \begin_inset Flex Code
27285 \begin_layout Plain Layout
27287 \begin_inset space ~
27295 A glob pattern that is used in the file dialog to filter out the desired
27297 If there is more than one possible file extension (e.
27298 \begin_inset space \thinspace{}
27302 \begin_inset space \space{}
27306 \begin_inset Flex Code
27309 \begin_layout Plain Layout
27316 \begin_inset Flex Code
27319 \begin_layout Plain Layout
27325 ), use something like
27326 \begin_inset Flex Code
27329 \begin_layout Plain Layout
27336 This command must occur exactly once.
27339 \begin_layout Description
27340 \begin_inset Flex Code
27343 \begin_layout Plain Layout
27345 \begin_inset space ~
27353 The text that is displayed on the button.
27354 This command must occur exactly once.
27357 \begin_layout Description
27358 \begin_inset Flex Code
27361 \begin_layout Plain Layout
27363 \begin_inset space ~
27367 \begin_inset space ~
27375 The help text that is used in the External dialog.
27376 Provide enough information to explain to the user just what the template
27377 can provide him with.
27378 This command must occur exactly once.
27381 \begin_layout Description
27382 \begin_inset Flex Code
27385 \begin_layout Plain Layout
27387 \begin_inset space ~
27395 The file format of the original file.
27396 This must be the name of a format that is known to \SpecialChar LyX
27398 \begin_inset CommandInset ref
27400 reference "sec:Formats"
27406 \begin_inset Quotes eld
27410 \begin_inset Flex Code
27413 \begin_layout Plain Layout
27420 \begin_inset Quotes erd
27423 if the template can handle original files of more than one format.
27425 will attempt to interrogate the file itself in order to deduce its format
27427 This command must occur exactly once.
27430 \begin_layout Description
27431 \begin_inset Flex Code
27434 \begin_layout Plain Layout
27436 \begin_inset space ~
27444 A unique name for the template.
27445 It must not contain substitution macros (see below).
27448 \begin_layout Description
27449 \begin_inset Flex Code
27452 \begin_layout Plain Layout
27454 \begin_inset space ~
27457 Rotate|Resize|Clip|Extra
27462 This command specifies which transformations are supported by this template.
27463 It may occur zero or more times.
27464 This command enables the corresponding tabs in the external dialog.
27466 \begin_inset Flex Code
27469 \begin_layout Plain Layout
27475 command must have either a corresponding
27476 \begin_inset Flex Code
27479 \begin_layout Plain Layout
27486 \begin_inset Flex Code
27489 \begin_layout Plain Layout
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27506 Otherwise the transformation will not be supported by that format.
27509 \begin_layout Subsection
27513 \begin_layout Description
27514 \begin_inset Flex Code
27517 \begin_layout Plain Layout
27519 \begin_inset space ~
27522 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27527 The primary document file format that this format definition is for.
27528 Not every template has a sensible representation in all document file formats.
27529 Please define nevertheless a
27530 \begin_inset Flex Code
27533 \begin_layout Plain Layout
27539 section for all templates.
27540 Use a dummy text when no representation is available.
27541 Then you can at least see a reference to the external material in the exported
27545 \begin_layout Description
27546 \begin_inset Flex Code
27549 \begin_layout Plain Layout
27551 \begin_inset space ~
27555 \begin_inset space ~
27563 This command defines an additional macro
27564 \begin_inset Flex Code
27567 \begin_layout Plain Layout
27573 for substitution in
27574 \begin_inset Flex Code
27577 \begin_layout Plain Layout
27585 \begin_inset Flex Code
27588 \begin_layout Plain Layout
27594 itself may contain substitution macros.
27595 The advantage over using
27596 \begin_inset Flex Code
27599 \begin_layout Plain Layout
27606 \begin_inset Flex Code
27609 \begin_layout Plain Layout
27615 is that the substituted value of
27616 \begin_inset Flex Code
27619 \begin_layout Plain Layout
27625 is sanitized so that it is a valid optional argument in the document format.
27626 This command may occur zero or more times.
27629 \begin_layout Description
27630 \begin_inset Flex Code
27633 \begin_layout Plain Layout
27635 \begin_inset space ~
27643 The text that is inserted in the exported document.
27644 This is actually the most important command and can be quite complex.
27645 This command must occur exactly once.
27648 \begin_layout Description
27649 \begin_inset Flex Code
27652 \begin_layout Plain Layout
27654 \begin_inset space ~
27662 This command specifies a preamble snippet that will be included in the
27665 It has to be defined using
27666 \begin_inset Flex Code
27669 \begin_layout Plain Layout
27677 \begin_inset Flex Code
27680 \begin_layout Plain Layout
27687 This command may occur zero or more times.
27690 \begin_layout Description
27691 \begin_inset Flex Code
27694 \begin_layout Plain Layout
27696 \begin_inset space ~
27700 \begin_inset space ~
27708 This command denotes files that are created by the conversion process and
27709 are needed for a particular export format.
27710 If the filename is relative, it is interpreted relative to the master document.
27711 This command may be given zero or more times.
27714 \begin_layout Description
27715 \begin_inset Flex Code
27718 \begin_layout Plain Layout
27720 \begin_inset space ~
27728 The name of a required \SpecialChar LaTeX
27730 The package is included via
27731 \begin_inset Flex Code
27734 \begin_layout Plain Layout
27742 in the \SpecialChar LaTeX
27744 This command may occur zero or more times.
27747 \begin_layout Description
27748 \begin_inset Flex Code
27751 \begin_layout Plain Layout
27753 \begin_inset space ~
27757 \begin_inset space ~
27760 RotationLatexCommand
27765 This command specifies that the built in \SpecialChar LaTeX
27766 command should be used for rotation.
27767 This command may occur once or not at all.
27770 \begin_layout Description
27771 \begin_inset Flex Code
27774 \begin_layout Plain Layout
27776 \begin_inset space ~
27780 \begin_inset space ~
27788 This command specifies that the built in \SpecialChar LaTeX
27789 command should be used for resizing.
27790 This command may occur once or not at all.
27793 \begin_layout Description
27794 \begin_inset Flex Code
27797 \begin_layout Plain Layout
27799 \begin_inset space ~
27803 \begin_inset space ~
27806 RotationLatexOption
27811 This command specifies that rotation is done via an optional argument.
27812 This command may occur once or not at all.
27815 \begin_layout Description
27816 \begin_inset Flex Code
27819 \begin_layout Plain Layout
27821 \begin_inset space ~
27825 \begin_inset space ~
27833 This command specifies that resizing is done via an optional argument.
27834 This command may occur once or not at all.
27837 \begin_layout Description
27838 \begin_inset Flex Code
27841 \begin_layout Plain Layout
27843 \begin_inset space ~
27847 \begin_inset space ~
27855 This command specifies that clipping is done via an optional argument.
27856 This command may occur once or not at all.
27859 \begin_layout Description
27860 \begin_inset Flex Code
27863 \begin_layout Plain Layout
27865 \begin_inset space ~
27869 \begin_inset space ~
27877 This command specifies that an extra optional argument is used.
27878 This command may occur once or not at all.
27881 \begin_layout Description
27882 \begin_inset Flex Code
27885 \begin_layout Plain Layout
27887 \begin_inset space ~
27895 The file format of the converted file.
27896 This must be the name of a format that is known to \SpecialChar LyX
27898 \begin_inset Flex Noun
27901 \begin_layout Plain Layout
27902 Tools\SpecialChar menuseparator
27903 Preferences\SpecialChar menuseparator
27904 File Handling\SpecialChar menuseparator
27911 This command must occur exactly once.
27912 If the resulting file format is PDF, you need to specify the format
27913 \begin_inset Flex Code
27916 \begin_layout Plain Layout
27923 This is the PDF format used for including graphics.
27924 The other defined PDF formats are for document export.
27927 \begin_layout Description
27928 \begin_inset Flex Code
27931 \begin_layout Plain Layout
27933 \begin_inset space ~
27941 The file name of the converted file.
27942 The file name must be absolute.
27943 This command must occur exactly once.
27946 \begin_layout Subsection
27947 Preamble definitions
27950 \begin_layout Standard
27951 The external template configuration file may contain additional preamble
27952 definitions enclosed by
27953 \begin_inset Flex Code
27956 \begin_layout Plain Layout
27964 \begin_inset Flex Code
27967 \begin_layout Plain Layout
27974 They can be used by the templates in the
27975 \begin_inset Flex Code
27978 \begin_layout Plain Layout
27987 \begin_layout Section
27988 The substitution mechanism
27991 \begin_layout Standard
27992 When the external material facility invokes an external program, it is done
27993 on the basis of a command defined in the template configuration file.
27994 These commands can contain various macros that are expanded before execution.
27995 Execution always take place in the directory of the containing document.
27998 \begin_layout Standard
27999 Also, whenever external material is to be displayed, the name will be produced
28000 by the substitution mechanism, and most other commands in the template
28001 definition support substitution as well.
28004 \begin_layout Standard
28005 The available macros are the following:
28008 \begin_layout Description
28009 \begin_inset Flex Code
28012 \begin_layout Plain Layout
28013 $$AbsOrRelPathMaster
28018 The file path, absolute or relative to the master \SpecialChar LyX
28022 \begin_layout Description
28023 \begin_inset Flex Code
28026 \begin_layout Plain Layout
28027 $$AbsOrRelPathParent
28032 The file path, absolute or relative to the \SpecialChar LyX
28036 \begin_layout Description
28037 \begin_inset Flex Code
28040 \begin_layout Plain Layout
28046 The absolute file path.
28049 \begin_layout Description
28050 \begin_inset Flex Code
28053 \begin_layout Plain Layout
28059 The filename without path and without the extension.
28062 \begin_layout Description
28063 \begin_inset Flex Code
28066 \begin_layout Plain Layout
28068 \begin_inset Quotes eld
28072 \begin_inset Quotes erd
28080 This macro will expand to the contents of the file with the name
28081 \begin_inset Flex Code
28084 \begin_layout Plain Layout
28093 \begin_layout Description
28094 \begin_inset Flex Code
28097 \begin_layout Plain Layout
28103 The file extension (including the dot).
28106 \begin_layout Description
28107 \begin_inset Flex Code
28110 \begin_layout Plain Layout
28116 This will be the string
28117 \begin_inset Quotes eld
28121 \begin_inset Quotes erd
28124 if the file is in JPEG format, otherwise it will be the string
28125 \begin_inset Quotes eld
28129 \begin_inset Quotes erd
28133 This is useful to avoid uneeded conversions for output formats that support
28134 both PNG and JPEG fomats.
28135 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
28140 \begin_layout Description
28141 \begin_inset Flex Code
28144 \begin_layout Plain Layout
28150 The filename of the file specified in the external material dialog.
28151 This is either an absolute name, or it is relative to the \SpecialChar LyX
28155 \begin_layout Description
28156 \begin_inset Flex Code
28159 \begin_layout Plain Layout
28166 \begin_inset Flex Code
28169 \begin_layout Plain Layout
28175 (absolute name or relative to the \SpecialChar LyX
28179 \begin_layout Description
28180 \begin_inset Flex Code
28183 \begin_layout Plain Layout
28189 The file path, relative to the master \SpecialChar LyX
28193 \begin_layout Description
28194 \begin_inset Flex Code
28197 \begin_layout Plain Layout
28203 The file path, relative to the \SpecialChar LyX
28207 \begin_layout Description
28208 \begin_inset Flex Code
28211 \begin_layout Plain Layout
28217 This macro will expand to the absolute path of the system directory.
28218 This is typically used to point to the various helper scripts that are
28219 bundled with \SpecialChar LyX
28223 \begin_layout Description
28224 \begin_inset Flex Code
28227 \begin_layout Plain Layout
28233 A name and full path to a temporary file which will be automatically deleted
28234 whenever the containing document is closed, or the external material insertion
28238 \begin_layout Standard
28239 All path macros contain a trailing directory separator, so you can construct
28241 \begin_inset space \thinspace{}
28245 \begin_inset space \space{}
28248 the absolute filename with
28249 \begin_inset Flex Code
28252 \begin_layout Plain Layout
28253 $$AbsPath$$Basename$$Extension
28261 \begin_layout Standard
28262 The macros above are substituted in all commands unless otherwise noted.
28264 \begin_inset Flex Code
28267 \begin_layout Plain Layout
28273 supports additionally the following substitutions if they are enabled by
28275 \begin_inset Flex Code
28278 \begin_layout Plain Layout
28285 \begin_inset Flex Code
28288 \begin_layout Plain Layout
28297 \begin_layout Description
28298 \begin_inset Flex Code
28301 \begin_layout Plain Layout
28307 The front part of the resize command.
28310 \begin_layout Description
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28320 The back part of the resize command.
28323 \begin_layout Description
28324 \begin_inset Flex Code
28327 \begin_layout Plain Layout
28333 The front part of the rotation command.
28336 \begin_layout Description
28337 \begin_inset Flex Code
28340 \begin_layout Plain Layout
28346 The back part of the rotation command.
28349 \begin_layout Standard
28350 The value string of the
28351 \begin_inset Flex Code
28354 \begin_layout Plain Layout
28360 command supports additionally the following substitutions if they are enabled
28362 \begin_inset Flex Code
28365 \begin_layout Plain Layout
28372 \begin_inset Flex Code
28375 \begin_layout Plain Layout
28384 \begin_layout Description
28385 \begin_inset Flex Code
28388 \begin_layout Plain Layout
28397 \begin_layout Description
28398 \begin_inset Flex Code
28401 \begin_layout Plain Layout
28410 \begin_layout Description
28411 \begin_inset Flex Code
28414 \begin_layout Plain Layout
28423 \begin_layout Description
28424 \begin_inset Flex Code
28427 \begin_layout Plain Layout
28433 The rotation option.
28436 \begin_layout Standard
28437 You may ask why there are so many path macros.
28438 There are mainly two reasons:
28441 \begin_layout Enumerate
28442 Relative and absolute file names should remain relative or absolute, respectivel
28444 Users may have reasons to prefer either form.
28445 Relative names are useful for portable documents that should work on different
28446 machines, for example.
28447 Absolute names may be required by some programs.
28450 \begin_layout Enumerate
28452 treats relative file names differently than \SpecialChar LyX
28453 and other programs in nested
28455 For \SpecialChar LyX
28456 , a relative file name is always relative to the document that contains
28458 For \SpecialChar LaTeX
28459 , it is always relative to the master document.
28460 These two definitions are identical if you have only one document, but
28461 differ if you have a master document that includes part documents.
28462 That means that relative filenames must be transformed when presented to
28465 Fortunately \SpecialChar LyX
28466 does this automatically for you if you choose the right macros.
28469 \begin_layout Standard
28470 So which path macro should be used in new template definitions? The rule
28474 \begin_layout Itemize
28476 \begin_inset Flex Code
28479 \begin_layout Plain Layout
28485 if an absolute path is required.
28488 \begin_layout Itemize
28490 \begin_inset Flex Code
28493 \begin_layout Plain Layout
28494 $$AbsOrRelPathMaster
28499 if the substituted string is some kind of \SpecialChar LaTeX
28503 \begin_layout Itemize
28505 \begin_inset Flex Code
28508 \begin_layout Plain Layout
28509 $$AbsOrRelPathParent
28514 in order to preserve the user's choice.
28517 \begin_layout Standard
28518 There are special cases where this rule does not work and e.
28519 \begin_inset space \thinspace{}
28523 \begin_inset space \space{}
28526 relative names are needed, but normally it will work just fine.
28527 One example for such a case is the command
28528 \begin_inset Flex Code
28531 \begin_layout Plain Layout
28532 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28537 in the XFig template above: We can't use the absolute name because the
28539 \begin_inset Flex Code
28542 \begin_layout Plain Layout
28548 files needs the relative name in order to rewrite the file content.
28551 \begin_layout Section
28552 Security discussion
28553 \begin_inset CommandInset label
28555 name "sec:Security-discussion"
28562 \begin_layout Standard
28563 The external material feature interfaces with a lot of external programs
28564 and does so automatically, so we have to consider the security implications
28566 In particular, since you have the option of including your own filenames
28567 and/or parameter strings and those are expanded into a command, it seems
28568 that it would be possible to create a malicious document which executes
28569 arbitrary commands when a user views or prints the document.
28570 This is something we definitely want to avoid.
28573 \begin_layout Standard
28574 However, since the external program commands are specified in the template
28575 configuration file only, there are no security issues if \SpecialChar LyX
28576 is properly configure
28577 d with safe templates only.
28578 This is so because the external programs are invoked with the
28579 \begin_inset Flex Code
28582 \begin_layout Plain Layout
28588 -system call rather than the
28589 \begin_inset Flex Code
28592 \begin_layout Plain Layout
28598 system-call, so it's not possible to execute arbitrary commands from the
28599 filename or parameter section via the shell.
28602 \begin_layout Standard
28603 This also implies that you are restricted in what command strings you can
28604 use in the external material templates.
28605 In particular, pipes and redirection are not readily available.
28606 This has to be so if \SpecialChar LyX
28607 should remain safe.
28608 If you want to use some of the shell features, you should write a safe
28609 script to do this in a controlled manner, and then invoke the script from
28610 the command string.
28614 \begin_layout Standard
28615 It is possible to design a template that interacts directly with the shell,
28616 but since this would allow a malicious user to execute arbitrary commands
28617 by writing clever filenames and/or parameters, we generally recommend that
28618 you only use safe scripts that work with the
28619 \begin_inset Flex Code
28622 \begin_layout Plain Layout
28628 system call in a controlled manner.
28629 Of course, for use in a controlled environment, it can be tempting to just
28630 fall back to use ordinary shell scripts.
28631 If you do so, be aware that you
28635 provide an easily exploitable security hole in your system.
28636 Of course it stands to reason that such unsafe templates will never be
28637 included in the standard \SpecialChar LyX
28638 distribution, although we do encourage people
28639 to submit new templates in the open source tradition.
28640 But \SpecialChar LyX
28641 as shipped from the official distribution channels will never have
28645 \begin_layout Standard
28646 Including external material provides a lot of power, and you have to be
28647 careful not to introduce security hazards with this power.
28648 A subtle error in a single line in an innocent looking script can open
28649 the door to huge security problems.
28650 So if you do not fully understand the issues, we recommend that you consult
28651 a knowledgeable security professional or the \SpecialChar LyX
28652 development team if you have
28653 any questions about whether a given template is safe or not.
28654 And do this before you use it in an uncontrolled environment.
28657 \begin_layout Chapter
28659 List of supported \SpecialChar LyX
28660 functions to be used in layouts
28661 \begin_inset CommandInset label
28663 name "chap:List-of-functions"
28670 \begin_layout Standard
28672 \begin_inset Tabular
28673 <lyxtabular version="3" rows="11" columns="8">
28674 <features tabularvalignment="middle">
28675 <column alignment="left" valignment="top">
28676 <column alignment="left" valignment="top">
28677 <column alignment="left" valignment="top">
28678 <column alignment="left" valignment="top">
28679 <column alignment="left" valignment="top">
28680 <column alignment="left" valignment="top">
28681 <column alignment="left" valignment="top">
28682 <column alignment="left" valignment="top">
28684 <cell alignment="left" valignment="top" usebox="none">
28687 \begin_layout Plain Layout
28693 <cell alignment="left" valignment="top" usebox="none">
28696 \begin_layout Plain Layout
28702 <cell alignment="left" valignment="top" usebox="none">
28705 \begin_layout Plain Layout
28711 <cell alignment="left" valignment="top" usebox="none">
28714 \begin_layout Plain Layout
28720 <cell alignment="center" valignment="top" usebox="none">
28723 \begin_layout Plain Layout
28729 <cell alignment="center" valignment="top" usebox="none">
28732 \begin_layout Plain Layout
28738 <cell alignment="center" valignment="top" usebox="none">
28741 \begin_layout Plain Layout
28747 <cell alignment="center" valignment="top" usebox="none">
28750 \begin_layout Plain Layout
28758 <cell alignment="left" valignment="top" usebox="none">
28761 \begin_layout Plain Layout
28767 <cell alignment="left" valignment="top" usebox="none">
28770 \begin_layout Plain Layout
28776 <cell alignment="left" valignment="top" usebox="none">
28779 \begin_layout Plain Layout
28785 <cell alignment="left" valignment="top" usebox="none">
28788 \begin_layout Plain Layout
28794 <cell alignment="center" valignment="top" usebox="none">
28797 \begin_layout Plain Layout
28803 <cell alignment="center" valignment="top" usebox="none">
28806 \begin_layout Plain Layout
28812 <cell alignment="center" valignment="top" usebox="none">
28815 \begin_layout Plain Layout
28821 <cell alignment="center" valignment="top" usebox="none">
28824 \begin_layout Plain Layout
28832 <cell alignment="left" valignment="top" usebox="none">
28835 \begin_layout Plain Layout
28841 <cell alignment="left" valignment="top" usebox="none">
28844 \begin_layout Plain Layout
28850 <cell alignment="left" valignment="top" usebox="none">
28853 \begin_layout Plain Layout
28859 <cell alignment="left" valignment="top" usebox="none">
28862 \begin_layout Plain Layout
28868 <cell alignment="center" valignment="top" usebox="none">
28871 \begin_layout Plain Layout
28877 <cell alignment="center" valignment="top" usebox="none">
28880 \begin_layout Plain Layout
28886 <cell alignment="center" valignment="top" usebox="none">
28889 \begin_layout Plain Layout
28895 <cell alignment="center" valignment="top" usebox="none">
28898 \begin_layout Plain Layout
28906 <cell alignment="left" valignment="top" usebox="none">
28909 \begin_layout Plain Layout
28915 <cell alignment="left" valignment="top" usebox="none">
28918 \begin_layout Plain Layout
28924 <cell alignment="left" valignment="top" usebox="none">
28927 \begin_layout Plain Layout
28933 <cell alignment="left" valignment="top" usebox="none">
28936 \begin_layout Plain Layout
28942 <cell alignment="center" valignment="top" usebox="none">
28945 \begin_layout Plain Layout
28951 <cell alignment="center" valignment="top" usebox="none">
28954 \begin_layout Plain Layout
28960 <cell alignment="center" valignment="top" usebox="none">
28963 \begin_layout Plain Layout
28969 <cell alignment="center" valignment="top" usebox="none">
28972 \begin_layout Plain Layout
28980 <cell alignment="left" valignment="top" usebox="none">
28983 \begin_layout Plain Layout
28989 <cell alignment="left" valignment="top" usebox="none">
28992 \begin_layout Plain Layout
28998 <cell alignment="left" valignment="top" usebox="none">
29001 \begin_layout Plain Layout
29007 <cell alignment="left" valignment="top" usebox="none">
29010 \begin_layout Plain Layout
29016 <cell alignment="center" valignment="top" usebox="none">
29019 \begin_layout Plain Layout
29025 <cell alignment="center" valignment="top" usebox="none">
29028 \begin_layout Plain Layout
29034 <cell alignment="center" valignment="top" usebox="none">
29037 \begin_layout Plain Layout
29043 <cell alignment="center" valignment="top" usebox="none">
29046 \begin_layout Plain Layout
29054 <cell alignment="left" valignment="top" usebox="none">
29057 \begin_layout Plain Layout
29063 <cell alignment="left" valignment="top" usebox="none">
29066 \begin_layout Plain Layout
29072 <cell alignment="left" valignment="top" usebox="none">
29075 \begin_layout Plain Layout
29081 <cell alignment="left" valignment="top" usebox="none">
29084 \begin_layout Plain Layout
29090 <cell alignment="center" valignment="top" usebox="none">
29093 \begin_layout Plain Layout
29099 <cell alignment="center" valignment="top" usebox="none">
29102 \begin_layout Plain Layout
29108 <cell alignment="center" valignment="top" usebox="none">
29111 \begin_layout Plain Layout
29117 <cell alignment="center" valignment="top" usebox="none">
29120 \begin_layout Plain Layout
29128 <cell alignment="left" valignment="top" usebox="none">
29131 \begin_layout Plain Layout
29137 <cell alignment="left" valignment="top" usebox="none">
29140 \begin_layout Plain Layout
29146 <cell alignment="left" valignment="top" usebox="none">
29149 \begin_layout Plain Layout
29155 <cell alignment="left" valignment="top" usebox="none">
29158 \begin_layout Plain Layout
29164 <cell alignment="center" valignment="top" usebox="none">
29167 \begin_layout Plain Layout
29173 <cell alignment="center" valignment="top" usebox="none">
29176 \begin_layout Plain Layout
29182 <cell alignment="center" valignment="top" usebox="none">
29185 \begin_layout Plain Layout
29191 <cell alignment="center" valignment="top" usebox="none">
29194 \begin_layout Plain Layout
29202 <cell alignment="left" valignment="top" usebox="none">
29205 \begin_layout Plain Layout
29211 <cell alignment="left" valignment="top" usebox="none">
29214 \begin_layout Plain Layout
29220 <cell alignment="left" valignment="top" usebox="none">
29223 \begin_layout Plain Layout
29229 <cell alignment="left" valignment="top" usebox="none">
29232 \begin_layout Plain Layout
29238 <cell alignment="center" valignment="top" usebox="none">
29241 \begin_layout Plain Layout
29247 <cell alignment="center" valignment="top" usebox="none">
29250 \begin_layout Plain Layout
29256 <cell alignment="center" valignment="top" usebox="none">
29259 \begin_layout Plain Layout
29265 <cell alignment="center" valignment="top" usebox="none">
29268 \begin_layout Plain Layout
29276 <cell alignment="left" valignment="top" usebox="none">
29279 \begin_layout Plain Layout
29285 <cell alignment="left" valignment="top" usebox="none">
29288 \begin_layout Plain Layout
29294 <cell alignment="left" valignment="top" usebox="none">
29297 \begin_layout Plain Layout
29303 <cell alignment="left" valignment="top" usebox="none">
29306 \begin_layout Plain Layout
29312 <cell alignment="center" valignment="top" usebox="none">
29315 \begin_layout Plain Layout
29321 <cell alignment="center" valignment="top" usebox="none">
29324 \begin_layout Plain Layout
29330 <cell alignment="center" valignment="top" usebox="none">
29333 \begin_layout Plain Layout
29339 <cell alignment="center" valignment="top" usebox="none">
29342 \begin_layout Plain Layout
29350 <cell alignment="left" valignment="top" usebox="none">
29353 \begin_layout Plain Layout
29359 <cell alignment="left" valignment="top" usebox="none">
29362 \begin_layout Plain Layout
29368 <cell alignment="left" valignment="top" usebox="none">
29371 \begin_layout Plain Layout
29377 <cell alignment="left" valignment="top" usebox="none">
29380 \begin_layout Plain Layout
29386 <cell alignment="center" valignment="top" usebox="none">
29389 \begin_layout Plain Layout
29395 <cell alignment="center" valignment="top" usebox="none">
29398 \begin_layout Plain Layout
29404 <cell alignment="center" valignment="top" usebox="none">
29407 \begin_layout Plain Layout
29413 <cell alignment="center" valignment="top" usebox="none">
29416 \begin_layout Plain Layout
29424 <cell alignment="center" valignment="top" usebox="none">
29427 \begin_layout Plain Layout
29433 <cell alignment="center" valignment="top" usebox="none">
29436 \begin_layout Plain Layout
29442 <cell alignment="center" valignment="top" usebox="none">
29445 \begin_layout Plain Layout
29451 <cell alignment="center" valignment="top" usebox="none">
29454 \begin_layout Plain Layout
29460 <cell alignment="center" valignment="top" usebox="none">
29463 \begin_layout Plain Layout
29469 <cell alignment="center" valignment="top" usebox="none">
29472 \begin_layout Plain Layout
29478 <cell alignment="center" valignment="top" usebox="none">
29481 \begin_layout Plain Layout
29487 <cell alignment="center" valignment="top" usebox="none">
29490 \begin_layout Plain Layout
29504 \begin_layout Chapter
29505 Names of available colors to be used in layouts
29506 \begin_inset CommandInset label
29508 name "chap:Names-of-colors"
29515 \begin_layout Standard
29516 The colors listed below are the standard colors and those that you can adjust
29517 in the \SpecialChar LyX
29521 \begin_layout Section
29525 \begin_layout Standard
29526 The following are no real colors, but rather act on color definitions:
29529 \begin_layout Description
29530 ignore The color is ignored
29533 \begin_layout Description
29534 inherit The color is inherited
29537 \begin_layout Description
29550 No particular color – clear or default
29553 \begin_layout Section
29557 \begin_layout Standard
29558 These are fixed colors that cannot be customized:
29561 \begin_layout Description
29565 \begin_layout Description
29569 \begin_layout Description
29573 \begin_layout Description
29577 \begin_layout Description
29581 \begin_layout Description
29585 \begin_layout Description
29589 \begin_layout Description
29593 \begin_layout Description
29597 \begin_layout Description
29601 \begin_layout Description
29605 \begin_layout Description
29609 \begin_layout Description
29613 \begin_layout Description
29617 \begin_layout Description
29621 \begin_layout Description
29625 \begin_layout Description
29629 \begin_layout Description
29633 \begin_layout Description
29637 \begin_layout Section
29641 \begin_layout Standard
29642 These are the colors allocated to specific elements in
29645 arg "dialog-show prefs"
29651 \begin_layout Description
29652 added_space Added space color
29655 \begin_layout Description
29656 addedtext Added text color
29659 \begin_layout Description
29660 appendix Appendix marker color
29663 \begin_layout Description
29664 background Background color
29667 \begin_layout Description
29668 bottomarea Bottom area color
29671 \begin_layout Description
29672 branchlabel Label color for branches
29675 \begin_layout Description
29676 buttonbg Color used for button background
29679 \begin_layout Description
29680 buttonframe Color for inset button frames
29683 \begin_layout Description
29684 buttonhoverbg Color used for button background under focus
29687 \begin_layout Description
29688 changebar Changebar color
29691 \begin_layout Description
29692 changedtextauthor1 Changed text color author 1
29695 \begin_layout Description
29696 changedtextauthor2 Changed text color author 2
29699 \begin_layout Description
29700 changedtextauthor3 Changed text color author 3
29703 \begin_layout Description
29704 changedtextauthor4 Changed text color author 4
29707 \begin_layout Description
29708 changedtextauthor5 Changed text color author 5
29711 \begin_layout Description
29712 collapsible Collapsible insets text color
29715 \begin_layout Description
29716 collapsibleframe Collapsible insets framecolor
29719 \begin_layout Description
29720 command Text color for command insets
29723 \begin_layout Description
29724 commandbg Background color for command insets
29727 \begin_layout Description
29728 commandframe Frame color for command insets
29731 \begin_layout Description
29732 comment Label color for comments
29735 \begin_layout Description
29736 commentbg Background color of comments
29739 \begin_layout Description
29740 cursor Cursor color
29743 \begin_layout Description
29744 deletedtext Deleted text color
29747 \begin_layout Description
29748 deletedtextmodifier Deleted text modifying color
29751 \begin_layout Description
29752 depthbar Color for the depth bars in the margin
29755 \begin_layout Description
29756 eolmarker End of line marker color
29759 \begin_layout Description
29760 error Color of the \SpecialChar LaTeX
29764 \begin_layout Description
29765 footlabel Label color for footnotes
29768 \begin_layout Description
29769 foreground Foreground color
29772 \begin_layout Description
29773 graphicsbg Graphics inset background color
29776 \begin_layout Description
29777 greyedoutbg Background color of greyedout inset
29780 \begin_layout Description
29781 greyedoutlabel Label color for greyedout insets
29784 \begin_layout Description
29785 greyedouttext Color for greyedout inset text
29788 \begin_layout Description
29789 indexlabel Label color for index insets
29792 \begin_layout Description
29793 inlinecompletion Inline completion color
29796 \begin_layout Description
29797 insetbg Inset marker background color
29800 \begin_layout Description
29801 insetframe Inset marker frame color
29804 \begin_layout Description
29805 language Color for marking foreign language words
29808 \begin_layout Description
29809 latex Text color in \SpecialChar LaTeX
29813 \begin_layout Description
29814 listingsbg Background color of listings inset
29817 \begin_layout Description
29818 marginlabel Label color for margin notes
29821 \begin_layout Description
29822 math Math inset text color
29825 \begin_layout Description
29826 mathbg Math inset background color
29829 \begin_layout Description
29830 mathcorners Math inset frame color not under focus
29833 \begin_layout Description
29834 mathframe Math inset frame color under focus
29837 \begin_layout Description
29838 mathline Math line color
29841 \begin_layout Description
29842 mathmacrobg Macro math inset background color
29845 \begin_layout Description
29846 mathmacroblend Macro math blended color
29849 \begin_layout Description
29850 mathmacroframe Macro math frame color
29853 \begin_layout Description
29854 mathmacrohoverbg Macro math inset background color hovered
29857 \begin_layout Description
29858 mathmacrolabel Macro math label color
29861 \begin_layout Description
29862 mathmacronewarg Macro template color for new parameters
29865 \begin_layout Description
29866 mathmacrooldarg Macro template color for old parameters
29869 \begin_layout Description
29870 newpage New page color
29873 \begin_layout Description
29874 nonunique_inlinecompletion Inline completion color for the non-unique part
29877 \begin_layout Description
29878 note Label color for notes
29881 \begin_layout Description
29882 notebg Background color of notes
29885 \begin_layout Description
29886 pagebreak Page break/line break color
29889 \begin_layout Description
29890 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29893 \begin_layout Description
29894 phantomtext Text color for phantom insets
29897 \begin_layout Description
29898 preview The color used for previews
29901 \begin_layout Description
29902 previewframe Preview frame color
29905 \begin_layout Description
29906 regexpframe Color for regexp frame
29909 \begin_layout Description
29910 scroll Color that indicates when a row can be scrolled
29913 \begin_layout Description
29914 selection Background color of selected text
29917 \begin_layout Description
29918 selectiontext Foreground color of selected text
29921 \begin_layout Description
29922 shadedbg Background color of shaded box
29925 \begin_layout Description
29926 special Special chars text color
29929 \begin_layout Description
29930 tabularline Table line color
29933 \begin_layout Description
29934 tabularonoffline Table line color
29937 \begin_layout Description
29938 urllabel Label color for URL insets
29941 \begin_layout Description
29942 urltext Color for URL inset text