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 false
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
136 \author -712698321 "Jürgen Spitzmüller"
137 \author -495245474 "Jean-Marc Lasgouttes"
138 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
144 Customizing \SpecialChar LyX
145 : Features for the Advanced User
149 by the \SpecialChar LyX
154 \begin_layout Plain Layout
156 If you have comments or error corrections, please send them to the \SpecialChar LyX
159 \begin_inset CommandInset href
161 target "lyx-docs@lists.lyx.org"
169 \begin_inset Quotes eld
173 \begin_inset Quotes erd
176 in the subject header, and please cc the current maintainer of this file,
177 Richard Heck <rgheck@comcast.net>.
183 \begin_inset Newline newline
187 \begin_inset Newline newline
193 \begin_layout Standard
194 \begin_inset CommandInset toc
195 LatexCommand tableofcontents
202 \begin_layout Standard
203 \begin_inset Note Note
206 \begin_layout Plain Layout
207 Please use change tracking when modifying this document.
208 This makes it easier for our translators to recognize things that have
209 been changed, and it helps the maintainer keep up-to-date with what's been
218 \begin_layout Chapter
222 \begin_layout Standard
223 This manual covers the customization features present in \SpecialChar LyX
225 In it, we discuss issues like keyboard shortcuts, screen previewing options,
226 printer options, sending commands to \SpecialChar LyX
227 via the \SpecialChar LyX
228 Server, internationalization,
229 installing new \SpecialChar LaTeX
230 classes and \SpecialChar LyX
232 We can't possibly hope to touch on everything you can change—our developers
233 add new features faster than we can document them—but we will explain the
234 most common customizations and hopefully point you in the right direction
235 for some of the more obscure ones.
238 \begin_layout Standard
239 \begin_inset Branch OutDated
243 \begin_layout Standard
244 Information from previous versions of this document that now seems to be
245 outdated is contained in the OutDated branch of this document.
246 By default, this information will not appear in the \SpecialChar LaTeX
255 \begin_layout Chapter
260 \begin_layout Standard
261 This chapter aims to help you to find your way through the \SpecialChar LyX
264 Before continuing to read this chapter, you should find out where your
266 library and user directories are by using
267 \begin_inset Flex Noun
270 \begin_layout Plain Layout
271 Help\SpecialChar menuseparator
282 The library directory is the place where \SpecialChar LyX
283 places its system-wide configuration
284 files; the user directory is where you can place your modified versions.
285 We will call the former
286 \begin_inset Flex Code
289 \begin_layout Plain Layout
296 \begin_inset Flex Noun
299 \begin_layout Plain Layout
305 in the remainder of this document.
309 \begin_layout Section
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
323 \begin_layout Standard
324 \begin_inset Flex Code
327 \begin_layout Plain Layout
333 and its sub-directories contain a number of files and that can be used
334 to customize \SpecialChar LyX
336 You can change many of these files from within \SpecialChar LyX
338 \begin_inset Flex Noun
341 \begin_layout Plain Layout
342 Tools\SpecialChar menuseparator
349 Most customization that you will want to do in \SpecialChar LyX
350 is possible through this
352 However, many other inner aspects of \SpecialChar LyX
353 can be customized by modifying the
355 \begin_inset Flex Code
358 \begin_layout Plain Layout
365 These files fall in different categories, described in the following subsection
369 \begin_layout Subsection
370 Automatically generated files
373 \begin_layout Standard
374 The files, which are to be found in
375 \begin_inset Flex Noun
378 \begin_layout Plain Layout
384 , are generated when you configure \SpecialChar LyX
386 They contain various default values that are guessed by inspection.
387 In general, it is not a good idea to modify them, since they might be overwritt
391 \begin_layout Labeling
392 \labelwidthstring 00.00.0000
393 \begin_inset Flex Code
396 \begin_layout Plain Layout
402 contains defaults for various commands.
405 \begin_layout Labeling
406 \labelwidthstring 00.00.0000
407 \begin_inset Flex Code
410 \begin_layout Plain Layout
416 contains the list of packages that have been recognized by \SpecialChar LyX
418 It is currently unused by the \SpecialChar LyX
419 program itself, but the information extracted,
420 and more, is made available with
421 \begin_inset Flex Noun
424 \begin_layout Plain Layout
425 Help\SpecialChar menuseparator
439 \begin_layout Labeling
440 \labelwidthstring 00.00.0000
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
450 the list of text classes that have been found in your
451 \begin_inset Flex Code
454 \begin_layout Plain Layout
460 directories, along with the associated \SpecialChar LaTeX
461 document class and their description.
464 \begin_layout Labeling
465 \labelwidthstring 00.00.0000
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
475 the list of layout modules found in your
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
488 \begin_layout Labeling
489 \labelwidthstring 00.00.0000
490 \begin_inset Flex Code
493 \begin_layout Plain Layout
499 lists of various sorts of \SpecialChar LaTeX
500 -related files found on your system
503 \begin_layout Labeling
504 \labelwidthstring 00.00.0000
505 \begin_inset Flex Code
508 \begin_layout Plain Layout
509 doc/\SpecialChar LaTeX
515 is automatically generated during configuration from the file
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
527 It contains information on your \SpecialChar LaTeX
531 \begin_layout Subsection
535 \begin_layout Standard
536 These directories are duplicated between
537 \begin_inset Flex Code
540 \begin_layout Plain Layout
547 \begin_inset Flex Code
550 \begin_layout Plain Layout
557 If a particular files exists in both places, the one in
558 \begin_inset Flex Code
561 \begin_layout Plain Layout
570 \begin_layout Labeling
571 \labelwidthstring 00.00.0000
572 \begin_inset Flex Code
575 \begin_layout Plain Layout
581 this directory contains files with the extension
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 that define the keybindings used in \SpecialChar LyX
593 If there exists an internationalized version of the bind file named
594 \begin_inset Flex Code
597 \begin_layout Plain Layout
603 , that will be used first.
606 \begin_layout Labeling
607 \labelwidthstring 00.00.0000
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
617 contains files with the extension
618 \begin_inset Flex Code
621 \begin_layout Plain Layout
627 which define the diverse citation possibilities (natbib, biblatex etc.).
629 \begin_inset CommandInset ref
631 reference "subsec:Cite-Engine-Files"
641 \begin_layout Labeling
642 \labelwidthstring 00.00.0000
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
652 contains graphics files that can be included in documents.
656 \begin_layout Labeling
657 \labelwidthstring 00.00.0000
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
667 contains \SpecialChar LyX
668 documentation files (including the one you are currently reading).
670 \begin_inset Flex Code
673 \begin_layout Plain Layout
680 deserves special attention, as noted above.
681 The internationalized help docs are in subdirectories
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
692 \begin_inset Quotes eld
696 \begin_inset Quotes erd
699 is the ISO language code.
701 \begin_inset CommandInset ref
703 reference "cha:Internationalizing-LyX"
710 \begin_layout Labeling
711 \labelwidthstring 00.00.0000
712 \begin_inset Flex Code
715 \begin_layout Plain Layout
721 contains example files that explain how to use some features.
722 In the file browser, press the
723 \begin_inset Flex Noun
726 \begin_layout Plain Layout
735 \begin_layout Labeling
736 \labelwidthstring 00.00.0000
737 \begin_inset Flex Code
740 \begin_layout Plain Layout
746 contains image files that are used by the
747 \begin_inset Flex Noun
750 \begin_layout Plain Layout
757 In addition, it also contains the individual icons used in the toolbar
758 and the banners that can be shown when \SpecialChar LyX
762 \begin_layout Labeling
763 \labelwidthstring 00.00.0000
764 \begin_inset Flex Code
767 \begin_layout Plain Layout
773 contains keyboard keymapping files.
775 \begin_inset CommandInset ref
777 reference "sec:International-Keymap-Stuff"
784 \begin_layout Labeling
785 \labelwidthstring 00.00.0000
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 contains the text class and module files described in
796 \begin_inset CommandInset ref
798 reference "cha:Installing-New-Document"
805 \begin_layout Labeling
806 \labelwidthstring 00.00.0000
807 \begin_inset Flex Code
810 \begin_layout Plain Layout
817 \begin_inset Flex Code
820 \begin_layout Plain Layout
826 Python scripts used to convert between \SpecialChar LyX
828 These can be run from the command line if, say, you want to batch-convert
832 \begin_layout Labeling
833 \labelwidthstring 00.00.0000
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
843 contains some files that demonstrate the capabilities of the
844 \begin_inset Flex Noun
847 \begin_layout Plain Layout
858 Also contains some scripts used by \SpecialChar LyX
862 \begin_layout Labeling
863 \labelwidthstring 00.00.0000
864 \begin_inset Flex Code
867 \begin_layout Plain Layout
873 contains the standard \SpecialChar LyX
874 template files described in
875 \begin_inset CommandInset ref
877 reference "subsec:Creating-Templates"
884 \begin_layout Labeling
885 \labelwidthstring 00.00.0000
886 \begin_inset Flex Code
889 \begin_layout Plain Layout
895 contains files with the extension
896 \begin_inset Flex Code
899 \begin_layout Plain Layout
905 that define the user interface to \SpecialChar LyX
907 That is, the files define which items appear in which menus and the items
908 appearing on the toolbar.
911 \begin_layout Labeling
912 \labelwidthstring 00.00.0000
913 \begin_inset Flex Code
916 \begin_layout Plain Layout
922 contains files with the extension
923 \begin_inset Flex Code
926 \begin_layout Plain Layout
932 which define the templates for the insertion of external material to a
935 \begin_inset CommandInset ref
937 reference "chap:Including-External-Material"
944 \begin_layout Subsection
945 Files you don't want to modify
948 \begin_layout Standard
949 These files are used internally by \SpecialChar LyX
950 and you generally do not need to modify
951 them unless you are a developer.
954 \begin_layout Labeling
955 \labelwidthstring 00.00.0000
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 this file contains the list of \SpecialChar LyX
967 The contents are displayed with the menu entry
968 \begin_inset Flex Noun
971 \begin_layout Plain Layout
972 Help\SpecialChar menuseparator
985 \begin_layout Labeling
986 \labelwidthstring 00.00.0000
987 \begin_inset Flex Code
990 \begin_layout Plain Layout
996 this is a \SpecialChar LaTeX
997 script used during the configuration process.
1001 \begin_layout Labeling
1002 \labelwidthstring 00.00.0000
1003 \begin_inset Flex Code
1006 \begin_layout Plain Layout
1012 this is a Python script that is used to re-configure \SpecialChar LyX
1014 It creates configuration files in the directory it was run from.
1017 \begin_layout Subsection
1018 Other files needing a line or two
1021 \begin_layout Labeling
1022 \labelwidthstring 00.00.0000
1023 \begin_inset Flex Code
1026 \begin_layout Plain Layout
1032 this contains tables describing how different character encodings can be
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 this file contains a list of all the languages currently supported by \SpecialChar LyX
1051 \begin_layout Labeling
1052 \labelwidthstring 00.00.0000
1053 \begin_inset Flex Code
1056 \begin_layout Plain Layout
1062 contains information about the supported fonts.
1065 \begin_layout Labeling
1066 \labelwidthstring 00.00.0000
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1076 this file contains translations for internationalized paragraph styles
1078 \begin_inset CommandInset ref
1080 reference "subsec:I18n"
1087 \begin_layout Labeling
1088 \labelwidthstring 00.00.0000
1089 \begin_inset Flex Code
1092 \begin_layout Plain Layout
1098 this file contains information about Unicode-encoded glyphs and the way
1099 they are supported by \SpecialChar LyX
1100 via \SpecialChar LaTeX
1104 \begin_layout Section
1105 Your local configuration directory
1108 \begin_layout Standard
1109 Even if you are using \SpecialChar LyX
1110 as an unprivileged user, you might want to change
1112 configuration for your own use.
1114 \begin_inset Flex Code
1117 \begin_layout Plain Layout
1123 directory contains all your personal configuration files.
1124 This is the directory described as
1125 \begin_inset Quotes eld
1129 \begin_inset Quotes erd
1133 \begin_inset Flex Noun
1136 \begin_layout Plain Layout
1137 Help\SpecialChar menuseparator
1139 \begin_inset space ~
1148 This directory is used as a mirror of
1149 \begin_inset Flex Code
1152 \begin_layout Plain Layout
1158 , which means that every file in
1159 \begin_inset Flex Code
1162 \begin_layout Plain Layout
1168 is a replacement for the corresponding file in
1169 \begin_inset Flex Code
1172 \begin_layout Plain Layout
1179 Any configuration file described in the above sections can be placed either
1180 in the system-wide directory, in which case it will affect all users, or
1181 in your local directory for your own use.
1184 \begin_layout Standard
1185 To make things clearer, let's provide a few examples:
1188 \begin_layout Itemize
1189 The preferences set in the
1190 \begin_inset Flex Noun
1193 \begin_layout Plain Layout
1194 Tools\SpecialChar menuseparator
1200 dialog are saved to a file
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1211 \begin_inset Flex Code
1214 \begin_layout Plain Layout
1223 \begin_layout Itemize
1224 When you reconfigure using
1225 \begin_inset Flex Noun
1228 \begin_layout Plain Layout
1229 Tools\SpecialChar menuseparator
1237 \begin_inset Flex Code
1240 \begin_layout Plain Layout
1246 script, and the resulting files are written in your local configuration
1248 This means that any additional text class file that you might have added
1250 \begin_inset Flex Code
1253 \begin_layout Plain Layout
1259 will be added to the list of classes in the
1260 \begin_inset Flex Noun
1263 \begin_layout Plain Layout
1264 Document\SpecialChar menuseparator
1273 \begin_layout Itemize
1274 If you get some updated documentation from \SpecialChar LyX
1275 ftp site and cannot install
1276 it because you do not have sysadmin rights on your system, you can just
1278 \begin_inset Flex Code
1281 \begin_layout Plain Layout
1287 and the items in the
1288 \begin_inset Flex Noun
1291 \begin_layout Plain Layout
1297 menu will open them!
1300 \begin_layout Section
1301 Running \SpecialChar LyX
1302 with multiple configurations
1305 \begin_layout Standard
1306 The configuration freedom of the local configuration directory may not suffice
1307 if you want to have more than one configuration at your disposal.
1308 For example, you may want to be use different key bindings or printer settings
1310 You can achieve this by having several such directories.
1311 You then specify which directory to use at run-time.
1314 \begin_layout Standard
1315 Invoking \SpecialChar LyX
1316 with the command line switch
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1330 instructs the program to read the configuration from that directory, and
1331 not from the default directory.
1332 (You can determine the default directory by running \SpecialChar LyX
1334 \begin_inset Flex Code
1337 \begin_layout Plain Layout
1343 switch.) If the specified directory does not exist, \SpecialChar LyX
1345 for you, just like it does for the default directory on the first time
1346 you run the program.
1347 You can modify the configuration options in this additional user directory
1348 exactly as you would for the default directory.
1349 These directories are completely independent (but read on).
1350 Note that setting the environment variable
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1360 to some value has exactly the same effect.
1363 \begin_layout Standard
1364 Having several configurations also requires more maintenance: if you want
1365 to add a new layout to
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1375 which you want available from all your configurations, you must add it
1376 to each directory separately.
1377 You can avoid this with the following trick: after \SpecialChar LyX
1378 creates the additional
1379 directory, most of the subdirectories (see above) are empty.
1380 If you want the new configuration to mirror an existing one, replace the
1381 empty subdirectory with a symbolic link to the matching subdirectory in
1382 the existing configuration.
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1393 subdirectory, however, since it contains a file written by the configuration
1394 script (also accessible through
1395 \begin_inset Flex Noun
1398 \begin_layout Plain Layout
1399 Tools\SpecialChar menuseparator
1405 ) which is configuration-specific.
1408 \begin_layout Chapter
1409 The Preferences dialog
1412 \begin_layout Standard
1413 All options of the preferences dialog are described in the Appendix
1415 The Preferences Dialog
1422 For some options you might find here more details.
1425 \begin_layout Section
1427 \begin_inset CommandInset label
1436 \begin_layout Standard
1437 The first step is to define your file formats if they are not already defined.
1439 \begin_inset Flex Noun
1442 \begin_layout Plain Layout
1443 Tools\SpecialChar menuseparator
1451 \begin_inset Flex Noun
1454 \begin_layout Plain Layout
1455 File Handling\SpecialChar menuseparator
1462 \begin_inset Flex Noun
1465 \begin_layout Plain Layout
1471 button to define your new format.
1473 \begin_inset Flex Noun
1476 \begin_layout Plain Layout
1482 field contains the name used to identify the format in the GUI.
1484 \begin_inset Flex Noun
1487 \begin_layout Plain Layout
1493 is used to identify the format internally.
1494 You will also need to enter a file extension.
1495 These are all required.
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1506 field is used to provide a keyboard shortcut on the menus.
1507 (For example, pressing
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1518 \begin_inset Flex Noun
1521 \begin_layout Plain Layout
1522 Document\SpecialChar menuseparator
1523 View (Other Formats)\SpecialChar menuseparator
1532 \begin_layout Standard
1534 \begin_inset Flex Noun
1537 \begin_layout Plain Layout
1544 \begin_inset Flex Noun
1547 \begin_layout Plain Layout
1554 For example, you might want to use
1555 \begin_inset Flex Noun
1558 \begin_layout Plain Layout
1564 to view PostScript files.
1565 You can enter the command needed to start the program in the corresponding
1567 In defining this command, you can use the four variables listed in the
1569 The viewer is launched when you view an image in \SpecialChar LyX
1571 \begin_inset Flex Noun
1574 \begin_layout Plain Layout
1575 Document\SpecialChar menuseparator
1582 The editor is for example launched when you right-click on an image and
1584 \begin_inset Flex Noun
1587 \begin_layout Plain Layout
1593 in the appearing context menu.
1596 \begin_layout Standard
1598 \begin_inset Flex Noun
1601 \begin_layout Plain Layout
1607 type of a format is optional, but if it is specified, it must be unique
1609 It is used to detect files of this format from the file contents.
1610 For some important file formats there is no MIME type officially registered
1612 \begin_inset CommandInset href
1615 target "http://www.iana.org/assignments/media-types/"
1621 Therefore \SpecialChar LyX
1622 uses the extended list of MIME types as specified by
1623 \begin_inset CommandInset href
1625 name "freedesktop.org"
1626 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1634 \begin_layout Standard
1636 \begin_inset Flex Noun
1639 \begin_layout Plain Layout
1645 option tells \SpecialChar LyX
1646 that a format is suitable for document export.
1647 If this is set and if a suitable conversion route exists (see
1648 \begin_inset CommandInset ref
1650 reference "sec:Converters"
1654 ), the format will appear in the
1655 \begin_inset Flex Noun
1658 \begin_layout Plain Layout
1659 File\SpecialChar menuseparator
1666 The format will also appear in the
1667 \begin_inset Flex Noun
1670 \begin_layout Plain Layout
1671 Document\SpecialChar menuseparator
1677 menu if a viewer is specified for the format.
1678 Pure image formats, such as
1679 \begin_inset Flex Code
1682 \begin_layout Plain Layout
1688 , should not use this option.
1689 Formats that can both represent vector graphics and documents like
1690 \begin_inset Flex Code
1693 \begin_layout Plain Layout
1702 \begin_layout Standard
1704 \begin_inset Flex Noun
1707 \begin_layout Plain Layout
1708 Vector graphics format
1713 tells \SpecialChar LyX
1714 that a format can contain vector graphics.
1715 This information is used to determine the target format of included graphics
1717 \begin_inset Flex Noun
1720 \begin_layout Plain Layout
1727 Included graphics may need to be converted to either
1728 \begin_inset Flex Noun
1731 \begin_layout Plain Layout
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1748 \begin_inset Flex Noun
1751 \begin_layout Plain Layout
1758 \begin_inset Flex Noun
1761 \begin_layout Plain Layout
1767 cannot handle other image formats.
1768 If an included graphic is not already in
1769 \begin_inset Flex Noun
1772 \begin_layout Plain Layout
1779 \begin_inset Flex Noun
1782 \begin_layout Plain Layout
1789 \begin_inset Flex Noun
1792 \begin_layout Plain Layout
1798 format, it is converted to
1799 \begin_inset Flex Noun
1802 \begin_layout Plain Layout
1808 if the vector format option is set, and otherwise to
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1821 \begin_layout Section
1825 \begin_layout Standard
1826 Since all conversions from one format to another take place in \SpecialChar LyX
1828 directory, it is sometimes necessary to modify a file before copying it
1829 to the temporary directory in order that the conversion may be performed.
1833 \begin_layout Plain Layout
1834 For example, the file may refer to other files—images, for example—using
1835 relative file names, and these may become invalid when the file is copied
1836 to the temporary directory.
1841 This is done by a Copier: It copies a file to (or from) the temporary directory
1842 and may modify it in the process.
1845 \begin_layout Standard
1846 The definitions of the copiers may use eight variables:
1849 \begin_layout Labeling
1850 \labelwidthstring 00.00.0000
1851 \begin_inset Flex Code
1854 \begin_layout Plain Layout
1860 The \SpecialChar LyX
1861 system directory (e.
1862 \begin_inset space \thinspace{}
1866 \begin_inset space \space{}
1870 \begin_inset Flex Noun
1873 \begin_layout Plain Layout
1882 \begin_layout Labeling
1883 \labelwidthstring 00.00.0000
1884 \begin_inset Flex Code
1887 \begin_layout Plain Layout
1896 \begin_layout Labeling
1897 \labelwidthstring 00.00.0000
1898 \begin_inset Flex Code
1901 \begin_layout Plain Layout
1910 \begin_layout Labeling
1911 \labelwidthstring 00.00.0000
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1921 The base name (without filename extension) in the \SpecialChar LyX
1925 \begin_layout Labeling
1926 \labelwidthstring 00.00.0000
1927 \begin_inset Flex Code
1930 \begin_layout Plain Layout
1936 The full directory path of the \SpecialChar LyX
1940 \begin_layout Labeling
1941 \labelwidthstring 00.00.0000
1942 \begin_inset Flex Code
1945 \begin_layout Plain Layout
1951 The full pathname to the original \SpecialChar LyX
1952 file being processed
1955 \begin_layout Labeling
1956 \labelwidthstring 00.00.0000
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1966 The filename (without any directory path) of the \SpecialChar LyX
1970 \begin_layout Labeling
1971 \labelwidthstring 00.00.0000
1972 \begin_inset Flex Code
1975 \begin_layout Plain Layout
1981 The `\SpecialChar LaTeX
1985 \begin_layout Standard
1986 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1994 It is relevant only when exporting files suitable for such inclusion.
1997 \begin_layout Standard
1998 Copiers can be used to do almost anything with output files.
1999 For example, suppose you want generated pdf files to be copied to a special
2001 \begin_inset Flex Code
2004 \begin_layout Plain Layout
2011 Then you could write a shell script such as this one:
2014 \begin_layout Standard
2015 \begin_inset listings
2019 \begin_layout Plain Layout
2024 \begin_layout Plain Layout
2029 \begin_layout Plain Layout
2031 TOFILE=`basename $2`
2034 \begin_layout Plain Layout
2036 cp $FROMFILE /home/you/pdf/$TOFILE
2041 Save it in your local \SpecialChar LyX
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2047 /home/you/.lyx/scripts/pdfcopier.sh
2052 —and make it executable, if you need to do so on your platform.
2054 \begin_inset Flex Noun
2057 \begin_layout Plain Layout
2058 Tools\SpecialChar menuseparator
2064 dialog, select under
2065 \begin_inset Flex Noun
2068 \begin_layout Plain Layout
2069 File Handling\SpecialChar menuseparator
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2085 format—or one of the other pdf formats—and enter
2086 \begin_inset Flex Code
2089 \begin_layout Plain Layout
2090 pdfcopier.sh $$i $$o
2096 \begin_inset Flex Noun
2099 \begin_layout Plain Layout
2109 \begin_layout Standard
2110 Copiers are used by \SpecialChar LyX
2111 in various of its own conversions.
2112 For example, if appropriate programs are found, \SpecialChar LyX
2113 will automatically install
2115 \begin_inset Flex Noun
2118 \begin_layout Plain Layout
2125 \begin_inset Flex Noun
2128 \begin_layout Plain Layout
2130 \begin_inset space ~
2139 When these formats are exported, the copier sees that not just the main
2140 HTML file but various associated files (style files, images, etc.) are also
2142 All these files are written to a subdirectory of the directory in which
2143 the original \SpecialChar LyX
2148 \begin_layout Plain Layout
2149 This copier can be customized.
2151 \begin_inset Quotes eld
2155 \begin_inset Quotes erd
2158 argument takes a comma-separated list of extensions to be copied; if it
2159 is omitted, all files will be copied.
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2168 argument determines the extension added to the generated directory.
2170 \begin_inset Quotes eld
2174 \begin_inset Flex Noun
2177 \begin_layout Plain Layout
2184 \begin_inset Quotes erd
2187 , so HTML generated from
2188 \begin_inset Flex Noun
2191 \begin_layout Plain Layout
2192 /path/to/filename.lyx
2198 \begin_inset Flex Noun
2201 \begin_layout Plain Layout
2202 /path/to/filename.html.LyXconv
2216 \begin_layout Section
2218 \begin_inset CommandInset label
2220 name "sec:Converters"
2227 \begin_layout Standard
2228 You can define your own Converters to convert files between different formats.
2230 \begin_inset Flex Noun
2233 \begin_layout Plain Layout
2234 Tools\SpecialChar menuseparator
2235 Preferences\SpecialChar menuseparator
2236 File Handling\SpecialChar menuseparator
2245 \begin_layout Standard
2246 To define a new converter, select the
2247 \begin_inset Flex Noun
2250 \begin_layout Plain Layout
2252 \begin_inset space ~
2261 \begin_inset Flex Noun
2264 \begin_layout Plain Layout
2266 \begin_inset space ~
2274 from the drop-down lists, enter the command needed for the conversion,
2276 \begin_inset Flex Noun
2279 \begin_layout Plain Layout
2286 Several variables can be used in the definition of converters:
2289 \begin_layout Labeling
2290 \labelwidthstring 00.00.0000
2291 \begin_inset Flex Code
2294 \begin_layout Plain Layout
2300 The \SpecialChar LyX
2304 \begin_layout Labeling
2305 \labelwidthstring 00.00.0000
2306 \begin_inset Flex Code
2309 \begin_layout Plain Layout
2318 \begin_layout Labeling
2319 \labelwidthstring 00.00.0000
2320 \begin_inset Flex Code
2323 \begin_layout Plain Layout
2332 \begin_layout Labeling
2333 \labelwidthstring 00.00.0000
2334 \begin_inset Flex Code
2337 \begin_layout Plain Layout
2343 The base filename of the input file (i.
2344 \begin_inset space \thinspace{}
2347 g., without the extension)
2350 \begin_layout Labeling
2351 \labelwidthstring 00.00.0000
2352 \begin_inset Flex Code
2355 \begin_layout Plain Layout
2361 The path to the input file
2364 \begin_layout Labeling
2365 \labelwidthstring 00.00.0000
2366 \begin_inset Flex Code
2369 \begin_layout Plain Layout
2375 The path to the original input file (this is different from $$p when a
2376 chain of converters is called)
2379 \begin_layout Labeling
2380 \labelwidthstring 00.00.0000
2381 \begin_inset Flex Code
2384 \begin_layout Plain Layout
2390 The iconv name for the encoding of the document.
2393 \begin_layout Standard
2395 \begin_inset Flex Noun
2398 \begin_layout Plain Layout
2400 \begin_inset space ~
2408 field you can enter the following flags, separated by commas:
2411 \begin_layout Labeling
2412 \labelwidthstring 00.00.0000
2413 \begin_inset Flex Code
2416 \begin_layout Plain Layout
2418 \change_inserted -712698321 1524656940
2426 This converter runs some form of \SpecialChar LaTeX
2428 This will make \SpecialChar LyX
2429 's \SpecialChar LaTeX
2430 error logs available.
2432 \change_inserted -712698321 1524657018
2434 \begin_inset Flex Code
2437 \begin_layout Plain Layout
2439 \change_inserted -712698321 1524657012
2447 value specifies the form of \SpecialChar LaTeX
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2454 \change_inserted -712698321 1524657005
2455 latex, pdflatex, platex, xetex, luatex
2463 If no value is specified,
2464 \begin_inset Flex Code
2467 \begin_layout Plain Layout
2469 \change_inserted -712698321 1524657018
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2489 \change_inserted -712698321 1524656935
2497 Needs the \SpecialChar LaTeX
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2508 file for the conversion.
2510 \change_inserted -712698321 1524657047
2512 \begin_inset Flex Code
2515 \begin_layout Plain Layout
2517 \change_inserted -712698321 1524657030
2523 value specifies the form of \SpecialChar LaTeX
2524 that is run in order to generate the
2525 \begin_inset Flex Noun
2528 \begin_layout Plain Layout
2530 \change_inserted -712698321 1524657047
2537 \begin_inset Flex Code
2540 \begin_layout Plain Layout
2542 \change_inserted -712698321 1524657030
2543 latex, pdflatex, platex, xetex, luatex
2549 If no value is specified,
2550 \begin_inset Flex Code
2553 \begin_layout Plain Layout
2555 \change_inserted -712698321 1524657030
2566 \begin_layout Labeling
2567 \labelwidthstring 00.00.0000
2568 \begin_inset Flex Code
2571 \begin_layout Plain Layout
2578 \begin_inset Quotes eld
2582 \begin_inset Quotes erd
2585 file from the backend, which in practice means a \SpecialChar LaTeX
2586 file like the one we
2587 would export, without
2588 \begin_inset Flex Code
2591 \begin_layout Plain Layout
2600 \begin_layout Labeling
2601 \labelwidthstring 00.00.0000
2602 \begin_inset Flex Code
2605 \begin_layout Plain Layout
2614 \begin_layout Standard
2615 The following three flags are not really flags at all because they take
2617 \begin_inset Flex Noun
2620 \begin_layout Plain Layout
2622 \begin_inset space ~
2626 \begin_inset space ~
2637 \begin_layout Labeling
2638 \labelwidthstring 00.00.0000
2640 \change_inserted -712698321 1523206314
2641 \begin_inset Flex Code
2644 \begin_layout Plain Layout
2646 \change_inserted -712698321 1523206193
2652 The name of the driver that needs to be loaded with the
2656 package for this converter.
2657 The loading of the correct driver is necessary to get some PDF-specific
2666 \begin_layout Labeling
2667 \labelwidthstring 00.00.0000
2668 \begin_inset Flex Code
2671 \begin_layout Plain Layout
2677 If set, the converter's standard error will be redirected to a file
2678 \begin_inset Flex Code
2681 \begin_layout Plain Layout
2687 , and the script given as argument will be run as:
2688 \begin_inset Flex Code
2691 \begin_layout Plain Layout
2692 script < infile.out > infile.log
2698 The argument may contain
2699 \begin_inset Flex Code
2702 \begin_layout Plain Layout
2711 \begin_layout Labeling
2712 \labelwidthstring 00.00.0000
2713 \begin_inset Flex Code
2716 \begin_layout Plain Layout
2722 The name of the directory in which the converter will dump the generated
2725 will not create this directory, and it does not copy anything into it,
2726 though it will copy this directory to the destination.
2727 The argument may contain
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2737 , which will be replaced by the base name of the input and output files,
2738 respectively, when the directory is copied.
2739 \begin_inset Newline newline
2742 Note that resultdir and usetempdir make no sense together.
2743 The latter will be ignored if the former is given.
2746 \begin_layout Labeling
2747 \labelwidthstring 00.00.0000
2748 \begin_inset Flex Code
2751 \begin_layout Plain Layout
2757 Determines the output file name and may, contain
2758 \begin_inset Flex Code
2761 \begin_layout Plain Layout
2768 Sensible only with resultdir and optional even then; if not given, it defaults
2772 \begin_layout Standard
2774 \change_inserted -712698321 1523206384
2775 A suitable hyperref-driver is set for some converters that are installed
2776 with \SpecialChar LyX
2779 \change_deleted -712698321 1523206388
2781 \change_inserted -712698321 1523206389
2785 \change_inserted -712698321 1523206400
2789 \change_inserted -712698321 1523206407
2793 \change_inserted -712698321 1523206437
2797 \change_deleted -712698321 1523206442
2798 that are installed with \SpecialChar LyX
2805 \begin_layout Standard
2806 You do not have to define converters for all formats between which you want
2808 For example, you will note that there is no `\SpecialChar LyX
2809 to PostScript' converter,
2810 but \SpecialChar LyX
2811 will export PostScript.
2812 It does so by first creating a \SpecialChar LaTeX
2813 file (no converter needs to be defined
2814 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2816 and finally converting the resulting DVI file to PostScript.
2818 finds such `chains' of converters automatically, and it will always choose
2819 the shortest possible chain.
2820 You can, though, still define multiple conversion methods between file
2822 For example, the standard \SpecialChar LyX
2823 configuration provides five ways to convert
2828 \begin_layout Enumerate
2830 \begin_inset Flex Noun
2833 \begin_layout Plain Layout
2842 \begin_layout Enumerate
2843 via (DVI and) PostScript, using
2844 \begin_inset Flex Noun
2847 \begin_layout Plain Layout
2856 \begin_layout Enumerate
2858 \begin_inset Flex Noun
2861 \begin_layout Plain Layout
2870 \begin_layout Enumerate
2872 \begin_inset Flex Noun
2875 \begin_layout Plain Layout
2885 \begin_layout Enumerate
2887 \begin_inset Flex Noun
2890 \begin_layout Plain Layout
2900 \begin_layout Standard
2901 To define such alternate chains, you must define multiple target `file formats',
2903 \begin_inset CommandInset ref
2905 reference "sec:Formats"
2910 For example, in the standard configuration, the formats named
2911 \begin_inset Flex Noun
2914 \begin_layout Plain Layout
2921 \begin_inset Flex Noun
2924 \begin_layout Plain Layout
2931 \begin_inset Flex Noun
2934 \begin_layout Plain Layout
2941 \begin_inset Flex Noun
2944 \begin_layout Plain Layout
2951 \begin_inset Flex Noun
2954 \begin_layout Plain Layout
2961 \begin_inset Flex Noun
2964 \begin_layout Plain Layout
2971 \begin_inset Flex Noun
2974 \begin_layout Plain Layout
2981 \begin_inset Flex Noun
2984 \begin_layout Plain Layout
2992 \begin_inset Flex Noun
2995 \begin_layout Plain Layout
3002 \begin_inset Flex Noun
3005 \begin_layout Plain Layout
3012 ) are defined, all of which share the extension
3013 \begin_inset Flex Noun
3016 \begin_layout Plain Layout
3022 , and which correspond to the conversion methods just mentioned.
3025 \begin_layout Chapter
3026 Internationalizing \SpecialChar LyX
3028 \begin_inset CommandInset label
3030 name "cha:Internationalizing-LyX"
3037 \begin_layout Standard
3039 supports using a translated interface.
3040 Last time we checked, \SpecialChar LyX
3041 provided text in thirty languages.
3042 The language of choice is called your
3047 (For further reading on locale settings, see also the documentation for
3048 locale that comes with your operating system.
3049 For Linux, the manual page for
3050 \begin_inset Flex Code
3053 \begin_layout Plain Layout
3059 could be a good place to start).
3062 \begin_layout Standard
3063 Notice that these translations will work, but do contain a few flaws.
3064 In particular, all dialogs have been designed with the English text in
3065 mind, which means that some of the translated text will be too large to
3066 fit within the space allocated.
3067 This is only a display problem and will not cause any harm.
3068 Also, you will find that some of the translations do not define shortcut
3069 keys for everything.
3070 Sometimes, there are simply not enough free letters to do it.
3071 Other times, the translator just hasn't got around to doing it yet.
3072 Our localization team, which you may wish to join,
3076 \begin_layout Plain Layout
3077 If you are a fluent speaker of a language other than English, joining these
3078 teams is a great way to give back to the \SpecialChar LyX
3084 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3088 \begin_layout Section
3089 Translating \SpecialChar LyX
3093 \begin_layout Subsection
3094 Translating the graphical user interface (text messages).
3097 \begin_layout Standard
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3109 library to handle the internationalization of the interface.
3110 To have \SpecialChar LyX
3111 speak your favorite language in all menus and dialogs, you need
3113 \begin_inset Flex Code
3116 \begin_layout Plain Layout
3122 -file for that language.
3123 When this is available, you'll have to generate a
3124 \begin_inset Flex Code
3127 \begin_layout Plain Layout
3133 -file from it and install the
3134 \begin_inset Flex Code
3137 \begin_layout Plain Layout
3144 The process of doing all of this is explained in the documentation for
3146 \begin_inset Flex Code
3149 \begin_layout Plain Layout
3156 It is possible to do this just for yourself, but if you're going to do
3157 it, you might as well share the results of your labors with the rest of
3158 the \SpecialChar LyX
3160 Send a message to the \SpecialChar LyX
3161 developers' list for more information about how
3165 \begin_layout Standard
3166 In short, this is what you should do (xx denotes the language code):
3169 \begin_layout Itemize
3170 Check out the \SpecialChar LyX
3173 \begin_inset CommandInset href
3175 name "information on the web"
3176 target "https://www.lyx.org/HowToUseGIT"
3184 \begin_layout Itemize
3186 \begin_inset Flex Code
3189 \begin_layout Plain Layout
3195 to the folder of the
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3207 \begin_inset Flex Code
3210 \begin_layout Plain Layout
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3227 doesn't exist anywhere, it can be remade with the console command
3228 \begin_inset Flex Code
3231 \begin_layout Plain Layout
3237 in that directory, or you can use an existing po-file for some other language
3241 \begin_layout Itemize
3243 \begin_inset Flex Code
3246 \begin_layout Plain Layout
3256 \begin_layout Plain Layout
3257 This is just a text file, so it can be edited in any text editor.
3258 But there are also specialized programs that support such editing, such
3263 (for all platforms) or
3272 contains a `mode' for editing
3273 \begin_inset Flex Code
3276 \begin_layout Plain Layout
3283 \begin_inset Flex URL
3286 \begin_layout Plain Layout
3288 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3298 For some menu- and widget-labels, there are also shortcut keys that should
3300 Those keys are marked after a `|', and should be translated according to
3301 the words and phrases of the language.
3302 You should also fill also out the information at the beginning of the new
3304 \begin_inset Flex Code
3307 \begin_layout Plain Layout
3313 -file with your email-address, etc., so people know where to reach you with
3314 suggestions and entertaining flames.
3317 \begin_layout Standard
3318 If you are just doing this on your own, then:
3321 \begin_layout Itemize
3323 \begin_inset Flex Code
3326 \begin_layout Plain Layout
3333 This can be done with
3334 \begin_inset Flex Code
3337 \begin_layout Plain Layout
3338 msgfmt -o xx.mo < xx.po
3346 \begin_layout Itemize
3348 \begin_inset Flex Code
3351 \begin_layout Plain Layout
3357 -file to your locale-tree, at the correct directory for application messages
3362 xx, and under the name
3363 \begin_inset Flex Code
3366 \begin_layout Plain Layout
3373 \begin_inset space \thinspace{}
3377 \begin_inset space \space{}
3381 \begin_inset Flex Code
3384 \begin_layout Plain Layout
3385 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3395 \begin_layout Standard
3396 As said, however, it would be best if the new
3397 \begin_inset Flex Code
3400 \begin_layout Plain Layout
3406 file could be added to the \SpecialChar LyX
3407 distribution, so others can use it.
3408 Adding it involves making additional changes to \SpecialChar LyX
3410 So send an email to the developers' mailing list if you're interested in
3414 \begin_layout Subsubsection
3418 \begin_layout Standard
3419 Sometimes it turns out that one English message needs to be translated into
3420 different messages in the target language.
3421 One example is the message
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3431 which has the German translation
3439 , depending upon exactly what the English
3440 \begin_inset Quotes eld
3444 \begin_inset Quotes erd
3449 \begin_inset Flex Code
3452 \begin_layout Plain Layout
3458 does not handle such ambiguous translations.
3459 Therefore you have to add some context information to the message: Instead
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3475 To[[as in 'From format x to format y']]
3481 \begin_inset Flex Code
3484 \begin_layout Plain Layout
3485 To[[as in 'From page x to page y']].
3490 Now the two occurrences of
3491 \begin_inset Flex Code
3494 \begin_layout Plain Layout
3501 \begin_inset Flex Code
3504 \begin_layout Plain Layout
3510 and can be translated correctly to
3521 \begin_layout Standard
3522 Of course the context information needs to be stripped off the original
3523 message when no translation is used.
3524 Therefore you have to put it in double square brackets at the end of the
3525 message (see the example above).
3526 The translation mechanism of \SpecialChar LyX
3527 ensures that everything in double square
3528 brackets at the end of messages is removed before displaying the message.
3531 \begin_layout Subsection
3532 Translating the documentation.
3535 \begin_layout Standard
3536 The online documentation (in the
3537 \begin_inset Flex Noun
3540 \begin_layout Plain Layout
3546 -menu) can (and should!) be translated.
3547 If there are translated versions of the documentation available
3551 \begin_layout Plain Layout
3552 As of March 2008, at least some of the documents have been translated into
3553 fourteen languages, with the Tutorial available in a few more.
3558 and the locale is set accordingly, these will be used automagically by
3562 looks for translated versions as
3563 \begin_inset Flex Code
3566 \begin_layout Plain Layout
3567 LyXDir/doc/xx/DocName.lyx
3573 \begin_inset Flex Code
3576 \begin_layout Plain Layout
3582 is the code for the language currently in use.
3583 If there are no translated documents, the default English versions will
3585 Note that the translated versions must have the same filenames (
3586 \begin_inset Flex Code
3589 \begin_layout Plain Layout
3595 above) as the original.
3596 If you feel up to translating the documentation (an excellent way to proof-read
3597 the original documentation by the way!), there are a few things you should
3601 \begin_layout Itemize
3602 Check out the documentation translation web page at
3603 \begin_inset CommandInset href
3605 name "https://www.lyx.org/Translation"
3606 target "https://www.lyx.org/Translation"
3612 That way, you can find out which (if any) documents have already been translate
3613 d into your language.
3614 You can also find out who (if anyone) is organizing the effort to translate
3615 the documentation into your language.
3616 If no one is organizing the effort, please let us know that you're interested.
3619 \begin_layout Standard
3620 Once you get to actually translating, here's a few hints for you that may
3624 \begin_layout Itemize
3625 Join the documentation team! There is information on how to do that in
3626 \begin_inset Flex Code
3629 \begin_layout Plain Layout
3636 \begin_inset Flex Noun
3639 \begin_layout Plain Layout
3640 Help\SpecialChar menuseparator
3646 ), which by the way is the first document you should translate.
3649 \begin_layout Itemize
3650 Learn the typographic conventions for the language you are translating to.
3651 Typography is an ancient art and over the centuries, a great variety of
3652 conventions have developed throughout different parts of the world.
3653 Also study the professional terminology amongst typographers in your country.
3654 Inventing your own terminology will only confuse the users.
3657 (Warning! Typography is addictive!)
3660 \begin_layout Itemize
3661 Make a copy of the document.
3662 This will be your working copy.
3663 You can use this as your personal translated help-file by placing it in
3665 \begin_inset Flex Code
3668 \begin_layout Plain Layout
3675 \begin_inset Note Greyedout
3678 \begin_layout Plain Layout
3683 For a complex document with external material (images, etc.), if you make
3685 \begin_inset space \thinspace{}
3689 \begin_inset space \space{}
3692 in a temp dir, beware that the links to external material may be broken
3693 when the document is moved to a different place.
3694 The best way is to retrieve the \SpecialChar LyX
3696 \begin_inset Flex URL
3699 \begin_layout Plain Layout
3701 https://www.lyx.org/HowToUseGIT
3706 ) and to edit the doc file in place.
3714 \begin_layout Itemize
3715 Sometimes the original document (from the \SpecialChar LyX
3716 team) will be updated.
3717 Use the source viewer at
3718 \begin_inset CommandInset href
3720 name "https://www.lyx.org/trac/timeline"
3721 target "https://www.lyx.org/trac/timeline"
3726 to see what has been changed.
3727 That way you can easily see which parts of the translated document need
3731 \begin_layout Standard
3732 If you ever find an error in the original document, fix it and notify the
3733 rest of the documentation team of the changes! (You didn't forget to join
3734 the documentation team, did you?)
3737 \begin_layout Standard
3738 \begin_inset Branch OutDated
3742 \begin_layout Section
3743 International Keyboard Support
3746 \begin_layout Standard
3749 [Editor's Note: The following section is by
3757 It needs to be fixed to conform to the new Documentation Style sheet and
3758 to make use of the new v1.0 features.
3759 The whole thing also needs to be merged with the section following it.-jw
3760 It may also be badly out of date.-rh (2008)]
3763 \begin_layout Subsection
3764 Defining Own Keymaps: Keymap File Format
3767 \begin_layout Standard
3768 Let's look at a keyboard definition file a little closer.
3769 It is a plain text file defining
3772 \begin_layout Itemize
3773 key-to-key or key-to-string translations
3776 \begin_layout Itemize
3780 \begin_layout Itemize
3781 dead keys exceptions
3784 \begin_layout Standard
3785 To define key-to-key or key-to-string translation, use this command:
3788 \begin_layout Quotation
3789 \begin_inset Flex Code
3792 \begin_layout Plain Layout
3801 \begin_inset Flex Code
3804 \begin_layout Plain Layout
3813 \begin_layout Standard
3815 \begin_inset Flex Code
3818 \begin_layout Plain Layout
3824 is the key to be translated and
3825 \begin_inset Flex Code
3828 \begin_layout Plain Layout
3834 is the string to be inserted into the document.
3835 To define dead keys, use:
3838 \begin_layout Quotation
3839 \begin_inset Flex Code
3842 \begin_layout Plain Layout
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3863 \begin_layout Standard
3865 \begin_inset Flex Code
3868 \begin_layout Plain Layout
3874 is a keyboard key and
3875 \begin_inset Flex Code
3878 \begin_layout Plain Layout
3885 The following dead keys are supported (shortcut name is in parentheses):
3888 \begin_layout Quotation
3892 \begin_inset space \hfill{}
3898 \begin_layout Quotation
3900 \begin_inset space \hfill{}
3906 \begin_layout Quotation
3908 \begin_inset space \hfill{}
3914 \begin_layout Quotation
3916 \begin_inset space \hfill{}
3922 \begin_layout Quotation
3924 \begin_inset space \hfill{}
3930 \begin_layout Quotation
3932 \begin_inset space \hfill{}
3939 \begin_layout Plain Layout
3951 \begin_layout Quotation
3953 \begin_inset space \hfill{}
3959 \begin_layout Quotation
3961 \begin_inset space \hfill{}
3968 \begin_layout Plain Layout
3980 \begin_layout Quotation
3982 \begin_inset space \hfill{}
3988 \begin_layout Quotation
3990 \begin_inset space \hfill{}
3996 \begin_layout Quotation
3998 \begin_inset space \hfill{}
4005 \begin_layout Plain Layout
4017 \begin_layout Quotation
4019 \begin_inset space \hfill{}
4026 \begin_layout Plain Layout
4038 \begin_layout Quotation
4040 \begin_inset space \hfill{}
4046 \begin_layout Quotation
4047 hungarian umlaut (hug)
4048 \begin_inset space \hfill{}
4054 \begin_layout Quotation
4056 \begin_inset space \hfill{}
4062 \begin_layout Quotation
4064 \begin_inset space \hfill{}
4071 \begin_layout Plain Layout
4083 \begin_layout Standard
4084 Since in many international keyboards there are exceptions to what some
4085 dead keys should do, you can define them using
4088 \begin_layout Quotation
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4100 deadkey key outstring
4103 \begin_layout Standard
4104 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4108 \begin_layout Quotation
4109 \begin_inset Flex Code
4112 \begin_layout Plain Layout
4125 \begin_layout Standard
4126 to make it work correctly.
4127 Also, you have to define as exceptions dead keys over i and j, to remove
4128 the dot from them before inserting an accent mark.
4129 I will change this when the time comes, but so far I haven't had time.
4132 \begin_layout Standard
4133 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4136 \begin_inset Flex Code
4139 \begin_layout Plain Layout
4145 have different meaning.
4147 \begin_inset Flex Code
4150 \begin_layout Plain Layout
4156 marks comments, quotes start and end \SpecialChar LaTeX
4158 To enter quote, you'll need to use
4159 \begin_inset Flex Code
4162 \begin_layout Plain Layout
4171 \begin_inset Flex Code
4174 \begin_layout Plain Layout
4181 \begin_inset Flex Code
4184 \begin_layout Plain Layout
4195 \begin_layout Standard
4196 If you make a keyboard description file that works for your language, please
4197 mail it to me, so I can include it in the next keymap distribution.
4200 \begin_layout Standard
4201 More keywords will be supported in keymap configuration file in future,
4205 \begin_layout Itemize
4206 \begin_inset Flex Code
4209 \begin_layout Plain Layout
4220 \begin_inset space \hfill{}
4224 \begin_inset Flex Code
4227 \begin_layout Plain Layout
4236 \begin_layout Itemize
4237 \begin_inset Flex Code
4240 \begin_layout Plain Layout
4251 \begin_inset space \hfill{}
4255 \begin_inset Flex Code
4258 \begin_layout Plain Layout
4264 an external keymap translation program
4267 \begin_layout Standard
4268 Also, it should look into
4269 \begin_inset Flex Code
4272 \begin_layout Plain Layout
4278 file for defaults, too (for example, a
4279 \begin_inset Flex Code
4282 \begin_layout Plain Layout
4290 option to include default keyboard).
4298 \begin_layout Section
4299 International Keymap Stuff
4300 \begin_inset CommandInset label
4302 name "sec:International-Keymap-Stuff"
4309 \begin_layout Standard
4310 \begin_inset Note Note
4313 \begin_layout Plain Layout
4314 In doing the revisions on this document in March 2008, I did not look over
4315 this stuff, as I do not understand it.
4316 It would be good if someone else could do so.
4325 \begin_layout Standard
4326 The next two sections describe the
4327 \begin_inset Flex Code
4330 \begin_layout Plain Layout
4339 \begin_inset Flex Code
4342 \begin_layout Plain Layout
4350 file syntax in detail.
4351 These sections should help you design your own key map if the ones provided
4352 do not meet your needs.
4355 \begin_layout Subsection
4359 \begin_layout Standard
4363 \begin_inset Flex Code
4366 \begin_layout Plain Layout
4372 file maps keystrokes to characters or strings.
4373 As the name suggests, it sets a keyboard mapping.
4375 \begin_inset Flex Code
4378 \begin_layout Plain Layout
4389 \begin_inset Flex Code
4392 \begin_layout Plain Layout
4407 \begin_inset Flex Code
4410 \begin_layout Plain Layout
4423 \begin_inset Flex Code
4426 \begin_layout Plain Layout
4435 \begin_inset Flex Code
4438 \begin_layout Plain Layout
4446 are described in this section.
4449 \begin_layout Labeling
4450 \labelwidthstring 00.00.0000
4451 \begin_inset Flex Code
4454 \begin_layout Plain Layout
4462 Map a character to a string
4465 \begin_layout LyX-Code
4480 \begin_layout Standard
4513 the double-quote (")
4530 must be escaped with a preceding backslash (
4541 \begin_layout Standard
4543 \begin_inset Flex Noun
4546 \begin_layout Plain Layout
4554 statement to cause the symbol
4555 \begin_inset Flex Noun
4558 \begin_layout Plain Layout
4566 to be output for the keystroke
4567 \begin_inset Flex Noun
4570 \begin_layout Plain Layout
4581 \begin_layout LyX-Code
4587 \begin_layout Labeling
4588 \labelwidthstring 00.00.0000
4589 \begin_inset Flex Code
4592 \begin_layout Plain Layout
4600 Specify an accent character
4603 \begin_layout LyX-Code
4612 \begin_layout Standard
4613 This will make the cha
4651 This is the dead key
4655 \begin_layout Plain Layout
4662 refers to a key that does not produce a character by itself, but when followed
4663 with another key, produces the desired accent character.
4664 For example, a German characte
4666 r with an umlaut like
4676 can be produced in this manner.
4685 \begin_layout Standard
4698 and then another key not in
4715 followed by the other, not allowed key, as output.
4719 \begin_inset Flex Noun
4722 \begin_layout Plain Layout
4730 cancels a dead key, so if
4741 \begin_inset Flex Noun
4744 \begin_layout Plain Layout
4753 , the cursor will not go one position backwards but will instead cancel
4769 might have had on the next keystroke.
4773 \begin_layout Standard
4774 The following example specifies that the character ' is to be an acute accent,
4775 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4778 \begin_layout LyX-Code
4781 kmod ' acute aeiouAEIOU
4784 \begin_layout Labeling
4785 \labelwidthstring 00.00.0000
4786 \begin_inset Flex Code
4789 \begin_layout Plain Layout
4795 Specify an exception to the accent character
4798 \begin_layout LyX-Code
4807 \begin_layout Standard
4808 This defines an exce
4849 have been assigned a keystroke with a previous
4852 \begin_inset Flex Code
4855 \begin_layout Plain Layout
4879 must not belong in the
4926 If such a declaration does not exist in
4934 \begin_inset Flex Code
4937 \begin_layout Plain Layout
4971 \begin_inset Flex Code
4974 \begin_layout Plain Layout
4988 \begin_layout Standard
4989 The following command produces causes äi to be produced when you enter acute-i
4993 \begin_layout LyX-Code
5007 \begin_layout Labeling
5008 \labelwidthstring 00.00.0000
5009 \begin_inset Flex Code
5012 \begin_layout Plain Layout
5018 Combine two accent characters
5021 \begin_layout LyX-Code
5027 accent1 accent2 allowed
5030 \begin_layout Standard
5031 This one is getting pretty esoteric.
5032 It allows you to combine the effect
5088 \begin_inset Flex Code
5091 \begin_layout Plain Layout
5119 \begin_layout Standard
5120 Consider this example from the
5121 \begin_inset Flex Code
5124 \begin_layout Plain Layout
5135 \begin_layout LyX-Code
5138 kmod ; acute aeioyvhAEIOYVH
5142 kcomb acute umlaut iyIY
5145 \begin_layout Standard
5146 This allows you to press
5147 \begin_inset Flex Noun
5150 \begin_layout Plain Layout
5158 and get the effect of
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5181 in this case cancels the last dead key, so if you press
5182 \begin_inset Flex Noun
5185 \begin_layout Plain Layout
5194 \begin_inset Flex Code
5197 \begin_layout Plain Layout
5210 \begin_layout Subsection
5214 \begin_layout Standard
5216 \begin_inset Flex Code
5219 \begin_layout Plain Layout
5227 mapping is performed, a
5228 \begin_inset Flex Code
5231 \begin_layout Plain Layout
5241 file maps the strings that the symbols generate to characters in the current
5243 The \SpecialChar LyX
5244 distribution currently includes at least the
5245 \begin_inset Flex Code
5248 \begin_layout Plain Layout
5257 \begin_inset Flex Code
5260 \begin_layout Plain Layout
5271 \begin_layout Standard
5273 \begin_inset Flex Code
5276 \begin_layout Plain Layout
5284 file is a sequence of declarations of the form
5287 \begin_layout LyX-Code
5300 \begin_layout Standard
5301 For example, in order to map
5302 \begin_inset Flex Noun
5305 \begin_layout Plain Layout
5315 to the corresponding character in the iso-8859-1 set (233), the following
5319 \begin_layout LyX-Code
5327 \begin_layout Standard
5329 \begin_inset Flex Code
5332 \begin_layout Plain Layout
5341 \begin_inset Flex Code
5344 \begin_layout Plain Layout
5362 the same character can apply to more than one string.
5364 \begin_inset Flex Code
5367 \begin_layout Plain Layout
5378 \begin_layout LyX-Code
5390 \begin_inset Newline newline
5406 \begin_layout Standard
5408 cannot find a mapping for the string produced by the keystroke or a
5409 deadkey sequence, it will check if it looks like an accented char and try
5410 to draw an accent over the character on screen.
5413 \begin_layout Subsection
5417 \begin_layout Standard
5418 There is a second way to add support for international characters through
5419 so-called dead-keys.
5420 A dead-key works in combination with a letter to produce an accented character.
5421 Here, we'll explain how to create a really simple dead-key to illustrate
5425 \begin_layout Standard
5426 Suppose you happen to need the circumflex character,
5427 \begin_inset Quotes eld
5431 \begin_inset Quotes erd
5436 \begin_inset Flex Noun
5439 \begin_layout Plain Layout
5446 \begin_inset space ~
5450 \begin_inset Flex Noun
5453 \begin_layout Plain Layout
5459 ] to the \SpecialChar LyX
5461 \begin_inset Flex Code
5464 \begin_layout Plain Layout
5471 \begin_inset Flex Code
5474 \begin_layout Plain Layout
5481 Now, whenever you type the
5482 \begin_inset Flex Noun
5485 \begin_layout Plain Layout
5491 -key followed by a letter, that letter will have a circumflex accent on
5493 For example, the sequence
5494 \begin_inset Quotes eld
5498 \begin_inset Flex Noun
5501 \begin_layout Plain Layout
5508 \begin_inset Quotes erd
5511 produces the letter:
5512 \begin_inset Quotes eld
5516 \begin_inset Quotes erd
5520 If you tried to type
5521 \begin_inset Quotes eld
5525 \begin_inset Flex Noun
5528 \begin_layout Plain Layout
5535 \begin_inset Quotes erd
5538 , however, \SpecialChar LyX
5539 will complain with a beep, since a
5540 \begin_inset Quotes eld
5544 \begin_inset Flex Noun
5547 \begin_layout Plain Layout
5554 \begin_inset Quotes erd
5557 never takes a circumflex accent.
5559 \begin_inset Flex Noun
5562 \begin_layout Plain Layout
5568 after a dead-key produces the bare-accent.
5569 Please note this last point! If you bind a key to a dead-key, you'll need
5570 to rebind the character on that key to yet another key.
5572 \begin_inset Flex Noun
5575 \begin_layout Plain Layout
5581 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5584 \begin_layout Standard
5585 One common way to bind dead-keys is to use
5586 \begin_inset Flex Noun
5589 \begin_layout Plain Layout
5596 \begin_inset Flex Noun
5599 \begin_layout Plain Layout
5606 \begin_inset Flex Noun
5609 \begin_layout Plain Layout
5615 in combination with an accent, like
5616 \begin_inset Quotes eld
5620 \begin_inset Flex Noun
5623 \begin_layout Plain Layout
5630 \begin_inset Quotes erd
5634 \begin_inset Quotes eld
5638 \begin_inset Flex Noun
5641 \begin_layout Plain Layout
5648 \begin_inset Quotes erd
5652 \begin_inset Quotes eld
5656 \begin_inset Flex Noun
5659 \begin_layout Plain Layout
5666 \begin_inset Quotes erd
5670 Another way involves using
5671 \begin_inset Flex Code
5674 \begin_layout Plain Layout
5681 \begin_inset Flex Code
5684 \begin_layout Plain Layout
5690 to set up the special
5691 \begin_inset Flex Code
5694 \begin_layout Plain Layout
5702 \begin_inset Flex Code
5705 \begin_layout Plain Layout
5711 acts in some ways just like
5712 \begin_inset Flex Noun
5715 \begin_layout Plain Layout
5721 and permits you to bind keys to accented characters.
5722 You can also turn keys into dead-keys by binding them to something like
5724 \begin_inset Flex Code
5727 \begin_layout Plain Layout
5733 and then binding this symbolic key to the corresponding \SpecialChar LyX
5738 \begin_layout Plain Layout
5743 : This is exactly what I do in my
5744 \begin_inset Flex Code
5747 \begin_layout Plain Layout
5754 \begin_inset Flex Code
5757 \begin_layout Plain Layout
5765 \begin_inset Flex Noun
5768 \begin_layout Plain Layout
5770 \begin_inset space ~
5779 \begin_inset Flex Code
5782 \begin_layout Plain Layout
5788 and a bunch of these
5789 \begin_inset Quotes eld
5793 \begin_inset Flex Code
5796 \begin_layout Plain Layout
5803 \begin_inset Quotes erd
5806 symbolic keys bound such things as
5807 \begin_inset Flex Noun
5810 \begin_layout Plain Layout
5812 \begin_inset space ~
5821 \begin_inset Flex Noun
5824 \begin_layout Plain Layout
5826 \begin_inset space ~
5835 This is how I produce my accented characters.
5840 You can make just about anything into the
5841 \begin_inset Flex Code
5844 \begin_layout Plain Layout
5851 \begin_inset Flex Noun
5854 \begin_layout Plain Layout
5860 keys, a spare function key, etc.
5861 As for the \SpecialChar LyX
5862 commands that produce accents, check the entry for
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5877 You'll find the complete list there.
5880 \begin_layout Subsection
5881 Saving your Language Configuration
5884 \begin_layout Standard
5885 You can edit your preferences so that your desired language environment
5886 is automatically configured when \SpecialChar LyX
5888 \begin_inset Flex Noun
5891 \begin_layout Plain Layout
5892 Edit\SpecialChar menuseparator
5901 \begin_layout Chapter
5902 Installing New Document Classes, Layouts, and Templates
5903 \begin_inset CommandInset label
5905 name "cha:Installing-New-Document"
5910 \begin_inset Argument 1
5913 \begin_layout Plain Layout
5914 Installing New Document Classes
5922 \begin_layout Standard
5923 In this chapter, we describe the procedures for creating and installing
5924 new \SpecialChar LyX
5925 layout and template files, as well as offer a refresher on correctly
5926 installing new \SpecialChar LaTeX
5931 \begin_layout Standard
5932 First, let us a say a few words about how one ought to think about the relation
5933 between \SpecialChar LyX
5934 and \SpecialChar LaTeX
5936 The thing to understand is that, in a certain sense, \SpecialChar LyX
5937 doesn't know anything
5938 about \SpecialChar LaTeX
5940 Indeed, from \SpecialChar LyX
5941 's point of view, \SpecialChar LaTeX
5942 is just one of several
5943 \begin_inset Quotes eld
5947 \begin_inset Quotes erd
5950 in which it is capable of producing output.
5951 Other such formats are DocBook, plaintext, and XHTML.
5953 is, of course, a particularly important format, but very little of the
5954 information \SpecialChar LyX
5955 has about \SpecialChar LaTeX
5956 is actually contained in the program itself.
5960 \begin_layout Plain Layout
5961 Some commands are sufficiently complex that they are
5962 \begin_inset Quotes eld
5966 \begin_inset Quotes erd
5969 into \SpecialChar LyX
5971 But the developers generally regard this as a Bad Thing.
5976 Rather, that information, even for the standard classes like
5977 \begin_inset Flex Code
5980 \begin_layout Plain Layout
5986 , is contained in `layout files'.
5987 Similarly, \SpecialChar LyX
5988 itself does not know much about DocBook or XHTML.
5989 What it knows is contained in layout files.
5992 \begin_layout Standard
5993 You can think of the layout file for a given document class as a translation
5994 manual between \SpecialChar LyX
5995 constructs—paragraphs with their corresponding styles,
5996 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5999 Almost everything \SpecialChar LyX
6001 \begin_inset Flex Code
6004 \begin_layout Plain Layout
6010 , for example, is contained in the file
6011 \begin_inset Flex Code
6014 \begin_layout Plain Layout
6020 and in various other files it includes.
6021 For this reason, anyone intending to write layout files should plan to
6022 study the existing files.
6023 A good place to start is with
6024 \begin_inset Flex Code
6027 \begin_layout Plain Layout
6033 , which is included in
6034 \begin_inset Flex Code
6037 \begin_layout Plain Layout
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6053 , and many of the other layout files for document classes.
6054 This file is where sections and the like are defined:
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6064 tells \SpecialChar LyX
6065 how paragraphs that are marked with the Section, Subsection, etc,
6066 styles can be translated into corresponding \SpecialChar LaTeX
6067 , DocBook, and XHTML commands
6070 \begin_inset Flex Code
6073 \begin_layout Plain Layout
6079 file basically just includes several of these
6080 \begin_inset Flex Code
6083 \begin_layout Plain Layout
6092 \begin_layout Standard
6093 Defining the \SpecialChar LyX
6095 correspondence is not the only thing layout files do, though.
6096 Their other job is to define how the \SpecialChar LyX
6097 constructs themselves will appear
6099 The fact that layout files have these two jobs is often a source of confusion,
6100 because they are completely separate.
6101 Telling \SpecialChar LyX
6102 how to translate a certain paragraph style into \SpecialChar LaTeX
6105 how to display it; conversely, telling \SpecialChar LyX
6106 how to display a certain paragraph
6107 style does not tell \SpecialChar LyX
6108 how to translate it into \SpecialChar LaTeX
6109 (let alone tell \SpecialChar LaTeX
6112 So, in general, when you define a new \SpecialChar LyX
6113 construct, you must always do two
6114 quite separate things: (i)
6115 \begin_inset space ~
6118 tell \SpecialChar LyX
6119 how to translate it into \SpecialChar LaTeX
6121 \begin_inset space ~
6124 tell \SpecialChar LyX
6128 \begin_layout Standard
6129 Much the same is true, of course, as regards \SpecialChar LyX
6130 's other backend formats, though
6131 XHTML is in some ways different, because in that case \SpecialChar LyX
6136 able, to some extent, to use information about how it should display a
6137 paragraph on the screen to output information (in the form of CSS) about
6138 how the paragraph should be displayed in a browser.
6139 Even in this case, however, the distinction between what \SpecialChar LyX
6141 and how things are rendered externally remains in force, and the two can
6142 be controlled separately.
6144 \begin_inset CommandInset ref
6146 reference "sec:Tags-for-XHTML"
6153 \begin_layout Section
6154 Installing new \SpecialChar LaTeX
6158 \begin_layout Standard
6159 Some installations may not include a \SpecialChar LaTeX
6160 package or class file that you would
6161 like to use within \SpecialChar LyX
6163 For example, you might need Foil\SpecialChar TeX
6164 , a package for preparing slides for overhead
6166 Modern \SpecialChar LaTeX
6167 distributions like \SpecialChar TeX
6168 Live (2008 or newer) or MiK\SpecialChar TeX
6169 provide a user interface
6170 for installing such packages.
6171 For example, with MiK\SpecialChar TeX
6172 , you start the program
6173 \begin_inset Quotes eld
6177 \begin_inset space ~
6181 \begin_inset Quotes erd
6184 to get a list of available packages.
6185 To install one of them, right click on it or use the corresponding toolbar
6189 \begin_layout Standard
6190 If your \SpecialChar LaTeX
6191 distribution does not provide such a `package manager', or if the
6192 package is not available from your distribution, then follow these steps
6193 to install it manually:
6196 \begin_layout Enumerate
6197 Get the package from
6198 \begin_inset CommandInset href
6201 target "http://www.ctan.org/"
6209 \begin_layout Enumerate
6210 If the package contains a file with the ending
6211 \begin_inset Quotes eld
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6225 \begin_inset Quotes erd
6228 (is the case for Foil\SpecialChar TeX
6229 ) then open a console, change to the folder of this
6230 file and execute the command
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6241 You have now unpacked the package and have all files to install it.
6242 Most \SpecialChar LaTeX
6243 -packages are not packed and you can skip this step.
6246 \begin_layout Enumerate
6247 Now you need to decide if the package should be available for all users
6252 \begin_layout Enumerate
6253 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6254 for all users on your system, then install it in your `local' \SpecialChar TeX
6256 install it in your own `user' \SpecialChar TeX
6258 Where these trees should be created, if they do not already exist, depends
6260 To find this out, look in the file
6261 \begin_inset Flex Code
6264 \begin_layout Plain Layout
6274 \begin_layout Plain Layout
6275 This is usually in the directory
6276 \begin_inset Flex Code
6279 \begin_layout Plain Layout
6285 , though you can execute the command
6286 \begin_inset Flex Code
6289 \begin_layout Plain Layout
6300 The location of the `local' \SpecialChar TeX
6301 tree is defined by the
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6311 variable; this is usually somewhere like
6312 \begin_inset Flex Code
6315 \begin_layout Plain Layout
6316 /usr/local/share/texmf
6321 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6324 The location of the `user' \SpecialChar TeX
6326 \begin_inset Flex Code
6329 \begin_layout Plain Layout
6336 \begin_inset Flex Code
6339 \begin_layout Plain Layout
6346 \begin_inset Flex Code
6349 \begin_layout Plain Layout
6358 (If these variables are not predefined, you have to define them.) You'll
6359 probably need root permissions to create or modify the `local' tree, but
6360 not for your `user' tree.
6361 \begin_inset Newline newline
6364 In general, it is recommended to install in the user tree because your user
6365 will not be modified or even overwritten when you upgrade your system.
6366 It will typically also be backed up together with everything else when
6367 you backup your home directory (which, of course, you do on a regular basis).
6370 \begin_layout Enumerate
6371 On Windows, if you want the new package to be available for all users on
6372 your system, change to the folder where \SpecialChar LaTeX
6373 is installed and then change to
6375 \begin_inset Flex Code
6378 \begin_layout Plain Layout
6389 (For MiK\SpecialChar TeX
6390 , this would be by default the folder
6391 \begin_inset Flex Code
6394 \begin_layout Plain Layout
6412 \begin_layout Plain Layout
6413 Note that this will be the correct path only on English installations.
6414 On a German one, it would be
6415 \begin_inset Flex Code
6418 \begin_layout Plain Layout
6432 , and similarly for other languages.
6437 Create there a new folder
6438 \begin_inset Flex Code
6441 \begin_layout Plain Layout
6447 and copy all files of the package into it.
6449 \begin_inset Newline newline
6452 If the package should only available for you or you don't have admin permissions
6453 , do the same, but in the local \SpecialChar LaTeX
6456 \begin_inset space \thinspace{}
6459 g., for MiK\SpecialChar TeX
6461 \begin_inset space ~
6464 2.8 under Windows XP, this would be the folder:
6465 \begin_inset Newline newline
6471 \begin_inset Flex Code
6474 \begin_layout Plain Layout
6477 Documents and Settings
6489 \begin_inset Newline newline
6495 \begin_inset Phantom HPhantom
6498 \begin_layout Plain Layout
6509 \begin_inset Flex Code
6512 \begin_layout Plain Layout
6525 \begin_inset Newline newline
6528 On Vista, it would be:
6529 \begin_inset Newline newline
6533 \begin_inset Flex Code
6536 \begin_layout Plain Layout
6562 \begin_layout Enumerate
6563 Now one only need to tell \SpecialChar LaTeX
6564 that there are new files.
6565 This depends on the used \SpecialChar LaTeX
6570 \begin_layout Enumerate
6571 For \SpecialChar TeX
6572 Live execute the command
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6583 If you installed the package for all users, then you will probably need
6584 to have root permissions for that.
6587 \begin_layout Enumerate
6588 For MiK\SpecialChar TeX
6589 , if you have installed the package for all users, start the program
6591 \begin_inset Quotes eld
6595 \begin_inset space ~
6599 \begin_inset Quotes erd
6602 and press the button marked
6603 \begin_inset Quotes eld
6607 \begin_inset Quotes erd
6611 Otherwise start the program
6612 \begin_inset Quotes eld
6616 \begin_inset Quotes erd
6623 \begin_layout Enumerate
6624 Finally, you need to tell \SpecialChar LyX
6625 that there are new packages available.
6626 So, in \SpecialChar LyX
6628 \begin_inset Flex Noun
6631 \begin_layout Plain Layout
6634 \SpecialChar menuseparator
6640 and then restart \SpecialChar LyX
6644 \begin_layout Standard
6645 Now the package is installed.
6646 In our example, the document class
6647 \begin_inset Flex Code
6650 \begin_layout Plain Layout
6656 will now be available under
6657 \begin_inset Flex Noun
6660 \begin_layout Plain Layout
6661 Document\SpecialChar menuseparator
6662 Settings\SpecialChar menuseparator
6669 \begin_inset Quotes eld
6673 \begin_inset Quotes erd
6680 \begin_layout Standard
6681 If you would like to use a \SpecialChar LaTeX
6682 document class that is not even listed in the
6684 \begin_inset Flex Noun
6687 \begin_layout Plain Layout
6688 Document\SpecialChar menuseparator
6689 Settings\SpecialChar menuseparator
6695 , then you need to create a `layout' file for it.
6696 That is the topic of the next section.
6699 \begin_layout Section
6700 Types of layout files
6703 \begin_layout Standard
6704 This section describes the various sorts of \SpecialChar LyX
6705 files that contain layout informati
6707 These files describe various paragraph and character styles, determining
6708 how \SpecialChar LyX
6709 should display them and how they should be translated into \SpecialChar LaTeX
6711 XHTML, or whatever output format is being used.
6715 \begin_layout Standard
6716 We shall try to provide a thorough description of the process of writing
6718 However, there are so many different types of documents supported even
6719 by just \SpecialChar LaTeX
6720 that we can't hope to cover every different possibility or problem
6721 you might encounter.
6722 The \SpecialChar LyX
6723 users' list is frequented by people with lots of experience with layout
6724 design who are willing to share what they've learned, so please feel free
6725 to ask questions there.
6728 \begin_layout Standard
6729 As you prepare to write a new layout, it is extremely helpful to look at
6730 the layouts distributed with \SpecialChar LyX
6732 If you write a \SpecialChar LyX
6733 layout for a \SpecialChar LaTeX
6734 document class that might also be used by
6735 others, or write a module that might be useful to others, then you should
6736 consider posting your layout to the
6737 \begin_inset CommandInset href
6739 name "layout section on the LyX wiki"
6740 target "https://wiki.lyx.org/Layouts/Layouts"
6745 or even to the \SpecialChar LyX
6746 developers' list, so that it might be included in \SpecialChar LyX
6751 \begin_layout Plain Layout
6752 Note that \SpecialChar LyX
6753 is licensed under the General Public License, so any material
6754 that is contributed to \SpecialChar LyX
6755 must be similarly licensed.
6763 \begin_layout Subsection
6765 \begin_inset CommandInset label
6767 name "subsec:Layout-modules"
6774 \begin_layout Standard
6775 We have spoken to this point about `layout files'.
6776 But there are different sorts of files that contain layout information.
6777 Layout files, strictly so called, have the
6778 \begin_inset Flex Code
6781 \begin_layout Plain Layout
6787 extension and provide \SpecialChar LyX
6788 with information about document classes.
6789 Since \SpecialChar LyX
6790 1.6 layout information can also be contained in layout
6795 \begin_inset Flex Code
6798 \begin_layout Plain Layout
6805 Modules are to \SpecialChar LaTeX
6806 packages much as layouts are to \SpecialChar LaTeX
6807 classes, and some modules—such
6809 \begin_inset Flex Code
6812 \begin_layout Plain Layout
6818 module—specifically provide support for one package.
6819 In a sense, layout modules are similar to included
6823 \begin_layout Plain Layout
6824 These can have any extension, but by convention have the
6825 \begin_inset Flex Code
6828 \begin_layout Plain Layout
6840 \begin_inset Flex Code
6843 \begin_layout Plain Layout
6849 —in that modules are not specific to a given document class but may be used
6850 with many different classes.
6851 The difference is that using an included file with
6852 \begin_inset Flex Code
6855 \begin_layout Plain Layout
6861 requires editing that file.
6862 Modules, by contrast, are selected in the
6863 \begin_inset Flex Noun
6866 \begin_layout Plain Layout
6867 Document\SpecialChar menuseparator
6876 \begin_layout Standard
6877 Building modules is the easiest way to get started with layout editing,
6878 since it can be as simple as adding a single new paragraph style or flex
6880 But modules may, in principle, contain anything a layout file can contain.
6883 \begin_layout Standard
6884 After creating a new module and copying it to the
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6894 folder, you will need to reconfigure and then restart \SpecialChar LyX
6897 However, changes you make to the module will be seen immediately, if you
6899 \begin_inset Flex Noun
6902 \begin_layout Plain Layout
6903 Document\SpecialChar menuseparator
6909 , highlight something, and then hit
6910 \begin_inset Quotes eld
6914 \begin_inset Quotes erd
6920 It is strongly recommended that you save your work before doing this
6925 it is strongly recommended that you not attempt to edit modules while simultaneo
6926 usly working on actual documents
6929 Though of course the developers strive to keep \SpecialChar LyX
6930 stable in such situations,
6931 syntax errors and the like in your module file could cause strange behavior.
6934 \begin_layout Subsubsection
6938 \begin_layout Standard
6939 Modules are to \SpecialChar LyX
6940 as packages are to \SpecialChar LaTeX
6942 Sometimes, however, you find yourself wanting a specific inset or character
6943 style just for one document and writing a module that will also be available
6944 to other documents makes little sense.
6945 What you need is \SpecialChar LyX
6947 \begin_inset Quotes eld
6951 \begin_inset Quotes erd
6957 \begin_layout Standard
6958 You will find it under
6960 Document\SpecialChar menuseparator
6961 Settings\SpecialChar menuseparator
6965 The large text box allows you to enter anything that you might enter in
6966 a layout file or module.
6967 You can think of a document's local layout, in fact, as a module that belongs
6969 So, in particular, you must enter a
6970 \begin_inset Flex Code
6973 \begin_layout Plain Layout
6980 Any format is acceptable, but one would normally use the format current
6982 (In \SpecialChar LyX
6989 , the current layout format is
6998 \begin_layout Standard
6999 When you have entered something in the
7000 \begin_inset Flex Code
7003 \begin_layout Plain Layout
7009 pane, \SpecialChar LyX
7011 \begin_inset Quotes eld
7015 \begin_inset Quotes erd
7018 button at the bottom.
7019 Clicking this button will cause \SpecialChar LyX
7020 to determine whether what you have entered
7021 is valid layout information for the chosen format.
7023 will report the result but, unfortunately, will not tell you what errors
7024 there might have been.
7025 These will be written to the terminal, however, if \SpecialChar LyX
7026 is started from a terminal.
7027 You will not be permitted to save your local layout until you have entered
7031 \begin_layout Standard
7032 The warnings at the end of the previous section apply here, too.
7033 Do not play with local layout while you are actually working, especially
7034 if you have not saved your document.
7035 That said, using local layout with a test document can be a very convenient
7036 way to try out layout ideas, or even to start developing a module.
7039 \begin_layout Subsection
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7053 \begin_layout Standard
7054 There are two situations you are likely to encounter when wanting to support
7055 a new \SpecialChar LaTeX
7056 document class, involving style (
7057 \begin_inset Flex Code
7060 \begin_layout Plain Layout
7066 ) files and \SpecialChar LaTeX2e
7068 \begin_inset Flex Code
7071 \begin_layout Plain Layout
7078 Supporting a style file is usually fairly easy.
7079 Supporting a new class file is a bit harder.
7080 We'll discuss the former in this section and the latter in the next.
7081 Similar remarks apply, of course, if you want to support a new DocBook
7085 \begin_layout Standard
7086 The easier case is the one in which your new document class is provided
7087 as a style file that is to be used in conjunction with an already supported
7089 For the sake of the example, we'll assume that the style file is called
7091 \begin_inset Flex Noun
7094 \begin_layout Plain Layout
7100 and that it is meant to be used with
7101 \begin_inset Flex Noun
7104 \begin_layout Plain Layout
7110 , which is a standard class.
7114 \begin_layout Standard
7115 Start by copying the existing class's layout file into your local directory:
7119 \begin_layout Plain Layout
7120 Of course, which directory is your local directory will vary by platform,
7121 and \SpecialChar LyX
7122 allows you to specify your local directory on startup, too, using
7124 \begin_inset Flex Code
7127 \begin_layout Plain Layout
7141 \begin_layout LyX-Code
7142 cp report.layout ~/.lyx/layouts/myclass.layout
7145 \begin_layout Standard
7147 \begin_inset Flex Code
7150 \begin_layout Plain Layout
7156 and change the line:
7159 \begin_layout LyX-Code
7162 DeclareLaTeXClass{Report (Standard Class)}
7165 \begin_layout Standard
7169 \begin_layout LyX-Code
7172 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7175 \begin_layout Standard
7179 \begin_layout LyX-Code
7181 \begin_inset Newline newline
7187 \begin_inset Newline newline
7193 \begin_layout Standard
7194 near the top of the file.
7197 \begin_layout Standard
7198 Start \SpecialChar LyX
7200 \begin_inset Flex Noun
7203 \begin_layout Plain Layout
7204 Tools\SpecialChar menuseparator
7211 Then restart \SpecialChar LyX
7212 and try creating a new document.
7214 \begin_inset Flex Noun
7217 \begin_layout Plain Layout
7223 " as a document class option in the
7224 \begin_inset Flex Noun
7227 \begin_layout Plain Layout
7228 Document\SpecialChar menuseparator
7235 It is likely that some of the sectioning commands and such in your new
7236 class will work differently from how they worked in the base class—
7237 \begin_inset Flex Code
7240 \begin_layout Plain Layout
7246 in this example—so you can fiddle around with the settings for the different
7247 sections if you wish.
7248 The layout information for sections is contained in
7249 \begin_inset Flex Code
7252 \begin_layout Plain Layout
7258 , but you do not need to copy and change this file.
7259 Instead, you can simply add your changes to your layout file, after the
7261 \begin_inset Flex Code
7264 \begin_layout Plain Layout
7270 , which itself includes
7271 \begin_inset Flex Code
7274 \begin_layout Plain Layout
7281 For example, you might add these lines:
7284 \begin_layout LyX-Code
7288 \begin_layout LyX-Code
7292 \begin_layout LyX-Code
7296 \begin_layout LyX-Code
7300 \begin_layout LyX-Code
7304 \begin_layout Standard
7305 to change the font for chapter headings to sans-serif.
7306 This will override (or, in this case, add to) the existing declaration
7307 for the Chapter style.
7311 \begin_layout Standard
7312 Your new package may also provide commands or environments not present in
7314 In this case, you will want to add these to the layout file.
7316 \begin_inset CommandInset ref
7318 reference "sec:TextClass"
7322 for information on how to do so.
7325 \begin_layout Standard
7327 \begin_inset Flex Noun
7330 \begin_layout Plain Layout
7336 can be used with several different document classes, and even if it cannot,
7337 you might find it easiest just to write a module that you can load with
7339 The simplest possible such module would be:
7342 \begin_layout LyX-Code
7345 DeclareLyXModule{My Class}
7348 \begin_layout LyX-Code
7352 \begin_layout LyX-Code
7353 #Support for myclass.sty.
7356 \begin_layout LyX-Code
7358 \begin_inset Newline newline
7364 \begin_layout LyX-Code
7372 \begin_inset Newline newline
7378 \begin_layout LyX-Code
7380 \begin_inset Newline newline
7386 \begin_inset Newline newline
7392 \begin_layout Standard
7393 A more complex module might modify the behavior of some existing constructs
7394 or define some new ones.
7396 \begin_inset CommandInset ref
7398 reference "sec:TextClass"
7405 \begin_layout Subsection
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 There are two possibilities here.
7421 One is that the class file is itself based upon an existing document class.
7422 For example, many thesis classes are based upon
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7433 To see whether yours is, look for a line like
7436 \begin_layout LyX-Code
7442 \begin_layout Standard
7444 If so, then you may proceed largely as in the previous section, though
7446 \begin_inset Flex Code
7449 \begin_layout Plain Layout
7450 Declare\SpecialChar LaTeX
7456 line will be different.
7457 If your new class is
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7467 and it is based upon
7468 \begin_inset Flex Code
7471 \begin_layout Plain Layout
7477 , then the line should read:
7481 \begin_layout Plain Layout
7482 And it will be easiest if you save the file to
7483 \begin_inset Flex Code
7486 \begin_layout Plain Layout
7493 assumes that the document class has the same name as the layout file.
7502 \begin_layout LyX-Code
7505 DeclareLaTeXClass[thesis,book]{thesis}
7508 \begin_layout Standard
7509 If, on the other hand, the new class is not based upon an existing class,
7510 you will probably have to
7511 \begin_inset Quotes eld
7515 \begin_inset Quotes erd
7519 We strongly suggest copying an existing layout file which uses a similar
7521 class and then modifying it, if you can do so.
7522 At least use an existing file as a starting point so you can find out what
7523 items you need to worry about.
7524 Again, the specifics are covered below.
7527 \begin_layout Subsection
7529 \begin_inset CommandInset label
7531 name "subsec:Creating-Templates"
7538 \begin_layout Standard
7539 Once you have written a layout file for a new document class, you might
7540 want to consider writing a
7545 A template acts as a kind of tutorial for your layout, showing how it might
7546 be used, though containing dummy content.
7547 You can of course look at the various templates included with \SpecialChar LyX
7551 \begin_layout Standard
7552 Templates are created just like usual documents: using \SpecialChar LyX
7554 The only difference is that usual documents contain all possible settings,
7555 including the font scheme and the paper size.
7556 Usually a user doesn't want a template to overwrite his preferred settings
7557 for such parameters.
7558 For that reason, the designer of a template should remove the corresponding
7560 \begin_inset Flex Code
7563 \begin_layout Plain Layout
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7583 from the template \SpecialChar LyX
7585 This can be done with any simple text-editor, for example
7586 \begin_inset Flex Code
7589 \begin_layout Plain Layout
7596 \begin_inset Flex Code
7599 \begin_layout Plain Layout
7608 \begin_layout Standard
7609 Put the edited template files you create in
7610 \begin_inset Flex Code
7613 \begin_layout Plain Layout
7619 , copy the ones you use from the global template directory in
7620 \begin_inset Flex Code
7623 \begin_layout Plain Layout
7629 to the same place, and redefine the template path in the
7630 \begin_inset Flex Noun
7633 \begin_layout Plain Layout
7634 Tools\SpecialChar menuseparator
7635 Preferences\SpecialChar menuseparator
7644 \begin_layout Standard
7645 Note, by the way, that there is a template which has a particular meaning:
7646 \begin_inset Newline linebreak
7650 \begin_inset Flex Code
7653 \begin_layout Plain Layout
7660 This template is loaded every time you create a new document with
7661 \begin_inset Flex Noun
7664 \begin_layout Plain Layout
7665 File\SpecialChar menuseparator
7671 in order to provide useful defaults.
7672 To create this template from inside \SpecialChar LyX
7673 , all you have to do is to open a document
7674 with the correct settings, and use the
7675 \begin_inset Flex Noun
7678 \begin_layout Plain Layout
7679 Save as Document Defaults
7687 \begin_layout Subsection
7688 Upgrading old layout files
7691 \begin_layout Standard
7692 The format of layout files changes with each \SpecialChar LyX
7693 release, so old layout files
7694 need to be converted to the new format.
7696 reads a layout file in an older format, it automatically calls the
7698 \begin_inset Flex Code
7701 \begin_layout Plain Layout
7707 to convert it to a temporary file in current format.
7708 The original file is left untouched.
7709 If you use the layout file often, then, you may want to convert it permanently,
7710 so that \SpecialChar LyX
7711 does not have to do so itself every time.
7712 To do this, you can call the converter manually:
7715 \begin_layout Enumerate
7717 \begin_inset Flex Code
7720 \begin_layout Plain Layout
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7739 \begin_layout Enumerate
7741 \begin_inset Newline newline
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7749 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7755 \begin_inset Newline newline
7759 \begin_inset Flex Code
7762 \begin_layout Plain Layout
7768 is the name of your \SpecialChar LyX
7772 \begin_layout Standard
7773 Note that manual conversion does not affect included files, so these will
7774 have to be converted separately.
7777 \begin_layout Subsection
7778 \begin_inset CommandInset label
7780 name "subsec:Cite-Engine-Files"
7787 \begin_layout Standard
7788 A specific form of layout files are the so-called
7789 \begin_inset Flex Code
7792 \begin_layout Plain Layout
7798 files that are located in the
7799 \begin_inset Flex Code
7802 \begin_layout Plain Layout
7809 Their purpose is to define the specifics of \SpecialChar LaTeX
7810 packages aimed at bibliography
7823 , but also the way how normal Bib\SpecialChar TeX
7824 citations (without additional packages)
7825 are handled in \SpecialChar LyX
7826 is defined in such a file.
7830 \begin_layout Standard
7831 More specifically, it is defined which packages \SpecialChar LyX
7832 needs to load, which citation
7833 commands are available, how these are to be displayed in \SpecialChar LyX
7835 the dialogs, the context menus) as well as in the XHTML and plain text
7837 Furthermore, the files specify available style variants (author-year, numerical
7838 , etc.) and their specifics.
7839 The cite engine files are also used to generate the options that are available
7842 Document\SpecialChar menuseparator
7843 Settings\SpecialChar menuseparator
7844 Bibliography\SpecialChar menuseparator
7850 \begin_layout Standard
7851 Even though a cite engine file is essentially a normal layout file that
7852 could theoretically include any layout information, it usually primarily
7853 includes some specific parameters such as
7854 \begin_inset Flex Code
7857 \begin_layout Plain Layout
7864 \begin_inset Flex Code
7867 \begin_layout Plain Layout
7874 \begin_inset Flex Code
7877 \begin_layout Plain Layout
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7894 The syntax of the latter two is described in
7895 \begin_inset CommandInset ref
7897 reference "subsec:Citation-engine-description"
7905 \begin_inset CommandInset ref
7907 reference "subsec:Citation-format-description"
7911 , as well as in the files themselves.
7914 \begin_layout Section
7915 \begin_inset CommandInset label
7917 name "sec:TextClass"
7921 The layout file format
7924 \begin_layout Standard
7925 The following sections describe how layout files are structured and written.
7926 Our advice is to go slowly, save and test often.
7927 It is really not that hard, except that the multitude of options can become
7928 overwhelming, especially if you try to check out too many at once.
7929 It becomes easier if you use existing layouts of \SpecialChar LyX
7930 as examples/reference
7931 or if you modify an existing layout to your needs.
7934 \begin_layout Standard
7935 Note that all the tags used in layout files are case-insensitive.
7937 \begin_inset Flex Code
7940 \begin_layout Plain Layout
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7957 \begin_inset Flex Code
7960 \begin_layout Plain Layout
7966 are really the same tag.
7967 The possible arguments are printed in brackets after the tag's name.
7968 The default argument is typeset
7969 \begin_inset Flex Code
7972 \begin_layout Plain Layout
7981 If the argument has a data type like
7982 \begin_inset Quotes eld
7986 \begin_inset Quotes erd
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7997 , the default is shown like this:
7998 \begin_inset Flex Code
8001 \begin_layout Plain Layout
8012 \begin_layout Subsection
8013 The document class declaration and classification
8016 \begin_layout Standard
8017 Lines in a layout file which begin with
8018 \begin_inset Flex Code
8021 \begin_layout Plain Layout
8028 There is one exception to this rule.
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8039 files should begin with lines like:
8042 \begin_layout LyX-Code
8045 #% Do not delete the line below; configure depends on this
8048 \begin_layout LyX-Code
8053 DeclareLaTeXClass{Article (Standard Class)}
8056 \begin_layout LyX-Code
8061 DeclareCategory{Articles}
8064 \begin_layout Standard
8065 The second and third lines are used when you (re)configure \SpecialChar LyX
8067 The layout file is read by the \SpecialChar LaTeX
8069 \begin_inset Flex Code
8072 \begin_layout Plain Layout
8078 , in a special mode where
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8089 The first line is just a \SpecialChar LaTeX
8090 comment, the second one contains the mandatory
8091 declaration of the text class and the third line contains the optional
8092 classification of the class.
8093 If these lines appear in a file named
8094 \begin_inset Flex Code
8097 \begin_layout Plain Layout
8103 , then they define a text class of name
8104 \begin_inset Flex Code
8107 \begin_layout Plain Layout
8113 (the name of the layout file) which uses the \SpecialChar LaTeX
8115 \begin_inset Flex Code
8118 \begin_layout Plain Layout
8124 (the default is to use the same name as the layout).
8126 \begin_inset Quotes eld
8129 Article (Standard Class)
8130 \begin_inset Quotes erd
8133 that appears above is used as a description of the text class in the
8134 \begin_inset Flex Noun
8137 \begin_layout Plain Layout
8138 Document\SpecialChar menuseparator
8146 \begin_inset Quotes eld
8150 \begin_inset Quotes erd
8153 in the example) is also used in the
8154 \begin_inset Flex Noun
8157 \begin_layout Plain Layout
8158 Document\SpecialChar menuseparator
8164 dialog: the text classes are grouped by these categories (which are usually
8165 genres, so typical categories are
8166 \begin_inset Quotes eld
8170 \begin_inset Quotes erd
8174 \begin_inset Quotes eld
8178 \begin_inset Quotes erd
8182 \begin_inset Quotes eld
8186 \begin_inset Quotes erd
8190 \begin_inset Quotes eld
8194 \begin_inset Quotes erd
8198 \begin_inset Quotes eld
8202 \begin_inset Quotes erd
8206 \begin_inset Quotes eld
8210 \begin_inset Quotes erd
8214 If no category has been declared, the class will be put in the
8215 \begin_inset Quotes eld
8219 \begin_inset Quotes erd
8225 \begin_layout Standard
8226 Let's assume that you wrote your own text class that uses the
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8236 document class, but where you changed the appearance of the section headings.
8237 If you put it in a file
8238 \begin_inset Flex Code
8241 \begin_layout Plain Layout
8247 , the header of this file should be:
8250 \begin_layout LyX-Code
8253 #% Do not delete the line below; configure depends on this
8256 \begin_layout LyX-Code
8261 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8264 \begin_layout LyX-Code
8269 DeclareCategory{Articles}
8272 \begin_layout Standard
8273 This declares a text class
8274 \begin_inset Flex Code
8277 \begin_layout Plain Layout
8283 , associated with the \SpecialChar LaTeX
8285 \begin_inset Flex Code
8288 \begin_layout Plain Layout
8295 \begin_inset Quotes eld
8298 Article (with My Own Headings)
8299 \begin_inset Quotes erd
8303 If your text class depends on several packages, you can declare it as:
8306 \begin_layout LyX-Code
8309 #% Do not delete the line below; configure depends on this
8312 \begin_layout LyX-Code
8317 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8320 \begin_layout LyX-Code
8325 DeclareCategory{Articles}
8328 \begin_layout Standard
8329 This indicates that your text class uses the
8330 \begin_inset Flex Code
8333 \begin_layout Plain Layout
8340 Finally, it is also possible to declare classes for DocBook code.
8341 Typical declarations will look like:
8344 \begin_layout LyX-Code
8347 #% Do not delete the line below; configure depends on this
8350 \begin_layout LyX-Code
8355 DeclareDocBookClass[article]{SGML (DocBook Article)}
8358 \begin_layout LyX-Code
8363 DeclareCategory{Articles (DocBook)}
8366 \begin_layout Standard
8367 Note that these declarations can also be given an optional parameter declaring
8368 the name of the document class (but not a list).
8371 \begin_layout Standard
8372 So, to be as explicit as possible, the form of the layout declaration is:
8375 \begin_layout LyX-Code
8380 DeclareLaTeXClass[class,package.sty]{layout description}
8383 \begin_layout LyX-Code
8388 DeclareCategory{category}
8391 \begin_layout Standard
8392 The class need only be specified if the name of the \SpecialChar LaTeX
8394 name of the layout file are different or if there are packages to load.
8395 If the name of the class file is not specified, then \SpecialChar LyX
8397 that it is the same as the name of the layout file.
8400 \begin_layout Standard
8401 When the text class has been modified to your taste, all you have to do
8402 is to copy it either to
8403 \begin_inset Flex Code
8406 \begin_layout Plain Layout
8413 \begin_inset Flex Code
8416 \begin_layout Plain Layout
8423 \begin_inset Flex Noun
8426 \begin_layout Plain Layout
8427 Tools\SpecialChar menuseparator
8433 , exit \SpecialChar LyX
8435 Then your new text class should be available along with the others.
8438 \begin_layout Standard
8439 Once the layout file is installed, you can edit it and see your changes
8440 without having to reconfigure or to restart \SpecialChar LyX
8445 \begin_layout Plain Layout
8446 In versions of \SpecialChar LyX
8447 prior to 1.6, this was not true.
8448 As a result, editing layout files was very time consuming, since you had
8449 constantly to restart \SpecialChar LyX
8455 You can force a reload of the current layout by using the \SpecialChar LyX
8457 \begin_inset Flex Noun
8460 \begin_layout Plain Layout
8467 There is no default binding for this function—though, of course, you can
8468 bind it to a key yourself.
8469 But you will normally use this function simply by entering it in the mini-buffe
8474 \begin_layout Standard
8480 \begin_inset Flex Noun
8483 \begin_layout Plain Layout
8489 is very much an `advanced feature'.
8494 recommended that you save your work before using this function.
8499 recommended that you not attempt to edit layout information while simultaneousl
8500 y working on a document that you care about.
8501 Use a test document.
8502 Syntax errors and the like in your layout file could cause peculiar behavior.
8503 In particular, such errors could cause \SpecialChar LyX
8504 to regard the current layout as
8505 invalid and to attempt to switch to some other layout.
8509 \begin_layout Plain Layout
8510 Really bad syntax errors may even caused \SpecialChar LyX
8512 This is because certain sorts of errors may make \SpecialChar LyX
8523 The \SpecialChar LyX
8524 team strives to keep \SpecialChar LyX
8525 stable in such situations, but safe is better
8530 \begin_layout Plain Layout
8531 While we're giving advice: make regular backups.
8532 And be nice to your mother.
8540 \begin_layout Subsection
8541 The Module declaration
8544 \begin_layout Standard
8545 A module must begin with a line like the following:
8548 \begin_layout LyX-Code
8551 DeclareLyXModule[endnotes.sty]{Endnotes}
8552 \change_inserted -712698321 1554395911
8556 \begin_layout LyX-Code
8558 \change_inserted -712698321 1554395924
8563 DeclareCategory{Foot- and Endnotes}
8564 \change_deleted -712698321 1554395911
8572 \begin_layout Standard
8573 The mandatory argument
8574 \change_inserted -712698321 1554395956
8583 , in curly brackets, is the name of the module, as it should appear in
8584 \begin_inset Flex Noun
8587 \begin_layout Plain Layout
8588 Document\SpecialChar menuseparator
8589 Settings\SpecialChar menuseparator
8596 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8598 on which the module depends.
8599 It is also possible to use the form
8600 \begin_inset Flex Noun
8603 \begin_layout Plain Layout
8609 as an optional argument, which declares that the module can only be used
8610 when there exists a conversion chain between the formats `
8611 \begin_inset Flex Code
8614 \begin_layout Plain Layout
8621 \begin_inset Flex Code
8624 \begin_layout Plain Layout
8632 \change_inserted -712698321 1554396133
8639 declaration is not strictly mandatory, but you should add it, since it
8640 is helpful to find the module.
8641 Please have a look at the existing module categories and if appropriate,
8647 \begin_layout Standard
8649 \change_inserted -712698321 1554395988
8652 declaration should then be followed by lines like the following:
8656 \begin_layout Plain Layout
8657 Preferably in English if the module should be published with \SpecialChar LyX
8659 This description will appear in the list of messages to be translated and
8660 will be thus translated with the next interface update.
8668 \begin_layout LyX-Code
8672 \begin_layout LyX-Code
8673 #Adds an endnote command, in addition to footnotes.
8677 \begin_layout LyX-Code
8678 #You will need to add
8680 theendnotes in TeX code where you
8683 \begin_layout LyX-Code
8684 #want the endnotes to appear.
8688 \begin_layout LyX-Code
8692 \begin_layout LyX-Code
8693 #Requires: somemodule | othermodule
8696 \begin_layout LyX-Code
8697 #Excludes: badmodule
8700 \begin_layout Standard
8701 The description is used in
8702 \begin_inset Flex Noun
8705 \begin_layout Plain Layout
8706 Document\SpecialChar menuseparator
8707 Settings\SpecialChar menuseparator
8713 to provide the user with information about what the module does.
8715 \begin_inset Flex Code
8718 \begin_layout Plain Layout
8724 line is used to identify other modules with which this one must be used;
8726 \begin_inset Flex Code
8729 \begin_layout Plain Layout
8735 line is used to identify modules with which this one may not be used.
8736 Both are optional, and, as shown, multiple modules should be separated
8737 with the pipe symbol: |.
8738 Note that the required modules are treated disjunctively:
8742 of the required modules must be used.
8747 excluded module may be used.
8748 Note that modules are identified here by their filenames without the
8749 \begin_inset Flex Code
8752 \begin_layout Plain Layout
8760 \begin_inset Flex Code
8763 \begin_layout Plain Layout
8770 \begin_inset Flex Code
8773 \begin_layout Plain Layout
8782 \begin_layout Subsection
8783 The CiteEngine file declaration
8786 \begin_layout Standard
8787 A cite engine file must begin with a line like the following:
8790 \begin_layout LyX-Code
8793 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8796 \begin_layout Standard
8797 The mandatory argument, in curly brackets, is the name of the cite style,
8798 as it should appear in
8799 \begin_inset Flex Noun
8802 \begin_layout Plain Layout
8803 Document\SpecialChar menuseparator
8804 Settings\SpecialChar menuseparator
8811 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8813 on which the cite engine depends.
8816 \begin_layout Standard
8817 The cite engine declaration should then be followed by lines like the following:
8821 \begin_layout Plain Layout
8822 Preferably in English if the module should be published with \SpecialChar LyX
8824 This description will appear in the list of messages to be translated and
8825 will be thus translated with the next interface update.
8833 \begin_layout LyX-Code
8837 \begin_layout LyX-Code
8838 # Biblatex supports many author-year and numerical styles.
8841 \begin_layout LyX-Code
8842 # It is mainly aimed at the Humanities.
8846 \begin_layout LyX-Code
8847 # customizable, fully localized and provides many features
8850 \begin_layout LyX-Code
8851 # that are not possible with BibTeX.
8852 The use of 'biber' as
8855 \begin_layout LyX-Code
8856 # bibliography processor is advised.
8859 \begin_layout LyX-Code
8863 \begin_layout Standard
8864 The description is used in
8865 \begin_inset Flex Noun
8868 \begin_layout Plain Layout
8869 Document\SpecialChar menuseparator
8870 Settings\SpecialChar menuseparator
8876 to provide the user with information about the cite engine.
8879 \begin_layout Subsection
8883 \begin_layout Standard
8884 The first non-comment line of any layout file, included file, or module
8889 contain the file format number:
8892 \begin_layout Description
8893 \begin_inset Flex Code
8896 \begin_layout Plain Layout
8903 \begin_inset Flex Code
8906 \begin_layout Plain Layout
8912 ] The format number of the layout file.
8915 \begin_layout Standard
8916 This tag was introduced with \SpecialChar LyX
8918 \begin_inset space ~
8922 Layout files from older \SpecialChar LyX
8923 versions do not have an explicit file format and
8924 are considered to have
8925 \begin_inset Flex Code
8928 \begin_layout Plain Layout
8930 \begin_inset space ~
8939 The format for the present version of \SpecialChar LyX
8941 But each version of \SpecialChar LyX
8942 is capable of reading earlier versions' layout files,
8943 just as they are capable of reading files produced by earlier versions
8946 There is, however, no provision for converting to earlier formats.
8949 \begin_layout Subsection
8950 \begin_inset CommandInset label
8952 name "subsec:General-text-class"
8956 General text class parameters
8959 \begin_layout Standard
8960 These are general parameters that govern the behavior of an entire document
8966 mean that they must appear in
8967 \begin_inset Flex Code
8970 \begin_layout Plain Layout
8976 files rather than in modules.
8977 A module can contain any layout tag.)
8980 \begin_layout Description
8982 \change_inserted -712698321 1526899478
8983 \begin_inset Flex Code
8986 \begin_layout Plain Layout
8988 \change_inserted -712698321 1526898610
8989 AddToCiteEngine <engine>
8994 Extends the possibilities for displaying citation references.
8996 \begin_inset CommandInset ref
8998 reference "subsec:Citation-engine-description"
9007 \begin_inset Flex Code
9010 \begin_layout Plain Layout
9012 \change_inserted -712698321 1526898823
9023 \begin_layout Description
9024 \begin_inset Flex Code
9027 \begin_layout Plain Layout
9033 Adds information that will be output in the
9034 \begin_inset Flex Code
9037 \begin_layout Plain Layout
9043 block when the document is output to XHTML.
9044 Typically, this would be used to output CSS style information, but it can
9045 be used for anything that can appear in
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9057 \begin_inset Quotes eld
9061 \begin_inset Flex Code
9064 \begin_layout Plain Layout
9071 \begin_inset Quotes erd
9077 \begin_layout Description
9078 \begin_inset Flex Code
9081 \begin_layout Plain Layout
9087 Adds information to the document preamble.
9089 \begin_inset Newline newline
9093 \begin_inset Quotes eld
9097 \begin_inset Flex Code
9100 \begin_layout Plain Layout
9107 \begin_inset Quotes erd
9111 \change_inserted -712698321 1562592950
9115 \begin_layout Description
9117 \change_inserted -712698321 1562593040
9118 \begin_inset Flex Code
9121 \begin_layout Plain Layout
9123 \change_inserted -712698321 1562592954
9130 \begin_inset Flex Code
9133 \begin_layout Plain Layout
9135 \change_inserted -712698321 1562592950
9144 \begin_inset space \thinspace{}
9148 \begin_inset Flex Code
9151 \begin_layout Plain Layout
9153 \change_inserted -712698321 1562592950
9159 ] If the document class adds the bibliography to the table of contents,
9160 add this option with value
9161 \begin_inset Flex Code
9164 \begin_layout Plain Layout
9166 \change_inserted -712698321 1562592996
9175 \begin_inset Flex Code
9178 \begin_layout Plain Layout
9180 \change_inserted -712698321 1562593006
9189 This prevents the bibliography from being added twice.
9194 \begin_layout Description
9195 \begin_inset Flex Code
9198 \begin_layout Plain Layout
9204 Defines the possibilities for displaying citation references.
9206 \begin_inset CommandInset ref
9208 reference "subsec:Citation-engine-description"
9217 \begin_inset Quotes eld
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9231 \begin_inset Quotes erd
9235 Primarily used in cite engine files (see
9236 \begin_inset CommandInset ref
9238 reference "subsec:Cite-Engine-Files"
9247 \change_inserted -712698321 1526898530
9248 Note that if you specify this in a layout file or module, any cite engine
9249 definition will be overridden.
9251 \begin_inset Flex Code
9254 \begin_layout Plain Layout
9256 \change_inserted -712698321 1526898530
9269 \begin_layout Description
9270 \begin_inset Flex Code
9273 \begin_layout Plain Layout
9279 Defines formats for use in the display of bibliographic information.
9281 \begin_inset CommandInset ref
9283 reference "subsec:Citation-format-description"
9289 \begin_inset Quotes eld
9293 \begin_inset Flex Code
9296 \begin_layout Plain Layout
9303 \begin_inset Quotes erd
9307 Primarily used in cite engine files (see
9308 \begin_inset CommandInset ref
9310 reference "subsec:Cite-Engine-Files"
9319 \change_inserted -712698321 1526898585
9320 A cite format defined in a layout or module will override the cite engine
9326 \begin_layout Description
9327 \begin_inset Flex Code
9330 \begin_layout Plain Layout
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9349 \begin_inset Flex Code
9352 \begin_layout Plain Layout
9358 ] Determines whether
9362 or Bib\SpecialChar TeX
9363 is used to generate a Bibliography.
9364 Primarily used in cite engine files (see
9365 \begin_inset CommandInset ref
9367 reference "subsec:Cite-Engine-Files"
9377 \begin_layout Description
9378 \begin_inset Flex Code
9381 \begin_layout Plain Layout
9387 Describes various global options supported by the document class.
9389 \begin_inset CommandInset ref
9391 reference "subsec:ClassOptions"
9397 \begin_inset Quotes eld
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9411 \begin_inset Quotes erd
9417 \begin_layout Description
9418 \begin_inset Flex Code
9421 \begin_layout Plain Layout
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9440 \begin_inset space \thinspace{}
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9453 ] Whether the class should
9457 to having one or two columns.
9458 Can be changed in the
9459 \begin_inset Flex Noun
9462 \begin_layout Plain Layout
9463 Document\SpecialChar menuseparator
9472 \begin_layout Description
9473 \begin_inset Flex Code
9476 \begin_layout Plain Layout
9483 \begin_inset Flex Code
9486 \begin_layout Plain Layout
9492 ] This sequence defines the properties for a counter.
9493 If the counter does not yet exist, it is created; if it does exist, it
9496 \begin_inset Quotes eld
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9510 \begin_inset Quotes erd
9514 \begin_inset Newline newline
9518 \begin_inset CommandInset ref
9520 reference "subsec:Counters"
9524 for details on counters.
9527 \begin_layout Description
9528 \begin_inset Flex Code
9531 \begin_layout Plain Layout
9537 Sets the default font used to display the document.
9539 \begin_inset CommandInset ref
9541 reference "subsec:Font-description"
9545 for how to declare fonts.
9547 \begin_inset Quotes eld
9551 \begin_inset Flex Code
9554 \begin_layout Plain Layout
9561 \begin_inset Quotes erd
9567 \begin_layout Description
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9578 \begin_inset Flex Code
9581 \begin_layout Plain Layout
9587 ] Specifies a module to be included by default with this document class.
9588 The module is specified as filename without the
9589 \begin_inset Flex Code
9592 \begin_layout Plain Layout
9599 The user can still remove the module, but it will be active at the outset.
9600 (This applies only when new files are created, or when this class is chosen
9601 for an existing document.)
9604 \begin_layout Description
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9624 ] This is the style that will be assigned to new paragraphs, usually
9625 \begin_inset Flex Noun
9628 \begin_layout Plain Layout
9635 This will default to the first defined style if not given, but you are
9636 encouraged to use this directive.
9639 \begin_layout Description
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9650 \begin_inset Flex Code
9653 \begin_layout Plain Layout
9659 ] This tag indicates that the module (which is specified by filename without
9661 \begin_inset Flex Code
9664 \begin_layout Plain Layout
9670 extension) cannot be used with this document class.
9671 This might be used in a journal-specific layout file to prevent, say, the
9673 \begin_inset Flex Code
9676 \begin_layout Plain Layout
9682 module that numbers theorems by section.
9687 be used in a module.
9688 Modules have their own way of excluding other modules (see
9689 \begin_inset CommandInset ref
9691 reference "subsec:Layout-modules"
9698 \begin_layout Description
9699 \begin_inset Flex Code
9702 \begin_layout Plain Layout
9708 Defines a new float.
9710 \begin_inset CommandInset ref
9712 reference "subsec:Floats"
9718 \begin_inset Quotes eld
9722 \begin_inset Flex Code
9725 \begin_layout Plain Layout
9732 \begin_inset Quotes erd
9738 \begin_layout Description
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9748 Sets the information that will be output in the
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9758 block when this document class is output to XHTML.
9759 Note that this will completely override any prior
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9781 \begin_inset Newline newline
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9794 if you just want to add material to the preamble.) Must end with
9795 \begin_inset Quotes eld
9799 \begin_inset Flex Code
9802 \begin_layout Plain Layout
9809 \begin_inset Quotes erd
9815 \begin_layout Description
9816 \begin_inset Flex Code
9819 \begin_layout Plain Layout
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9835 ] The style to use for the table of contents, bibliography, and so forth,
9836 when the document is output to HTML.
9837 For articles, this should normally be
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9858 If it is not given, then \SpecialChar LyX
9859 will attempt to figure out which layout to use.
9862 \begin_layout Description
9863 \begin_inset Flex Code
9866 \begin_layout Plain Layout
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9882 ] Modifies the properties of the given counter.
9883 If the counter does not exist, the statement is ignored.
9885 \begin_inset Quotes eld
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9899 \begin_inset Quotes erd
9903 \begin_inset Newline newline
9907 \begin_inset CommandInset ref
9909 reference "subsec:Counters"
9913 for details on counters.
9916 \begin_layout Description
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9927 \begin_inset Flex Code
9930 \begin_layout Plain Layout
9936 ] This allows you to include another layout definition file within yours
9937 to avoid duplicating commands.
9938 Common examples are the standard layout files, for example,
9939 \begin_inset Flex Code
9942 \begin_layout Plain Layout
9948 , which contains most of the basic layouts.
9951 \begin_layout Description
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9971 ] This section (re-)defines the layout of an inset.
9972 It can be applied to an existing inset or to a new, user-defined inset,
9973 e.g., a new character style.
9975 \begin_inset Quotes eld
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9989 \begin_inset Quotes erd
9993 \begin_inset Newline newline
9997 \begin_inset CommandInset ref
9999 reference "subsec:Flex-insets-and"
10003 for more information.
10007 \begin_layout Description
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10018 \begin_inset Flex Code
10021 \begin_layout Plain Layout
10027 ] A string that indicates the width of the left margin on the screen, for
10029 \begin_inset Quotes eld
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10043 \begin_inset Quotes erd
10047 (Note that this is not a `length', like
10048 \begin_inset Quotes eld
10052 \begin_inset Quotes erd
10058 \begin_layout Description
10059 \begin_inset Flex Code
10062 \begin_layout Plain Layout
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10078 ] An integer that determines the maximal number of names displayed in an
10079 author-year citation before the citation switches to
10080 \begin_inset Quotes eld
10084 \begin_inset Quotes erd
10088 Primarily used in cite engine files (see
10089 \begin_inset CommandInset ref
10091 reference "subsec:Cite-Engine-Files"
10101 \begin_layout Description
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10121 ] Modifies the properties of the given paragraph style.
10122 If the style does not exist, this section is ignored.
10124 \begin_inset Quotes eld
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10138 \begin_inset Quotes erd
10144 \begin_layout Description
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10164 ] Deletes an existing counter, usually one defined in an included file.
10167 \begin_layout Description
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10187 ] Deletes an existing float.
10188 This is particularly useful when you want to suppress a float that has
10189 been defined in an input file.
10192 \begin_layout Description
10193 \begin_inset Flex Code
10196 \begin_layout Plain Layout
10203 \begin_inset Flex Code
10206 \begin_layout Plain Layout
10212 ] Deletes an existing style.
10215 \begin_layout Description
10216 \begin_inset Flex Code
10219 \begin_layout Plain Layout
10226 \begin_inset Flex Code
10229 \begin_layout Plain Layout
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10245 ] Define a new table of contents with type
10246 \begin_inset Flex Code
10249 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10266 See also the AddToToc commands.
10269 \begin_layout Description
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] The file format (as defined in the \SpecialChar LyX
10290 preferences) produced by this document
10292 It is mainly useful when
10293 \begin_inset Flex Code
10296 \begin_layout Plain Layout
10303 \begin_inset Flex Code
10306 \begin_layout Plain Layout
10312 and one wants to define a new type of literate document.
10313 The format is reset to
10314 \begin_inset Quotes eld
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Quotes erd
10332 \begin_inset Quotes eld
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10346 \begin_inset Quotes erd
10349 when the corresponding
10350 \begin_inset Flex Code
10353 \begin_layout Plain Layout
10359 parameter is encountered.
10362 \begin_layout Description
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10373 \begin_inset Flex Code
10376 \begin_layout Plain Layout
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10406 ] Specifies what sort of output documents using this class will produce.
10409 \begin_layout Description
10410 \begin_inset Flex Code
10413 \begin_layout Plain Layout
10420 \begin_inset Flex Code
10423 \begin_layout Plain Layout
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10439 ] Specifies options, given in the second string, for the package named by
10442 \begin_inset Quotes eld
10446 \begin_inset Flex Code
10449 \begin_layout Plain Layout
10450 PackageOptions natbib square
10456 \begin_inset Quotes erd
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10469 to be loaded with the
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10480 (For \SpecialChar TeX
10481 perts, this causes \SpecialChar LyX
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10489 PassOptionsToPackage{natbib}{square}
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10505 \change_inserted -712698321 1565102364
10509 \begin_layout Description
10511 \change_inserted -712698321 1565102470
10512 \begin_inset Flex Code
10515 \begin_layout Plain Layout
10517 \change_inserted -712698321 1565102365
10524 \begin_inset Flex Code
10527 \begin_layout Plain Layout
10529 \change_inserted -712698321 1565105222
10534 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10535 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10540 ] The default page size.
10541 This is used by some converters.
10546 \begin_layout Description
10547 \begin_inset Flex Code
10550 \begin_layout Plain Layout
10557 \begin_inset Flex Code
10560 \begin_layout Plain Layout
10569 \begin_inset Flex Code
10572 \begin_layout Plain Layout
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10588 ] The default pagestyle.
10589 Can be changed in the
10590 \begin_inset Flex Noun
10593 \begin_layout Plain Layout
10594 Document\SpecialChar menuseparator
10603 \begin_layout Description
10604 \begin_inset Flex Code
10607 \begin_layout Plain Layout
10613 Sets the preamble for the \SpecialChar LaTeX
10615 Note that this will completely override any prior
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10626 \begin_inset Flex Code
10629 \begin_layout Plain Layout
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10646 if you just want to add material to the preamble.) Must end with
10647 \begin_inset Quotes eld
10651 \begin_inset Flex Code
10654 \begin_layout Plain Layout
10661 \begin_inset Quotes erd
10667 \begin_layout Description
10668 \begin_inset Flex Code
10671 \begin_layout Plain Layout
10678 \begin_inset Flex Code
10681 \begin_layout Plain Layout
10688 \begin_inset Flex Code
10691 \begin_layout Plain Layout
10700 \begin_inset space \thinspace{}
10704 \begin_inset Flex Code
10707 \begin_layout Plain Layout
10713 ] Whether the class already provides the feature
10714 \begin_inset Flex Code
10717 \begin_layout Plain Layout
10724 A feature is in general the name of a package (e.
10725 \begin_inset space \thinspace{}
10729 \begin_inset space \space{}
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 \begin_inset Flex Code
10746 \begin_layout Plain Layout
10753 \begin_inset space \thinspace{}
10757 \begin_inset space \space{}
10761 \begin_inset Flex Code
10764 \begin_layout Plain Layout
10771 \begin_inset Flex Code
10774 \begin_layout Plain Layout
10782 \begin_inset CommandInset ref
10784 reference "chap:List-of-functions"
10788 for the list of features.
10791 \begin_layout Description
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10802 \begin_inset Flex Code
10805 \begin_layout Plain Layout
10811 ] Indicates that this layout provides the functionality of the module mentioned,
10812 which should be specified by the filename without the
10813 \begin_inset Flex Code
10816 \begin_layout Plain Layout
10823 This will typically be used if the layout includes the module directly,
10824 rather than using the
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10834 tag to indicate that it ought to be used.
10835 It could also be used in a module that provided an alternate implementation
10836 of the same functionality.
10839 \begin_layout Description
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10850 \begin_inset Flex Code
10853 \begin_layout Plain Layout
10859 ] Creates a new paragraph style if it does not already exist.
10860 If the style does exist, this section is ignored.
10862 \begin_inset Quotes eld
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10876 \begin_inset Quotes erd
10882 \begin_layout Description
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10893 \begin_inset Flex Code
10896 \begin_layout Plain Layout
10902 ] Whether the class requires the feature
10903 \begin_inset Flex Code
10906 \begin_layout Plain Layout
10913 Multiple features must be separated by commas.
10914 Note that you can only request supported features.
10916 \begin_inset CommandInset ref
10918 reference "chap:List-of-functions"
10922 for the list of features.).
10923 If you require a package with specific options, you can additionally use
10925 \begin_inset Flex Code
10928 \begin_layout Plain Layout
10937 \begin_layout Description
10938 \begin_inset Flex Code
10941 \begin_layout Plain Layout
10948 \begin_inset Flex Code
10951 \begin_layout Plain Layout
10957 ] A string that indicates the width of the right margin on the screen, for
10959 \begin_inset Quotes eld
10963 \begin_inset Flex Code
10966 \begin_layout Plain Layout
10973 \begin_inset Quotes erd
10979 \begin_layout Description
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
10999 ] Sets which divisions get numbered.
11001 \begin_inset Newline newline
11005 \begin_inset Flex Code
11008 \begin_layout Plain Layout
11014 counter in \SpecialChar LaTeX
11018 \begin_layout Description
11019 \begin_inset Flex Code
11022 \begin_layout Plain Layout
11029 \begin_inset Flex Code
11032 \begin_layout Plain Layout
11041 \begin_inset space \thinspace{}
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11054 ] Whether the class-default should be printing on one or both sides of the
11056 Can be changed in the
11057 \begin_inset Flex Noun
11060 \begin_layout Plain Layout
11061 Document\SpecialChar menuseparator
11070 \begin_layout Description
11071 \begin_inset Flex Code
11074 \begin_layout Plain Layout
11081 \begin_inset Flex Code
11084 \begin_layout Plain Layout
11090 ] This sequence defines a paragraph style.
11091 If the style does not yet exist, it is created; if it does exist, its parameter
11094 \begin_inset Quotes eld
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11108 \begin_inset Quotes erd
11112 \begin_inset Newline newline
11116 \begin_inset CommandInset ref
11118 reference "subsec:Paragraph-Styles"
11122 for details on paragraph styles.
11123 \change_inserted -712698321 1553617804
11127 \begin_layout Description
11129 \change_inserted -712698321 1553617862
11130 \begin_inset Flex Code
11133 \begin_layout Plain Layout
11135 \change_inserted -712698321 1553617809
11142 \begin_inset Flex Code
11145 \begin_layout Plain Layout
11147 \change_inserted -712698321 1553617805
11153 ] defines the default table style that is used when inserting a table.
11154 The following styles are available:
11158 \begin_layout Itemize
11160 \change_inserted -712698321 1554308039
11161 \begin_inset Flex Code
11164 \begin_layout Plain Layout
11166 \change_inserted -712698321 1554307928
11167 Formal_with_Footline
11175 \begin_inset Quotes eld
11179 \begin_inset Quotes erd
11182 ) style with horizontal lines only, using a bold top and bottom line, the
11183 first and last row are additionally separated from the table body with
11184 a thin middle line.
11187 \begin_layout Itemize
11189 \change_inserted -712698321 1554308087
11190 \begin_inset Flex Code
11193 \begin_layout Plain Layout
11195 \change_inserted -712698321 1554308042
11196 Formal_without_Footline
11201 : same as the above, but the last row is not separated with a middle line
11205 \begin_layout Itemize
11207 \change_inserted -712698321 1553618031
11208 \begin_inset Flex Code
11211 \begin_layout Plain Layout
11213 \change_inserted -712698321 1553618006
11219 : Simple table lines.
11222 \begin_layout Itemize
11224 \change_inserted -712698321 1553618309
11225 \begin_inset Flex Code
11228 \begin_layout Plain Layout
11230 \change_inserted -712698321 1553618031
11237 \begin_inset Flex Code
11240 \begin_layout Plain Layout
11242 \change_inserted -712698321 1553618043
11248 , but with the header column offset with a second horizontal line.
11249 This is also the default style of \SpecialChar LyX
11253 \begin_layout Itemize
11255 \change_inserted -712698321 1553618280
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11261 \change_inserted -712698321 1553618261
11267 : Table without lines.
11273 \begin_layout Description
11274 \begin_inset Flex Code
11277 \begin_layout Plain Layout
11284 \begin_inset Flex Code
11287 \begin_layout Plain Layout
11293 ] The name of the command or environment to be used with
11294 \begin_inset Flex Code
11297 \begin_layout Plain Layout
11306 \begin_layout Description
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11317 \begin_inset Flex Code
11320 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11338 ] Indicates what kind of markup is used to define the title of a document.
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11349 means that the macro with name
11350 \begin_inset Flex Code
11353 \begin_layout Plain Layout
11359 will be inserted after the last layout which has
11360 \begin_inset Quotes eld
11364 \begin_inset Flex Code
11367 \begin_layout Plain Layout
11369 \begin_inset space ~
11378 \begin_inset Quotes erd
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11392 corresponds to the case where all layouts which have
11393 \begin_inset Quotes eld
11397 \begin_inset Flex Code
11400 \begin_layout Plain Layout
11402 \begin_inset space ~
11411 \begin_inset Quotes erd
11414 should be enclosed into the
11415 \begin_inset Flex Code
11418 \begin_layout Plain Layout
11427 \begin_layout Description
11428 \begin_inset Flex Code
11431 \begin_layout Plain Layout
11438 \begin_inset Flex Code
11441 \begin_layout Plain Layout
11447 ] Sets which divisions are included in the table of contents.
11449 \begin_inset Flex Code
11452 \begin_layout Plain Layout
11458 counter in \SpecialChar LaTeX
11462 \begin_layout Subsection
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11473 \begin_inset CommandInset label
11475 name "subsec:ClassOptions"
11482 \begin_layout Standard
11484 \begin_inset Flex Code
11487 \begin_layout Plain Layout
11493 section can contain the following entries:
11496 \begin_layout Description
11497 \begin_inset Flex Code
11500 \begin_layout Plain Layout
11507 \begin_inset Flex Code
11510 \begin_layout Plain Layout
11516 ] The list of available font sizes for the document's main font, separated
11518 \begin_inset Quotes eld
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11532 \begin_inset Quotes erd
11537 \change_inserted -712698321 1565110196
11538 Any number is possible.
11541 \begin_layout Description
11543 \change_inserted -712698321 1565110259
11544 \begin_inset Flex Code
11547 \begin_layout Plain Layout
11549 \change_inserted -712698321 1565110199
11556 \begin_inset Flex Code
11559 \begin_layout Plain Layout
11561 \change_inserted -712698321 1565110196
11567 ] The format for the font size option.
11569 \begin_inset Flex Code
11572 \begin_layout Plain Layout
11574 \change_inserted -712698321 1565110238
11584 \begin_inset Flex Code
11587 \begin_layout Plain Layout
11589 \change_inserted -712698321 1565110248
11595 is a placeholder for the font size.
11600 \begin_layout Description
11601 \begin_inset Flex Code
11604 \begin_layout Plain Layout
11610 Used to set the DTD line with XML-based output classes.
11612 \begin_inset space \thinspace{}
11616 \begin_inset Quotes eld
11619 -//OASIS//DTD DocBook V4.2//EN
11620 \begin_inset Quotes erd
11624 \change_inserted -712698321 1565101761
11628 \begin_layout Description
11630 \change_inserted -712698321 1565180598
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11636 \change_inserted -712698321 1565101918
11643 \begin_inset Flex Code
11646 \begin_layout Plain Layout
11648 \change_inserted -712698321 1565105399
11649 string="letter|\SpecialChar allowbreak
11650 legal|\SpecialChar allowbreak
11651 executive|\SpecialChar allowbreak
11652 a0|\SpecialChar allowbreak
11653 a1|\SpecialChar allowbreak
11654 a2|\SpecialChar allowbreak
11655 a3|\SpecialChar allowbreak
11656 a4|\SpecialChar allowbreak
11657 a5|\SpecialChar allowbreak
11658 a6|\SpecialChar allowbreak
11659 b0|\SpecialChar allowbreak
11660 b1|\SpecialChar allowbreak
11661 b2|\SpecialChar allowbreak
11662 b3|\SpecialChar allowbreak
11663 b4|\SpecialChar allowbreak
11664 b5|\SpecialChar allowbreak
11665 b6|\SpecialChar allowbreak
11666 c0|\SpecialChar allowbreak
11667 c1|\SpecialChar allowbreak
11669 2|\SpecialChar allowbreak
11670 c3|\SpecialChar allowbreak
11671 c4|\SpecialChar allowbreak
11672 c5|\SpecialChar allowbreak
11673 c6|\SpecialChar allowbreak
11674 b0j|\SpecialChar allowbreak
11675 b1j|\SpecialChar allowbreak
11676 b2j|\SpecialChar allowbreak
11677 b3j|\SpecialChar allowbreak
11678 b4j|\SpecialChar allowbreak
11679 b5j|\SpecialChar allowbreak
11685 ] The list of available page sizes, separated by
11686 \begin_inset Quotes eld
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11695 \change_inserted -712698321 1565101779
11702 \begin_inset Quotes erd
11706 Currently, only the listed sizes are supported.
11707 Other sizes might be entered as custom class option.
11710 \begin_layout Description
11712 \change_inserted -712698321 1565180623
11713 \begin_inset Flex Code
11716 \begin_layout Plain Layout
11718 \change_inserted -712698321 1565180605
11725 \begin_inset Flex Code
11728 \begin_layout Plain Layout
11730 \change_inserted -712698321 1565180601
11736 ] The format for the page size option.
11738 \begin_inset Flex Code
11741 \begin_layout Plain Layout
11743 \change_inserted -712698321 1565180618
11751 \begin_inset Flex Code
11754 \begin_layout Plain Layout
11756 \change_inserted -712698321 1565180601
11762 is a placeholder for the paper size.
11767 \begin_layout Description
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11778 \begin_inset Flex Code
11781 \begin_layout Plain Layout
11782 string="empty|plain|headings|fancy"
11787 ] The list of available page sty\SpecialChar softhyphen
11789 \begin_inset Quotes eld
11793 \begin_inset Flex Code
11796 \begin_layout Plain Layout
11803 \begin_inset Quotes erd
11809 \begin_layout Description
11810 \begin_inset Flex Code
11813 \begin_layout Plain Layout
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11829 ] Some document class options, separated by a comma, that will be added
11830 to the optional part of the
11831 \begin_inset Flex Code
11834 \begin_layout Plain Layout
11845 \begin_layout Standard
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11856 section must end with
11857 \begin_inset Quotes eld
11861 \begin_inset Flex Code
11864 \begin_layout Plain Layout
11871 \begin_inset Quotes erd
11877 \begin_layout Subsection
11879 \begin_inset CommandInset label
11881 name "subsec:Paragraph-Styles"
11888 \begin_layout Standard
11889 A paragraph style description looks like this:
11893 \begin_layout Plain Layout
11894 Note that this will either define a new style or modify an existing one.
11902 \begin_layout LyX-Code
11909 \begin_layout LyX-Code
11913 \begin_layout LyX-Code
11917 \begin_layout Standard
11918 where the following commands are allowed:
11921 \begin_layout Description
11922 \begin_inset Flex Code
11925 \begin_layout Plain Layout
11932 \begin_inset Flex Code
11935 \begin_layout Plain Layout
11941 =""] This paragraph will appear in the table of contents of the given type.
11942 An empty string disables.
11943 See also the OutlinerName and the IsTocCaption commands.
11947 \begin_layout Description
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11958 \begin_inset Flex Code
11961 \begin_layout Plain Layout
11966 , left, right, center
11971 ] Paragraph alignment.
11974 \begin_layout Description
11975 \begin_inset Flex Code
11978 \begin_layout Plain Layout
11985 \begin_inset Flex Code
11988 \begin_layout Plain Layout
11993 , left, right, center
11998 ] A comma separated list of permitted alignments.
11999 (Some \SpecialChar LaTeX
12000 styles prohibit certain alignments, since those wouldn't make sense.
12001 For example a right-aligned or centered enumeration isn't possible.)
12004 \begin_layout Description
12005 \begin_inset Flex Code
12008 \begin_layout Plain Layout
12015 \begin_inset Flex Code
12018 \begin_layout Plain Layout
12024 ] Defines argument number <int> of a command\SpecialChar breakableslash
12025 environment associated with
12027 This is useful for things like section headings, and only makes sense with
12030 Every (optional or required) argument of a command or environment – except
12031 for the required argument that is associated with the content of the paragraph
12032 itself – has a separate definition, where the number specifies the order
12034 The definition must end with
12035 \begin_inset Flex Code
12038 \begin_layout Plain Layout
12045 So a command with two optional arguments has:
12049 \begin_layout Quote
12055 \begin_layout Quote
12061 \begin_layout Quote
12067 \begin_layout Quote
12073 \begin_layout Quote
12079 \begin_layout Quote
12085 \begin_layout Standard
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12096 definition, the following specifications are possible:
12099 \begin_layout Itemize
12100 \begin_inset Flex Code
12103 \begin_layout Plain Layout
12110 \begin_inset Flex Code
12113 \begin_layout Plain Layout
12119 The string that will appear both in the menu (to insert this argument)
12120 and on the argument inset button (unless you also specify a separate
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12131 For the menu, you can define an accelerator by appending the respective
12132 character to the string, divided by
12133 \begin_inset Quotes eld
12137 \begin_inset Quotes erd
12141 \begin_inset space \thinspace{}
12145 \begin_inset space \space{}
12149 \begin_inset Quotes eld
12153 \begin_inset Flex Code
12156 \begin_layout Plain Layout
12163 \begin_inset Quotes erd
12169 \begin_layout Itemize
12170 \begin_inset Flex Code
12173 \begin_layout Plain Layout
12180 \begin_inset Flex Code
12183 \begin_layout Plain Layout
12189 A separate string for the menu.
12190 You can define an accelerator by appending the respective character to
12191 the string, divided by
12192 \begin_inset Quotes eld
12196 \begin_inset Quotes erd
12200 \begin_inset space \thinspace{}
12204 \begin_inset space \space{}
12208 \begin_inset Quotes eld
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12222 \begin_inset Quotes erd
12226 This specification is optional.
12227 If it is not given the
12228 \begin_inset Flex Code
12231 \begin_layout Plain Layout
12237 will be used instead for the menu.
12240 \begin_layout Itemize
12241 \begin_inset Flex Code
12244 \begin_layout Plain Layout
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12260 A longer explanatory text that appears in the tooltip when hovering over
12261 the argument inset.
12264 \begin_layout Itemize
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12275 \begin_inset Flex Code
12278 \begin_layout Plain Layout
12287 \begin_inset space \thinspace{}
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12300 ] Declare if this is a mandatory (1) or an optional (0) argument.
12301 Mandatory arguments will be output empty if not given, while optional arguments
12302 will not be output at all.
12303 By default, mandatory arguments are delimited by
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12313 , while optional arguments are delimited by
12314 \begin_inset Flex Code
12317 \begin_layout Plain Layout
12324 \change_inserted -712698321 1555579782
12328 \begin_layout Itemize
12330 \change_inserted -712698321 1555579780
12331 \begin_inset Flex Code
12334 \begin_layout Plain Layout
12336 \change_inserted -712698321 1555579780
12343 \begin_inset Flex Code
12346 \begin_layout Plain Layout
12348 \change_inserted -712698321 1555579780
12354 Option to define a different command (from the default
12355 \begin_inset Flex Code
12358 \begin_layout Plain Layout
12360 \change_inserted -712698321 1555579780
12370 ) to be used for line breaks.
12371 The initial backslash must not be specified.
12376 \begin_layout Itemize
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12387 \begin_inset Flex Code
12390 \begin_layout Plain Layout
12396 defines another argument (by its number) which this argument requires to
12397 be output if it is itself output.
12399 \begin_inset space \thinspace{}
12402 g., in \SpecialChar LaTeX
12403 commands, optional arguments often require previous optional arguments
12404 to be output (at least empty), as in
12405 \begin_inset Flex Code
12408 \begin_layout Plain Layout
12411 command[][argument]{text}
12417 This can be achieved by the statement
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12428 \begin_inset Flex Code
12431 \begin_layout Plain Layout
12440 \begin_layout Itemize
12441 \begin_inset Flex Code
12444 \begin_layout Plain Layout
12451 \begin_inset Flex Code
12454 \begin_layout Plain Layout
12460 defines a custom left delimiter (instead of
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12471 \begin_inset Flex Code
12474 \begin_layout Plain Layout
12481 A line break in the output can be indicated by
12482 \begin_inset Flex Code
12485 \begin_layout Plain Layout
12494 \begin_layout Itemize
12495 \begin_inset Flex Code
12498 \begin_layout Plain Layout
12505 \begin_inset Flex Code
12508 \begin_layout Plain Layout
12514 defines a custom right delimiter (instead of
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12535 A line break in the output can be indicated by
12536 \begin_inset Flex Code
12539 \begin_layout Plain Layout
12548 \begin_layout Itemize
12549 \begin_inset Flex Code
12552 \begin_layout Plain Layout
12559 \begin_inset Flex Code
12562 \begin_layout Plain Layout
12568 defines an argument that is inserted if and only if no user-specified arguments
12570 \begin_inset space \thinspace{}
12574 \begin_inset space \space{}
12577 if no argument inset has been inserted (note that also an empty argument
12578 inset omits the DefaultArg).
12579 Multiple arguments need to be separated by comma.
12582 \begin_layout Itemize
12583 \begin_inset Flex Code
12586 \begin_layout Plain Layout
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12602 defines an argument that is inserted in any case (alone or in addition
12603 to user-specified arguments).
12604 Multiple arguments need to be separated by comma.
12607 \begin_layout Itemize
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12617 The font used for the argument content, see
12618 \begin_inset CommandInset ref
12620 reference "subsec:Font-description"
12625 \change_inserted -712698321 1559484228
12629 \begin_layout Itemize
12631 \change_inserted -712698321 1559484228
12632 \begin_inset Flex Code
12635 \begin_layout Plain Layout
12637 \change_inserted -712698321 1559484228
12644 \begin_inset Flex Code
12647 \begin_layout Plain Layout
12649 \change_inserted -712698321 1559484228
12658 \begin_inset space \thinspace{}
12662 \begin_inset Flex Code
12665 \begin_layout Plain Layout
12667 \change_inserted -712698321 1559484228
12673 ] As with paragraph styles, see
12674 \begin_inset CommandInset ref
12676 reference "subsec:Paragraph-Styles"
12685 \begin_layout Itemize
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12695 The font used for the label; see
12696 \begin_inset CommandInset ref
12698 reference "subsec:Font-description"
12705 \begin_layout Itemize
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12716 \begin_inset Flex Code
12719 \begin_layout Plain Layout
12724 , Minimalistic, Conglomerate
12729 ] describes the rendering style used for the inset's frame and buttons.
12732 \begin_layout Itemize
12733 \begin_inset Flex Code
12736 \begin_layout Plain Layout
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12753 \begin_inset Flex Code
12756 \begin_layout Plain Layout
12762 , this argument is automatically inserted when the respective style is selected.
12764 \change_deleted -712698321 1559484200
12765 Currently, only one argument per style\SpecialChar breakableslash
12766 layout can be automatically inserted.
12771 \begin_layout Itemize
12773 \change_inserted -712698321 1559491402
12774 \begin_inset Flex Code
12777 \begin_layout Plain Layout
12779 \change_inserted -712698321 1559490711
12786 \begin_inset Flex Code
12789 \begin_layout Plain Layout
12791 \change_inserted -712698321 1559490703
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12803 \change_inserted -712698321 1559490703
12809 , this argument will be inserted on a new line with
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12815 \change_inserted -712698321 1559491402
12821 (only available within Flex insets).
12824 \begin_layout Itemize
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12835 \begin_inset Flex Code
12838 \begin_layout Plain Layout
12845 \begin_inset Flex Code
12848 \begin_layout Plain Layout
12854 , this argument will be inserted with a copy of the co-text (either selected
12855 text or the whole paragraph) as content.
12858 \begin_layout Itemize
12859 \begin_inset Flex Code
12862 \begin_layout Plain Layout
12869 \begin_inset Flex Code
12872 \begin_layout Plain Layout
12882 ] Whether the contents of this argument should be output in raw form, meaning
12883 without special translations that \SpecialChar LaTeX
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12895 status is inherited by the inset or paragraph layout the argument belongs
12896 to, true and false change the status for the given argument only.
12899 \begin_layout Itemize
12900 \begin_inset Flex Code
12903 \begin_layout Plain Layout
12910 \begin_inset Flex Code
12913 \begin_layout Plain Layout
12914 string of characters
12923 Defines individual characters
12924 \begin_inset Newline linebreak
12927 that should be output in raw form, meaning without special translations
12928 that \SpecialChar LaTeX
12930 Note that, contrary to PassThru, this needs to be explicitly defined for
12932 That is, arguments do not inherit PassThruChars from their parent inset
12936 \begin_layout Itemize
12937 \begin_inset Flex Code
12940 \begin_layout Plain Layout
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12959 \begin_inset space \thinspace{}
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12972 ] If this is set to 1, the argument will output its content in the corresponding
12973 item in the table of contents.
12977 \begin_layout Standard
12978 By default, the text entered in the \SpecialChar LyX
12979 workarea in the respective layout is
12980 the last (mandatory) argument of a command if the
12981 \begin_inset Flex Code
12984 \begin_layout Plain Layout
12991 \begin_inset Flex Code
12994 \begin_layout Plain Layout
13001 However, arguments with the prefix
13002 \begin_inset Flex Code
13005 \begin_layout Plain Layout
13011 are output after this workarea argument.
13012 Note that post-argument numbering restarts at 1, so the first argument
13013 following the workarea argument is
13014 \begin_inset Flex Code
13017 \begin_layout Plain Layout
13024 Post-arguments are ignored in any other
13025 \begin_inset Flex Code
13028 \begin_layout Plain Layout
13035 \begin_inset Flex Code
13038 \begin_layout Plain Layout
13047 \begin_layout Standard
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13061 \begin_inset Flex Code
13064 \begin_layout Plain Layout
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13082 followed by the number (e.
13083 \begin_inset space \thinspace{}
13087 \begin_inset space \space{}
13091 \begin_inset Flex Code
13094 \begin_layout Plain Layout
13101 \change_inserted -712698321 1534487781
13105 \begin_layout Standard
13107 \change_inserted -712698321 1534488561
13108 Finally, there is a special argument type with the prefix
13109 \begin_inset Flex Code
13112 \begin_layout Plain Layout
13114 \change_inserted -712698321 1534487844
13123 It is not really an argument, but uses the argument interface (thus, the
13124 prefix is also followed by a number, e.
13125 \begin_inset space \thinspace{}
13130 \begin_inset Flex Code
13133 \begin_layout Plain Layout
13135 \change_inserted -712698321 1534488412
13136 Argument listpreamble:1
13142 As the name implies, it is targeted at lists such as
13159 Its content will be output at the list start, before the first
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13165 \change_inserted -712698321 1534488058
13175 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13177 This way, users can insert redefinitions (of lengths etc.) to individual
13179 By default, these arguments do not have a delimiter.
13185 \begin_layout Description
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13195 Includes a comma-separated list of layouts that should be nested in and
13196 after the current layout.
13197 Only makes sense for nestable layouts (such as environments).
13199 \begin_inset Quotes eld
13203 \begin_inset Flex Code
13206 \begin_layout Plain Layout
13213 \begin_inset Quotes erd
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13230 \begin_layout Description
13231 \begin_inset Flex Code
13234 \begin_layout Plain Layout
13240 Note that this will completely override any prior
13241 \begin_inset Flex Code
13244 \begin_layout Plain Layout
13250 declaration for this style.
13252 \begin_inset Quotes eld
13256 \begin_inset Flex Code
13259 \begin_layout Plain Layout
13266 \begin_inset Quotes erd
13271 \begin_inset CommandInset ref
13273 reference "subsec:I18n"
13277 for details on its use.
13280 \begin_layout Description
13281 \begin_inset Flex Code
13284 \begin_layout Plain Layout
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13304 \begin_layout Plain Layout
13305 Note that a `float' here is a real number, such as: 1.5.
13310 The vertical space with which the last of a chain of paragraphs with this
13311 style is separated from the following paragraph.
13312 If the next paragraph has another style, the separations are not simply
13313 added, but the maximum is taken.
13316 \begin_layout Description
13317 \begin_inset Flex Code
13320 \begin_layout Plain Layout
13327 \begin_inset Flex Code
13330 \begin_layout Plain Layout
13336 ] The category for this style.
13337 This is used to group related styles in the style combobox on the toolbar.
13338 Any string can be used, but you may want to use existing categories with
13343 \begin_layout Description
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13353 Depth of XML command.
13354 Used only with XML-type formats.
13357 \begin_layout Description
13358 \begin_inset Flex Code
13361 \begin_layout Plain Layout
13368 \begin_inset Flex Code
13371 \begin_layout Plain Layout
13377 ] Copies all the features of an existing style into the current one.
13381 \begin_layout Description
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13401 ] The name of a style whose preamble should be output
13406 This allows to ensure some ordering of the preamble snippets when macros
13407 definitions depend on one another.
13411 \begin_layout Plain Layout
13412 Note that, besides that functionality, there is no way to ensure any ordering
13414 The ordering that you see in a given version of \SpecialChar LyX
13415 may change without warning
13424 \begin_layout Description
13425 \begin_inset Flex Code
13428 \begin_layout Plain Layout
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13443 , Box, Filled_Box, Static
13448 ] The type of label that stands at the end of the paragraph (or sequence
13450 \begin_inset Flex Code
13453 \begin_layout Plain Layout
13460 \begin_inset Newline newline
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13495 \begin_inset Flex Code
13498 \begin_layout Plain Layout
13505 \begin_inset Quotes eld
13509 \begin_inset Quotes erd
13513 \begin_inset Flex Code
13516 \begin_layout Plain Layout
13523 \begin_inset space \space{}
13527 \begin_inset Flex Code
13530 \begin_layout Plain Layout
13536 ) is a white (resp.
13537 \begin_inset space ~
13540 black) square suitable for end of proof markers,
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13550 is an explicit text string.
13553 \begin_layout Description
13554 \begin_inset Flex Code
13557 \begin_layout Plain Layout
13564 \begin_inset Flex Code
13567 \begin_layout Plain Layout
13573 ] The string used for a label with a
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13584 \begin_inset Newline newline
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13601 \begin_layout Description
13602 \begin_inset Flex Code
13605 \begin_layout Plain Layout
13611 The font used for both the text body
13617 \begin_inset CommandInset ref
13619 reference "subsec:Font-description"
13624 Note that defining this font automatically defines the
13625 \begin_inset Flex Code
13628 \begin_layout Plain Layout
13635 So you should define this one first if you also want to define
13636 \begin_inset Flex Code
13639 \begin_layout Plain Layout
13648 \begin_layout Description
13649 \begin_inset Flex Code
13652 \begin_layout Plain Layout
13659 \begin_inset Flex Code
13662 \begin_layout Plain Layout
13668 ] Used for backporting new styles to stable \SpecialChar LyX
13670 The first stable version that supports this tag is \SpecialChar LyX
13672 The argument is a number which may either be 0, -1 or any value greater
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13684 flag of a style is greater than zero, it will always be written to the
13686 If a .lyx file is read, the style definitions from the document header are
13687 added to the document class.
13688 Therefore even older \SpecialChar LyX
13689 versions can handle the style.
13691 \begin_inset Flex Code
13694 \begin_layout Plain Layout
13700 is a version number: if the style is read, and the version number is less
13701 than the version number of the already existing style in the document class,
13702 the new style is ignored.
13703 If the version number is greater, the new style replaces the existing style.
13704 A value of -1 means an infinite version number, i.
13705 \begin_inset space \thinspace{}
13709 \begin_inset space \space{}
13712 the style is always used.
13715 \begin_layout Description
13716 \begin_inset Flex Code
13719 \begin_layout Plain Layout
13726 \begin_inset Flex Code
13729 \begin_layout Plain Layout
13738 \begin_inset space \thinspace{}
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13751 ] Usually \SpecialChar LyX
13752 does not allow you to insert more than one space between words,
13753 since a space is considered as the separation between two words, not a
13754 character or symbol of its own.
13755 This is a very fine thing but sometimes annoying, for example, when typing
13756 program code or plain \SpecialChar LaTeX
13759 \begin_inset Flex Code
13762 \begin_layout Plain Layout
13770 \change_deleted -495245474 1550490105
13774 will create protected blanks for the additional blanks when in
13775 \change_inserted -495245474 1550490096
13777 \begin_inset Flex Code
13780 \begin_layout Plain Layout
13782 \change_inserted -495245474 1550490089
13789 \change_deleted -495245474 1550490116
13790 another mode than \SpecialChar LaTeX
13793 \change_inserted -495245474 1550247760
13795 \begin_inset Flex Code
13798 \begin_layout Plain Layout
13800 \change_inserted -495245474 1550247736
13807 \begin_inset Flex Code
13810 \begin_layout Plain Layout
13812 \change_inserted -495245474 1550247755
13823 \begin_layout Description
13824 \begin_inset Flex Code
13827 \begin_layout Plain Layout
13833 These tags are used with XHTML output.
13835 \begin_inset CommandInset ref
13837 reference "subsec:Paragraph-Style-XHTML"
13844 \begin_layout Description
13845 \begin_inset Flex Code
13848 \begin_layout Plain Layout
13854 [FIXME] (Used only with XML-type formats.)
13857 \begin_layout Description
13858 \begin_inset Flex Code
13861 \begin_layout Plain Layout
13868 \begin_inset Flex Code
13871 \begin_layout Plain Layout
13880 \begin_inset space \thinspace{}
13884 \begin_inset Flex Code
13887 \begin_layout Plain Layout
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13903 , marks the style as to be included in the document preamble and not in
13905 This is useful for document classes that want such information as the title
13906 and author to appear in the preamble.
13907 Note that this works only for styles for which the
13908 \begin_inset Flex Code
13911 \begin_layout Plain Layout
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13928 \begin_inset Flex Code
13931 \begin_layout Plain Layout
13940 \begin_layout Description
13941 \begin_inset Flex Code
13944 \begin_layout Plain Layout
13951 \begin_inset Flex Code
13954 \begin_layout Plain Layout
13963 \begin_inset space \thinspace{}
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13977 \begin_inset Flex Code
13980 \begin_layout Plain Layout
13986 , marks the style as being part of a title block (see also the
13987 \begin_inset Flex Code
13990 \begin_layout Plain Layout
13997 \begin_inset Flex Code
14000 \begin_layout Plain Layout
14009 \begin_layout Description
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14019 Includes a comma-separated list of layouts after which this one should
14021 Only makes sense with regard to nestable layouts (such as environments).
14023 \begin_inset Quotes eld
14027 \begin_inset Flex Code
14030 \begin_layout Plain Layout
14037 \begin_inset Quotes erd
14042 \begin_inset Flex Code
14045 \begin_layout Plain Layout
14054 \begin_layout Description
14055 \begin_inset Flex Code
14058 \begin_layout Plain Layout
14065 \begin_inset Flex Code
14068 \begin_layout Plain Layout
14077 \begin_inset space \thinspace{}
14081 \begin_inset Flex Code
14084 \begin_layout Plain Layout
14090 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14091 of its contents in its item in the table of contents.
14092 Otherwise, only the label, if it exists, appears.
14095 \begin_layout Description
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14106 \begin_inset Flex Code
14109 \begin_layout Plain Layout
14115 ] The \SpecialChar LaTeX
14116 command sequence declaring an item in a list.
14117 The command is to be defined without the preceding backslash (the default
14119 \begin_inset Quotes eld
14123 \begin_inset Quotes erd
14127 \begin_inset Flex Code
14130 \begin_layout Plain Layout
14138 in the \SpecialChar LaTeX
14142 \begin_layout Description
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14162 ] This provides extra space between paragraphs that have the same style.
14163 If you put other styles into an environment, each is separated with the
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14175 But the whole items of the environment are additionally separated with
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14187 Note that this is a
14192 \begin_layout Description
14193 \begin_inset Flex Code
14196 \begin_layout Plain Layout
14202 [FIXME] (Used only with XML-type formats.)
14205 \begin_layout Description
14206 \begin_inset Flex Code
14209 \begin_layout Plain Layout
14216 \begin_inset Flex Code
14219 \begin_layout Plain Layout
14228 \begin_inset space \thinspace{}
14232 \begin_inset Flex Code
14235 \begin_layout Plain Layout
14241 ] Usually \SpecialChar LyX
14242 does not allow you to leave a paragraph empty, since it would
14243 lead to empty \SpecialChar LaTeX
14245 There are some cases where this could be desirable however: in a letter
14246 template, the required fields can be provided as empty fields, so that
14247 people do not forget them; in some special classes, a style can be used
14248 as some kind of break, which does not contain actual text.
14251 \begin_layout Description
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14271 ] The vertical space between the label and the text body.
14272 Only used for labels that are above the text body (
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14283 \begin_inset Newline newline
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14291 Centered_Top_Environment
14299 \begin_layout Description
14300 \begin_inset Flex Code
14303 \begin_layout Plain Layout
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14319 ] The name of the counter for automatic numbering.
14320 In order to have the counter appear with your label, you will need to reference
14322 \begin_inset Flex Code
14325 \begin_layout Plain Layout
14334 This will work with
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14345 \begin_inset Flex Code
14348 \begin_layout Plain Layout
14355 \begin_inset Flex Code
14358 \begin_layout Plain Layout
14365 \begin_inset Flex Code
14368 \begin_layout Plain Layout
14375 \begin_inset Newline newline
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14393 \begin_inset Flex Code
14396 \begin_layout Plain Layout
14402 , though this case is a bit complicated.
14403 Suppose you declare
14404 \begin_inset Quotes eld
14408 \begin_inset Flex Code
14411 \begin_layout Plain Layout
14412 LabelCounter myenum
14418 \begin_inset Quotes erd
14422 Then the actual counters used are
14423 \begin_inset Flex Code
14426 \begin_layout Plain Layout
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14443 \begin_inset Flex Code
14446 \begin_layout Plain Layout
14453 \begin_inset Flex Code
14456 \begin_layout Plain Layout
14462 , much as in \SpecialChar LaTeX
14464 These counters must all be declared separately.
14465 \begin_inset Newline newline
14469 \begin_inset CommandInset ref
14471 reference "subsec:Counters"
14475 for details on counters.
14478 \begin_layout Description
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14488 The font used for the label.
14490 \begin_inset CommandInset ref
14492 reference "subsec:Font-description"
14499 \begin_layout Description
14500 \begin_inset Flex Code
14503 \begin_layout Plain Layout
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14519 ] Text that indicates how far a label should be indented.
14522 \begin_layout Description
14523 \begin_inset Flex Code
14526 \begin_layout Plain Layout
14533 \begin_inset Flex Code
14536 \begin_layout Plain Layout
14542 ] Text that indicates the amount of horizontal space between the label and
14544 Only used for labels that are not above the text body.
14547 \begin_layout Description
14548 \begin_inset Flex Code
14551 \begin_layout Plain Layout
14558 \begin_inset Flex Code
14561 \begin_layout Plain Layout
14567 ] The string used for the label.
14569 \begin_inset Flex Code
14572 \begin_layout Plain Layout
14578 is set, this string can be contain the special formatting commands described
14580 \begin_inset CommandInset ref
14582 reference "subsec:Counters"
14589 \begin_layout Description
14590 \begin_inset Flex Code
14593 \begin_layout Plain Layout
14594 LabelStringAppendix
14600 \begin_inset Flex Code
14603 \begin_layout Plain Layout
14609 ] This is used inside the appendix instead of
14610 \begin_inset Newline newline
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14625 \begin_inset Flex Code
14628 \begin_layout Plain Layout
14635 \begin_inset Newline newline
14639 \begin_inset Flex Code
14642 \begin_layout Plain Layout
14643 LabelStringAppendix
14651 \begin_layout Description
14652 \begin_inset Flex Code
14655 \begin_layout Plain Layout
14661 [FIXME] (Used only with XML-type formats.)
14664 \begin_layout Description
14665 \begin_inset Flex Code
14668 \begin_layout Plain Layout
14675 \begin_inset Flex Code
14678 \begin_layout Plain Layout
14683 , Manual, Static, Above,
14684 \begin_inset Newline newline
14687 Centered, Sensitive, Enumerate,
14688 \begin_inset Newline newline
14691 Itemize, Bibliography
14700 \begin_layout Description
14701 \begin_inset Flex Code
14704 \begin_layout Plain Layout
14710 means the label is the very first word (up to the first real blank).
14711 Use protected spaces if you want more than one word as the label.
14715 \begin_layout Description
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14725 means the label is simply what is declared as
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14736 This will be displayed
14737 \begin_inset Quotes eld
14741 \begin_inset Quotes erd
14744 , at the beginning of the paragraph.
14746 \begin_inset Flex Code
14749 \begin_layout Plain Layout
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14765 , then it will be displayed only in the first paragraph of any sequence
14766 of paragraphs with the same
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14779 \begin_layout Description
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14790 \begin_inset space ~
14794 \begin_inset space ~
14798 \begin_inset Flex Code
14801 \begin_layout Plain Layout
14807 are special cases of
14808 \begin_inset Flex Code
14811 \begin_layout Plain Layout
14818 The label will be printed above the paragraph either at the beginning of
14819 the line or centered.
14822 \begin_layout Description
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14832 is a special case for the caption-labels
14833 \begin_inset Quotes eld
14837 \begin_inset Quotes erd
14841 \begin_inset Quotes eld
14845 \begin_inset Quotes erd
14849 \begin_inset Newline newline
14853 \begin_inset Flex Code
14856 \begin_layout Plain Layout
14862 means the (hardcoded) label string depends on the kind of float: It is
14863 hardcoded to be `FloatType N', where N is the value of the counter associated
14865 For the case that a caption is inserted outside of a float the
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Quotes eld
14880 \begin_inset Quotes erd
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14896 produces the usual sort of enumeration labels.
14897 The number type needs to be set in the
14902 \begin_inset CommandInset ref
14904 reference "subsec:Counters"
14911 \begin_layout Description
14912 \begin_inset Flex Code
14915 \begin_layout Plain Layout
14921 produces various bullets at the different levels.
14922 The bullet types displayed can be set via
14923 \begin_inset Flex Noun
14926 \begin_layout Plain Layout
14927 Document\SpecialChar menuseparator
14928 Settings\SpecialChar menuseparator
14937 \begin_layout Description
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14947 should be used only with
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14952 LatexType BibEnvironment
14961 \begin_layout Description
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14971 Note that this will completely override any prior
14972 \begin_inset Flex Code
14975 \begin_layout Plain Layout
14981 declaration for this style.
14983 \begin_inset Quotes eld
14987 \begin_inset Flex Code
14990 \begin_layout Plain Layout
14997 \begin_inset Quotes erd
15002 \begin_inset CommandInset ref
15004 reference "subsec:I18n"
15008 for details on its use.
15011 \begin_layout Description
15012 \begin_inset Flex Code
15015 \begin_layout Plain Layout
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15031 ] The name of the corresponding \SpecialChar LaTeX
15033 Either the environment or command name.
15036 \begin_layout Description
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15056 ] An optional parameter for the corresponding
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15067 This parameter cannot be changed from within \SpecialChar LyX
15069 \begin_inset Flex Code
15072 \begin_layout Plain Layout
15078 for customizable parameters).
15079 This will be output as is after all \SpecialChar LaTeX
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15093 \begin_layout Description
15094 \begin_inset Flex Code
15097 \begin_layout Plain Layout
15104 \begin_inset Flex Code
15107 \begin_layout Plain Layout
15112 , Command, Environment, Item_Environment,
15113 \begin_inset Newline newline
15116 List_Environment, Bib_Environment
15121 ] How the style should be translated into \SpecialChar LaTeX
15126 \begin_layout Plain Layout
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15136 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15137 Visit the SGML class files for specific examples.
15146 \begin_layout Description
15147 \begin_inset Flex Code
15150 \begin_layout Plain Layout
15156 means nothing special.
15159 \begin_layout Description
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15170 \begin_inset Flex Code
15173 \begin_layout Plain Layout
15180 {\SpecialChar ldots
15189 \begin_layout Description
15190 \begin_inset Flex Code
15193 \begin_layout Plain Layout
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15210 }\SpecialChar ldots
15226 \begin_layout Description
15227 \begin_inset Flex Code
15230 \begin_layout Plain Layout
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15258 is generated for each paragraph of this environment.
15262 \begin_layout Description
15263 \begin_inset Flex Code
15266 \begin_layout Plain Layout
15273 \begin_inset Flex Code
15276 \begin_layout Plain Layout
15283 \begin_inset Newline newline
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15296 is passed as an argument to the environment.
15297 \begin_inset Newline newline
15301 \begin_inset Flex Code
15304 \begin_layout Plain Layout
15310 can be defined in the
15311 \begin_inset Flex Noun
15314 \begin_layout Plain Layout
15315 Edit\SpecialChar menuseparator
15317 \begin_inset space ~
15328 \begin_layout Description
15329 \begin_inset Flex Code
15332 \begin_layout Plain Layout
15339 \begin_inset Flex Code
15342 \begin_layout Plain Layout
15348 but adds the necessary mandatory argument (the longest label) to the begin
15349 statement of the bibliography environment:
15350 \begin_inset Newline newline
15354 \begin_inset Flex Code
15357 \begin_layout Plain Layout
15360 begin{thebibliography}{99}
15366 It is therefore only useful for bibliography environments.
15367 The default longest label
15368 \begin_inset Quotes eld
15372 \begin_inset Quotes erd
15375 can be changed by the user in the paragraph settings of a bibliography
15379 \begin_layout Standard
15380 Putting the last few things together, the \SpecialChar LaTeX
15381 output will be either:
15384 \begin_layout LyX-Code
15387 LatexName[LatexParam]{\SpecialChar ldots
15391 \begin_layout Standard
15395 \begin_layout LyX-Code
15398 begin{LatexName}[LatexParam] \SpecialChar ldots
15404 \begin_layout Standard
15405 depending upon the \SpecialChar LaTeX
15410 \begin_layout Description
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 ] A string that is put at the beginning of the style content.
15431 A line break in the output can be indicated by
15432 \begin_inset Flex Code
15435 \begin_layout Plain Layout
15444 \begin_layout Description
15445 \begin_inset Flex Code
15448 \begin_layout Plain Layout
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15464 ] If you put styles into environments, the different
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15474 are not simply added, but added with a factor
15475 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15479 Note that this parameter is also used when
15480 \begin_inset Flex Code
15483 \begin_layout Plain Layout
15490 \begin_inset Flex Code
15493 \begin_layout Plain Layout
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15510 Then it is added to the manual or dynamic margin.
15511 \begin_inset Newline newline
15515 \begin_inset Quotes eld
15519 \begin_inset Flex Code
15522 \begin_layout Plain Layout
15529 \begin_inset Quotes erd
15532 means that the paragraph is indented with the width of
15533 \begin_inset Quotes eld
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15547 \begin_inset Quotes erd
15550 in the normal font.
15551 You can get a negative width by prefixing the string with
15552 \begin_inset Quotes eld
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15566 \begin_inset Quotes erd
15570 This way was chosen so that the look is the same with each used screen
15574 \begin_layout Description
15575 \begin_inset Flex Code
15578 \begin_layout Plain Layout
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15593 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15599 \begin_inset Newline newline
15602 The kind of margin that the style has on the left side.
15606 \begin_layout Description
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15616 just means a fixed margin.
15619 \begin_layout Description
15620 \begin_inset Flex Code
15623 \begin_layout Plain Layout
15629 means that the left margin depends on the string entered in the
15630 \begin_inset Flex Noun
15633 \begin_layout Plain Layout
15634 Edit\SpecialChar menuseparator
15636 \begin_inset space ~
15645 This is used to typeset nice lists without tabulators.
15648 \begin_layout Description
15649 \begin_inset Flex Code
15652 \begin_layout Plain Layout
15658 means that the margin depends on the size of the label.
15659 This is used for automatic enumerated headlines.
15660 It is obvious that the headline
15661 \begin_inset Quotes eld
15664 5.4.3.2.1 Very long headline
15665 \begin_inset Quotes erd
15668 must have a wider left margin (as wide as
15669 \begin_inset Quotes eld
15673 \begin_inset Quotes erd
15676 plus the space) than
15677 \begin_inset Quotes eld
15680 3.2 Very long headline
15681 \begin_inset Quotes erd
15685 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15692 are not able to do this.
15695 \begin_layout Description
15696 \begin_inset Flex Code
15699 \begin_layout Plain Layout
15705 is similar, but only the very first row of the paragraph is dynamic, while
15706 the others are static; this is used, for example, for descriptions.
15709 \begin_layout Description
15710 \begin_inset Flex Code
15713 \begin_layout Plain Layout
15719 means the margin is chosen in a way that the longest row of this paragraph
15720 fits to the right margin.
15721 This is used to typeset an address on the right edge of the page.
15725 \begin_layout Description
15726 \begin_inset Flex Code
15729 \begin_layout Plain Layout
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15748 \begin_inset space \thinspace{}
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15761 ] Whether fragile commands in this style should be
15762 \begin_inset Flex Code
15765 \begin_layout Plain Layout
15778 whether this command should itself be protected.)
15779 \change_inserted -712698321 1523696949
15783 \begin_layout Description
15785 \change_inserted -712698321 1552395557
15786 \begin_inset Flex Code
15789 \begin_layout Plain Layout
15791 \change_inserted -712698321 1523696950
15798 \begin_inset Flex Code
15801 \begin_layout Plain Layout
15803 \change_inserted -712698321 1523696950
15812 \begin_inset space \thinspace{}
15816 \begin_inset Flex Code
15819 \begin_layout Plain Layout
15821 \change_inserted -712698321 1523696950
15827 ] This causes macros that contain this layout to be protected with
15828 \begin_inset Flex Code
15831 \begin_layout Plain Layout
15833 \change_inserted -712698321 1523696950
15846 ) if necessary and thus allows (some) verbatim stuff in macros.
15849 \begin_layout Description
15851 \change_inserted -712698321 1552395844
15852 \begin_inset Flex Code
15855 \begin_layout Plain Layout
15857 \change_inserted -712698321 1552395561
15864 \begin_inset Flex Code
15867 \begin_layout Plain Layout
15869 \change_inserted -712698321 1552395557
15878 \begin_inset space \thinspace{}
15882 \begin_inset Flex Code
15885 \begin_layout Plain Layout
15887 \change_inserted -712698321 1552395557
15893 ] Whether specific commands in this style (such as
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15899 \change_inserted -712698321 1552395655
15910 \begin_inset Flex Code
15913 \begin_layout Plain Layout
15915 \change_inserted -712698321 1552395661
15925 ) should be protected in an
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15931 \change_inserted -712698321 1552395631
15942 This is particularly needed for styles that draw on
15950 commands which parse their content in complex ways.
15955 \begin_layout Description
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15976 \begin_inset space \thinspace{}
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15991 ] Whether newlines are translated into \SpecialChar LaTeX
15993 \begin_inset Flex Code
15996 \begin_layout Plain Layout
16007 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16009 inside \SpecialChar LyX
16013 \begin_layout Description
16014 \begin_inset Flex Code
16017 \begin_layout Plain Layout
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16036 \begin_inset space \thinspace{}
16040 \begin_inset Flex Code
16043 \begin_layout Plain Layout
16049 ] If set to true, and if
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16060 \begin_inset Flex Code
16063 \begin_layout Plain Layout
16069 ) paragraphs are being indented, then the indentation of such a paragraph
16070 following one of this type will be suppressed.
16071 (So this will not affect the display of non-default paragraphs.)
16074 \begin_layout Description
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16094 ] Name of a style that has replaced this style.
16095 This is used to rename a style, while keeping backward compatibility.
16098 \begin_layout Description
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16119 \begin_inset space \thinspace{}
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16132 ] Determines whether consecutive paragraphs of the same type are treated
16133 as belonging together.
16134 This has the effect that the
16135 \begin_inset Flex Code
16138 \begin_layout Plain Layout
16144 is only printed once before such a group.
16145 By default, this is true for
16146 \begin_inset Flex Code
16149 \begin_layout Plain Layout
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16175 and false for all other types.
16178 \begin_layout Description
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16201 \begin_inset space \thinspace{}
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16214 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16216 but only by a line break; together with
16217 \begin_inset Flex Code
16220 \begin_layout Plain Layout
16226 , this allows to emulate a plain text editor (like the ERT inset).
16229 \begin_layout Description
16230 \begin_inset Flex Code
16233 \begin_layout Plain Layout
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16249 ] The indent of the very first line of a paragraph.
16251 \begin_inset Newline newline
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16264 will be fixed for a certain style.
16265 The exception is the default style, since the indentation for these paragraphs
16266 can be prohibited with
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16278 \begin_inset Flex Code
16281 \begin_layout Plain Layout
16287 style paragraphs inside environments use the
16288 \begin_inset Flex Code
16291 \begin_layout Plain Layout
16297 of the environment, not their native one.
16299 \begin_inset Flex Code
16302 \begin_layout Plain Layout
16308 paragraphs inside an enumeration are not indented.
16311 \begin_layout Description
16312 \begin_inset Flex Code
16315 \begin_layout Plain Layout
16322 \begin_inset Flex Code
16325 \begin_layout Plain Layout
16331 ] The vertical space between two paragraphs of this style.
16334 \begin_layout Description
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16345 \begin_inset Flex Code
16348 \begin_layout Plain Layout
16355 allows the user to choose either
16356 \begin_inset Quotes eld
16360 \begin_inset Quotes erd
16364 \begin_inset Quotes eld
16368 \begin_inset Quotes erd
16371 to separate paragraphs.
16373 \begin_inset Quotes eld
16377 \begin_inset Quotes erd
16381 \begin_inset Flex Code
16384 \begin_layout Plain Layout
16392 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16409 is ignored and all paragraphs are separated by the
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16420 The vertical space is calculated with
16421 \begin_inset Flex Code
16424 \begin_layout Plain Layout
16426 \begin_inset space ~
16435 \begin_inset Flex Code
16438 \begin_layout Plain Layout
16444 is the height of a row with the normal font.
16445 This way, the look stays the same with different screen fonts.
16448 \begin_layout Description
16449 \begin_inset Flex Code
16452 \begin_layout Plain Layout
16459 \begin_inset Flex Code
16462 \begin_layout Plain Layout
16471 \begin_inset space \thinspace{}
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16484 ] Whether the contents of this paragraph should be output in raw form, meaning
16485 without special translations that \SpecialChar LaTeX
16489 \begin_layout Description
16490 \begin_inset Flex Code
16493 \begin_layout Plain Layout
16500 \begin_inset Flex Code
16503 \begin_layout Plain Layout
16513 Defines individual characters that should be output in raw form, meaning
16514 without special translations that \SpecialChar LaTeX
16518 \begin_layout Description
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16528 Information to be included in the \SpecialChar LaTeX
16529 preamble when this style is used.
16530 Used to define macros, load packages, etc., required by this particular
16533 \begin_inset Quotes eld
16537 \begin_inset Flex Code
16540 \begin_layout Plain Layout
16547 \begin_inset Quotes erd
16553 \begin_layout Description
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16564 \begin_inset Flex Code
16567 \begin_layout Plain Layout
16573 ] The prefix to use when creating labels referring to paragraphs of this
16575 This allows the use of formatted references.
16578 \begin_layout Description
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16589 \begin_inset Flex Code
16592 \begin_layout Plain Layout
16598 ] Whether the style requires the feature
16599 \begin_inset Flex Code
16602 \begin_layout Plain Layout
16609 \begin_inset CommandInset ref
16611 reference "chap:List-of-functions"
16615 for the list of features).
16616 If you require a package with specific options, you can additionally use
16618 \begin_inset Flex Code
16621 \begin_layout Plain Layout
16627 as a general text class parameter (see
16628 \begin_inset CommandInset ref
16630 reference "subsec:General-text-class"
16637 \begin_layout Description
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16648 \begin_inset Flex Code
16651 \begin_layout Plain Layout
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16669 ] Resets the \SpecialChar LaTeX
16670 arguments of this style (as defined via the
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16681 This is useful if you have copied a style via
16682 \begin_inset Flex Code
16685 \begin_layout Plain Layout
16691 , but you do not want to inherit its (required and optional) arguments.
16694 \begin_layout Description
16695 \begin_inset Flex Code
16698 \begin_layout Plain Layout
16705 \begin_inset Flex Code
16708 \begin_layout Plain Layout
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16726 ] Resumes a counter that is usually reset at each new sequence of layouts.
16727 This is currently only useful when
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16738 \begin_inset Flex Code
16741 \begin_layout Plain Layout
16750 \begin_layout Description
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16761 \begin_inset Flex Code
16764 \begin_layout Plain Layout
16770 ] A string that is put at the end of the layout content.
16771 A line break in the output can be indicated by
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16784 \begin_layout Description
16785 \begin_inset Flex Code
16788 \begin_layout Plain Layout
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16817 \begin_layout Description
16818 \begin_inset Flex Code
16821 \begin_layout Plain Layout
16828 \begin_inset Flex Code
16831 \begin_layout Plain Layout
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16860 \begin_inset Flex Code
16863 \begin_layout Plain Layout
16865 \begin_inset space ~
16873 ] This defines what the default spacing should be in the style.
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16885 \begin_inset Flex Code
16888 \begin_layout Plain Layout
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16904 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16905 If you specify the argument
16906 \begin_inset Flex Code
16909 \begin_layout Plain Layout
16915 , then you must also provide a value argument which will be the actual multiplie
16917 Note that, contrary to other parameters,
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16927 implies the generation of specific \SpecialChar LaTeX
16928 code, using the \SpecialChar LaTeX
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16944 \begin_layout Description
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16965 \begin_inset space \thinspace{}
16969 \begin_inset Flex Code
16972 \begin_layout Plain Layout
16980 ] Allow spell-checking paragraphs of this style.
16984 \begin_layout Description
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17016 ] Steps the master counter of a given counter at the beginning of a new
17017 sequence of layouts.
17018 This is currently only useful when
17019 \begin_inset Flex Code
17022 \begin_layout Plain Layout
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17041 \begin_layout Description
17042 \begin_inset Flex Code
17045 \begin_layout Plain Layout
17051 The font used for the text body .
17053 \begin_inset CommandInset ref
17055 reference "subsec:Font-description"
17062 \begin_layout Description
17063 \begin_inset Flex Code
17066 \begin_layout Plain Layout
17075 \begin_inset Flex Code
17078 \begin_layout Plain Layout
17088 The level of the style in the table of contents.
17089 This is used for automatic numbering of section headings.
17092 \begin_layout Description
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17105 \begin_inset Flex Code
17108 \begin_layout Plain Layout
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17129 \begin_inset Flex Code
17132 \begin_layout Plain Layout
17138 ] This tag determines whether the first line indentation of this paragraph
17139 can be toggled via the Paragraph settings dialog.
17143 \begin_inset Flex Code
17146 \begin_layout Plain Layout
17156 is set, indentation can be toggled if the document settings use
17157 \begin_inset Quotes eld
17161 \begin_inset Quotes erd
17164 paragraph style, with
17165 \begin_inset Flex Code
17168 \begin_layout Plain Layout
17174 , indentation can always be toggled, notwithstanding the document settings,
17176 \begin_inset Flex Code
17179 \begin_layout Plain Layout
17185 , indentation can never be toggled.
17188 \begin_layout Description
17189 \begin_inset Flex Code
17192 \begin_layout Plain Layout
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17208 ] The vertical space with which the very first of a chain of paragraphs
17209 with this style is separated from the previous paragraph.
17210 If the previous paragraph has another style, the separations are not simply
17211 added, but the maximum is taken.
17214 \begin_layout Subsection
17215 \begin_inset CommandInset label
17221 Internationalization of Paragraph Styles
17224 \begin_layout Standard
17226 has long supported internationalization of layout information, but, until
17227 version 2.0, this applied only to the user interface and not to, say, PDF
17229 Thus, French authors were forced to resort to ugly hacks if they wanted
17234 1' instead of `Theorem 1'.
17235 Thanks to Georg Baum, that is no longer the case.
17238 \begin_layout Standard
17240 \begin_inset Flex Code
17243 \begin_layout Plain Layout
17249 defines text that is to appear in the typeset document, it may use
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17269 to support non-English and even multi-language documents correctly.
17270 The following excerpt (from the
17271 \begin_inset Flex Code
17274 \begin_layout Plain Layout
17280 file) shows how this works:
17283 \begin_layout LyX-Code
17288 \begin_layout LyX-Code
17291 theoremstyle{remark}
17294 \begin_layout LyX-Code
17297 newtheorem{claim}[thm]{
17304 \begin_layout LyX-Code
17308 \begin_layout LyX-Code
17312 \begin_layout LyX-Code
17317 claimname}{_(Claim)}
17320 \begin_layout LyX-Code
17324 \begin_layout LyX-Code
17328 \begin_layout LyX-Code
17337 claimname}{_(Claim)}}
17340 \begin_layout LyX-Code
17345 \begin_layout Standard
17346 In principle, any legal \SpecialChar LaTeX
17348 \begin_inset Flex Code
17351 \begin_layout Plain Layout
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 tags, but in practice they will typically look as they do here.
17368 The key to correct translation of the typeset text is the definition of
17369 the \SpecialChar LaTeX
17371 \begin_inset Flex Code
17374 \begin_layout Plain Layout
17383 \begin_inset Flex Code
17386 \begin_layout Plain Layout
17398 \begin_layout Standard
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17409 tag provides for internationalization based upon the overall language of
17411 The contents of the tag will be included in the preamble, just as with
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17423 What makes it special is the use of the
17424 \begin_inset Quotes eld
17428 \begin_inset Quotes erd
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17441 , which will be replaced, when \SpecialChar LyX
17442 produces \SpecialChar LaTeX
17443 output, with the translation of
17444 its argument into the document language.
17447 \begin_layout Standard
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17458 tag is more complex, since it is meant to provide support for multi-language
17459 documents and so offers an interface to the
17460 \begin_inset Flex Code
17463 \begin_layout Plain Layout
17470 Its contents will be added to the preamble once for each language that
17471 appears in the document.
17472 In this case, the argument to
17473 \begin_inset Flex Code
17476 \begin_layout Plain Layout
17482 will be replaced with its translation into the language in question; the
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17493 is replaced by the language name (as used by the babel package).
17496 \begin_layout Standard
17497 A German document that also included a French section would thus have the
17498 following in the preamble:
17501 \begin_layout LyX-Code
17510 claimname}{Affirmation}}
17511 \begin_inset Newline newline
17522 claimname}{Behauptung}}
17523 \begin_inset Newline newline
17530 claimname}{Behauptung}
17533 \begin_layout Standard
17536 \begin_inset Flex Code
17539 \begin_layout Plain Layout
17545 will then conspire to produce the correct text in the output.
17548 \begin_layout Standard
17549 One important point to note here is that the translations are provided by
17551 itself, through the file
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17562 This means, in effect, that
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17573 \begin_inset Flex Code
17576 \begin_layout Plain Layout
17582 are really only of use in layout files that are provided with \SpecialChar LyX
17584 entered in user-created layout files will not be seen by \SpecialChar LyX
17585 's internationalizatio
17586 n routines unless the
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17596 file is modified accordingly.
17597 That said, however, any layout created with the intention that it will
17598 be included with \SpecialChar LyX
17599 should use these tags where appropriate.
17600 Please note that the paragraph style translations provided by \SpecialChar LyX
17602 change with a minor update (e.
17603 \begin_inset space \thinspace{}
17607 \begin_inset space \space{}
17610 from version 2.1.x to 2.1.y).
17611 It is however quite likely that a major update (e.
17612 \begin_inset space \thinspace{}
17616 \begin_inset space \space{}
17619 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17622 \begin_layout Subsection
17624 \begin_inset CommandInset label
17626 name "subsec:Floats"
17633 \begin_layout Standard
17634 It is necessary to define the floats (
17635 \begin_inset Flex Noun
17638 \begin_layout Plain Layout
17645 \begin_inset Flex Noun
17648 \begin_layout Plain Layout
17654 , \SpecialChar ldots
17655 ) in the text class itself.
17656 Standard floats are included in the file
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17666 , so you may have to do no more than add
17669 \begin_layout LyX-Code
17670 Input stdfloats.inc
17673 \begin_layout Standard
17674 to your layout file.
17675 If you want to implement a text class that proposes some other float types
17676 (like the AGU class bundled with \SpecialChar LyX
17677 ), the information below will hopefully
17681 \begin_layout Description
17682 \begin_inset Flex Code
17685 \begin_layout Plain Layout
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17701 =!htbpH] Allowed placement options for this float type.
17702 The value is a string of placement characters.
17703 Possible characters include:
17708 \begin_inset Quotes eld
17712 \begin_inset Quotes erd
17720 \begin_inset Quotes eld
17724 \begin_inset Quotes erd
17732 \begin_inset Quotes eld
17736 \begin_inset Quotes erd
17744 \begin_inset Quotes eld
17748 \begin_inset Quotes erd
17756 \begin_inset Quotes eld
17760 \begin_inset Quotes erd
17768 \begin_inset Quotes eld
17772 \begin_inset Quotes erd
17776 The order of the characters in the string does not matter.
17777 If no placement options are allowed, use the string
17784 \begin_layout Description
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17807 \begin_inset space \thinspace{}
17813 \begin_inset Flex Code
17816 \begin_layout Plain Layout
17826 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17833 \begin_inset Flex Code
17836 \begin_layout Plain Layout
17842 if the float does not support this feature.
17845 \begin_layout Description
17846 \begin_inset Flex Code
17849 \begin_layout Plain Layout
17856 \begin_inset Flex Code
17859 \begin_layout Plain Layout
17868 \begin_inset space \thinspace{}
17874 \begin_inset Flex Code
17877 \begin_layout Plain Layout
17887 ] Defines whether the float has a starred variant that spans columns in
17888 a two column paragraph.
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17899 if the float does not support this feature.
17902 \begin_layout Description
17903 \begin_inset Flex Code
17906 \begin_layout Plain Layout
17913 \begin_inset Flex Code
17916 \begin_layout Plain Layout
17923 \begin_inset Quotes erd
17927 \begin_inset Quotes erd
17930 ] The file name extension of an auxiliary file for the list of figures (or
17933 writes the captions to this file.
17936 \begin_layout Description
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17957 \begin_inset Quotes erd
17961 \begin_inset Quotes erd
17964 ] The string that will be used in the menus and also for the caption.
17965 This is translated to the current language if babel is used.
17968 \begin_layout Description
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17978 These tags control the XHTML output.
17980 \begin_inset CommandInset ref
17982 reference "sec:Tags-for-XHTML"
17989 \begin_layout Description
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18002 \begin_inset Flex Code
18005 \begin_layout Plain Layout
18014 \begin_inset space \thinspace{}
18018 \begin_inset Flex Code
18021 \begin_layout Plain Layout
18027 ] Indicates whether the float is already defined in the document class or
18028 if instead the \SpecialChar LaTeX
18030 \begin_inset Flex Code
18033 \begin_layout Plain Layout
18039 needs to be loaded to define it on-the-fly.
18041 \begin_inset Flex Code
18044 \begin_layout Plain Layout
18051 \begin_inset Flex Code
18054 \begin_layout Plain Layout
18061 It should be set to
18062 \begin_inset Flex Code
18065 \begin_layout Plain Layout
18071 if the float is already defined by the \SpecialChar LaTeX
18075 \begin_layout Description
18076 \begin_inset Flex Code
18079 \begin_layout Plain Layout
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18096 \begin_inset Quotes erd
18100 \begin_inset Quotes erd
18103 ] The command used to generate a list of floats of this type; the leading
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 is false, since there is no standard way to generate this command.
18123 \begin_inset Flex Code
18126 \begin_layout Plain Layout
18132 is true, since in that case there is a standard way to define the command.
18135 \begin_layout Description
18136 \begin_inset Flex Code
18139 \begin_layout Plain Layout
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18156 \begin_inset Quotes erd
18160 \begin_inset Quotes erd
18163 ] A title for a list of floats of this kind (list of figures, tables, or
18165 It is used for the screen label within \SpecialChar LyX
18166 , it is used by \SpecialChar LaTeX
18168 it is used as the title in the XHTML output.
18169 It will be translated to the document language.
18172 \begin_layout Description
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18193 \begin_inset Quotes erd
18197 \begin_inset Quotes erd
18200 ] This (optional) argument determines whether floats of this class will
18201 be numbered within some sectional unit of the document.
18203 \begin_inset Flex Code
18206 \begin_layout Plain Layout
18213 \begin_inset Quotes eld
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18227 \begin_inset Quotes erd
18230 , the floats will be numbered within chapters.
18234 \begin_layout Description
18235 \begin_inset Flex Code
18238 \begin_layout Plain Layout
18245 \begin_inset Flex Code
18248 \begin_layout Plain Layout
18255 \begin_inset Quotes erd
18259 \begin_inset Quotes erd
18262 ] The default placement for the given class of floats.
18263 The string should be as in standard \SpecialChar LaTeX
18265 \begin_inset Flex Code
18268 \begin_layout Plain Layout
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18295 \begin_inset Flex Code
18298 \begin_layout Plain Layout
18304 for top, bottom, page, and here, respectively.
18308 \begin_layout Plain Layout
18309 Note that the order of these letters in the string is irrelevant, like in
18316 On top of that there is a new type,
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18326 , which does not really correspond to a float, since it means: put it
18327 \begin_inset Quotes eld
18331 \begin_inset Quotes erd
18335 Note however that the
18336 \begin_inset Flex Code
18339 \begin_layout Plain Layout
18345 specifier is special and, because of implementation details, cannot be
18346 used in non-built in float types.
18347 If you do not understand what this means, just use
18348 \begin_inset Quotes eld
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18362 \begin_inset Quotes erd
18368 \begin_layout Description
18369 \begin_inset Flex Code
18372 \begin_layout Plain Layout
18379 \begin_inset Flex Code
18382 \begin_layout Plain Layout
18388 ] The prefix to use when creating labels referring to floats of this type.
18389 This allows the use of formatted references.
18390 Note that you can remove any
18391 \begin_inset Flex Code
18394 \begin_layout Plain Layout
18400 set by a copied style by using the special value
18401 \begin_inset Quotes eld
18405 \begin_inset Quotes erd
18408 , which must be all caps.
18409 \change_inserted -712698321 1565605014
18413 \begin_layout Description
18415 \change_inserted -712698321 1565605014
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18421 \change_inserted -712698321 1565605014
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18433 \change_inserted -712698321 1565605014
18439 ] As with paragraph styles, see
18440 \begin_inset CommandInset ref
18442 reference "subsec:Paragraph-Styles"
18451 \begin_layout Description
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18472 \begin_inset Quotes erd
18476 \begin_inset Quotes erd
18479 ] The style used when defining the float using
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18494 \begin_layout Description
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18515 \begin_inset Quotes erd
18519 \begin_inset Quotes erd
18523 \begin_inset Quotes eld
18527 \begin_inset Quotes erd
18530 of the new class of floats, like program or algorithm.
18531 After the appropriate
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18556 \begin_inset Flex Code
18559 \begin_layout Plain Layout
18570 \begin_layout Description
18571 \begin_inset Flex Code
18574 \begin_layout Plain Layout
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18591 \begin_inset space \thinspace{}
18595 \begin_inset Flex Code
18598 \begin_layout Plain Layout
18606 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18608 \begin_inset Flex Code
18611 \begin_layout Plain Layout
18617 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18621 \begin_layout Standard
18622 Note that defining a float with type
18623 \begin_inset Flex Code
18626 \begin_layout Plain Layout
18634 automatically defines the corresponding counter with name
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18649 \begin_layout Subsection
18650 Flex insets and InsetLayout
18651 \begin_inset CommandInset label
18653 name "subsec:Flex-insets-and"
18660 \begin_layout Standard
18661 Flex insets come in three different kinds:
18664 \begin_layout Itemize
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18675 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18703 \begin_layout Itemize
18705 \begin_inset Flex Code
18708 \begin_layout Plain Layout
18714 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18716 footnote, and the like.
18717 An obvious example is an endnote inset, which is defined in the
18718 \begin_inset Flex Code
18721 \begin_layout Plain Layout
18730 \begin_layout Itemize
18732 \begin_inset Flex Code
18735 \begin_layout Plain Layout
18741 ): For use with DocBook classes.
18744 \begin_layout Standard
18745 Flex insets are defined using the
18746 \begin_inset Flex Code
18749 \begin_layout Plain Layout
18755 tag, which shall be explained in a moment.
18758 \begin_layout Standard
18760 \begin_inset Flex Code
18763 \begin_layout Plain Layout
18769 tag also serves another function: It can be used to customize the general
18770 layout of many different types of insets.
18772 \begin_inset Flex Code
18775 \begin_layout Plain Layout
18781 can be used to customize the layout parameters for footnotes, marginal
18782 notes, note insets, \SpecialChar TeX
18783 code (ERT) insets, branches, listings, indexes, boxes,
18784 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18787 \begin_layout Standard
18789 \begin_inset Flex Code
18792 \begin_layout Plain Layout
18798 definition must begin with a line of the form:
18801 \begin_layout LyX-Code
18805 \begin_layout Standard
18807 \begin_inset Flex Code
18810 \begin_layout Plain Layout
18816 indicates the inset whose layout is being defined, and here there are four
18820 \begin_layout Enumerate
18821 The layout for a pre-existing inset is being modified.
18822 In this case, can be
18823 \begin_inset Flex Code
18826 \begin_layout Plain Layout
18832 any one of the following:
18833 \begin_inset Flex Code
18836 \begin_layout Plain Layout
18843 \begin_inset Flex Code
18846 \begin_layout Plain Layout
18853 \begin_inset Flex Code
18856 \begin_layout Plain Layout
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18883 \begin_inset Flex Code
18886 \begin_layout Plain Layout
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18913 \begin_inset Flex Code
18916 \begin_layout Plain Layout
18923 \begin_inset Flex Code
18926 \begin_layout Plain Layout
18933 \begin_inset Flex Code
18936 \begin_layout Plain Layout
18943 \begin_inset Flex Code
18946 \begin_layout Plain Layout
18953 \begin_inset Flex Code
18956 \begin_layout Plain Layout
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18983 \begin_inset Flex Code
18986 \begin_layout Plain Layout
18993 \begin_inset Flex Code
18996 \begin_layout Plain Layout
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19013 \begin_inset Flex Code
19016 \begin_layout Plain Layout
19023 \begin_inset Flex Code
19026 \begin_layout Plain Layout
19035 \begin_layout Enumerate
19036 The layout for a Flex inset is being defined.
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19047 must be of the form
19048 \begin_inset Quotes eld
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19062 \begin_inset Quotes erd
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19075 may be be any valid identifier not used by a pre-existing Flex inset.
19076 The identifier may include spaces, but in that case the whole thing must
19077 be wrapped in quotes.
19078 Note that the definition of a flex inset
19083 \begin_inset Flex Code
19086 \begin_layout Plain Layout
19092 entry, declaring which type of inset it defines.
19095 \begin_layout Enumerate
19096 The layout for user specific branch is being defined.
19098 \begin_inset Flex Code
19101 \begin_layout Plain Layout
19107 must be of the form
19108 \begin_inset Quotes eld
19112 \begin_inset Flex Code
19115 \begin_layout Plain Layout
19122 \begin_inset Quotes erd
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19135 may be be any valid identifier of branch defined in user's document.
19136 The identifier may include spaces, but in that case the whole thing must
19137 be wrapped in quotes.
19138 The main purpose of this feature is to allow \SpecialChar LaTeX
19139 wrapping around specific
19140 branches as user needs.
19143 \begin_layout Enumerate
19144 The layout of a user (or class) specific caption is being defined.
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19155 must be of the form
19156 \begin_inset Quotes eld
19160 \begin_inset Flex Code
19163 \begin_layout Plain Layout
19170 \begin_inset Quotes erd
19174 \begin_inset Flex Code
19177 \begin_layout Plain Layout
19183 specifies the name of the caption as it appears in the menu.
19184 Have a look at the standard caption (
19185 \begin_inset Flex Code
19188 \begin_layout Plain Layout
19194 ), the specific captions of the KOMA-Script classes (
19195 \begin_inset Flex Code
19198 \begin_layout Plain Layout
19205 \begin_inset Flex Code
19208 \begin_layout Plain Layout
19217 \begin_inset space ~
19221 \begin_inset Newline linebreak
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19236 ) for applications.
19239 \begin_layout Standard
19241 \begin_inset Flex Code
19244 \begin_layout Plain Layout
19250 definition can contain the following entries:
19253 \begin_layout Description
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19264 \begin_inset Flex Code
19267 \begin_layout Plain Layout
19273 =""] This inset will appear in the table of contents of the given type.
19274 An empty string disables.
19275 See also the OutlinerName and the IsTocCaption commands.
19276 This is only implemented for Flex insets.
19280 \begin_layout Description
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19291 \begin_inset Flex Code
19294 \begin_layout Plain Layout
19300 ] Defines argument number of a command\SpecialChar breakableslash
19301 environment associated with the current
19303 The definition must end with
19304 \begin_inset Flex Code
19307 \begin_layout Plain Layout
19315 \begin_inset CommandInset ref
19317 reference "subsec:Paragraph-Styles"
19324 \begin_layout Description
19325 \begin_inset Flex Code
19328 \begin_layout Plain Layout
19334 Preamble for changing language commands; see
19335 \begin_inset CommandInset ref
19337 reference "subsec:I18n"
19344 \begin_layout Description
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19355 \begin_inset Flex Code
19358 \begin_layout Plain Layout
19364 ] The color for the inset's background.
19366 \begin_inset CommandInset ref
19368 reference "chap:Names-of-colors"
19372 for a list of the available color names.
19375 \begin_layout Description
19376 \begin_inset Flex Code
19379 \begin_layout Plain Layout
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19398 \begin_inset space \thinspace{}
19402 \begin_inset Flex Code
19405 \begin_layout Plain Layout
19411 ] Whether to use the content of the inset as the label, when the inset is
19416 \begin_layout Description
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19436 ] As with paragraph styles, see
19437 \begin_inset CommandInset ref
19439 reference "subsec:Paragraph-Styles"
19444 Note that you need to specify the complete type, e.
19445 \begin_inset space \thinspace{}
19449 \begin_inset space ~
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19457 CopyStyle Flex:<name>
19465 \begin_layout Description
19466 \begin_inset Flex Code
19469 \begin_layout Plain Layout
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19488 \begin_inset space \thinspace{}
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19501 ] Indicates whether the user may employ the Paragraph Settings dialog to
19502 customize the paragraph.
19505 \begin_layout Description
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19516 \begin_inset Flex Code
19519 \begin_layout Plain Layout
19526 \begin_inset Flex Code
19529 \begin_layout Plain Layout
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19545 , describing the rendering style used for the inset's frame and buttons.
19546 Footnotes generally use
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19556 , ERT insets generally
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19566 , and character styles
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19579 \begin_layout Description
19580 \begin_inset Flex Code
19583 \begin_layout Plain Layout
19590 \begin_inset Flex Code
19593 \begin_layout Plain Layout
19602 \begin_inset space \thinspace{}
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19640 Indicates whether the environment will stand on its own in the output or
19641 will appear inline with the surrounding text.
19642 If set to false, it is supposed that the \SpecialChar LaTeX
19643 environment ignores white space
19644 (including one newline character) after the
19645 \begin_inset Flex Code
19648 \begin_layout Plain Layout
19661 \begin_inset Flex Code
19664 \begin_layout Plain Layout
19678 \change_inserted 731793113 1538674858
19682 \begin_layout Description
19684 \change_inserted 731793113 1538674891
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19690 \change_inserted 731793113 1538674863
19702 ,1] Allow the contents of the inset to be edited externally (using whatever
19703 editor is defined for the document's output format).
19708 \begin_layout Description
19709 \begin_inset Flex Code
19712 \begin_layout Plain Layout
19718 Required at the end of the
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19731 \begin_layout Description
19732 \begin_inset Flex Code
19735 \begin_layout Plain Layout
19741 The font used for both the text body
19747 \begin_inset CommandInset ref
19749 reference "subsec:Font-description"
19754 Note that defining this font automatically defines the
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19764 to the same value, so define this first and define
19765 \begin_inset Flex Code
19768 \begin_layout Plain Layout
19774 later if you want them to be different.
19777 \begin_layout Description
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19782 FixedWidthPreambleEncoding
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19800 \begin_inset space \thinspace{}
19804 \begin_inset Flex Code
19807 \begin_layout Plain Layout
19813 ] Force a fixed width encoding for the translated contents of
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19833 code generated by this layout.
19834 This is needed for special \SpecialChar LaTeX
19839 that do not work with variable width encodings such as
19844 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19845 backends such as Xe\SpecialChar TeX
19847 Lua\SpecialChar TeX
19851 \begin_layout Description
19852 \begin_inset Flex Code
19855 \begin_layout Plain Layout
19856 ForceLocalFontSwitch
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19874 \begin_inset space \thinspace{}
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19887 ] When using babel, always use a local font switch (
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19899 ), never a global one (such as
19900 \begin_inset Flex Code
19903 \begin_layout Plain Layout
19914 \begin_layout Description
19915 \begin_inset Flex Code
19918 \begin_layout Plain Layout
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19937 \begin_inset space \thinspace{}
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19951 \begin_inset Quotes eld
19955 \begin_inset Quotes erd
19958 language, leading to Left-to-Right (Latin) output, e.
19959 \begin_inset space \thinspace{}
19963 \begin_inset space \space{}
19966 in \SpecialChar TeX
19971 \begin_layout Description
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19994 \begin_inset space \thinspace{}
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20007 ] Force a a line break in the \SpecialChar LaTeX
20008 output before the inset starts and after
20010 This assures the inset itself is output on its own lines, for parsing purposes.
20013 \begin_layout Description
20014 \begin_inset Flex Code
20017 \begin_layout Plain Layout
20024 \begin_inset Flex Code
20027 \begin_layout Plain Layout
20036 \begin_inset space \thinspace{}
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20049 ] Indicates whether the
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20059 should be used or, instead, the user can change the paragraph style used
20064 \begin_layout Description
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20075 \begin_inset Flex Code
20078 \begin_layout Plain Layout
20087 \begin_inset space \thinspace{}
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20100 ] As with paragraph styles, see
20101 \begin_inset CommandInset ref
20103 reference "subsec:Paragraph-Styles"
20110 \begin_layout Description
20111 \begin_inset Flex Code
20114 \begin_layout Plain Layout
20120 These tags control the XHTML output.
20122 \begin_inset CommandInset ref
20124 reference "sec:Tags-for-XHTML"
20131 \begin_layout Description
20132 \begin_inset Flex Code
20135 \begin_layout Plain Layout
20142 \begin_inset Flex Code
20145 \begin_layout Plain Layout
20154 \begin_inset space \thinspace{}
20158 \begin_inset Flex Code
20161 \begin_layout Plain Layout
20167 ] Whether to include the contents of this inset in the strings generated
20168 for the `Outline' pane for all table of contents, regardless of the AddToToc
20170 One would not, for example, want the content of a footnote in a section
20171 header to be included in the TOC displayed in the outline, but one would
20172 normally want the content of a character style displayed.
20173 Default is false: not to include.
20176 \begin_layout Description
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20187 \begin_inset Flex Code
20190 \begin_layout Plain Layout
20199 \begin_inset space \thinspace{}
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20212 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20213 of its contents in its item in the table of contents.
20214 Otherwise, only the label appears.
20217 \begin_layout Description
20218 \begin_inset Flex Code
20221 \begin_layout Plain Layout
20230 \begin_inset Flex Code
20233 \begin_layout Plain Layout
20242 \begin_inset space \thinspace{}
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20255 ] As with paragraph styles, see
20256 \begin_inset CommandInset ref
20258 reference "subsec:Paragraph-Styles"
20265 \begin_layout Description
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20275 The font used for the label.
20277 \begin_inset CommandInset ref
20279 reference "subsec:Font-description"
20284 Note that this definition can never appear before
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20294 , lest it be ineffective.
20297 \begin_layout Description
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20318 \begin_inset Quotes erd
20322 \begin_inset Quotes erd
20325 ] What will be displayed on the button or elsewhere as the inset label.
20327 \begin_inset Flex Code
20330 \begin_layout Plain Layout
20338 \begin_inset Flex Code
20341 \begin_layout Plain Layout
20347 ) modify this label on the fly.
20350 \begin_layout Description
20351 \begin_inset Flex Code
20354 \begin_layout Plain Layout
20360 Language dependent preamble; see
20361 \begin_inset CommandInset ref
20363 reference "subsec:I18n"
20370 \begin_layout Description
20371 \begin_inset Flex Code
20374 \begin_layout Plain Layout
20381 \begin_inset Flex Code
20384 \begin_layout Plain Layout
20390 ] The name of the corresponding \SpecialChar LaTeX
20392 Either the environment or command name.
20395 \begin_layout Description
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20415 ] The optional parameter for the corresponding
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20425 stuff, including possible bracket pairs like
20426 \begin_inset Flex Code
20429 \begin_layout Plain Layout
20436 This parameter cannot be changed from within \SpecialChar LyX
20438 \begin_inset Flex Code
20441 \begin_layout Plain Layout
20447 for customizable parameters).
20448 It will be output as is after all \SpecialChar LaTeX
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20462 \begin_layout Description
20463 \begin_inset Flex Code
20466 \begin_layout Plain Layout
20473 \begin_inset Flex Code
20476 \begin_layout Plain Layout
20477 Command, Environment, None
20482 ] How the style should be translated into \SpecialChar LaTeX
20487 \begin_layout Plain Layout
20488 \begin_inset Flex Code
20491 \begin_layout Plain Layout
20497 is perhaps a bit misleading, since these rules apply to SGML classes too.
20498 Visit the SGML class files for specific examples.
20507 \begin_layout Description
20508 \begin_inset Flex Code
20511 \begin_layout Plain Layout
20517 means nothing special
20520 \begin_layout Description
20521 \begin_inset Flex Code
20524 \begin_layout Plain Layout
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20541 {\SpecialChar ldots
20550 \begin_layout Description
20551 \begin_inset Flex Code
20554 \begin_layout Plain Layout
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20571 }\SpecialChar ldots
20586 \begin_layout Standard
20587 Putting the last few things together, the \SpecialChar LaTeX
20588 output will be either:
20591 \begin_layout LyX-Code
20594 LatexName[LatexParam]{\SpecialChar ldots
20598 \begin_layout Standard
20602 \begin_layout LyX-Code
20605 begin{LatexName}[LatexParam] \SpecialChar ldots
20611 \begin_layout Standard
20612 depending upon the \SpecialChar LaTeX
20617 \begin_layout Description
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20637 ] A string that is put at the beginning of the layout content.
20638 A line break in the output can be indicated by
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20651 \begin_layout Description
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20682 \begin_inset Flex Code
20685 \begin_layout Plain Layout
20692 \begin_inset Flex Code
20695 \begin_layout Plain Layout
20701 (indicating a dummy definition ending definitions of charstyles, etc).
20702 This entry is required in and is only meaningful for Flex insets.
20703 Among other things, it determines on which menu this inset will appear.
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20724 will automatically set
20725 \begin_inset Flex Code
20728 \begin_layout Plain Layout
20735 \begin_inset Flex Code
20738 \begin_layout Plain Layout
20746 \begin_inset Flex Code
20749 \begin_layout Plain Layout
20755 can be set to true, or
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20766 \begin_inset Flex Code
20769 \begin_layout Plain Layout
20775 insets by setting it
20780 \begin_inset Flex Code
20783 \begin_layout Plain Layout
20790 \change_inserted -712698321 1555575738
20794 \begin_layout Description
20796 \change_inserted -712698321 1555575844
20797 \begin_inset Flex Code
20800 \begin_layout Plain Layout
20802 \change_inserted -712698321 1555575740
20809 \begin_inset Flex Code
20812 \begin_layout Plain Layout
20814 \change_inserted -712698321 1555575740
20820 A dedicated string for the menu.
20821 You can define an accelerator by appending the respective character to
20822 the string, divided by
20823 \begin_inset Quotes eld
20827 \begin_inset Quotes erd
20831 \begin_inset space \thinspace{}
20835 \begin_inset space \space{}
20839 \begin_inset Quotes eld
20843 \begin_inset Flex Code
20846 \begin_layout Plain Layout
20848 \change_inserted -712698321 1555575781
20855 \begin_inset Quotes erd
20859 This specification is optional.
20860 If it is not given the inset name as specified in the type declaration
20861 will be used instead for the menu.
20866 \begin_layout Description
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20877 \begin_inset Flex Code
20880 \begin_layout Plain Layout
20889 \begin_inset space \thinspace{}
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20902 ] Whether multiple paragraphs are permitted in this inset.
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20913 to the same value and
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20923 to the opposite value.
20924 These can be reset to other values, if they are used
20929 \begin_inset Flex Code
20932 \begin_layout Plain Layout
20942 \begin_layout Description
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20965 \begin_inset space \thinspace{}
20969 \begin_inset Flex Code
20972 \begin_layout Plain Layout
20978 ] Whether fragile commands in this inset should be
20979 \begin_inset Flex Code
20982 \begin_layout Plain Layout
20995 whether the command should itself be protected.) Default is false.
20996 \change_inserted -712698321 1523633958
21000 \begin_layout Description
21002 \change_inserted -712698321 1552395786
21003 \begin_inset Flex Code
21006 \begin_layout Plain Layout
21008 \change_inserted -712698321 1523633961
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21020 \change_inserted -712698321 1523633958
21029 \begin_inset space \thinspace{}
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21038 \change_inserted -712698321 1523633958
21044 ] This causes macros that contain this inset to be protected with
21045 \begin_inset Flex Code
21048 \begin_layout Plain Layout
21050 \change_inserted -712698321 1523634038
21065 ) if necessary and thus allows (some) verbatim stuff in macros.
21069 \begin_layout Description
21071 \change_inserted -712698321 1555579651
21072 \begin_inset Flex Code
21075 \begin_layout Plain Layout
21077 \change_inserted -712698321 1552395787
21084 \begin_inset Flex Code
21087 \begin_layout Plain Layout
21089 \change_inserted -712698321 1552395787
21098 \begin_inset space \thinspace{}
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21107 \change_inserted -712698321 1552395787
21113 ] Whether specific commands in this inset (such as
21114 \begin_inset Flex Code
21117 \begin_layout Plain Layout
21119 \change_inserted -712698321 1552395787
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21133 \change_inserted -712698321 1552395787
21141 ) should be protected in an
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21147 \change_inserted -712698321 1552395787
21156 This is particularly needed for insets that draw on
21164 commands which parse their content in complex ways.
21168 \begin_layout Description
21170 \change_inserted -712698321 1555579742
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21176 \change_inserted -712698321 1555579658
21183 \begin_inset Flex Code
21186 \begin_layout Plain Layout
21188 \change_inserted -712698321 1555579651
21194 Option to define a different command (from the default
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21200 \change_inserted -712698321 1555579742
21212 ) to be used for line breaks.
21213 The initial backslash must not be specified.
21218 \begin_layout Description
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21238 ] Deletes an existing
21239 \begin_inset Flex Code
21242 \begin_layout Plain Layout
21251 \begin_layout Description
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21262 \begin_inset Flex Code
21265 \begin_layout Plain Layout
21272 \begin_inset Flex Code
21275 \begin_layout Plain Layout
21281 that has replaced this
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21292 This is used to rename an
21293 \begin_inset Flex Code
21296 \begin_layout Plain Layout
21302 , while keeping backward compatibility.
21303 \change_inserted -712698321 1559491850
21307 \begin_layout Description
21309 \change_inserted -712698321 1559492002
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21315 \change_inserted -712698321 1559491854
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21327 \change_inserted -712698321 1559491850
21336 \begin_inset space \thinspace{}
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21345 \change_inserted -712698321 1559491850
21351 ] If this is set to
21352 \begin_inset Flex Code
21355 \begin_layout Plain Layout
21357 \change_inserted -712698321 1559491881
21365 , paragraph breaks will be ignored in the output.
21366 This might be useful for insets where the content should be alignable on
21367 different lines only in the \SpecialChar LyX
21368 workarea, without any effect in the output.
21373 \begin_layout Description
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21384 \begin_inset Flex Code
21387 \begin_layout Plain Layout
21396 \begin_inset space \thinspace{}
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21409 ] As with paragraph styles, see
21410 \begin_inset CommandInset ref
21412 reference "subsec:Paragraph-Styles"
21420 \begin_layout Description
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21443 \begin_inset space \thinspace{}
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21456 ] As with paragraph styles, see
21457 \begin_inset CommandInset ref
21459 reference "subsec:Paragraph-Styles"
21467 \begin_layout Description
21468 \begin_inset Flex Code
21471 \begin_layout Plain Layout
21477 As with paragraph styles, see
21478 \begin_inset CommandInset ref
21480 reference "subsec:Paragraph-Styles"
21487 \begin_layout Description
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21498 \begin_inset Flex Code
21501 \begin_layout Plain Layout
21507 ] The prefix to use when creating labels referring to insets of this type.
21508 This allows the use of formatted references.
21511 \begin_layout Description
21512 \begin_inset Flex Code
21515 \begin_layout Plain Layout
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21531 ] As with paragraph styles, see
21532 \begin_inset CommandInset ref
21534 reference "subsec:Paragraph-Styles"
21541 \begin_layout Description
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21552 \begin_inset Flex Code
21555 \begin_layout Plain Layout
21564 \begin_inset space \thinspace{}
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21577 ] Resets the \SpecialChar LaTeX
21578 arguments of this layout (as defined via the
21579 \begin_inset Flex Code
21582 \begin_layout Plain Layout
21589 This is useful if you have copied a style via
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21599 , but you do not want to inherit its (required and optional) arguments.
21602 \begin_layout Description
21603 \begin_inset Flex Code
21606 \begin_layout Plain Layout
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21623 \begin_inset space \thinspace{}
21627 \begin_inset Flex Code
21630 \begin_layout Plain Layout
21638 ] Whether this inset should use the font of its surrounding environment
21640 Default is false: use the font of the surrounding environment.
21643 \begin_layout Description
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21663 ] A string that is put at the end of the layout content.
21664 A line break in the output can be indicated by
21665 \begin_inset Flex Code
21668 \begin_layout Plain Layout
21677 \begin_layout Description
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21688 \begin_inset Flex Code
21691 \begin_layout Plain Layout
21698 \begin_inset space \thinspace{}
21702 \begin_inset Flex Code
21705 \begin_layout Plain Layout
21713 ] Allow spell-checking the contents of this inset.
21717 \begin_layout Subsection
21719 \begin_inset CommandInset label
21721 name "subsec:Counters"
21728 \begin_layout Standard
21729 It is necessary to define the counters (
21730 \begin_inset Flex Noun
21733 \begin_layout Plain Layout
21740 \begin_inset Flex Noun
21743 \begin_layout Plain Layout
21749 , \SpecialChar ldots
21750 ) in the text class itself.
21751 The standard counters are defined in the file
21752 \begin_inset Flex Code
21755 \begin_layout Plain Layout
21761 , so you may have to do no more than add
21764 \begin_layout LyX-Code
21765 Input stdcounters.inc
21768 \begin_layout Standard
21769 to your layout file to get them to work.
21770 But if you want to define custom counters, then you can do so.
21771 The counter declaration must begin with:
21774 \begin_layout LyX-Code
21775 Counter CounterName
21778 \begin_layout Standard
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21789 ' is replaced by the name of the counter.
21790 And it must end with
21791 \begin_inset Quotes eld
21795 \begin_inset Flex Code
21798 \begin_layout Plain Layout
21805 \begin_inset Quotes erd
21809 The following parameters can also be used:
21812 \begin_layout Description
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21832 ] Sets the initial value for the counter, to which it will be reset whenever
21834 Normally, one will want the default, 1.
21837 \begin_layout Description
21838 \begin_inset Flex Code
21841 \begin_layout Plain Layout
21848 \begin_inset Flex Code
21851 \begin_layout Plain Layout
21858 \begin_inset Quotes erd
21862 \begin_inset Quotes erd
21865 ] When defined, this string defines how the counter is displayed.
21866 Setting this value sets
21867 \begin_inset Flex Code
21870 \begin_layout Plain Layout
21871 LabelStringAppendix
21877 The following special constructs can be used in the string:
21881 \begin_layout Itemize
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21893 will be replaced by the expansion of the
21894 \begin_inset Flex Code
21897 \begin_layout Plain Layout
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21908 LabelStringAppendix
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21927 \begin_layout Itemize
21928 counter values can be expressed using \SpecialChar LaTeX
21930 \begin_inset Newline newline
21934 \begin_inset Flex Code
21937 \begin_layout Plain Layout
21954 \begin_inset Flex Code
21957 \begin_layout Plain Layout
21969 \begin_layout Plain Layout
21979 Actually, the situation is a bit more complicated: any
21998 other than those described below will produce arabic numerals.
21999 It would not be surprising to see this change in the future.
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22014 : 1, 2, 3,\SpecialChar ldots
22016 \begin_inset Flex Code
22019 \begin_layout Plain Layout
22025 for lower-case letters: a, b, c, \SpecialChar ldots
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22036 for upper-case letters: A, B, C, \SpecialChar ldots
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22047 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22058 for upper-case roman numerals: I, II, III\SpecialChar ldots
22060 \begin_inset Flex Code
22063 \begin_layout Plain Layout
22069 for hebrew numerals.
22073 \begin_layout Standard
22074 If LabelString is not defined, a default value is constructed as follows:
22075 if the counter has a master counter
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22096 \begin_inset Newline newline
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22113 is used; otherwise the string
22114 \begin_inset Flex Code
22117 \begin_layout Plain Layout
22128 \begin_layout Description
22129 \begin_inset Flex Code
22132 \begin_layout Plain Layout
22133 LabelStringAppendix
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22149 \begin_inset Quotes erd
22153 \begin_inset Quotes erd
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22166 , but for use in the Appendix.
22169 \begin_layout Description
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22190 \begin_inset Quotes erd
22194 \begin_inset Quotes erd
22197 ] A format for use with formatted references to this counter.
22198 For example, one might want to have references to section numbers appear
22200 \begin_inset Quotes eld
22204 \begin_inset Quotes erd
22208 The string should contain
22209 \begin_inset Quotes eld
22213 \begin_inset Quotes erd
22217 This will be replaced by the counter number itself.
22218 So, for sections, it would be: Section ##.
22221 \begin_layout Description
22222 \begin_inset Flex Code
22225 \begin_layout Plain Layout
22232 \begin_inset Flex Code
22235 \begin_layout Plain Layout
22242 \begin_inset Quotes erd
22246 \begin_inset Quotes erd
22249 ] If this is set to the name of another counter, the present counter will
22250 be reset every time the other one is increased.
22252 \begin_inset Flex Code
22255 \begin_layout Plain Layout
22262 \begin_inset Flex Code
22265 \begin_layout Plain Layout
22274 \begin_layout Subsection
22276 \begin_inset CommandInset label
22278 name "subsec:Font-description"
22285 \begin_layout Standard
22286 A font description looks like this:
22289 \begin_layout LyX-Code
22306 \begin_layout LyX-Code
22310 \begin_layout LyX-Code
22314 \begin_layout Standard
22315 The following commands are available:
22318 \begin_layout Description
22319 \begin_inset Flex Code
22322 \begin_layout Plain Layout
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22341 \begin_inset Flex Code
22344 \begin_layout Plain Layout
22351 \begin_inset Flex Code
22354 \begin_layout Plain Layout
22361 \begin_inset Flex Code
22364 \begin_layout Plain Layout
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22381 \begin_inset Flex Code
22384 \begin_layout Plain Layout
22391 \begin_inset Flex Code
22394 \begin_layout Plain Layout
22401 \begin_inset Flex Code
22404 \begin_layout Plain Layout
22411 \begin_inset Flex Code
22414 \begin_layout Plain Layout
22421 \begin_inset Flex Code
22424 \begin_layout Plain Layout
22431 \begin_inset Flex Code
22434 \begin_layout Plain Layout
22441 \begin_inset Flex Code
22444 \begin_layout Plain Layout
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22491 \begin_inset Flex Code
22494 \begin_layout Plain Layout
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22521 \begin_inset Flex Code
22524 \begin_layout Plain Layout
22533 \begin_layout Description
22534 \begin_inset Flex Code
22537 \begin_layout Plain Layout
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22566 \begin_inset Flex Code
22569 \begin_layout Plain Layout
22578 \begin_layout Description
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22598 ] Valid arguments are:
22599 \begin_inset Flex Code
22602 \begin_layout Plain Layout
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22619 \begin_inset Flex Code
22622 \begin_layout Plain Layout
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22639 \begin_inset Flex Code
22642 \begin_layout Plain Layout
22649 \begin_inset Flex Code
22652 \begin_layout Plain Layout
22659 \begin_inset Flex Code
22662 \begin_layout Plain Layout
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22689 \begin_inset Flex Code
22692 \begin_layout Plain Layout
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22709 \begin_inset Flex Code
22712 \begin_layout Plain Layout
22719 Each of these turns on or off the corresponding attribute.
22721 \begin_inset Flex Code
22724 \begin_layout Plain Layout
22730 turns on emphasis, and
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22742 \begin_inset Newline newline
22745 If the latter seems puzzling, remember that the font settings for the present
22746 context are generally inherited from the surrounding context.
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22757 would turn off the emphasis that was anyway in effect, say, in a theorem
22761 \begin_layout Description
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22784 \begin_inset Flex Code
22787 \begin_layout Plain Layout
22796 \begin_layout Description
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22819 \begin_inset Flex Code
22822 \begin_layout Plain Layout
22829 \begin_inset Flex Code
22832 \begin_layout Plain Layout
22839 \begin_inset Flex Code
22842 \begin_layout Plain Layout
22851 \begin_layout Description
22852 \begin_inset Flex Code
22855 \begin_layout Plain Layout
22862 \begin_inset Flex Code
22865 \begin_layout Plain Layout
22872 \begin_inset Flex Code
22875 \begin_layout Plain Layout
22882 \begin_inset Flex Code
22885 \begin_layout Plain Layout
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22946 \begin_layout Subsection
22947 \begin_inset CommandInset label
22949 name "subsec:Citation-engine-description"
22953 Cite engine description
22956 \begin_layout Standard
22958 \begin_inset Flex Code
22961 \begin_layout Plain Layout
22967 blocks, as used mainly in cite engine files (see
22968 \begin_inset CommandInset ref
22970 reference "subsec:Cite-Engine-Files"
22977 ), define the citation commands provided by a specific
22978 \begin_inset Quotes eld
22982 \begin_inset Quotes erd
22986 A cite engine, in \SpecialChar LyX
22987 terms, is way specific way to format citations, using
22988 numbers, author names and/or years.
22989 Currently, \SpecialChar LyX
22990 supports three such engine types, namely:
22993 \begin_layout Enumerate
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
23003 : the default Bib\SpecialChar TeX
23004 way to format citations, a simple numeric style (e.
23005 \begin_inset space \thinspace{}
23009 \begin_inset Quotes eld
23013 \begin_inset Quotes erd
23019 \begin_layout Enumerate
23020 \begin_inset Flex Code
23023 \begin_layout Plain Layout
23029 : Harvard-styled citations using author names and publication year (e.
23030 \begin_inset space \thinspace{}
23034 \begin_inset Quotes eld
23037 Smith and Miller (2017b)
23038 \begin_inset Quotes erd
23044 \begin_layout Enumerate
23045 \begin_inset Flex Code
23048 \begin_layout Plain Layout
23054 : extended numerical citations that also allow for author or title next
23056 \begin_inset space \thinspace{}
23060 \begin_inset Quotes eld
23063 Smith and Miller [1]
23064 \begin_inset Quotes erd
23070 \begin_layout Standard
23071 \begin_inset Flex Code
23074 \begin_layout Plain Layout
23080 blocks look like this:
23083 \begin_layout LyX-Code
23087 \begin_layout LyX-Code
23091 \begin_layout LyX-Code
23095 \begin_layout LyX-Code
23096 citeyearpar[][]=parencite*
23099 \begin_layout LyX-Code
23103 \begin_layout LyX-Code
23107 \begin_layout Standard
23109 \begin_inset Flex Code
23112 \begin_layout Plain Layout
23118 denotes the engine.
23119 The individual lines respectively define a cite command or cite command
23120 paradigm supported by this engine.
23121 The line can be as simple as a cite command that is used both to name the
23122 respective \SpecialChar LyX
23123 command and the \SpecialChar LaTeX
23124 output or more complex in order to differentiate
23126 The full syntax is:
23129 \begin_layout LyX-Code
23130 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23133 \begin_layout Itemize
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23143 : The name as used in the
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23157 \begin_layout Standard
23158 For portability reasons, we try to use the same name for same-formatted
23159 commands in different cite packages (thus many names stem from natbib,
23160 and thus we need to differentiate a
23161 \begin_inset Flex Code
23164 \begin_layout Plain Layout
23170 sometimes, if the \SpecialChar LaTeX
23171 command names differ).
23175 \begin_layout Itemize
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23185 : a (comma-separated) list of commands that fall back to the given
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23195 in the current engine.
23196 This eases the switch of citation packages and engines.
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23217 in layout definitions.
23220 \begin_layout Itemize
23221 \begin_inset Flex Code
23224 \begin_layout Plain Layout
23230 : The actual \SpecialChar LaTeX
23231 command that is output.
23235 \begin_layout Standard
23236 \begin_inset Flex Code
23239 \begin_layout Plain Layout
23246 \begin_inset Flex Code
23249 \begin_layout Plain Layout
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23267 \begin_inset Flex Code
23270 \begin_layout Plain Layout
23276 will be output to \SpecialChar LaTeX
23280 \begin_layout Standard
23284 \begin_layout Itemize
23285 Capitalization indicates that the command also has a capitalized form (
23286 \begin_inset Flex Code
23289 \begin_layout Plain Layout
23299 \begin_inset Flex Code
23302 \begin_layout Plain Layout
23311 These usually enforce up-casing of name prefixes (
23316 \begin_inset Formula $\Rightarrow$
23326 \begin_layout Itemize
23328 \begin_inset Flex Code
23331 \begin_layout Plain Layout
23337 indicate the number of optional arguments (there can be 0–2).
23340 \begin_layout Itemize
23342 \begin_inset Flex Code
23345 \begin_layout Plain Layout
23351 indicates there is a starred version of the command (
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23381 \begin_layout Standard
23382 By default, the starred version means: Output all authors even if it should
23384 \begin_inset Quotes eld
23388 \begin_inset Quotes erd
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23404 \begin_layout Standard
23405 If the star has a different meaning for a given command, it can be specified
23407 \begin_inset Flex Code
23410 \begin_layout Plain Layout
23411 <!_stardesc!_stardesctooltip>
23417 Maximal two translatable macro keywords, marked by the prefix
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23428 The first points to the string that replaces the
23429 \begin_inset Quotes eld
23433 \begin_inset Quotes erd
23436 checkbox label in the citation dialog, the second one to an optional tool
23437 tip for this checkbox.
23441 \begin_layout Standard
23442 Note that these two macros have to be defined in a
23443 \begin_inset Flex Code
23446 \begin_layout Plain Layout
23452 (see next section), dropping the
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23462 from the prefix, like this:
23465 \begin_layout LyX-Code
23466 _stardesc Sta&rred command label
23469 \begin_layout LyX-Code
23470 _stardesctooltip Tooltip for the starred command checkbox.
23474 \begin_layout Itemize
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23485 indicates that this command features
23486 \begin_inset Quotes eld
23489 qualified citation lists
23490 \begin_inset Quotes erd
23498 -specific feature for multi-reference citations where an individual pre-
23499 and postnote can be given to each reference in the list.
23500 Please refer to the
23504 manual for details.
23505 \change_inserted -712698321 1526898670
23509 \begin_layout Standard
23511 \change_inserted -712698321 1526899524
23512 If you want to add a cite command to a cite engine (e.
23513 \begin_inset space \thinspace{}
23516 g., add a specific command provided by a class), you can use
23517 \begin_inset Flex Code
23520 \begin_layout Plain Layout
23522 \change_inserted -712698321 1526898768
23523 AddToCiteEngine <engine type> \SpecialChar ldots
23532 Note that only cite commands that do not exist yet are added.
23537 \begin_layout Subsection
23538 \begin_inset CommandInset label
23540 name "subsec:Citation-format-description"
23544 Cite format description
23547 \begin_layout Standard
23549 \begin_inset Flex Code
23552 \begin_layout Plain Layout
23558 blocks are used to describe how bibliographic information should be displayed,
23559 both within \SpecialChar LyX
23560 itself (in the citation dialog and in tooltips, for example)
23561 and in XHTML output.
23562 Such a block might look like this:
23565 \begin_layout LyX-Code
23569 \begin_layout LyX-Code
23573 \begin_layout LyX-Code
23577 \begin_layout LyX-Code
23581 \begin_layout Standard
23585 \begin_layout LyX-Code
23589 \begin_layout LyX-Code
23593 \begin_layout LyX-Code
23597 \begin_layout LyX-Code
23601 \begin_layout Standard
23602 In the first case, the individual lines define how the bibliographic information
23603 associated with an article or book, respectively, is to be displayed, and
23604 such a definition can be given for any
23605 \begin_inset Quotes els
23609 \begin_inset Quotes ers
23612 that might be present in a Bib\SpecialChar TeX
23615 defines a default format in the source code that will be used if no specific
23616 definition has been given.
23618 predefines several formats in the file
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23628 , which is included in most of \SpecialChar LyX
23629 's document classes.
23632 \begin_layout Standard
23633 In the second case, the lines define how a specific citation command (in
23635 \begin_inset Flex Code
23638 \begin_layout Plain Layout
23647 \begin_inset Flex Code
23650 \begin_layout Plain Layout
23658 ) is to be displayed on the citation inset label, in the citation dialog,
23659 menu or XHTML output.
23661 defines such formats for the citation style variants it supports via
23663 Document\SpecialChar menuseparator
23664 Setting\SpecialChar menuseparator
23665 Bibliography\SpecialChar ldots
23669 \begin_inset Flex Code
23672 \begin_layout Plain Layout
23678 files that are shipped with \SpecialChar LyX
23680 \begin_inset CommandInset ref
23682 reference "subsec:Cite-Engine-Files"
23692 \begin_layout Standard
23693 The definitions use a simple language that allows Bib\SpecialChar TeX
23694 keys to be replaced
23696 Keys should be enclosed in
23697 \begin_inset Flex Code
23700 \begin_layout Plain Layout
23707 \begin_inset Flex Code
23710 \begin_layout Plain Layout
23717 So a simple definition might look like this:
23720 \begin_layout LyX-Code
23722 \begin_inset Quotes eld
23726 \begin_inset Quotes erd
23732 \begin_layout Standard
23733 This would print the author, followed by a comma, followed by the title,
23734 in quotes, followed by a period.
23737 \begin_layout Standard
23738 Of course, sometimes you may want to print a key only if it exists.
23739 This can be done by using a conditional construction, such as:
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23745 \begin_inset space ~
23755 \begin_inset Flex Code
23758 \begin_layout Plain Layout
23764 key exists, then print
23765 \begin_inset Quotes eld
23769 \begin_inset space ~
23773 \begin_inset Quotes erd
23776 followed by the volume key.
23777 It is also possible to have an else clause in the conditional, such as:
23778 \begin_inset Newline newline
23782 \begin_inset Flex Code
23785 \begin_layout Plain Layout
23786 {%author%[[%author%]][[%editor%, ed.]]}
23792 \begin_inset Newline newline
23796 \begin_inset Flex Code
23799 \begin_layout Plain Layout
23805 key is printed if it exists; otherwise, the editor key is printed, followed
23807 \begin_inset Quotes eld
23811 \begin_inset space ~
23815 \begin_inset Quotes erd
23818 Note that the key is again enclosed in
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23828 signs; the entire conditional is enclosed in braces; and the if and else
23829 clauses are enclosed in double brackets,
23830 \begin_inset Quotes eld
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23844 \begin_inset Quotes eld
23848 \begin_inset Quotes eld
23852 \begin_inset Flex Code
23855 \begin_layout Plain Layout
23862 \begin_inset Quotes erd
23866 There must be no space between any of these.
23869 \begin_layout Standard
23870 Next to the entry keys, there are some special keys that can be used for
23871 these conditionals:
23874 \begin_layout Itemize
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23879 {%dialog%[[true]][[false]]}
23885 \begin_inset Quotes eld
23889 \begin_inset Quotes erd
23892 part for dialogs and menus, the
23893 \begin_inset Quotes eld
23897 \begin_inset Quotes erd
23900 part for other contexts (workarea, export)
23903 \begin_layout Itemize
23904 \begin_inset Flex Code
23907 \begin_layout Plain Layout
23908 {%export%[[true]][[false]]}
23914 \begin_inset Quotes eld
23918 \begin_inset Quotes erd
23921 part for export and menus, the
23922 \begin_inset Quotes eld
23926 \begin_inset Quotes erd
23929 part for other contexts (workarea, dialog)
23932 \begin_layout Itemize
23933 \begin_inset Flex Code
23936 \begin_layout Plain Layout
23943 \begin_inset Quotes eld
23947 \begin_inset Quotes erd
23950 part if another item follows (e.
23951 \begin_inset space \thinspace{}
23954 g., in a citation with multiple keys)
23957 \begin_layout Itemize
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23962 {%second%[[true]][[false]]}
23968 \begin_inset Quotes eld
23972 \begin_inset Quotes erd
23975 if this is the second of multiple items, else the
23976 \begin_inset Quotes eld
23980 \begin_inset Quotes erd
23986 \begin_layout Itemize
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23991 {%ifstar%[[true]][[false]]}
23997 \begin_inset Quotes eld
24001 \begin_inset Quotes erd
24004 part for starred citation commands (such as
24005 \begin_inset Flex Code
24008 \begin_layout Plain Layout
24016 ), the false part for unstarred
24019 \begin_layout Itemize
24020 \begin_inset Flex Code
24023 \begin_layout Plain Layout
24024 {%ifentrytype:<type>%[[true]][[false]]}
24030 \begin_inset Quotes eld
24034 \begin_inset Quotes erd
24037 if the current entry type matches
24038 \begin_inset Flex Code
24041 \begin_layout Plain Layout
24047 , else the false part (e.g., in a citation definition:
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24052 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24060 \begin_layout Itemize
24061 \begin_inset Flex Code
24064 \begin_layout Plain Layout
24065 {%ifmultiple:<authortype>%[[true]][[false]]}
24071 \begin_inset Quotes eld
24075 \begin_inset Quotes erd
24078 if the current author type (author, editor etc.) has multiple authors, else
24079 the false part (e.g., in a bibliography definition:
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24084 {%ifmultiple:editor%[[eds.]][[ed.]]}
24092 \begin_layout Itemize
24093 \begin_inset Flex Code
24096 \begin_layout Plain Layout
24097 {%ifqualified%[[true]][[false]]}
24103 \begin_inset Quotes eld
24107 \begin_inset Quotes erd
24110 part if the current citation is a qualified citation list (a specific
24114 format for multi-reference citations), the false part if this is not the
24118 \begin_layout Standard
24120 \begin_inset Flex Code
24123 \begin_layout Plain Layout
24129 prints the author key as it is recorded in the bibliography file.
24130 This might not be what you want, since it will result in a string such
24132 \begin_inset Quotes eld
24135 Miller, Peter and Smith, Mary and White, Jane
24136 \begin_inset Quotes erd
24140 \begin_inset Quotes eld
24144 \begin_inset Quotes erd
24147 is used by Bib\SpecialChar TeX
24148 to delimit authors).
24150 therefore provides some methods to get properly formatted name lists (which
24151 will also get translated).
24152 The following keys are provided:
24155 \begin_layout Enumerate
24156 For name lists with pre- and surname, suitable for the main authors/editors
24157 of a bibliography item.
24159 \begin_inset Flex Code
24162 \begin_layout Plain Layout
24168 part denotes the kind of list that is requested (e.g.
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24183 \begin_layout Itemize
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24188 %abbrvnames:<nametype>%
24193 : Provides a name list which is abbreviated (with
24194 \begin_inset Quotes eld
24198 \begin_inset Quotes erd
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24214 \begin_layout Itemize
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24219 %fullnames:<nametype>%
24224 : Provides a full name list (never abbreviated with
24225 \begin_inset Quotes eld
24229 \begin_inset Quotes erd
24235 \begin_layout Itemize
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24240 %forceabbrvnames:<nametype>%
24245 : Provides a name list which is always abbreviated (with
24246 \begin_inset Quotes eld
24250 \begin_inset Quotes erd
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24267 \begin_layout Enumerate
24268 Alternative name lists with pre- and surname, if the order of pre- and surname
24269 inside the bibliography item differs (as in:
24270 \begin_inset Quotes eld
24273 Miller, John: Some text, in: Mary Smith, ed.: A volume
24274 \begin_inset Quotes erd
24281 \begin_layout Itemize
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24286 %abbrvbynames:<nametype>%
24291 : Provides a name list which is abbreviated (with
24292 \begin_inset Quotes eld
24296 \begin_inset Quotes erd
24300 \begin_inset Flex Code
24303 \begin_layout Plain Layout
24312 \begin_layout Itemize
24313 \begin_inset Flex Code
24316 \begin_layout Plain Layout
24317 %fullbynames:<nametype>%
24322 : Provides a full name list (never abbreviated with
24323 \begin_inset Quotes eld
24327 \begin_inset Quotes erd
24333 \begin_layout Itemize
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24338 %forceabbrvbynames:<nametype>%
24343 : Provides a name list which is always abbreviated (with
24344 \begin_inset Quotes eld
24348 \begin_inset Quotes erd
24352 \begin_inset Flex Code
24355 \begin_layout Plain Layout
24365 \begin_layout Enumerate
24366 And finally name lists which consist of family names only, as used in author-yea
24368 These do not take a
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24378 part, but always return either an author list or, if this does not exist,
24379 an editor list (as common in author-year labels):
24383 \begin_layout Itemize
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24393 : Provides a name list which is abbreviated (with
24394 \begin_inset Quotes eld
24398 \begin_inset Quotes erd
24402 \begin_inset Flex Code
24405 \begin_layout Plain Layout
24414 \begin_layout Itemize
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24424 : Provides a full name list (never abbreviated with
24425 \begin_inset Quotes eld
24429 \begin_inset Quotes erd
24435 \begin_layout Itemize
24436 \begin_inset Flex Code
24439 \begin_layout Plain Layout
24440 %forceabbrvciteauthor%
24445 : Provides a name list which is always abbreviated (with
24446 \begin_inset Quotes eld
24450 \begin_inset Quotes erd
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24467 \begin_layout Standard
24468 The order of pre- and surname in the former two lists can be adjusted by
24472 \begin_layout Itemize
24473 \begin_inset Flex Code
24476 \begin_layout Plain Layout
24477 !firstnameform %surname%, %prename%
24482 (first author in lists of type 1)
24485 \begin_layout Itemize
24486 \begin_inset Flex Code
24489 \begin_layout Plain Layout
24490 !othernameform %surname%, %prename%
24495 (other authors in lists of type 1)
24498 \begin_layout Itemize
24499 \begin_inset Flex Code
24502 \begin_layout Plain Layout
24503 !firstbynameform %prename% %surname%
24508 (first author in lists of type 2)
24511 \begin_layout Itemize
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24516 !otherbynameform %prename% %surname%
24521 (other authors in lists of type 2)
24524 \begin_layout Standard
24525 This allows you to configure namings like
24526 \begin_inset Quotes eld
24529 Miller, Peter and Mary Smith: \SpecialChar ldots
24530 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24532 \begin_inset Quotes erd
24538 \begin_layout Standard
24539 There is one other piece of syntax available in definitions, which looks
24541 \begin_inset Flex Code
24544 \begin_layout Plain Layout
24551 This defines a piece of formatting information that is to be used when
24553 \begin_inset Quotes eld
24557 \begin_inset Quotes erd
24561 Obviously, we do not want to output HTML tags when writing plain text,
24562 so they should be wrapped in
24563 \begin_inset Quotes eld
24567 \begin_inset Quotes erd
24571 \begin_inset Quotes eld
24575 \begin_inset Quotes erd
24581 \begin_layout Standard
24582 Two special sorts of definitions are also possible in a
24583 \begin_inset Flex Code
24586 \begin_layout Plain Layout
24593 An example of the first would be:
24596 \begin_layout LyX-Code
24598 \begin_inset Quotes eld
24602 \begin_inset Quotes erd
24608 \begin_layout Standard
24609 This is an abbreviation, or macro, and it can be used by treating it as
24611 \begin_inset Flex Code
24614 \begin_layout Plain Layout
24623 \begin_inset Flex Code
24626 \begin_layout Plain Layout
24632 exactly as it would treat its definition.
24633 So, let us issue the obvious
24641 \begin_layout LyX-Code
24645 \begin_layout Standard
24646 or anything like it.
24648 shouldn't go into an infinite loop, but it may go into a long one before
24652 \begin_layout Standard
24653 The second sort of special definition might look like this:
24656 \begin_layout LyX-Code
24660 \begin_layout Standard
24661 This defines a translatable piece of text, which allows relevant parts of
24662 the bibliography or citation to be translated.
24663 It can be included in a definition by treating it as a key:
24664 \begin_inset Flex Code
24667 \begin_layout Plain Layout
24674 Note that there are two different translation paths: All definitions starting
24676 \begin_inset Flex Code
24679 \begin_layout Plain Layout
24685 , such as in the example above, will be translated to the currently active
24686 buffer language (so the translation will match the generated document).
24687 All definitions starting with underscore only will be translated to the
24689 This is the proper translation for strings that only occur in the dialogs
24690 or on buttons, such as this one:
24693 \begin_layout LyX-Code
24694 _addtobib Add to bibliography only.
24697 \begin_layout Standard
24698 Several of these translatable strings are predefined in
24699 \begin_inset Flex Code
24702 \begin_layout Plain Layout
24709 \begin_inset Flex Code
24712 \begin_layout Plain Layout
24719 Note that these are not macros, in the sense just defined.
24720 They will not be expanded.
24723 \begin_layout Standard
24724 So here then is an example that uses several of these features:
24725 \begin_inset VSpace defskip
24731 \begin_layout Standard
24735 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24738 \begin_layout Standard
24739 \begin_inset VSpace defskip
24742 This defines a macro that prints the author, followed by a comma, if the
24744 \begin_inset Flex Code
24747 \begin_layout Plain Layout
24753 key is defined, or else prints the name of the editor, followed by the
24755 \begin_inset Flex Code
24758 \begin_layout Plain Layout
24764 or its translation (it is by default
24765 \begin_inset Quotes eld
24769 \begin_inset Quotes erd
24773 \begin_inset Flex Code
24776 \begin_layout Plain Layout
24783 Note that this is in fact defined in
24784 \begin_inset Flex Code
24787 \begin_layout Plain Layout
24793 , so you can use it in your own definitions, or re-definitions, if you load
24797 \begin_layout Section
24798 \begin_inset CommandInset label
24800 name "sec:Tags-for-XHTML"
24804 Tags for XHTML output
24807 \begin_layout Standard
24808 As with \SpecialChar LaTeX
24809 or DocBook, the format of \SpecialChar LyX
24810 's XHTML output is also controlled by
24811 layout information.
24812 In general, \SpecialChar LyX
24813 provides sensible defaults and, as mentioned earlier, it will
24814 even construct default CSS style rules from the other layout tags.
24815 For example, \SpecialChar LyX
24816 will attempt to use the information provided in the
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24826 declaration for the Chapter style to write CSS that will appropriately
24827 format chapter headings.
24830 \begin_layout Standard
24831 In many cases, then, you may not have to do anything at all to get acceptable
24832 XHTML output for your own environments, custom insets, and so forth.
24833 But in some cases you will, and so \SpecialChar LyX
24834 provides a number of layout tags that
24835 can be used to customize the XHTML and CSS that are generated.
24838 \begin_layout Standard
24839 Note that there are two tags,
24840 \begin_inset Flex Code
24843 \begin_layout Plain Layout
24850 \begin_inset Flex Code
24853 \begin_layout Plain Layout
24859 that may appear outside style and inset declarations.
24861 \begin_inset CommandInset ref
24863 reference "subsec:General-text-class"
24867 for details on these.
24870 \begin_layout Subsection
24871 \begin_inset CommandInset label
24873 name "subsec:Paragraph-Style-XHTML"
24880 \begin_layout Standard
24881 The sort of XHTML \SpecialChar LyX
24882 outputs for a paragraph depends upon whether we are dealing
24883 with a normal paragraph, a command, or an environment, where this is itself
24884 determined by the contents of the corresponding
24885 \begin_inset Flex Code
24888 \begin_layout Plain Layout
24899 \begin_layout Standard
24900 For a command or normal paragraph, the output XHTML has the following form:
24903 \begin_layout LyX-Code
24907 \begin_inset Quotes erd
24911 \begin_inset Quotes erd
24917 \begin_layout LyX-Code
24921 \begin_inset Quotes erd
24925 \begin_inset Quotes erd
24931 \begin_layout LyX-Code
24934 Contents of the paragraph.
24937 \begin_layout LyX-Code
24943 \begin_layout Standard
24944 The label tags are of course omitted if the paragraph does not have a label.
24947 \begin_layout Standard
24948 For an environment that is not some sort of list, the XHTML takes this form:
24951 \begin_layout LyX-Code
24955 \begin_inset Quotes erd
24959 \begin_inset Quotes erd
24965 \begin_layout LyX-Code
24969 \begin_inset Quotes erd
24973 \begin_inset Quotes erd
24977 \begin_inset Quotes erd
24981 \begin_inset Quotes erd
24984 >Environment Label</labeltag>First paragraph.</itemtag>
24987 \begin_layout LyX-Code
24990 <itemtag>Second paragraph.</itemtag>
24993 \begin_layout LyX-Code
24999 \begin_layout Standard
25000 Note that the label is output only for the first paragraph, as it should
25001 be for a theorem, for example.
25005 \begin_layout Standard
25006 For a list, we have one of these forms:
25009 \begin_layout LyX-Code
25013 \begin_inset Quotes erd
25017 \begin_inset Quotes erd
25023 \begin_layout LyX-Code
25027 \begin_inset Quotes erd
25031 \begin_inset Quotes erd
25035 \begin_inset Quotes erd
25039 \begin_inset Quotes erd
25042 >List Label</labeltag>First item.</itemtag>
25045 \begin_layout LyX-Code
25049 \begin_inset Quotes erd
25053 \begin_inset Quotes erd
25057 \begin_inset Quotes erd
25061 \begin_inset Quotes erd
25064 >List Label</labeltag>Second item.</itemtag>
25067 \begin_layout LyX-Code
25073 \begin_layout LyX-Code
25077 \begin_layout LyX-Code
25081 \begin_inset Quotes erd
25085 \begin_inset Quotes erd
25091 \begin_layout LyX-Code
25095 \begin_inset Quotes erd
25099 \begin_inset Quotes erd
25102 >List Label</labeltag><itemtag attr=
25103 \begin_inset Quotes erd
25107 \begin_inset Quotes erd
25110 >First item.</itemtag>
25113 \begin_layout LyX-Code
25117 \begin_inset Quotes erd
25121 \begin_inset Quotes erd
25124 >List Label</labeltag><itemtag attr=
25125 \begin_inset Quotes erd
25129 \begin_inset Quotes erd
25132 >Second item.</itemtag>
25135 \begin_layout LyX-Code
25141 \begin_layout Standard
25142 Note the different orders of
25143 \begin_inset Flex Code
25146 \begin_layout Plain Layout
25153 \begin_inset Flex Code
25156 \begin_layout Plain Layout
25163 Which order we get depends upon the setting of
25164 \begin_inset Flex Code
25167 \begin_layout Plain Layout
25174 \begin_inset Flex Code
25177 \begin_layout Plain Layout
25183 is false (the default), you get the first of these, with the label within
25184 the item; if true, you get the second, with the label outside the item.
25187 \begin_layout Standard
25188 The specific tags and attributes output for each paragraph type can be controlle
25189 d by means of the layout tags we are about to describe.
25190 As mentioned earlier, however, \SpecialChar LyX
25191 uses sensible defaults for many of these,
25192 so you often may not need to do very much to get good XHTML output.
25193 Think of the available tags as there so you can tweak things to your liking.
25196 \begin_layout Description
25197 \begin_inset Flex Code
25200 \begin_layout Plain Layout
25207 \begin_inset Flex Code
25210 \begin_layout Plain Layout
25216 ] Specifies attribute information to be output with the main tag.
25218 \begin_inset Quotes eld
25222 \begin_inset Flex Code
25225 \begin_layout Plain Layout
25232 \begin_inset Quotes erd
25236 By default, \SpecialChar LyX
25238 \begin_inset Quotes eld
25242 \begin_inset Flex Code
25245 \begin_layout Plain Layout
25252 \begin_inset Quotes erd
25256 \begin_inset Flex Code
25259 \begin_layout Plain Layout
25265 is the \SpecialChar LyX
25266 name of the layout, made lowercase, for example: chapter.
25271 contain any style information.
25273 \begin_inset Flex Code
25276 \begin_layout Plain Layout
25285 \begin_layout Description
25286 \begin_inset Flex Code
25289 \begin_layout Plain Layout
25296 \begin_inset Flex Code
25299 \begin_layout Plain Layout
25309 ] Whether to output the default CSS information \SpecialChar LyX
25310 generates for this layout,
25311 even if additional information is explicitly provided via
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25323 \begin_inset Flex Code
25326 \begin_layout Plain Layout
25332 allows you to alter or augment the generated CSS, rather than to override
25335 \begin_inset Flex Code
25338 \begin_layout Plain Layout
25347 \begin_layout Description
25348 \begin_inset Flex Code
25351 \begin_layout Plain Layout
25358 \begin_inset Flex Code
25361 \begin_layout Plain Layout
25367 ] The tag to be used for individual paragraphs of environments, replacing
25369 \begin_inset Flex Code
25372 \begin_layout Plain Layout
25378 in the examples above.
25380 \begin_inset Flex Code
25383 \begin_layout Plain Layout
25392 \begin_layout Description
25393 \begin_inset Flex Code
25396 \begin_layout Plain Layout
25403 \begin_inset Flex Code
25406 \begin_layout Plain Layout
25412 ] Attributes for the item tag.
25414 \begin_inset Newline newline
25418 \begin_inset Quotes eld
25422 \begin_inset Flex Code
25425 \begin_layout Plain Layout
25426 class=`layoutname_item'
25432 \begin_inset Quotes erd
25440 contain any style information.
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25454 \begin_layout Description
25455 \begin_inset Flex Code
25458 \begin_layout Plain Layout
25465 \begin_inset Flex Code
25468 \begin_layout Plain Layout
25474 ] The tag to be used for paragraph and item labels, replacing
25475 \begin_inset Flex Code
25478 \begin_layout Plain Layout
25484 in the examples above.
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25496 \begin_inset Flex Code
25499 \begin_layout Plain Layout
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25516 \begin_inset Flex Code
25519 \begin_layout Plain Layout
25520 Centered_Top_Environment
25525 , in which case it defaults to
25526 \begin_inset Flex Code
25529 \begin_layout Plain Layout
25538 \begin_layout Description
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25549 \begin_inset Flex Code
25552 \begin_layout Plain Layout
25558 ] Attributes for the label tag.
25560 \begin_inset Newline newline
25564 \begin_inset Quotes eld
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25572 class=`layoutname_label'
25578 \begin_inset Quotes erd
25586 contain any style information.
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25600 \begin_layout Description
25601 \begin_inset Flex Code
25604 \begin_layout Plain Layout
25611 \begin_inset Flex Code
25614 \begin_layout Plain Layout
25624 ] Meaningful only for list-like environments, this tag controls whether
25625 the label tag is output before or inside the item tag.
25626 This is used, for example, in the description environment, where we want
25628 \begin_inset Flex Code
25631 \begin_layout Plain Layout
25632 <dt>\SpecialChar ldots
25633 </dt><dd>\SpecialChar ldots
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25650 : The label tag is output inside the item tag.
25653 \begin_layout Description
25654 \begin_inset Flex Code
25657 \begin_layout Plain Layout
25663 Information to be output in the
25664 \begin_inset Flex Code
25667 \begin_layout Plain Layout
25673 section when this style is used.
25674 This might, for example, be used to include a
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25685 \begin_inset Flex Code
25688 \begin_layout Plain Layout
25697 \begin_layout Description
25698 \begin_inset Flex Code
25701 \begin_layout Plain Layout
25707 CSS style information to be included when this style is used.
25708 Note that this will automatically be wrapped in a layout-generated
25709 \begin_inset Flex Code
25712 \begin_layout Plain Layout
25718 block, so only the CSS itself need be included.
25720 \begin_inset Flex Code
25723 \begin_layout Plain Layout
25732 \begin_layout Description
25733 \begin_inset Flex Code
25736 \begin_layout Plain Layout
25743 \begin_inset Flex Code
25746 \begin_layout Plain Layout
25752 ] The tag to be used for the main label, replacing
25753 \begin_inset Flex Code
25756 \begin_layout Plain Layout
25762 in the examples above.
25764 \begin_inset Flex Code
25767 \begin_layout Plain Layout
25776 \begin_layout Description
25777 \begin_inset Flex Code
25780 \begin_layout Plain Layout
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25800 ] Marks this style as the one to be used to generate the
25801 \begin_inset Flex Code
25804 \begin_layout Plain Layout
25810 tag for the XHTML file.
25811 By default, it is false.
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25822 file sets it to true for the
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25836 \begin_layout Subsection
25840 \begin_layout Standard
25841 The XHTML output of insets can also be controlled by information in layout
25846 \begin_layout Plain Layout
25847 At present, this is true only for
25848 \begin_inset Quotes eld
25852 \begin_inset Quotes erd
25855 insets (insets you can type into) and is not true for
25856 \begin_inset Quotes eld
25860 \begin_inset Quotes erd
25863 insets (insets that are associated with dialog boxes).
25868 Here, too, \SpecialChar LyX
25869 tries to provide sensible defaults, and it constructs default
25871 But everything can be customized.
25874 \begin_layout Standard
25875 The XHTML \SpecialChar LyX
25876 outputs for an inset has the following form:
25879 \begin_layout LyX-Code
25881 \begin_inset Quotes erd
25885 \begin_inset Quotes erd
25891 \begin_layout LyX-Code
25892 <labeltag>Label</labeltag>
25895 \begin_layout LyX-Code
25897 \begin_inset Quotes erd
25901 \begin_inset Quotes erd
25904 >Contents of the inset.</innertag>
25907 \begin_layout LyX-Code
25911 \begin_layout Standard
25912 If the inset permits multiple paragraphs—that is, if
25913 \begin_inset Flex Code
25916 \begin_layout Plain Layout
25922 is true—then the contents of the inset will itself be output as paragraphs
25923 formatted according to the styles used for those paragraphs (standard,
25924 quote, and the like).
25925 The label tag is of course omitted if the paragraph does not have a label
25926 and, at present, is always
25927 \begin_inset Flex Code
25930 \begin_layout Plain Layout
25937 The inner tag is optional and, by default, does not appear.
25940 \begin_layout Standard
25941 The specific tags and attributes output for each inset can be controlled
25942 by means of the following layout tags.
25945 \begin_layout Description
25946 \begin_inset Flex Code
25949 \begin_layout Plain Layout
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25965 ] Specifies attribute information to be output with the main tag.
25967 \begin_inset Quotes eld
25971 \begin_inset Flex Code
25974 \begin_layout Plain Layout
25975 class=`myinset' onclick=`\SpecialChar ldots
25982 \begin_inset Quotes erd
25986 By default, \SpecialChar LyX
25988 \begin_inset Quotes eld
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26002 \begin_inset Quotes erd
26006 \begin_inset Flex Code
26009 \begin_layout Plain Layout
26015 is the \SpecialChar LyX
26016 name of the inset, made lowercase and with non-alphanumeric characters
26017 converted to underscores, for example: footnote.
26020 \begin_layout Description
26021 \begin_inset Flex Code
26024 \begin_layout Plain Layout
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26044 ] Whether to output the default CSS information \SpecialChar LyX
26045 generates for this layout,
26046 even if additional information is explicitly provided via
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26067 allows you to alter or augment the generated CSS, rather than to override
26072 \begin_layout Description
26073 \begin_inset Flex Code
26076 \begin_layout Plain Layout
26083 \begin_inset Flex Code
26086 \begin_layout Plain Layout
26092 ] Attributes for the inner tag.
26094 \begin_inset Newline newline
26098 \begin_inset Quotes eld
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26106 class=`insetname_inner'
26112 \begin_inset Quotes erd
26118 \begin_layout Description
26119 \begin_inset Flex Code
26122 \begin_layout Plain Layout
26129 \begin_inset Flex Code
26132 \begin_layout Plain Layout
26138 ] The inner tag, replacing
26139 \begin_inset Flex Code
26142 \begin_layout Plain Layout
26148 in the examples above.
26149 By default, there is none.
26152 \begin_layout Description
26153 \begin_inset Flex Code
26156 \begin_layout Plain Layout
26163 \begin_inset Flex Code
26166 \begin_layout Plain Layout
26174 ] Whether this inset represents a standalone block of text (such as a footnote)
26175 or instead represents material that is included in the surrounding text
26176 (such as a branch).
26180 \begin_layout Description
26181 \begin_inset Flex Code
26184 \begin_layout Plain Layout
26191 \begin_inset Flex Code
26194 \begin_layout Plain Layout
26200 ] A label for this inset, possibly including a reference to a counter.
26201 For example, for footnote, it might be:
26202 \begin_inset Flex Code
26205 \begin_layout Plain Layout
26214 This is optional, and there is no default.
26217 \begin_layout Description
26218 \begin_inset Flex Code
26221 \begin_layout Plain Layout
26227 Information to be output in the
26228 \begin_inset Flex Code
26231 \begin_layout Plain Layout
26237 section when this style is used.
26238 This might, for example, be used to include a
26239 \begin_inset Flex Code
26242 \begin_layout Plain Layout
26249 \begin_inset Flex Code
26252 \begin_layout Plain Layout
26261 \begin_layout Description
26262 \begin_inset Flex Code
26265 \begin_layout Plain Layout
26271 CSS style information to be included when this style is used.
26272 Note that this will automatically be wrapped in a layout-generated
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26282 block, so only the CSS itself need be included.
26285 \begin_layout Description
26286 \begin_inset Flex Code
26289 \begin_layout Plain Layout
26296 \begin_inset Flex Code
26299 \begin_layout Plain Layout
26305 ] The tag to be used for the main label, replacing
26306 \begin_inset Flex Code
26309 \begin_layout Plain Layout
26315 in the examples above.
26316 The default depends upon the setting of
26317 \begin_inset Flex Code
26320 \begin_layout Plain Layout
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26336 is true, the default is
26337 \begin_inset Flex Code
26340 \begin_layout Plain Layout
26346 ; if it is false, the default is
26347 \begin_inset Flex Code
26350 \begin_layout Plain Layout
26359 \begin_layout Subsection
26363 \begin_layout Standard
26364 The XHTML output for floats too can be controlled by layout information.
26365 The output has the following form:
26368 \begin_layout LyX-Code
26370 \begin_inset Quotes erd
26374 \begin_inset Quotes erd
26380 \begin_layout LyX-Code
26381 Contents of the float.
26384 \begin_layout LyX-Code
26388 \begin_layout Standard
26389 The caption, if there is one, is a separate inset and will be output as
26391 Its appearance can be controlled via the InsetLayout for caption insets.
26395 \begin_layout Description
26396 \begin_inset Flex Code
26399 \begin_layout Plain Layout
26406 \begin_inset Flex Code
26409 \begin_layout Plain Layout
26415 ] Specifies attribute information to be output with the main tag.
26417 \begin_inset Quotes eld
26421 \begin_inset Flex Code
26424 \begin_layout Plain Layout
26425 class=`myfloat' onclick=`\SpecialChar ldots
26432 \begin_inset Quotes erd
26436 By default, \SpecialChar LyX
26438 \begin_inset Quotes eld
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26446 class=`float float-floattype'
26452 \begin_inset Quotes erd
26456 \begin_inset Flex Code
26459 \begin_layout Plain Layout
26465 is \SpecialChar LyX
26466 's name for this type of float, as determined by the float declaration
26468 \begin_inset CommandInset ref
26470 reference "subsec:Floats"
26474 ), though made lowercase and with non-alphanumeric characters converted
26475 to underscores, for example: float-table.
26478 \begin_layout Description
26479 \begin_inset Flex Code
26482 \begin_layout Plain Layout
26488 CSS style information to be included when this float is used.
26489 Note that this will automatically be wrapped in a layout-generated
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26499 block, so only the CSS itself need be included.
26502 \begin_layout Description
26503 \begin_inset Flex Code
26506 \begin_layout Plain Layout
26513 \begin_inset Flex Code
26516 \begin_layout Plain Layout
26522 ] The tag to be used for this float, replacing
26523 \begin_inset Quotes eld
26527 \begin_inset Flex Code
26530 \begin_layout Plain Layout
26537 \begin_inset Quotes erd
26540 in the example above.
26542 \begin_inset Flex Code
26545 \begin_layout Plain Layout
26551 and will rarely need changing.
26554 \begin_layout Subsection
26555 Bibliography formatting
26558 \begin_layout Standard
26559 The bibliography can be formatted using
26560 \begin_inset Flex Code
26563 \begin_layout Plain Layout
26571 \begin_inset CommandInset ref
26573 reference "subsec:Citation-format-description"
26580 \begin_layout Subsection
26585 \begin_layout Standard
26586 We have several times mentioned that \SpecialChar LyX
26587 will generate default CSS style rules
26588 for both insets and paragraph styles, based upon the other layout information
26590 In this section, we shall say a word about which layout information \SpecialChar LyX
26595 \begin_layout Standard
26596 At present, \SpecialChar LyX
26597 auto-generates CSS only for font information, making use of
26599 \begin_inset Flex Code
26602 \begin_layout Plain Layout
26609 \begin_inset Flex Code
26612 \begin_layout Plain Layout
26619 \begin_inset Flex Code
26622 \begin_layout Plain Layout
26629 \begin_inset Flex Code
26632 \begin_layout Plain Layout
26639 \begin_inset Flex Code
26642 \begin_layout Plain Layout
26649 \begin_inset CommandInset ref
26651 reference "subsec:Font-description"
26656 The translation is mostly straightforward and obvious.
26658 \begin_inset Quotes eld
26662 \begin_inset Flex Code
26665 \begin_layout Plain Layout
26672 \begin_inset Quotes erd
26676 \begin_inset Quotes eld
26680 \begin_inset Flex Code
26683 \begin_layout Plain Layout
26684 font-family: sans-serif;
26690 \begin_inset Quotes erd
26694 The correspondence of \SpecialChar LyX
26695 sizes and CSS sizes is a little less obvious but
26696 nonetheless intuitive.
26698 \begin_inset Flex Code
26701 \begin_layout Plain Layout
26708 \begin_inset Flex URL
26711 \begin_layout Plain Layout
26721 \begin_layout Chapter
26722 Including External Material
26723 \begin_inset CommandInset label
26725 name "chap:Including-External-Material"
26732 \begin_layout Standard
26733 \begin_inset Box Shadowbox
26743 height_special "totalheight"
26748 backgroundcolor "none"
26751 \begin_layout Plain Layout
26752 WARNING: This portion of the documentation has not been updated for some
26754 We certainly hope that it is still accurate, but there are no guarantees.
26762 \begin_layout Standard
26763 The use of material from sources external to \SpecialChar LyX
26764 is covered in detail in the
26770 This part of the manual covers what needs to happen behind the scenes for
26771 new sorts of material to be included.
26774 \begin_layout Section
26778 \begin_layout Standard
26779 The external material feature is based on the concept of a
26784 A template is a specification of how \SpecialChar LyX
26785 should interface with a certain kind
26787 As bundled, \SpecialChar LyX
26788 comes with predefined templates for Xfig figures, various
26789 raster format images, chess diagrams, and LilyPond music notation.
26790 You can check the actual list by using the menu
26791 \begin_inset Flex Noun
26794 \begin_layout Plain Layout
26795 Insert\SpecialChar menuseparator
26796 File\SpecialChar menuseparator
26803 Furthermore, it is possible to roll your own template to support a specific
26805 Later we'll describe in more detail what is involved, and hopefully you
26806 will submit all the templates you create so we can include them in a later
26811 \begin_layout Standard
26812 Another basic idea of the external material feature is to distinguish between
26813 the original file that serves as a base for final material and the produced
26814 file that is included in your exported or printed document.
26815 For example, consider the case of a figure produced with
26816 \begin_inset Flex Code
26819 \begin_layout Plain Layout
26826 The Xfig application itself works on an original file with the
26827 \begin_inset Flex Code
26830 \begin_layout Plain Layout
26837 Within Xfig, you create and change your figure, and when you are done,
26839 \begin_inset Flex Code
26842 \begin_layout Plain Layout
26849 When you want to include the figure in your document, you invoke
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26859 in order to create a PostScript file that can readily be included in your
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26872 file is the original file, and the PostScript file is the produced file.
26875 \begin_layout Standard
26876 This distinction is important in order to allow updating of the material
26877 while you are in the process of writing the document.
26878 Furthermore, it provides us with the flexibility that is needed to support
26879 multiple export formats.
26880 For instance, in the case of a plain text file, it is not exactly an award-winn
26881 ing idea to include the figure as raw PostScript.
26882 Instead, you would either prefer to just include a reference to the figure
26883 or try to invoke some graphics to ASCII converter to make the final result
26884 look similar to the real graphics.
26885 The external material management allows you to do this, because it is parametri
26886 zed on the different export formats that \SpecialChar LyX
26890 \begin_layout Standard
26891 Besides supporting the production of different products according to the
26892 exported format, it supports tight integration with editing and viewing
26894 In the case of an Xfig figure, you are able to invoke Xfig on the original
26895 file with a single click from within the external material dialog in \SpecialChar LyX
26897 and also preview the produced PostScript file with Ghostview with another
26899 No more fiddling around with the command line and/or file browsers to locate
26900 and manipulate the original or produced files.
26901 In this way, you are finally able to take full advantage of the many different
26902 applications that are relevant to use when you write your documents, and
26903 ultimately be more productive.
26906 \begin_layout Section
26907 The external template configuration files
26910 \begin_layout Standard
26911 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26913 However, be aware that doing this in an careless manner most probably
26917 introduce an easily exploitable security hole.
26918 So before you do this, please read the discussion about security in
26919 \begin_inset CommandInset ref
26921 reference "sec:Security-discussion"
26928 \begin_layout Standard
26929 Having said that, we encourage you to submit any interesting templates that
26934 \begin_layout Standard
26935 The external templates are defined in the
26936 \begin_inset Flex Code
26939 \begin_layout Plain Layout
26945 files that are stored in the
26946 \begin_inset Flex Code
26949 \begin_layout Plain Layout
26950 LyXDir/lib/xtemplates/
26956 Each template is defined in a file of its own.
26957 You can place your own templates in
26958 \begin_inset Flex Code
26961 \begin_layout Plain Layout
26962 UserDir/xtemplates/
26967 or copy existing templates to that directory in order to modify them.
26970 \begin_layout Standard
26971 A typical template looks like this:
26974 \begin_layout LyX-Code
26978 \begin_layout LyX-Code
26979 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26982 \begin_layout LyX-Code
26986 \begin_layout LyX-Code
26990 \begin_layout LyX-Code
26994 \begin_layout LyX-Code
26998 \begin_layout LyX-Code
27002 \begin_layout LyX-Code
27003 AutomaticProduction true
27006 \begin_layout LyX-Code
27010 \begin_layout LyX-Code
27014 \begin_layout LyX-Code
27018 \begin_layout LyX-Code
27019 TransformCommand Rotate RotationLatexCommand
27022 \begin_layout LyX-Code
27023 TransformCommand Resize ResizeLatexCommand
27026 \begin_layout LyX-Code
27027 Product "$$RotateFront$$ResizeFront
27030 \begin_layout LyX-Code
27035 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
27038 \begin_layout LyX-Code
27039 $$ResizeBack$$RotateBack"
27042 \begin_layout LyX-Code
27046 \begin_layout LyX-Code
27047 UpdateResult "$$AbsPath$$Basename.pstex_t"
27050 \begin_layout LyX-Code
27051 Requirement "graphicx"
27054 \begin_layout LyX-Code
27055 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27058 \begin_layout LyX-Code
27059 ReferencedFile latex "$$AbsPath$$Basename.eps"
27062 \begin_layout LyX-Code
27063 ReferencedFile dvi "$$AbsPath$$Basename.eps"
27066 \begin_layout LyX-Code
27070 \begin_layout LyX-Code
27074 \begin_layout LyX-Code
27075 TransformCommand Rotate RotationLatexCommand
27078 \begin_layout LyX-Code
27079 TransformCommand Resize ResizeLatexCommand
27082 \begin_layout LyX-Code
27083 Product "$$RotateFront$$ResizeFront
27086 \begin_layout LyX-Code
27091 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
27094 \begin_layout LyX-Code
27095 $$ResizeBack$$RotateBack"
27098 \begin_layout LyX-Code
27099 UpdateFormat pdftex
27102 \begin_layout LyX-Code
27103 UpdateResult "$$AbsPath$$Basename.pdftex_t"
27106 \begin_layout LyX-Code
27107 Requirement "graphicx"
27110 \begin_layout LyX-Code
27111 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
27114 \begin_layout LyX-Code
27115 ReferencedFile latex "$$AbsPath$$Basename.pdf"
27118 \begin_layout LyX-Code
27122 \begin_layout LyX-Code
27126 \begin_layout LyX-Code
27127 Product "[XFig: $$FName]"
27130 \begin_layout LyX-Code
27134 \begin_layout LyX-Code
27138 \begin_layout LyX-Code
27139 Product "<graphic fileref=
27141 "$$AbsOrRelPathMaster$$Basename.eps
27146 \begin_layout LyX-Code
27150 \begin_layout LyX-Code
27154 \begin_layout LyX-Code
27155 UpdateResult "$$AbsPath$$Basename.eps"
27158 \begin_layout LyX-Code
27159 ReferencedFile docbook "$$AbsPath$$Basename.eps"
27162 \begin_layout LyX-Code
27163 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
27166 \begin_layout LyX-Code
27170 \begin_layout LyX-Code
27174 \begin_layout Standard
27175 As you can see, the template is enclosed in
27176 \begin_inset Flex Code
27179 \begin_layout Plain Layout
27187 \begin_inset Flex Code
27190 \begin_layout Plain Layout
27197 It contains a header specifying some general settings and, for each supported
27198 primary document file format, a section
27199 \begin_inset Flex Code
27202 \begin_layout Plain Layout
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27222 \begin_layout Subsection
27223 The template header
27226 \begin_layout Description
27227 \begin_inset Flex Code
27230 \begin_layout Plain Layout
27231 AutomaticProduction
27232 \begin_inset space ~
27240 Whether the file represented by the template must be generated by \SpecialChar LyX
27242 This command must occur exactly once.
27245 \begin_layout Description
27246 \begin_inset Flex Code
27249 \begin_layout Plain Layout
27251 \begin_inset space ~
27259 A glob pattern that is used in the file dialog to filter out the desired
27261 If there is more than one possible file extension (e.
27262 \begin_inset space \thinspace{}
27266 \begin_inset space \space{}
27270 \begin_inset Flex Code
27273 \begin_layout Plain Layout
27280 \begin_inset Flex Code
27283 \begin_layout Plain Layout
27289 ), use something like
27290 \begin_inset Flex Code
27293 \begin_layout Plain Layout
27300 This command must occur exactly once.
27303 \begin_layout Description
27304 \begin_inset Flex Code
27307 \begin_layout Plain Layout
27309 \begin_inset space ~
27317 The text that is displayed on the button.
27318 This command must occur exactly once.
27321 \begin_layout Description
27322 \begin_inset Flex Code
27325 \begin_layout Plain Layout
27327 \begin_inset space ~
27331 \begin_inset space ~
27339 The help text that is used in the External dialog.
27340 Provide enough information to explain to the user just what the template
27341 can provide him with.
27342 This command must occur exactly once.
27345 \begin_layout Description
27346 \begin_inset Flex Code
27349 \begin_layout Plain Layout
27351 \begin_inset space ~
27359 The file format of the original file.
27360 This must be the name of a format that is known to \SpecialChar LyX
27362 \begin_inset CommandInset ref
27364 reference "sec:Formats"
27370 \begin_inset Quotes eld
27374 \begin_inset Flex Code
27377 \begin_layout Plain Layout
27384 \begin_inset Quotes erd
27387 if the template can handle original files of more than one format.
27389 will attempt to interrogate the file itself in order to deduce its format
27391 This command must occur exactly once.
27394 \begin_layout Description
27395 \begin_inset Flex Code
27398 \begin_layout Plain Layout
27400 \begin_inset space ~
27408 A unique name for the template.
27409 It must not contain substitution macros (see below).
27412 \begin_layout Description
27413 \begin_inset Flex Code
27416 \begin_layout Plain Layout
27418 \begin_inset space ~
27421 Rotate|Resize|Clip|Extra
27426 This command specifies which transformations are supported by this template.
27427 It may occur zero or more times.
27428 This command enables the corresponding tabs in the external dialog.
27430 \begin_inset Flex Code
27433 \begin_layout Plain Layout
27439 command must have either a corresponding
27440 \begin_inset Flex Code
27443 \begin_layout Plain Layout
27450 \begin_inset Flex Code
27453 \begin_layout Plain Layout
27460 \begin_inset Flex Code
27463 \begin_layout Plain Layout
27470 Otherwise the transformation will not be supported by that format.
27473 \begin_layout Subsection
27477 \begin_layout Description
27478 \begin_inset Flex Code
27481 \begin_layout Plain Layout
27483 \begin_inset space ~
27486 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27491 The primary document file format that this format definition is for.
27492 Not every template has a sensible representation in all document file formats.
27493 Please define nevertheless a
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27503 section for all templates.
27504 Use a dummy text when no representation is available.
27505 Then you can at least see a reference to the external material in the exported
27509 \begin_layout Description
27510 \begin_inset Flex Code
27513 \begin_layout Plain Layout
27515 \begin_inset space ~
27519 \begin_inset space ~
27527 This command defines an additional macro
27528 \begin_inset Flex Code
27531 \begin_layout Plain Layout
27537 for substitution in
27538 \begin_inset Flex Code
27541 \begin_layout Plain Layout
27549 \begin_inset Flex Code
27552 \begin_layout Plain Layout
27558 itself may contain substitution macros.
27559 The advantage over using
27560 \begin_inset Flex Code
27563 \begin_layout Plain Layout
27570 \begin_inset Flex Code
27573 \begin_layout Plain Layout
27579 is that the substituted value of
27580 \begin_inset Flex Code
27583 \begin_layout Plain Layout
27589 is sanitized so that it is a valid optional argument in the document format.
27590 This command may occur zero or more times.
27593 \begin_layout Description
27594 \begin_inset Flex Code
27597 \begin_layout Plain Layout
27599 \begin_inset space ~
27607 The text that is inserted in the exported document.
27608 This is actually the most important command and can be quite complex.
27609 This command must occur exactly once.
27612 \begin_layout Description
27613 \begin_inset Flex Code
27616 \begin_layout Plain Layout
27618 \begin_inset space ~
27626 This command specifies a preamble snippet that will be included in the
27629 It has to be defined using
27630 \begin_inset Flex Code
27633 \begin_layout Plain Layout
27641 \begin_inset Flex Code
27644 \begin_layout Plain Layout
27651 This command may occur zero or more times.
27654 \begin_layout Description
27655 \begin_inset Flex Code
27658 \begin_layout Plain Layout
27660 \begin_inset space ~
27664 \begin_inset space ~
27672 This command denotes files that are created by the conversion process and
27673 are needed for a particular export format.
27674 If the filename is relative, it is interpreted relative to the master document.
27675 This command may be given zero or more times.
27678 \begin_layout Description
27679 \begin_inset Flex Code
27682 \begin_layout Plain Layout
27684 \begin_inset space ~
27692 The name of a required \SpecialChar LaTeX
27694 The package is included via
27695 \begin_inset Flex Code
27698 \begin_layout Plain Layout
27706 in the \SpecialChar LaTeX
27708 This command may occur zero or more times.
27711 \begin_layout Description
27712 \begin_inset Flex Code
27715 \begin_layout Plain Layout
27717 \begin_inset space ~
27721 \begin_inset space ~
27724 RotationLatexCommand
27729 This command specifies that the built in \SpecialChar LaTeX
27730 command should be used for rotation.
27731 This command may occur once or not at all.
27734 \begin_layout Description
27735 \begin_inset Flex Code
27738 \begin_layout Plain Layout
27740 \begin_inset space ~
27744 \begin_inset space ~
27752 This command specifies that the built in \SpecialChar LaTeX
27753 command should be used for resizing.
27754 This command may occur once or not at all.
27757 \begin_layout Description
27758 \begin_inset Flex Code
27761 \begin_layout Plain Layout
27763 \begin_inset space ~
27767 \begin_inset space ~
27770 RotationLatexOption
27775 This command specifies that rotation is done via an optional argument.
27776 This command may occur once or not at all.
27779 \begin_layout Description
27780 \begin_inset Flex Code
27783 \begin_layout Plain Layout
27785 \begin_inset space ~
27789 \begin_inset space ~
27797 This command specifies that resizing is done via an optional argument.
27798 This command may occur once or not at all.
27801 \begin_layout Description
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27807 \begin_inset space ~
27811 \begin_inset space ~
27819 This command specifies that clipping is done via an optional argument.
27820 This command may occur once or not at all.
27823 \begin_layout Description
27824 \begin_inset Flex Code
27827 \begin_layout Plain Layout
27829 \begin_inset space ~
27833 \begin_inset space ~
27841 This command specifies that an extra optional argument is used.
27842 This command may occur once or not at all.
27845 \begin_layout Description
27846 \begin_inset Flex Code
27849 \begin_layout Plain Layout
27851 \begin_inset space ~
27859 The file format of the converted file.
27860 This must be the name of a format that is known to \SpecialChar LyX
27862 \begin_inset Flex Noun
27865 \begin_layout Plain Layout
27866 Tools\SpecialChar menuseparator
27867 Preferences\SpecialChar menuseparator
27868 File Handling\SpecialChar menuseparator
27875 This command must occur exactly once.
27876 If the resulting file format is PDF, you need to specify the format
27877 \begin_inset Flex Code
27880 \begin_layout Plain Layout
27887 This is the PDF format used for including graphics.
27888 The other defined PDF formats are for document export.
27891 \begin_layout Description
27892 \begin_inset Flex Code
27895 \begin_layout Plain Layout
27897 \begin_inset space ~
27905 The file name of the converted file.
27906 The file name must be absolute.
27907 This command must occur exactly once.
27910 \begin_layout Subsection
27911 Preamble definitions
27914 \begin_layout Standard
27915 The external template configuration file may contain additional preamble
27916 definitions enclosed by
27917 \begin_inset Flex Code
27920 \begin_layout Plain Layout
27928 \begin_inset Flex Code
27931 \begin_layout Plain Layout
27938 They can be used by the templates in the
27939 \begin_inset Flex Code
27942 \begin_layout Plain Layout
27951 \begin_layout Section
27952 The substitution mechanism
27955 \begin_layout Standard
27956 When the external material facility invokes an external program, it is done
27957 on the basis of a command defined in the template configuration file.
27958 These commands can contain various macros that are expanded before execution.
27959 Execution always take place in the directory of the containing document.
27962 \begin_layout Standard
27963 Also, whenever external material is to be displayed, the name will be produced
27964 by the substitution mechanism, and most other commands in the template
27965 definition support substitution as well.
27968 \begin_layout Standard
27969 The available macros are the following:
27972 \begin_layout Description
27973 \begin_inset Flex Code
27976 \begin_layout Plain Layout
27977 $$AbsOrRelPathMaster
27982 The file path, absolute or relative to the master \SpecialChar LyX
27986 \begin_layout Description
27987 \begin_inset Flex Code
27990 \begin_layout Plain Layout
27991 $$AbsOrRelPathParent
27996 The file path, absolute or relative to the \SpecialChar LyX
28000 \begin_layout Description
28001 \begin_inset Flex Code
28004 \begin_layout Plain Layout
28010 The absolute file path.
28013 \begin_layout Description
28014 \begin_inset Flex Code
28017 \begin_layout Plain Layout
28023 The filename without path and without the extension.
28026 \begin_layout Description
28027 \begin_inset Flex Code
28030 \begin_layout Plain Layout
28032 \begin_inset Quotes eld
28036 \begin_inset Quotes erd
28044 This macro will expand to the contents of the file with the name
28045 \begin_inset Flex Code
28048 \begin_layout Plain Layout
28057 \begin_layout Description
28058 \begin_inset Flex Code
28061 \begin_layout Plain Layout
28067 The file extension (including the dot).
28070 \begin_layout Description
28071 \begin_inset Flex Code
28074 \begin_layout Plain Layout
28080 This will be the string
28081 \begin_inset Quotes eld
28085 \begin_inset Quotes erd
28088 if the file is in JPEG format, otherwise it will be the string
28089 \begin_inset Quotes eld
28093 \begin_inset Quotes erd
28097 This is useful to avoid uneeded conversions for output formats that support
28098 both PNG and JPEG fomats.
28099 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
28104 \begin_layout Description
28105 \begin_inset Flex Code
28108 \begin_layout Plain Layout
28114 The filename of the file specified in the external material dialog.
28115 This is either an absolute name, or it is relative to the \SpecialChar LyX
28119 \begin_layout Description
28120 \begin_inset Flex Code
28123 \begin_layout Plain Layout
28130 \begin_inset Flex Code
28133 \begin_layout Plain Layout
28139 (absolute name or relative to the \SpecialChar LyX
28143 \begin_layout Description
28144 \begin_inset Flex Code
28147 \begin_layout Plain Layout
28153 The file path, relative to the master \SpecialChar LyX
28157 \begin_layout Description
28158 \begin_inset Flex Code
28161 \begin_layout Plain Layout
28167 The file path, relative to the \SpecialChar LyX
28171 \begin_layout Description
28172 \begin_inset Flex Code
28175 \begin_layout Plain Layout
28181 This macro will expand to the absolute path of the system directory.
28182 This is typically used to point to the various helper scripts that are
28183 bundled with \SpecialChar LyX
28187 \begin_layout Description
28188 \begin_inset Flex Code
28191 \begin_layout Plain Layout
28197 A name and full path to a temporary file which will be automatically deleted
28198 whenever the containing document is closed, or the external material insertion
28202 \begin_layout Standard
28203 All path macros contain a trailing directory separator, so you can construct
28205 \begin_inset space \thinspace{}
28209 \begin_inset space \space{}
28212 the absolute filename with
28213 \begin_inset Flex Code
28216 \begin_layout Plain Layout
28217 $$AbsPath$$Basename$$Extension
28225 \begin_layout Standard
28226 The macros above are substituted in all commands unless otherwise noted.
28228 \begin_inset Flex Code
28231 \begin_layout Plain Layout
28237 supports additionally the following substitutions if they are enabled by
28239 \begin_inset Flex Code
28242 \begin_layout Plain Layout
28249 \begin_inset Flex Code
28252 \begin_layout Plain Layout
28261 \begin_layout Description
28262 \begin_inset Flex Code
28265 \begin_layout Plain Layout
28271 The front part of the resize command.
28274 \begin_layout Description
28275 \begin_inset Flex Code
28278 \begin_layout Plain Layout
28284 The back part of the resize command.
28287 \begin_layout Description
28288 \begin_inset Flex Code
28291 \begin_layout Plain Layout
28297 The front part of the rotation command.
28300 \begin_layout Description
28301 \begin_inset Flex Code
28304 \begin_layout Plain Layout
28310 The back part of the rotation command.
28313 \begin_layout Standard
28314 The value string of the
28315 \begin_inset Flex Code
28318 \begin_layout Plain Layout
28324 command supports additionally the following substitutions if they are enabled
28326 \begin_inset Flex Code
28329 \begin_layout Plain Layout
28336 \begin_inset Flex Code
28339 \begin_layout Plain Layout
28348 \begin_layout Description
28349 \begin_inset Flex Code
28352 \begin_layout Plain Layout
28361 \begin_layout Description
28362 \begin_inset Flex Code
28365 \begin_layout Plain Layout
28374 \begin_layout Description
28375 \begin_inset Flex Code
28378 \begin_layout Plain Layout
28387 \begin_layout Description
28388 \begin_inset Flex Code
28391 \begin_layout Plain Layout
28397 The rotation option.
28400 \begin_layout Standard
28401 You may ask why there are so many path macros.
28402 There are mainly two reasons:
28405 \begin_layout Enumerate
28406 Relative and absolute file names should remain relative or absolute, respectivel
28408 Users may have reasons to prefer either form.
28409 Relative names are useful for portable documents that should work on different
28410 machines, for example.
28411 Absolute names may be required by some programs.
28414 \begin_layout Enumerate
28416 treats relative file names differently than \SpecialChar LyX
28417 and other programs in nested
28419 For \SpecialChar LyX
28420 , a relative file name is always relative to the document that contains
28422 For \SpecialChar LaTeX
28423 , it is always relative to the master document.
28424 These two definitions are identical if you have only one document, but
28425 differ if you have a master document that includes part documents.
28426 That means that relative filenames must be transformed when presented to
28429 Fortunately \SpecialChar LyX
28430 does this automatically for you if you choose the right macros.
28433 \begin_layout Standard
28434 So which path macro should be used in new template definitions? The rule
28438 \begin_layout Itemize
28440 \begin_inset Flex Code
28443 \begin_layout Plain Layout
28449 if an absolute path is required.
28452 \begin_layout Itemize
28454 \begin_inset Flex Code
28457 \begin_layout Plain Layout
28458 $$AbsOrRelPathMaster
28463 if the substituted string is some kind of \SpecialChar LaTeX
28467 \begin_layout Itemize
28469 \begin_inset Flex Code
28472 \begin_layout Plain Layout
28473 $$AbsOrRelPathParent
28478 in order to preserve the user's choice.
28481 \begin_layout Standard
28482 There are special cases where this rule does not work and e.
28483 \begin_inset space \thinspace{}
28487 \begin_inset space \space{}
28490 relative names are needed, but normally it will work just fine.
28491 One example for such a case is the command
28492 \begin_inset Flex Code
28495 \begin_layout Plain Layout
28496 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28501 in the XFig template above: We can't use the absolute name because the
28503 \begin_inset Flex Code
28506 \begin_layout Plain Layout
28512 files needs the relative name in order to rewrite the file content.
28515 \begin_layout Section
28516 Security discussion
28517 \begin_inset CommandInset label
28519 name "sec:Security-discussion"
28526 \begin_layout Standard
28527 The external material feature interfaces with a lot of external programs
28528 and does so automatically, so we have to consider the security implications
28530 In particular, since you have the option of including your own filenames
28531 and/or parameter strings and those are expanded into a command, it seems
28532 that it would be possible to create a malicious document which executes
28533 arbitrary commands when a user views or prints the document.
28534 This is something we definitely want to avoid.
28537 \begin_layout Standard
28538 However, since the external program commands are specified in the template
28539 configuration file only, there are no security issues if \SpecialChar LyX
28540 is properly configure
28541 d with safe templates only.
28542 This is so because the external programs are invoked with the
28543 \begin_inset Flex Code
28546 \begin_layout Plain Layout
28552 -system call rather than the
28553 \begin_inset Flex Code
28556 \begin_layout Plain Layout
28562 system-call, so it's not possible to execute arbitrary commands from the
28563 filename or parameter section via the shell.
28566 \begin_layout Standard
28567 This also implies that you are restricted in what command strings you can
28568 use in the external material templates.
28569 In particular, pipes and redirection are not readily available.
28570 This has to be so if \SpecialChar LyX
28571 should remain safe.
28572 If you want to use some of the shell features, you should write a safe
28573 script to do this in a controlled manner, and then invoke the script from
28574 the command string.
28578 \begin_layout Standard
28579 It is possible to design a template that interacts directly with the shell,
28580 but since this would allow a malicious user to execute arbitrary commands
28581 by writing clever filenames and/or parameters, we generally recommend that
28582 you only use safe scripts that work with the
28583 \begin_inset Flex Code
28586 \begin_layout Plain Layout
28592 system call in a controlled manner.
28593 Of course, for use in a controlled environment, it can be tempting to just
28594 fall back to use ordinary shell scripts.
28595 If you do so, be aware that you
28599 provide an easily exploitable security hole in your system.
28600 Of course it stands to reason that such unsafe templates will never be
28601 included in the standard \SpecialChar LyX
28602 distribution, although we do encourage people
28603 to submit new templates in the open source tradition.
28604 But \SpecialChar LyX
28605 as shipped from the official distribution channels will never have
28609 \begin_layout Standard
28610 Including external material provides a lot of power, and you have to be
28611 careful not to introduce security hazards with this power.
28612 A subtle error in a single line in an innocent looking script can open
28613 the door to huge security problems.
28614 So if you do not fully understand the issues, we recommend that you consult
28615 a knowledgeable security professional or the \SpecialChar LyX
28616 development team if you have
28617 any questions about whether a given template is safe or not.
28618 And do this before you use it in an uncontrolled environment.
28621 \begin_layout Chapter
28623 List of supported \SpecialChar LyX
28624 functions to be used in layouts
28625 \begin_inset CommandInset label
28627 name "chap:List-of-functions"
28634 \begin_layout Standard
28636 \begin_inset Tabular
28637 <lyxtabular version="3" rows="11" columns="8">
28638 <features tabularvalignment="middle">
28639 <column alignment="left" valignment="top">
28640 <column alignment="left" valignment="top">
28641 <column alignment="left" valignment="top">
28642 <column alignment="left" valignment="top">
28643 <column alignment="left" valignment="top">
28644 <column alignment="left" valignment="top">
28645 <column alignment="left" valignment="top">
28646 <column alignment="left" valignment="top">
28648 <cell alignment="left" valignment="top" usebox="none">
28651 \begin_layout Plain Layout
28657 <cell alignment="left" valignment="top" usebox="none">
28660 \begin_layout Plain Layout
28666 <cell alignment="left" valignment="top" usebox="none">
28669 \begin_layout Plain Layout
28675 <cell alignment="left" valignment="top" usebox="none">
28678 \begin_layout Plain Layout
28684 <cell alignment="center" valignment="top" usebox="none">
28687 \begin_layout Plain Layout
28693 <cell alignment="center" valignment="top" usebox="none">
28696 \begin_layout Plain Layout
28702 <cell alignment="center" valignment="top" usebox="none">
28705 \begin_layout Plain Layout
28711 <cell alignment="center" valignment="top" usebox="none">
28714 \begin_layout Plain Layout
28722 <cell alignment="left" valignment="top" usebox="none">
28725 \begin_layout Plain Layout
28731 <cell alignment="left" valignment="top" usebox="none">
28734 \begin_layout Plain Layout
28740 <cell alignment="left" valignment="top" usebox="none">
28743 \begin_layout Plain Layout
28749 <cell alignment="left" valignment="top" usebox="none">
28752 \begin_layout Plain Layout
28758 <cell alignment="center" valignment="top" usebox="none">
28761 \begin_layout Plain Layout
28767 <cell alignment="center" valignment="top" usebox="none">
28770 \begin_layout Plain Layout
28776 <cell alignment="center" valignment="top" usebox="none">
28779 \begin_layout Plain Layout
28785 <cell alignment="center" valignment="top" usebox="none">
28788 \begin_layout Plain Layout
28796 <cell alignment="left" valignment="top" usebox="none">
28799 \begin_layout Plain Layout
28805 <cell alignment="left" valignment="top" usebox="none">
28808 \begin_layout Plain Layout
28814 <cell alignment="left" valignment="top" usebox="none">
28817 \begin_layout Plain Layout
28823 <cell alignment="left" valignment="top" usebox="none">
28826 \begin_layout Plain Layout
28832 <cell alignment="center" valignment="top" usebox="none">
28835 \begin_layout Plain Layout
28841 <cell alignment="center" valignment="top" usebox="none">
28844 \begin_layout Plain Layout
28850 <cell alignment="center" valignment="top" usebox="none">
28853 \begin_layout Plain Layout
28859 <cell alignment="center" valignment="top" usebox="none">
28862 \begin_layout Plain Layout
28870 <cell alignment="left" valignment="top" usebox="none">
28873 \begin_layout Plain Layout
28879 <cell alignment="left" valignment="top" usebox="none">
28882 \begin_layout Plain Layout
28888 <cell alignment="left" valignment="top" usebox="none">
28891 \begin_layout Plain Layout
28897 <cell alignment="left" valignment="top" usebox="none">
28900 \begin_layout Plain Layout
28906 <cell alignment="center" valignment="top" usebox="none">
28909 \begin_layout Plain Layout
28915 <cell alignment="center" valignment="top" usebox="none">
28918 \begin_layout Plain Layout
28924 <cell alignment="center" valignment="top" usebox="none">
28927 \begin_layout Plain Layout
28933 <cell alignment="center" valignment="top" usebox="none">
28936 \begin_layout Plain Layout
28944 <cell alignment="left" valignment="top" usebox="none">
28947 \begin_layout Plain Layout
28953 <cell alignment="left" valignment="top" usebox="none">
28956 \begin_layout Plain Layout
28962 <cell alignment="left" valignment="top" usebox="none">
28965 \begin_layout Plain Layout
28971 <cell alignment="left" valignment="top" usebox="none">
28974 \begin_layout Plain Layout
28980 <cell alignment="center" valignment="top" usebox="none">
28983 \begin_layout Plain Layout
28989 <cell alignment="center" valignment="top" usebox="none">
28992 \begin_layout Plain Layout
28998 <cell alignment="center" valignment="top" usebox="none">
29001 \begin_layout Plain Layout
29007 <cell alignment="center" valignment="top" usebox="none">
29010 \begin_layout Plain Layout
29018 <cell alignment="left" valignment="top" usebox="none">
29021 \begin_layout Plain Layout
29027 <cell alignment="left" valignment="top" usebox="none">
29030 \begin_layout Plain Layout
29036 <cell alignment="left" valignment="top" usebox="none">
29039 \begin_layout Plain Layout
29045 <cell alignment="left" valignment="top" usebox="none">
29048 \begin_layout Plain Layout
29054 <cell alignment="center" valignment="top" usebox="none">
29057 \begin_layout Plain Layout
29063 <cell alignment="center" valignment="top" usebox="none">
29066 \begin_layout Plain Layout
29072 <cell alignment="center" valignment="top" usebox="none">
29075 \begin_layout Plain Layout
29081 <cell alignment="center" valignment="top" usebox="none">
29084 \begin_layout Plain Layout
29092 <cell alignment="left" valignment="top" usebox="none">
29095 \begin_layout Plain Layout
29101 <cell alignment="left" valignment="top" usebox="none">
29104 \begin_layout Plain Layout
29110 <cell alignment="left" valignment="top" usebox="none">
29113 \begin_layout Plain Layout
29119 <cell alignment="left" valignment="top" usebox="none">
29122 \begin_layout Plain Layout
29128 <cell alignment="center" valignment="top" usebox="none">
29131 \begin_layout Plain Layout
29137 <cell alignment="center" valignment="top" usebox="none">
29140 \begin_layout Plain Layout
29146 <cell alignment="center" valignment="top" usebox="none">
29149 \begin_layout Plain Layout
29155 <cell alignment="center" valignment="top" usebox="none">
29158 \begin_layout Plain Layout
29166 <cell alignment="left" valignment="top" usebox="none">
29169 \begin_layout Plain Layout
29175 <cell alignment="left" valignment="top" usebox="none">
29178 \begin_layout Plain Layout
29184 <cell alignment="left" valignment="top" usebox="none">
29187 \begin_layout Plain Layout
29193 <cell alignment="left" valignment="top" usebox="none">
29196 \begin_layout Plain Layout
29202 <cell alignment="center" valignment="top" usebox="none">
29205 \begin_layout Plain Layout
29211 <cell alignment="center" valignment="top" usebox="none">
29214 \begin_layout Plain Layout
29220 <cell alignment="center" valignment="top" usebox="none">
29223 \begin_layout Plain Layout
29229 <cell alignment="center" valignment="top" usebox="none">
29232 \begin_layout Plain Layout
29240 <cell alignment="left" valignment="top" usebox="none">
29243 \begin_layout Plain Layout
29249 <cell alignment="left" valignment="top" usebox="none">
29252 \begin_layout Plain Layout
29258 <cell alignment="left" valignment="top" usebox="none">
29261 \begin_layout Plain Layout
29267 <cell alignment="left" valignment="top" usebox="none">
29270 \begin_layout Plain Layout
29276 <cell alignment="center" valignment="top" usebox="none">
29279 \begin_layout Plain Layout
29285 <cell alignment="center" valignment="top" usebox="none">
29288 \begin_layout Plain Layout
29294 <cell alignment="center" valignment="top" usebox="none">
29297 \begin_layout Plain Layout
29303 <cell alignment="center" valignment="top" usebox="none">
29306 \begin_layout Plain Layout
29314 <cell alignment="left" valignment="top" usebox="none">
29317 \begin_layout Plain Layout
29323 <cell alignment="left" valignment="top" usebox="none">
29326 \begin_layout Plain Layout
29332 <cell alignment="left" valignment="top" usebox="none">
29335 \begin_layout Plain Layout
29341 <cell alignment="left" valignment="top" usebox="none">
29344 \begin_layout Plain Layout
29350 <cell alignment="center" valignment="top" usebox="none">
29353 \begin_layout Plain Layout
29359 <cell alignment="center" valignment="top" usebox="none">
29362 \begin_layout Plain Layout
29368 <cell alignment="center" valignment="top" usebox="none">
29371 \begin_layout Plain Layout
29377 <cell alignment="center" valignment="top" usebox="none">
29380 \begin_layout Plain Layout
29388 <cell alignment="center" valignment="top" usebox="none">
29391 \begin_layout Plain Layout
29397 <cell alignment="center" valignment="top" usebox="none">
29400 \begin_layout Plain Layout
29406 <cell alignment="center" valignment="top" usebox="none">
29409 \begin_layout Plain Layout
29415 <cell alignment="center" valignment="top" usebox="none">
29418 \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
29468 \begin_layout Chapter
29469 Names of available colors to be used in layouts
29470 \begin_inset CommandInset label
29472 name "chap:Names-of-colors"
29479 \begin_layout Standard
29480 The colors listed below are the standard colors and those that you can adjust
29481 in the \SpecialChar LyX
29485 \begin_layout Section
29489 \begin_layout Standard
29490 The following are no real colors, but rather act on color definitions:
29493 \begin_layout Description
29494 ignore The color is ignored
29497 \begin_layout Description
29498 inherit The color is inherited
29501 \begin_layout Description
29514 No particular color – clear or default
29517 \begin_layout Section
29521 \begin_layout Standard
29522 These are fixed colors that cannot be customized:
29525 \begin_layout Description
29529 \begin_layout Description
29533 \begin_layout Description
29537 \begin_layout Description
29541 \begin_layout Description
29545 \begin_layout Description
29549 \begin_layout Description
29553 \begin_layout Description
29557 \begin_layout Description
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 Section
29605 \begin_layout Standard
29606 These are the colors allocated to specific elements in
29609 arg "dialog-show prefs"
29615 \begin_layout Description
29616 added_space Added space color
29619 \begin_layout Description
29620 addedtext Added text color
29623 \begin_layout Description
29624 appendix Appendix marker color
29627 \begin_layout Description
29628 background Background color
29631 \begin_layout Description
29632 bottomarea Bottom area color
29635 \begin_layout Description
29636 branchlabel Label color for branches
29639 \begin_layout Description
29640 buttonbg Color used for button background
29643 \begin_layout Description
29644 buttonframe Color for inset button frames
29647 \begin_layout Description
29648 buttonhoverbg Color used for button background under focus
29651 \begin_layout Description
29652 changebar Changebar color
29655 \begin_layout Description
29656 changedtextauthor1 Changed text color author 1
29659 \begin_layout Description
29660 changedtextauthor2 Changed text color author 2
29663 \begin_layout Description
29664 changedtextauthor3 Changed text color author 3
29667 \begin_layout Description
29668 changedtextauthor4 Changed text color author 4
29671 \begin_layout Description
29672 changedtextauthor5 Changed text color author 5
29675 \begin_layout Description
29676 collapsible Collapsible insets text color
29679 \begin_layout Description
29680 collapsibleframe Collapsible insets framecolor
29683 \begin_layout Description
29684 command Text color for command insets
29687 \begin_layout Description
29688 commandbg Background color for command insets
29691 \begin_layout Description
29692 commandframe Frame color for command insets
29695 \begin_layout Description
29696 comment Label color for comments
29699 \begin_layout Description
29700 commentbg Background color of comments
29703 \begin_layout Description
29704 cursor Cursor color
29707 \begin_layout Description
29708 deletedtext Deleted text color
29711 \begin_layout Description
29712 deletedtextmodifier Deleted text modifying color
29715 \begin_layout Description
29716 depthbar Color for the depth bars in the margin
29719 \begin_layout Description
29720 eolmarker End of line marker color
29723 \begin_layout Description
29724 error Color of the \SpecialChar LaTeX
29728 \begin_layout Description
29729 footlabel Label color for footnotes
29732 \begin_layout Description
29733 foreground Foreground color
29736 \begin_layout Description
29737 graphicsbg Graphics inset background color
29740 \begin_layout Description
29741 greyedoutbg Background color of greyedout inset
29744 \begin_layout Description
29745 greyedoutlabel Label color for greyedout insets
29748 \begin_layout Description
29749 greyedouttext Color for greyedout inset text
29752 \begin_layout Description
29753 indexlabel Label color for index insets
29756 \begin_layout Description
29757 inlinecompletion Inline completion color
29760 \begin_layout Description
29761 insetbg Inset marker background color
29764 \begin_layout Description
29765 insetframe Inset marker frame color
29768 \begin_layout Description
29769 language Color for marking foreign language words
29772 \begin_layout Description
29773 latex Text color in \SpecialChar LaTeX
29777 \begin_layout Description
29778 listingsbg Background color of listings inset
29781 \begin_layout Description
29782 marginlabel Label color for margin notes
29785 \begin_layout Description
29786 math Math inset text color
29789 \begin_layout Description
29790 mathbg Math inset background color
29793 \begin_layout Description
29794 mathcorners Math inset frame color not under focus
29797 \begin_layout Description
29798 mathframe Math inset frame color under focus
29801 \begin_layout Description
29802 mathline Math line color
29805 \begin_layout Description
29806 mathmacrobg Macro math inset background color
29809 \begin_layout Description
29810 mathmacroblend Macro math blended color
29813 \begin_layout Description
29814 mathmacroframe Macro math frame color
29817 \begin_layout Description
29818 mathmacrohoverbg Macro math inset background color hovered
29821 \begin_layout Description
29822 mathmacrolabel Macro math label color
29825 \begin_layout Description
29826 mathmacronewarg Macro template color for new parameters
29829 \begin_layout Description
29830 mathmacrooldarg Macro template color for old parameters
29833 \begin_layout Description
29834 newpage New page color
29837 \begin_layout Description
29838 nonunique_inlinecompletion Inline completion color for the non-unique part
29841 \begin_layout Description
29842 note Label color for notes
29845 \begin_layout Description
29846 notebg Background color of notes
29849 \begin_layout Description
29850 pagebreak Page break/line break color
29853 \begin_layout Description
29854 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29857 \begin_layout Description
29858 phantomtext Text color for phantom insets
29861 \begin_layout Description
29862 preview The color used for previews
29865 \begin_layout Description
29866 previewframe Preview frame color
29869 \begin_layout Description
29870 regexpframe Color for regexp frame
29873 \begin_layout Description
29874 scroll Color that indicates when a row can be scrolled
29877 \begin_layout Description
29878 selection Background color of selected text
29881 \begin_layout Description
29882 selectiontext Foreground color of selected text
29885 \begin_layout Description
29886 shadedbg Background color of shaded box
29889 \begin_layout Description
29890 special Special chars text color
29893 \begin_layout Description
29894 tabularline Table line color
29897 \begin_layout Description
29898 tabularonoffline Table line color
29901 \begin_layout Description
29902 urllabel Label color for URL insets
29905 \begin_layout Description
29906 urltext Color for URL inset text