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
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 1
86 \use_package amssymb 1
89 \use_package mathdots 1
90 \use_package mathtools 1
92 \use_package stackrel 1
93 \use_package stmaryrd 1
94 \use_package undertilde 1
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes true
128 \output_changes false
132 \author -712698321 "Jürgen Spitzmüller"
133 \author -495245474 "Jean-Marc Lasgouttes"
134 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
140 Customizing \SpecialChar LyX
141 : Features for the Advanced User
145 by the \SpecialChar LyX
150 \begin_layout Plain Layout
152 If you have comments or error corrections, please send them to the \SpecialChar LyX
155 \begin_inset CommandInset href
157 target "lyx-docs@lists.lyx.org"
165 \begin_inset Quotes eld
169 \begin_inset Quotes erd
172 in the subject header, and please cc the current maintainer of this file,
173 Richard Heck <rgheck@comcast.net>.
179 \begin_inset Newline newline
183 \begin_inset Newline newline
189 \begin_layout Standard
190 \begin_inset CommandInset toc
191 LatexCommand tableofcontents
198 \begin_layout Standard
199 \begin_inset Note Note
202 \begin_layout Plain Layout
203 Please use change tracking when modifying this document.
204 This makes it easier for our translators to recognize things that have
205 been changed, and it helps the maintainer keep up-to-date with what's been
214 \begin_layout Chapter
218 \begin_layout Standard
219 This manual covers the customization features present in \SpecialChar LyX
221 In it, we discuss issues like keyboard shortcuts, screen previewing options,
222 printer options, sending commands to \SpecialChar LyX
223 via the \SpecialChar LyX
224 Server, internationalization,
225 installing new \SpecialChar LaTeX
226 classes and \SpecialChar LyX
228 We can't possibly hope to touch on everything you can change—our developers
229 add new features faster than we can document them—but we will explain the
230 most common customizations and hopefully point you in the right direction
231 for some of the more obscure ones.
234 \begin_layout Standard
235 \begin_inset Branch OutDated
239 \begin_layout Standard
240 Information from previous versions of this document that now seems to be
241 outdated is contained in the OutDated branch of this document.
242 By default, this information will not appear in the \SpecialChar LaTeX
251 \begin_layout Chapter
256 \begin_layout Standard
257 This chapter aims to help you to find your way through the \SpecialChar LyX
260 Before continuing to read this chapter, you should find out where your
262 library and user directories are by using
263 \begin_inset Flex Noun
266 \begin_layout Plain Layout
267 Help\SpecialChar menuseparator
278 The library directory is the place where \SpecialChar LyX
279 places its system-wide configuration
280 files; the user directory is where you can place your modified versions.
281 We will call the former
282 \begin_inset Flex Code
285 \begin_layout Plain Layout
292 \begin_inset Flex Noun
295 \begin_layout Plain Layout
301 in the remainder of this document.
305 \begin_layout Section
307 \begin_inset Flex Code
310 \begin_layout Plain Layout
319 \begin_layout Standard
320 \begin_inset Flex Code
323 \begin_layout Plain Layout
329 and its sub-directories contain a number of files and that can be used
330 to customize \SpecialChar LyX
332 You can change many of these files from within \SpecialChar LyX
334 \begin_inset Flex Noun
337 \begin_layout Plain Layout
338 Tools\SpecialChar menuseparator
345 Most customization that you will want to do in \SpecialChar LyX
346 is possible through this
348 However, many other inner aspects of \SpecialChar LyX
349 can be customized by modifying the
351 \begin_inset Flex Code
354 \begin_layout Plain Layout
361 These files fall in different categories, described in the following subsection
365 \begin_layout Subsection
366 Automatically generated files
369 \begin_layout Standard
370 The files, which are to be found in
371 \begin_inset Flex Noun
374 \begin_layout Plain Layout
380 , are generated when you configure \SpecialChar LyX
382 They contain various default values that are guessed by inspection.
383 In general, it is not a good idea to modify them, since they might be overwritt
387 \begin_layout Labeling
388 \labelwidthstring 00.00.0000
389 \begin_inset Flex Code
392 \begin_layout Plain Layout
398 contains defaults for various commands.
401 \begin_layout Labeling
402 \labelwidthstring 00.00.0000
403 \begin_inset Flex Code
406 \begin_layout Plain Layout
412 contains the list of packages that have been recognized by \SpecialChar LyX
414 It is currently unused by the \SpecialChar LyX
415 program itself, but the information extracted,
416 and more, is made available with
417 \begin_inset Flex Noun
420 \begin_layout Plain Layout
421 Help\SpecialChar menuseparator
435 \begin_layout Labeling
436 \labelwidthstring 00.00.0000
437 \begin_inset Flex Code
440 \begin_layout Plain Layout
446 the list of text classes that have been found in your
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
456 directories, along with the associated \SpecialChar LaTeX
457 document class and their description.
460 \begin_layout Labeling
461 \labelwidthstring 00.00.0000
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
471 the list of layout modules found in your
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
484 \begin_layout Labeling
485 \labelwidthstring 00.00.0000
486 \begin_inset Flex Code
489 \begin_layout Plain Layout
495 lists of various sorts of \SpecialChar LaTeX
496 -related files found on your system
499 \begin_layout Labeling
500 \labelwidthstring 00.00.0000
501 \begin_inset Flex Code
504 \begin_layout Plain Layout
505 doc/\SpecialChar LaTeX
511 is automatically generated during configuration from the file
512 \begin_inset Flex Code
515 \begin_layout Plain Layout
523 It contains information on your \SpecialChar LaTeX
527 \begin_layout Subsection
531 \begin_layout Standard
532 These directories are duplicated between
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
553 If a particular files exists in both places, the one in
554 \begin_inset Flex Code
557 \begin_layout Plain Layout
566 \begin_layout Labeling
567 \labelwidthstring 00.00.0000
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 this directory contains files with the extension
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
587 that define the keybindings used in \SpecialChar LyX
589 If there exists an internationalized version of the bind file named
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 , that will be used first.
602 \begin_layout Labeling
603 \labelwidthstring 00.00.0000
604 \begin_inset Flex Code
607 \begin_layout Plain Layout
613 contains files with the extension
614 \begin_inset Flex Code
617 \begin_layout Plain Layout
623 which define the diverse citation possibilities (natbib, biblatex etc.).
625 \begin_inset CommandInset ref
627 reference "subsec:Cite-Engine-Files"
637 \begin_layout Labeling
638 \labelwidthstring 00.00.0000
639 \begin_inset Flex Code
642 \begin_layout Plain Layout
648 contains graphics files that can be included in documents.
652 \begin_layout Labeling
653 \labelwidthstring 00.00.0000
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
663 contains \SpecialChar LyX
664 documentation files (including the one you are currently reading).
666 \begin_inset Flex Code
669 \begin_layout Plain Layout
676 deserves special attention, as noted above.
677 The internationalized help docs are in subdirectories
678 \begin_inset Flex Code
681 \begin_layout Plain Layout
688 \begin_inset Quotes eld
692 \begin_inset Quotes erd
695 is the ISO language code.
697 \begin_inset CommandInset ref
699 reference "cha:Internationalizing-LyX"
706 \begin_layout Labeling
707 \labelwidthstring 00.00.0000
708 \begin_inset Flex Code
711 \begin_layout Plain Layout
717 contains example files that explain how to use some features.
718 In the file browser, press the
719 \begin_inset Flex Noun
722 \begin_layout Plain Layout
731 \begin_layout Labeling
732 \labelwidthstring 00.00.0000
733 \begin_inset Flex Code
736 \begin_layout Plain Layout
742 contains image files that are used by the
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
753 In addition, it also contains the individual icons used in the toolbar
754 and the banners that can be shown when \SpecialChar LyX
758 \begin_layout Labeling
759 \labelwidthstring 00.00.0000
760 \begin_inset Flex Code
763 \begin_layout Plain Layout
769 contains keyboard keymapping files.
771 \begin_inset CommandInset ref
773 reference "sec:International-Keymap-Stuff"
780 \begin_layout Labeling
781 \labelwidthstring 00.00.0000
782 \begin_inset Flex Code
785 \begin_layout Plain Layout
791 contains the text class and module files described in
792 \begin_inset CommandInset ref
794 reference "cha:Installing-New-Document"
801 \begin_layout Labeling
802 \labelwidthstring 00.00.0000
803 \begin_inset Flex Code
806 \begin_layout Plain Layout
813 \begin_inset Flex Code
816 \begin_layout Plain Layout
822 Python scripts used to convert between \SpecialChar LyX
824 These can be run from the command line if, say, you want to batch-convert
828 \begin_layout Labeling
829 \labelwidthstring 00.00.0000
830 \begin_inset Flex Code
833 \begin_layout Plain Layout
839 contains some files that demonstrate the capabilities of the
840 \begin_inset Flex Noun
843 \begin_layout Plain Layout
854 Also contains some scripts used by \SpecialChar LyX
858 \begin_layout Labeling
859 \labelwidthstring 00.00.0000
860 \begin_inset Flex Code
863 \begin_layout Plain Layout
869 contains the standard \SpecialChar LyX
870 template files described in
871 \begin_inset CommandInset ref
873 reference "subsec:Creating-Templates"
880 \begin_layout Labeling
881 \labelwidthstring 00.00.0000
882 \begin_inset Flex Code
885 \begin_layout Plain Layout
891 contains files with the extension
892 \begin_inset Flex Code
895 \begin_layout Plain Layout
901 that define the user interface to \SpecialChar LyX
903 That is, the files define which items appear in which menus and the items
904 appearing on the toolbar.
907 \begin_layout Labeling
908 \labelwidthstring 00.00.0000
909 \begin_inset Flex Code
912 \begin_layout Plain Layout
918 contains files with the extension
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
928 which define the templates for the insertion of external material to a
931 \begin_inset CommandInset ref
933 reference "chap:Including-External-Material"
940 \begin_layout Subsection
941 Files you don't want to modify
944 \begin_layout Standard
945 These files are used internally by \SpecialChar LyX
946 and you generally do not need to modify
947 them unless you are a developer.
950 \begin_layout Labeling
951 \labelwidthstring 00.00.0000
952 \begin_inset Flex Code
955 \begin_layout Plain Layout
961 this file contains the list of \SpecialChar LyX
963 The contents are displayed with the menu entry
964 \begin_inset Flex Noun
967 \begin_layout Plain Layout
968 Help\SpecialChar menuseparator
981 \begin_layout Labeling
982 \labelwidthstring 00.00.0000
983 \begin_inset Flex Code
986 \begin_layout Plain Layout
992 this is a \SpecialChar LaTeX
993 script used during the configuration process.
997 \begin_layout Labeling
998 \labelwidthstring 00.00.0000
999 \begin_inset Flex Code
1002 \begin_layout Plain Layout
1008 this is a Python script that is used to re-configure \SpecialChar LyX
1010 It creates configuration files in the directory it was run from.
1013 \begin_layout Subsection
1014 Other files needing a line or two
1017 \begin_layout Labeling
1018 \labelwidthstring 00.00.0000
1019 \begin_inset Flex Code
1022 \begin_layout Plain Layout
1028 this contains tables describing how different character encodings can be
1032 \begin_layout Labeling
1033 \labelwidthstring 00.00.0000
1034 \begin_inset Flex Code
1037 \begin_layout Plain Layout
1043 this file contains a list of all the languages currently supported by \SpecialChar LyX
1047 \begin_layout Labeling
1048 \labelwidthstring 00.00.0000
1049 \begin_inset Flex Code
1052 \begin_layout Plain Layout
1058 contains information about the supported fonts.
1061 \begin_layout Labeling
1062 \labelwidthstring 00.00.0000
1063 \begin_inset Flex Code
1066 \begin_layout Plain Layout
1072 this file contains translations for internationalized paragraph styles
1074 \begin_inset CommandInset ref
1076 reference "subsec:I18n"
1083 \begin_layout Labeling
1084 \labelwidthstring 00.00.0000
1085 \begin_inset Flex Code
1088 \begin_layout Plain Layout
1094 this file contains information about Unicode-encoded glyphs and the way
1095 they are supported by \SpecialChar LyX
1096 via \SpecialChar LaTeX
1100 \begin_layout Section
1101 Your local configuration directory
1104 \begin_layout Standard
1105 Even if you are using \SpecialChar LyX
1106 as an unprivileged user, you might want to change
1108 configuration for your own use.
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1119 directory contains all your personal configuration files.
1120 This is the directory described as
1121 \begin_inset Quotes eld
1125 \begin_inset Quotes erd
1129 \begin_inset Flex Noun
1132 \begin_layout Plain Layout
1133 Help\SpecialChar menuseparator
1135 \begin_inset space ~
1144 This directory is used as a mirror of
1145 \begin_inset Flex Code
1148 \begin_layout Plain Layout
1154 , which means that every file in
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1164 is a replacement for the corresponding file in
1165 \begin_inset Flex Code
1168 \begin_layout Plain Layout
1175 Any configuration file described in the above sections can be placed either
1176 in the system-wide directory, in which case it will affect all users, or
1177 in your local directory for your own use.
1180 \begin_layout Standard
1181 To make things clearer, let's provide a few examples:
1184 \begin_layout Itemize
1185 The preferences set in the
1186 \begin_inset Flex Noun
1189 \begin_layout Plain Layout
1190 Tools\SpecialChar menuseparator
1196 dialog are saved to a file
1197 \begin_inset Flex Code
1200 \begin_layout Plain Layout
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1219 \begin_layout Itemize
1220 When you reconfigure using
1221 \begin_inset Flex Noun
1224 \begin_layout Plain Layout
1225 Tools\SpecialChar menuseparator
1233 \begin_inset Flex Code
1236 \begin_layout Plain Layout
1242 script, and the resulting files are written in your local configuration
1244 This means that any additional text class file that you might have added
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1255 will be added to the list of classes in the
1256 \begin_inset Flex Noun
1259 \begin_layout Plain Layout
1260 Document\SpecialChar menuseparator
1269 \begin_layout Itemize
1270 If you get some updated documentation from \SpecialChar LyX
1271 ftp site and cannot install
1272 it because you do not have sysadmin rights on your system, you can just
1274 \begin_inset Flex Code
1277 \begin_layout Plain Layout
1283 and the items in the
1284 \begin_inset Flex Noun
1287 \begin_layout Plain Layout
1293 menu will open them!
1296 \begin_layout Section
1297 Running \SpecialChar LyX
1298 with multiple configurations
1301 \begin_layout Standard
1302 The configuration freedom of the local configuration directory may not suffice
1303 if you want to have more than one configuration at your disposal.
1304 For example, you may want to be use different key bindings or printer settings
1306 You can achieve this by having several such directories.
1307 You then specify which directory to use at run-time.
1310 \begin_layout Standard
1311 Invoking \SpecialChar LyX
1312 with the command line switch
1313 \begin_inset Flex Code
1316 \begin_layout Plain Layout
1326 instructs the program to read the configuration from that directory, and
1327 not from the default directory.
1328 (You can determine the default directory by running \SpecialChar LyX
1330 \begin_inset Flex Code
1333 \begin_layout Plain Layout
1339 switch.) If the specified directory does not exist, \SpecialChar LyX
1341 for you, just like it does for the default directory on the first time
1342 you run the program.
1343 You can modify the configuration options in this additional user directory
1344 exactly as you would for the default directory.
1345 These directories are completely independent (but read on).
1346 Note that setting the environment variable
1347 \begin_inset Flex Code
1350 \begin_layout Plain Layout
1356 to some value has exactly the same effect.
1359 \begin_layout Standard
1360 Having several configurations also requires more maintenance: if you want
1361 to add a new layout to
1362 \begin_inset Flex Code
1365 \begin_layout Plain Layout
1371 which you want available from all your configurations, you must add it
1372 to each directory separately.
1373 You can avoid this with the following trick: after \SpecialChar LyX
1374 creates the additional
1375 directory, most of the subdirectories (see above) are empty.
1376 If you want the new configuration to mirror an existing one, replace the
1377 empty subdirectory with a symbolic link to the matching subdirectory in
1378 the existing configuration.
1380 \begin_inset Flex Code
1383 \begin_layout Plain Layout
1389 subdirectory, however, since it contains a file written by the configuration
1390 script (also accessible through
1391 \begin_inset Flex Noun
1394 \begin_layout Plain Layout
1395 Tools\SpecialChar menuseparator
1401 ) which is configuration-specific.
1404 \begin_layout Chapter
1405 The Preferences dialog
1408 \begin_layout Standard
1409 All options of the preferences dialog are described in the Appendix
1411 The Preferences Dialog
1418 For some options you might find here more details.
1421 \begin_layout Section
1423 \begin_inset CommandInset label
1432 \begin_layout Standard
1433 The first step is to define your file formats if they are not already defined.
1435 \begin_inset Flex Noun
1438 \begin_layout Plain Layout
1439 Tools\SpecialChar menuseparator
1447 \begin_inset Flex Noun
1450 \begin_layout Plain Layout
1451 File Handling\SpecialChar menuseparator
1458 \begin_inset Flex Noun
1461 \begin_layout Plain Layout
1467 button to define your new format.
1469 \begin_inset Flex Noun
1472 \begin_layout Plain Layout
1478 field contains the name used to identify the format in the GUI.
1480 \begin_inset Flex Noun
1483 \begin_layout Plain Layout
1489 is used to identify the format internally.
1490 You will also need to enter a file extension.
1491 These are all required.
1493 \begin_inset Flex Noun
1496 \begin_layout Plain Layout
1502 field is used to provide a keyboard shortcut on the menus.
1503 (For example, pressing
1504 \begin_inset Flex Noun
1507 \begin_layout Plain Layout
1514 \begin_inset Flex Noun
1517 \begin_layout Plain Layout
1518 Document\SpecialChar menuseparator
1519 View (Other Formats)\SpecialChar menuseparator
1528 \begin_layout Standard
1530 \begin_inset Flex Noun
1533 \begin_layout Plain Layout
1540 \begin_inset Flex Noun
1543 \begin_layout Plain Layout
1550 For example, you might want to use
1551 \begin_inset Flex Noun
1554 \begin_layout Plain Layout
1560 to view PostScript files.
1561 You can enter the command needed to start the program in the corresponding
1563 In defining this command, you can use the four variables listed in the
1565 The viewer is launched when you view an image in \SpecialChar LyX
1567 \begin_inset Flex Noun
1570 \begin_layout Plain Layout
1571 Document\SpecialChar menuseparator
1578 The editor is for example launched when you right-click on an image and
1580 \begin_inset Flex Noun
1583 \begin_layout Plain Layout
1589 in the appearing context menu.
1592 \begin_layout Standard
1594 \begin_inset Flex Noun
1597 \begin_layout Plain Layout
1603 type of a format is optional, but if it is specified, it must be unique
1605 It is used to detect files of this format from the file contents.
1606 For some important file formats there is no MIME type officially registered
1608 \begin_inset CommandInset href
1611 target "http://www.iana.org/assignments/media-types/"
1617 Therefore \SpecialChar LyX
1618 uses the extended list of MIME types as specified by
1619 \begin_inset CommandInset href
1621 name "freedesktop.org"
1622 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1630 \begin_layout Standard
1632 \begin_inset Flex Noun
1635 \begin_layout Plain Layout
1641 option tells \SpecialChar LyX
1642 that a format is suitable for document export.
1643 If this is set and if a suitable conversion route exists (see
1644 \begin_inset CommandInset ref
1646 reference "sec:Converters"
1650 ), the format will appear in the
1651 \begin_inset Flex Noun
1654 \begin_layout Plain Layout
1655 File\SpecialChar menuseparator
1662 The format will also appear in the
1663 \begin_inset Flex Noun
1666 \begin_layout Plain Layout
1667 Document\SpecialChar menuseparator
1673 menu if a viewer is specified for the format.
1674 Pure image formats, such as
1675 \begin_inset Flex Code
1678 \begin_layout Plain Layout
1684 , should not use this option.
1685 Formats that can both represent vector graphics and documents like
1686 \begin_inset Flex Code
1689 \begin_layout Plain Layout
1698 \begin_layout Standard
1700 \begin_inset Flex Noun
1703 \begin_layout Plain Layout
1704 Vector graphics format
1709 tells \SpecialChar LyX
1710 that a format can contain vector graphics.
1711 This information is used to determine the target format of included graphics
1713 \begin_inset Flex Noun
1716 \begin_layout Plain Layout
1723 Included graphics may need to be converted to either
1724 \begin_inset Flex Noun
1727 \begin_layout Plain Layout
1734 \begin_inset Flex Noun
1737 \begin_layout Plain Layout
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1754 \begin_inset Flex Noun
1757 \begin_layout Plain Layout
1763 cannot handle other image formats.
1764 If an included graphic is not already in
1765 \begin_inset Flex Noun
1768 \begin_layout Plain Layout
1775 \begin_inset Flex Noun
1778 \begin_layout Plain Layout
1785 \begin_inset Flex Noun
1788 \begin_layout Plain Layout
1794 format, it is converted to
1795 \begin_inset Flex Noun
1798 \begin_layout Plain Layout
1804 if the vector format option is set, and otherwise to
1805 \begin_inset Flex Noun
1808 \begin_layout Plain Layout
1817 \begin_layout Section
1821 \begin_layout Standard
1822 Since all conversions from one format to another take place in \SpecialChar LyX
1824 directory, it is sometimes necessary to modify a file before copying it
1825 to the temporary directory in order that the conversion may be performed.
1829 \begin_layout Plain Layout
1830 For example, the file may refer to other files—images, for example—using
1831 relative file names, and these may become invalid when the file is copied
1832 to the temporary directory.
1837 This is done by a Copier: It copies a file to (or from) the temporary directory
1838 and may modify it in the process.
1841 \begin_layout Standard
1842 The definitions of the copiers may use eight variables:
1845 \begin_layout Labeling
1846 \labelwidthstring 00.00.0000
1847 \begin_inset Flex Code
1850 \begin_layout Plain Layout
1856 The \SpecialChar LyX
1857 system directory (e.
1858 \begin_inset space \thinspace{}
1862 \begin_inset space \space{}
1866 \begin_inset Flex Noun
1869 \begin_layout Plain Layout
1878 \begin_layout Labeling
1879 \labelwidthstring 00.00.0000
1880 \begin_inset Flex Code
1883 \begin_layout Plain Layout
1892 \begin_layout Labeling
1893 \labelwidthstring 00.00.0000
1894 \begin_inset Flex Code
1897 \begin_layout Plain Layout
1906 \begin_layout Labeling
1907 \labelwidthstring 00.00.0000
1908 \begin_inset Flex Code
1911 \begin_layout Plain Layout
1917 The base name (without filename extension) in the \SpecialChar LyX
1921 \begin_layout Labeling
1922 \labelwidthstring 00.00.0000
1923 \begin_inset Flex Code
1926 \begin_layout Plain Layout
1932 The full directory path of the \SpecialChar LyX
1936 \begin_layout Labeling
1937 \labelwidthstring 00.00.0000
1938 \begin_inset Flex Code
1941 \begin_layout Plain Layout
1947 The full pathname to the original \SpecialChar LyX
1948 file being processed
1951 \begin_layout Labeling
1952 \labelwidthstring 00.00.0000
1953 \begin_inset Flex Code
1956 \begin_layout Plain Layout
1962 The filename (without any directory path) of the \SpecialChar LyX
1966 \begin_layout Labeling
1967 \labelwidthstring 00.00.0000
1968 \begin_inset Flex Code
1971 \begin_layout Plain Layout
1977 The `\SpecialChar LaTeX
1981 \begin_layout Standard
1982 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1990 It is relevant only when exporting files suitable for such inclusion.
1993 \begin_layout Standard
1994 Copiers can be used to do almost anything with output files.
1995 For example, suppose you want generated pdf files to be copied to a special
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2007 Then you could write a shell script such as this one:
2010 \begin_layout Standard
2011 \begin_inset listings
2015 \begin_layout Plain Layout
2020 \begin_layout Plain Layout
2025 \begin_layout Plain Layout
2027 TOFILE=`basename $2`
2030 \begin_layout Plain Layout
2032 cp $FROMFILE /home/you/pdf/$TOFILE
2037 Save it in your local \SpecialChar LyX
2039 \begin_inset Flex Code
2042 \begin_layout Plain Layout
2043 /home/you/.lyx/scripts/pdfcopier.sh
2048 —and make it executable, if you need to do so on your platform.
2050 \begin_inset Flex Noun
2053 \begin_layout Plain Layout
2054 Tools\SpecialChar menuseparator
2060 dialog, select under
2061 \begin_inset Flex Noun
2064 \begin_layout Plain Layout
2065 File Handling\SpecialChar menuseparator
2072 \begin_inset Flex Noun
2075 \begin_layout Plain Layout
2081 format—or one of the other pdf formats—and enter
2082 \begin_inset Flex Code
2085 \begin_layout Plain Layout
2086 pdfcopier.sh $$i $$o
2092 \begin_inset Flex Noun
2095 \begin_layout Plain Layout
2105 \begin_layout Standard
2106 Copiers are used by \SpecialChar LyX
2107 in various of its own conversions.
2108 For example, if appropriate programs are found, \SpecialChar LyX
2109 will automatically install
2111 \begin_inset Flex Noun
2114 \begin_layout Plain Layout
2121 \begin_inset Flex Noun
2124 \begin_layout Plain Layout
2126 \begin_inset space ~
2135 When these formats are exported, the copier sees that not just the main
2136 HTML file but various associated files (style files, images, etc.) are also
2138 All these files are written to a subdirectory of the directory in which
2139 the original \SpecialChar LyX
2144 \begin_layout Plain Layout
2145 This copier can be customized.
2147 \begin_inset Quotes eld
2151 \begin_inset Quotes erd
2154 argument takes a comma-separated list of extensions to be copied; if it
2155 is omitted, all files will be copied.
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2164 argument determines the extension added to the generated directory.
2166 \begin_inset Quotes eld
2170 \begin_inset Flex Noun
2173 \begin_layout Plain Layout
2180 \begin_inset Quotes erd
2183 , so HTML generated from
2184 \begin_inset Flex Noun
2187 \begin_layout Plain Layout
2188 /path/to/filename.lyx
2194 \begin_inset Flex Noun
2197 \begin_layout Plain Layout
2198 /path/to/filename.html.LyXconv
2212 \begin_layout Section
2214 \begin_inset CommandInset label
2216 name "sec:Converters"
2223 \begin_layout Standard
2224 You can define your own Converters to convert files between different formats.
2226 \begin_inset Flex Noun
2229 \begin_layout Plain Layout
2230 Tools\SpecialChar menuseparator
2231 Preferences\SpecialChar menuseparator
2232 File Handling\SpecialChar menuseparator
2241 \begin_layout Standard
2242 To define a new converter, select the
2243 \begin_inset Flex Noun
2246 \begin_layout Plain Layout
2248 \begin_inset space ~
2257 \begin_inset Flex Noun
2260 \begin_layout Plain Layout
2262 \begin_inset space ~
2270 from the drop-down lists, enter the command needed for the conversion,
2272 \begin_inset Flex Noun
2275 \begin_layout Plain Layout
2282 Several variables can be used in the definition of converters:
2285 \begin_layout Labeling
2286 \labelwidthstring 00.00.0000
2287 \begin_inset Flex Code
2290 \begin_layout Plain Layout
2296 The \SpecialChar LyX
2300 \begin_layout Labeling
2301 \labelwidthstring 00.00.0000
2302 \begin_inset Flex Code
2305 \begin_layout Plain Layout
2314 \begin_layout Labeling
2315 \labelwidthstring 00.00.0000
2316 \begin_inset Flex Code
2319 \begin_layout Plain Layout
2328 \begin_layout Labeling
2329 \labelwidthstring 00.00.0000
2330 \begin_inset Flex Code
2333 \begin_layout Plain Layout
2339 The base filename of the input file (i.
2340 \begin_inset space \thinspace{}
2343 g., without the extension)
2346 \begin_layout Labeling
2347 \labelwidthstring 00.00.0000
2348 \begin_inset Flex Code
2351 \begin_layout Plain Layout
2357 The path to the input file
2360 \begin_layout Labeling
2361 \labelwidthstring 00.00.0000
2362 \begin_inset Flex Code
2365 \begin_layout Plain Layout
2371 The path to the original input file (this is different from $$p when a
2372 chain of converters is called)
2375 \begin_layout Labeling
2376 \labelwidthstring 00.00.0000
2377 \begin_inset Flex Code
2380 \begin_layout Plain Layout
2386 The iconv name for the encoding of the document.
2389 \begin_layout Standard
2391 \begin_inset Flex Noun
2394 \begin_layout Plain Layout
2396 \begin_inset space ~
2404 field you can enter the following flags, separated by commas:
2407 \begin_layout Labeling
2408 \labelwidthstring 00.00.0000
2409 \begin_inset Flex Code
2412 \begin_layout Plain Layout
2414 \change_inserted -712698321 1524656940
2422 This converter runs some form of \SpecialChar LaTeX
2424 This will make \SpecialChar LyX
2425 's \SpecialChar LaTeX
2426 error logs available.
2428 \change_inserted -712698321 1524657018
2430 \begin_inset Flex Code
2433 \begin_layout Plain Layout
2435 \change_inserted -712698321 1524657012
2443 value specifies the form of \SpecialChar LaTeX
2445 \begin_inset Flex Code
2448 \begin_layout Plain Layout
2450 \change_inserted -712698321 1524657005
2451 latex, pdflatex, platex, xetex, luatex
2459 If no value is specified,
2460 \begin_inset Flex Code
2463 \begin_layout Plain Layout
2465 \change_inserted -712698321 1524657018
2478 \begin_layout Labeling
2479 \labelwidthstring 00.00.0000
2480 \begin_inset Flex Code
2483 \begin_layout Plain Layout
2485 \change_inserted -712698321 1524656935
2493 Needs the \SpecialChar LaTeX
2495 \begin_inset Flex Noun
2498 \begin_layout Plain Layout
2504 file for the conversion.
2506 \change_inserted -712698321 1524657047
2508 \begin_inset Flex Code
2511 \begin_layout Plain Layout
2513 \change_inserted -712698321 1524657030
2519 value specifies the form of \SpecialChar LaTeX
2520 that is run in order to generate the
2521 \begin_inset Flex Noun
2524 \begin_layout Plain Layout
2526 \change_inserted -712698321 1524657047
2533 \begin_inset Flex Code
2536 \begin_layout Plain Layout
2538 \change_inserted -712698321 1524657030
2539 latex, pdflatex, platex, xetex, luatex
2545 If no value is specified,
2546 \begin_inset Flex Code
2549 \begin_layout Plain Layout
2551 \change_inserted -712698321 1524657030
2562 \begin_layout Labeling
2563 \labelwidthstring 00.00.0000
2564 \begin_inset Flex Code
2567 \begin_layout Plain Layout
2574 \begin_inset Quotes eld
2578 \begin_inset Quotes erd
2581 file from the backend, which in practice means a \SpecialChar LaTeX
2582 file like the one we
2583 would export, without
2584 \begin_inset Flex Code
2587 \begin_layout Plain Layout
2596 \begin_layout Labeling
2597 \labelwidthstring 00.00.0000
2598 \begin_inset Flex Code
2601 \begin_layout Plain Layout
2610 \begin_layout Standard
2611 The following three flags are not really flags at all because they take
2613 \begin_inset Flex Noun
2616 \begin_layout Plain Layout
2618 \begin_inset space ~
2622 \begin_inset space ~
2633 \begin_layout Labeling
2634 \labelwidthstring 00.00.0000
2636 \change_inserted -712698321 1523206314
2637 \begin_inset Flex Code
2640 \begin_layout Plain Layout
2642 \change_inserted -712698321 1523206193
2648 The name of the driver that needs to be loaded with the
2652 package for this converter.
2653 The loading of the correct driver is necessary to get some PDF-specific
2662 \begin_layout Labeling
2663 \labelwidthstring 00.00.0000
2664 \begin_inset Flex Code
2667 \begin_layout Plain Layout
2673 If set, the converter's standard error will be redirected to a file
2674 \begin_inset Flex Code
2677 \begin_layout Plain Layout
2683 , and the script given as argument will be run as:
2684 \begin_inset Flex Code
2687 \begin_layout Plain Layout
2688 script < infile.out > infile.log
2694 The argument may contain
2695 \begin_inset Flex Code
2698 \begin_layout Plain Layout
2707 \begin_layout Labeling
2708 \labelwidthstring 00.00.0000
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2718 The name of the directory in which the converter will dump the generated
2721 will not create this directory, and it does not copy anything into it,
2722 though it will copy this directory to the destination.
2723 The argument may contain
2724 \begin_inset Flex Code
2727 \begin_layout Plain Layout
2733 , which will be replaced by the base name of the input and output files,
2734 respectively, when the directory is copied.
2735 \begin_inset Newline newline
2738 Note that resultdir and usetempdir make no sense together.
2739 The latter will be ignored if the former is given.
2742 \begin_layout Labeling
2743 \labelwidthstring 00.00.0000
2744 \begin_inset Flex Code
2747 \begin_layout Plain Layout
2753 Determines the output file name and may, contain
2754 \begin_inset Flex Code
2757 \begin_layout Plain Layout
2764 Sensible only with resultdir and optional even then; if not given, it defaults
2768 \begin_layout Standard
2770 \change_inserted -712698321 1523206384
2771 A suitable hyperref-driver is set for some converters that are installed
2772 with \SpecialChar LyX
2775 \change_deleted -712698321 1523206388
2777 \change_inserted -712698321 1523206389
2781 \change_inserted -712698321 1523206400
2785 \change_inserted -712698321 1523206407
2789 \change_inserted -712698321 1523206437
2793 \change_deleted -712698321 1523206442
2794 that are installed with \SpecialChar LyX
2801 \begin_layout Standard
2802 You do not have to define converters for all formats between which you want
2804 For example, you will note that there is no `\SpecialChar LyX
2805 to PostScript' converter,
2806 but \SpecialChar LyX
2807 will export PostScript.
2808 It does so by first creating a \SpecialChar LaTeX
2809 file (no converter needs to be defined
2810 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2812 and finally converting the resulting DVI file to PostScript.
2814 finds such `chains' of converters automatically, and it will always choose
2815 the shortest possible chain.
2816 You can, though, still define multiple conversion methods between file
2818 For example, the standard \SpecialChar LyX
2819 configuration provides five ways to convert
2824 \begin_layout Enumerate
2826 \begin_inset Flex Noun
2829 \begin_layout Plain Layout
2838 \begin_layout Enumerate
2839 via (DVI and) PostScript, using
2840 \begin_inset Flex Noun
2843 \begin_layout Plain Layout
2852 \begin_layout Enumerate
2854 \begin_inset Flex Noun
2857 \begin_layout Plain Layout
2866 \begin_layout Enumerate
2868 \begin_inset Flex Noun
2871 \begin_layout Plain Layout
2881 \begin_layout Enumerate
2883 \begin_inset Flex Noun
2886 \begin_layout Plain Layout
2896 \begin_layout Standard
2897 To define such alternate chains, you must define multiple target `file formats',
2899 \begin_inset CommandInset ref
2901 reference "sec:Formats"
2906 For example, in the standard configuration, the formats named
2907 \begin_inset Flex Noun
2910 \begin_layout Plain Layout
2917 \begin_inset Flex Noun
2920 \begin_layout Plain Layout
2927 \begin_inset Flex Noun
2930 \begin_layout Plain Layout
2937 \begin_inset Flex Noun
2940 \begin_layout Plain Layout
2947 \begin_inset Flex Noun
2950 \begin_layout Plain Layout
2957 \begin_inset Flex Noun
2960 \begin_layout Plain Layout
2967 \begin_inset Flex Noun
2970 \begin_layout Plain Layout
2977 \begin_inset Flex Noun
2980 \begin_layout Plain Layout
2988 \begin_inset Flex Noun
2991 \begin_layout Plain Layout
2998 \begin_inset Flex Noun
3001 \begin_layout Plain Layout
3008 ) are defined, all of which share the extension
3009 \begin_inset Flex Noun
3012 \begin_layout Plain Layout
3018 , and which correspond to the conversion methods just mentioned.
3021 \begin_layout Chapter
3022 Internationalizing \SpecialChar LyX
3024 \begin_inset CommandInset label
3026 name "cha:Internationalizing-LyX"
3033 \begin_layout Standard
3035 supports using a translated interface.
3036 Last time we checked, \SpecialChar LyX
3037 provided text in thirty languages.
3038 The language of choice is called your
3043 (For further reading on locale settings, see also the documentation for
3044 locale that comes with your operating system.
3045 For Linux, the manual page for
3046 \begin_inset Flex Code
3049 \begin_layout Plain Layout
3055 could be a good place to start).
3058 \begin_layout Standard
3059 Notice that these translations will work, but do contain a few flaws.
3060 In particular, all dialogs have been designed with the English text in
3061 mind, which means that some of the translated text will be too large to
3062 fit within the space allocated.
3063 This is only a display problem and will not cause any harm.
3064 Also, you will find that some of the translations do not define shortcut
3065 keys for everything.
3066 Sometimes, there are simply not enough free letters to do it.
3067 Other times, the translator just hasn't got around to doing it yet.
3068 Our localization team, which you may wish to join,
3072 \begin_layout Plain Layout
3073 If you are a fluent speaker of a language other than English, joining these
3074 teams is a great way to give back to the \SpecialChar LyX
3080 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3084 \begin_layout Section
3085 Translating \SpecialChar LyX
3089 \begin_layout Subsection
3090 Translating the graphical user interface (text messages).
3093 \begin_layout Standard
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3105 library to handle the internationalization of the interface.
3106 To have \SpecialChar LyX
3107 speak your favorite language in all menus and dialogs, you need
3109 \begin_inset Flex Code
3112 \begin_layout Plain Layout
3118 -file for that language.
3119 When this is available, you'll have to generate a
3120 \begin_inset Flex Code
3123 \begin_layout Plain Layout
3129 -file from it and install the
3130 \begin_inset Flex Code
3133 \begin_layout Plain Layout
3140 The process of doing all of this is explained in the documentation for
3142 \begin_inset Flex Code
3145 \begin_layout Plain Layout
3152 It is possible to do this just for yourself, but if you're going to do
3153 it, you might as well share the results of your labors with the rest of
3154 the \SpecialChar LyX
3156 Send a message to the \SpecialChar LyX
3157 developers' list for more information about how
3161 \begin_layout Standard
3162 In short, this is what you should do (xx denotes the language code):
3165 \begin_layout Itemize
3166 Check out the \SpecialChar LyX
3169 \begin_inset CommandInset href
3171 name "information on the web"
3172 target "https://www.lyx.org/HowToUseGIT"
3180 \begin_layout Itemize
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3191 to the folder of the
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3214 \begin_inset Flex Code
3217 \begin_layout Plain Layout
3223 doesn't exist anywhere, it can be remade with the console command
3224 \begin_inset Flex Code
3227 \begin_layout Plain Layout
3233 in that directory, or you can use an existing po-file for some other language
3237 \begin_layout Itemize
3239 \begin_inset Flex Code
3242 \begin_layout Plain Layout
3252 \begin_layout Plain Layout
3253 This is just a text file, so it can be edited in any text editor.
3254 But there are also specialized programs that support such editing, such
3259 (for all platforms) or
3268 contains a `mode' for editing
3269 \begin_inset Flex Code
3272 \begin_layout Plain Layout
3279 \begin_inset Flex URL
3282 \begin_layout Plain Layout
3284 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3294 For some menu- and widget-labels, there are also shortcut keys that should
3296 Those keys are marked after a `|', and should be translated according to
3297 the words and phrases of the language.
3298 You should also fill also out the information at the beginning of the new
3300 \begin_inset Flex Code
3303 \begin_layout Plain Layout
3309 -file with your email-address, etc., so people know where to reach you with
3310 suggestions and entertaining flames.
3313 \begin_layout Standard
3314 If you are just doing this on your own, then:
3317 \begin_layout Itemize
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 This can be done with
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3334 msgfmt -o xx.mo < xx.po
3342 \begin_layout Itemize
3344 \begin_inset Flex Code
3347 \begin_layout Plain Layout
3353 -file to your locale-tree, at the correct directory for application messages
3358 xx, and under the name
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3369 \begin_inset space \thinspace{}
3373 \begin_inset space \space{}
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3381 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3391 \begin_layout Standard
3392 As said, however, it would be best if the new
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3402 file could be added to the \SpecialChar LyX
3403 distribution, so others can use it.
3404 Adding it involves making additional changes to \SpecialChar LyX
3406 So send an email to the developers' mailing list if you're interested in
3410 \begin_layout Subsubsection
3414 \begin_layout Standard
3415 Sometimes it turns out that one English message needs to be translated into
3416 different messages in the target language.
3417 One example is the message
3418 \begin_inset Flex Code
3421 \begin_layout Plain Layout
3427 which has the German translation
3435 , depending upon exactly what the English
3436 \begin_inset Quotes eld
3440 \begin_inset Quotes erd
3445 \begin_inset Flex Code
3448 \begin_layout Plain Layout
3454 does not handle such ambiguous translations.
3455 Therefore you have to add some context information to the message: Instead
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3467 \begin_inset Flex Code
3470 \begin_layout Plain Layout
3471 To[[as in 'From format x to format y']]
3477 \begin_inset Flex Code
3480 \begin_layout Plain Layout
3481 To[[as in 'From page x to page y']].
3486 Now the two occurrences of
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3506 and can be translated correctly to
3517 \begin_layout Standard
3518 Of course the context information needs to be stripped off the original
3519 message when no translation is used.
3520 Therefore you have to put it in double square brackets at the end of the
3521 message (see the example above).
3522 The translation mechanism of \SpecialChar LyX
3523 ensures that everything in double square
3524 brackets at the end of messages is removed before displaying the message.
3527 \begin_layout Subsection
3528 Translating the documentation.
3531 \begin_layout Standard
3532 The online documentation (in the
3533 \begin_inset Flex Noun
3536 \begin_layout Plain Layout
3542 -menu) can (and should!) be translated.
3543 If there are translated versions of the documentation available
3547 \begin_layout Plain Layout
3548 As of March 2008, at least some of the documents have been translated into
3549 fourteen languages, with the Tutorial available in a few more.
3554 and the locale is set accordingly, these will be used automagically by
3558 looks for translated versions as
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3563 LyXDir/doc/xx/DocName.lyx
3569 \begin_inset Flex Code
3572 \begin_layout Plain Layout
3578 is the code for the language currently in use.
3579 If there are no translated documents, the default English versions will
3581 Note that the translated versions must have the same filenames (
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3591 above) as the original.
3592 If you feel up to translating the documentation (an excellent way to proof-read
3593 the original documentation by the way!), there are a few things you should
3597 \begin_layout Itemize
3598 Check out the documentation translation web page at
3599 \begin_inset CommandInset href
3601 name "https://www.lyx.org/Translation"
3602 target "https://www.lyx.org/Translation"
3608 That way, you can find out which (if any) documents have already been translate
3609 d into your language.
3610 You can also find out who (if anyone) is organizing the effort to translate
3611 the documentation into your language.
3612 If no one is organizing the effort, please let us know that you're interested.
3615 \begin_layout Standard
3616 Once you get to actually translating, here's a few hints for you that may
3620 \begin_layout Itemize
3621 Join the documentation team! There is information on how to do that in
3622 \begin_inset Flex Code
3625 \begin_layout Plain Layout
3632 \begin_inset Flex Noun
3635 \begin_layout Plain Layout
3636 Help\SpecialChar menuseparator
3642 ), which by the way is the first document you should translate.
3645 \begin_layout Itemize
3646 Learn the typographic conventions for the language you are translating to.
3647 Typography is an ancient art and over the centuries, a great variety of
3648 conventions have developed throughout different parts of the world.
3649 Also study the professional terminology amongst typographers in your country.
3650 Inventing your own terminology will only confuse the users.
3653 (Warning! Typography is addictive!)
3656 \begin_layout Itemize
3657 Make a copy of the document.
3658 This will be your working copy.
3659 You can use this as your personal translated help-file by placing it in
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3671 \begin_inset Note Greyedout
3674 \begin_layout Plain Layout
3679 For a complex document with external material (images, etc.), if you make
3681 \begin_inset space \thinspace{}
3685 \begin_inset space \space{}
3688 in a temp dir, beware that the links to external material may be broken
3689 when the document is moved to a different place.
3690 The best way is to retrieve the \SpecialChar LyX
3692 \begin_inset Flex URL
3695 \begin_layout Plain Layout
3697 https://www.lyx.org/HowToUseGIT
3702 ) and to edit the doc file in place.
3710 \begin_layout Itemize
3711 Sometimes the original document (from the \SpecialChar LyX
3712 team) will be updated.
3713 Use the source viewer at
3714 \begin_inset CommandInset href
3716 name "https://www.lyx.org/trac/timeline"
3717 target "https://www.lyx.org/trac/timeline"
3722 to see what has been changed.
3723 That way you can easily see which parts of the translated document need
3727 \begin_layout Standard
3728 If you ever find an error in the original document, fix it and notify the
3729 rest of the documentation team of the changes! (You didn't forget to join
3730 the documentation team, did you?)
3733 \begin_layout Standard
3734 \begin_inset Branch OutDated
3738 \begin_layout Section
3739 International Keyboard Support
3742 \begin_layout Standard
3745 [Editor's Note: The following section is by
3753 It needs to be fixed to conform to the new Documentation Style sheet and
3754 to make use of the new v1.0 features.
3755 The whole thing also needs to be merged with the section following it.-jw
3756 It may also be badly out of date.-rh (2008)]
3759 \begin_layout Subsection
3760 Defining Own Keymaps: Keymap File Format
3763 \begin_layout Standard
3764 Let's look at a keyboard definition file a little closer.
3765 It is a plain text file defining
3768 \begin_layout Itemize
3769 key-to-key or key-to-string translations
3772 \begin_layout Itemize
3776 \begin_layout Itemize
3777 dead keys exceptions
3780 \begin_layout Standard
3781 To define key-to-key or key-to-string translation, use this command:
3784 \begin_layout Quotation
3785 \begin_inset Flex Code
3788 \begin_layout Plain Layout
3797 \begin_inset Flex Code
3800 \begin_layout Plain Layout
3809 \begin_layout Standard
3811 \begin_inset Flex Code
3814 \begin_layout Plain Layout
3820 is the key to be translated and
3821 \begin_inset Flex Code
3824 \begin_layout Plain Layout
3830 is the string to be inserted into the document.
3831 To define dead keys, use:
3834 \begin_layout Quotation
3835 \begin_inset Flex Code
3838 \begin_layout Plain Layout
3847 \begin_inset Flex Code
3850 \begin_layout Plain Layout
3859 \begin_layout Standard
3861 \begin_inset Flex Code
3864 \begin_layout Plain Layout
3870 is a keyboard key and
3871 \begin_inset Flex Code
3874 \begin_layout Plain Layout
3881 The following dead keys are supported (shortcut name is in parentheses):
3884 \begin_layout Quotation
3888 \begin_inset space \hfill{}
3894 \begin_layout Quotation
3896 \begin_inset space \hfill{}
3902 \begin_layout Quotation
3904 \begin_inset space \hfill{}
3910 \begin_layout Quotation
3912 \begin_inset space \hfill{}
3918 \begin_layout Quotation
3920 \begin_inset space \hfill{}
3926 \begin_layout Quotation
3928 \begin_inset space \hfill{}
3935 \begin_layout Plain Layout
3947 \begin_layout Quotation
3949 \begin_inset space \hfill{}
3955 \begin_layout Quotation
3957 \begin_inset space \hfill{}
3964 \begin_layout Plain Layout
3976 \begin_layout Quotation
3978 \begin_inset space \hfill{}
3984 \begin_layout Quotation
3986 \begin_inset space \hfill{}
3992 \begin_layout Quotation
3994 \begin_inset space \hfill{}
4001 \begin_layout Plain Layout
4013 \begin_layout Quotation
4015 \begin_inset space \hfill{}
4022 \begin_layout Plain Layout
4034 \begin_layout Quotation
4036 \begin_inset space \hfill{}
4042 \begin_layout Quotation
4043 hungarian umlaut (hug)
4044 \begin_inset space \hfill{}
4050 \begin_layout Quotation
4052 \begin_inset space \hfill{}
4058 \begin_layout Quotation
4060 \begin_inset space \hfill{}
4067 \begin_layout Plain Layout
4079 \begin_layout Standard
4080 Since in many international keyboards there are exceptions to what some
4081 dead keys should do, you can define them using
4084 \begin_layout Quotation
4085 \begin_inset Flex Code
4088 \begin_layout Plain Layout
4096 deadkey key outstring
4099 \begin_layout Standard
4100 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4104 \begin_layout Quotation
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4121 \begin_layout Standard
4122 to make it work correctly.
4123 Also, you have to define as exceptions dead keys over i and j, to remove
4124 the dot from them before inserting an accent mark.
4125 I will change this when the time comes, but so far I haven't had time.
4128 \begin_layout Standard
4129 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4132 \begin_inset Flex Code
4135 \begin_layout Plain Layout
4141 have different meaning.
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 marks comments, quotes start and end \SpecialChar LaTeX
4154 To enter quote, you'll need to use
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4177 \begin_inset Flex Code
4180 \begin_layout Plain Layout
4191 \begin_layout Standard
4192 If you make a keyboard description file that works for your language, please
4193 mail it to me, so I can include it in the next keymap distribution.
4196 \begin_layout Standard
4197 More keywords will be supported in keymap configuration file in future,
4201 \begin_layout Itemize
4202 \begin_inset Flex Code
4205 \begin_layout Plain Layout
4216 \begin_inset space \hfill{}
4220 \begin_inset Flex Code
4223 \begin_layout Plain Layout
4232 \begin_layout Itemize
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4247 \begin_inset space \hfill{}
4251 \begin_inset Flex Code
4254 \begin_layout Plain Layout
4260 an external keymap translation program
4263 \begin_layout Standard
4264 Also, it should look into
4265 \begin_inset Flex Code
4268 \begin_layout Plain Layout
4274 file for defaults, too (for example, a
4275 \begin_inset Flex Code
4278 \begin_layout Plain Layout
4286 option to include default keyboard).
4294 \begin_layout Section
4295 International Keymap Stuff
4296 \begin_inset CommandInset label
4298 name "sec:International-Keymap-Stuff"
4305 \begin_layout Standard
4306 \begin_inset Note Note
4309 \begin_layout Plain Layout
4310 In doing the revisions on this document in March 2008, I did not look over
4311 this stuff, as I do not understand it.
4312 It would be good if someone else could do so.
4321 \begin_layout Standard
4322 The next two sections describe the
4323 \begin_inset Flex Code
4326 \begin_layout Plain Layout
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4346 file syntax in detail.
4347 These sections should help you design your own key map if the ones provided
4348 do not meet your needs.
4351 \begin_layout Subsection
4355 \begin_layout Standard
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4368 file maps keystrokes to characters or strings.
4369 As the name suggests, it sets a keyboard mapping.
4371 \begin_inset Flex Code
4374 \begin_layout Plain Layout
4385 \begin_inset Flex Code
4388 \begin_layout Plain Layout
4403 \begin_inset Flex Code
4406 \begin_layout Plain Layout
4419 \begin_inset Flex Code
4422 \begin_layout Plain Layout
4431 \begin_inset Flex Code
4434 \begin_layout Plain Layout
4442 are described in this section.
4445 \begin_layout Labeling
4446 \labelwidthstring 00.00.0000
4447 \begin_inset Flex Code
4450 \begin_layout Plain Layout
4458 Map a character to a string
4461 \begin_layout LyX-Code
4476 \begin_layout Standard
4509 the double-quote (")
4526 must be escaped with a preceding backslash (
4537 \begin_layout Standard
4539 \begin_inset Flex Noun
4542 \begin_layout Plain Layout
4550 statement to cause the symbol
4551 \begin_inset Flex Noun
4554 \begin_layout Plain Layout
4562 to be output for the keystroke
4563 \begin_inset Flex Noun
4566 \begin_layout Plain Layout
4577 \begin_layout LyX-Code
4583 \begin_layout Labeling
4584 \labelwidthstring 00.00.0000
4585 \begin_inset Flex Code
4588 \begin_layout Plain Layout
4596 Specify an accent character
4599 \begin_layout LyX-Code
4608 \begin_layout Standard
4609 This will make the cha
4647 This is the dead key
4651 \begin_layout Plain Layout
4658 refers to a key that does not produce a character by itself, but when followed
4659 with another key, produces the desired accent character.
4660 For example, a German characte
4662 r with an umlaut like
4672 can be produced in this manner.
4681 \begin_layout Standard
4694 and then another key not in
4711 followed by the other, not allowed key, as output.
4715 \begin_inset Flex Noun
4718 \begin_layout Plain Layout
4726 cancels a dead key, so if
4737 \begin_inset Flex Noun
4740 \begin_layout Plain Layout
4749 , the cursor will not go one position backwards but will instead cancel
4765 might have had on the next keystroke.
4769 \begin_layout Standard
4770 The following example specifies that the character ' is to be an acute accent,
4771 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4774 \begin_layout LyX-Code
4777 kmod ' acute aeiouAEIOU
4780 \begin_layout Labeling
4781 \labelwidthstring 00.00.0000
4782 \begin_inset Flex Code
4785 \begin_layout Plain Layout
4791 Specify an exception to the accent character
4794 \begin_layout LyX-Code
4803 \begin_layout Standard
4804 This defines an exce
4845 have been assigned a keystroke with a previous
4848 \begin_inset Flex Code
4851 \begin_layout Plain Layout
4875 must not belong in the
4922 If such a declaration does not exist in
4930 \begin_inset Flex Code
4933 \begin_layout Plain Layout
4967 \begin_inset Flex Code
4970 \begin_layout Plain Layout
4984 \begin_layout Standard
4985 The following command produces causes äi to be produced when you enter acute-i
4989 \begin_layout LyX-Code
5003 \begin_layout Labeling
5004 \labelwidthstring 00.00.0000
5005 \begin_inset Flex Code
5008 \begin_layout Plain Layout
5014 Combine two accent characters
5017 \begin_layout LyX-Code
5023 accent1 accent2 allowed
5026 \begin_layout Standard
5027 This one is getting pretty esoteric.
5028 It allows you to combine the effect
5084 \begin_inset Flex Code
5087 \begin_layout Plain Layout
5115 \begin_layout Standard
5116 Consider this example from the
5117 \begin_inset Flex Code
5120 \begin_layout Plain Layout
5131 \begin_layout LyX-Code
5134 kmod ; acute aeioyvhAEIOYVH
5138 kcomb acute umlaut iyIY
5141 \begin_layout Standard
5142 This allows you to press
5143 \begin_inset Flex Noun
5146 \begin_layout Plain Layout
5154 and get the effect of
5155 \begin_inset Flex Code
5158 \begin_layout Plain Layout
5177 in this case cancels the last dead key, so if you press
5178 \begin_inset Flex Noun
5181 \begin_layout Plain Layout
5190 \begin_inset Flex Code
5193 \begin_layout Plain Layout
5206 \begin_layout Subsection
5210 \begin_layout Standard
5212 \begin_inset Flex Code
5215 \begin_layout Plain Layout
5223 mapping is performed, a
5224 \begin_inset Flex Code
5227 \begin_layout Plain Layout
5237 file maps the strings that the symbols generate to characters in the current
5239 The \SpecialChar LyX
5240 distribution currently includes at least the
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5253 \begin_inset Flex Code
5256 \begin_layout Plain Layout
5267 \begin_layout Standard
5269 \begin_inset Flex Code
5272 \begin_layout Plain Layout
5280 file is a sequence of declarations of the form
5283 \begin_layout LyX-Code
5296 \begin_layout Standard
5297 For example, in order to map
5298 \begin_inset Flex Noun
5301 \begin_layout Plain Layout
5311 to the corresponding character in the iso-8859-1 set (233), the following
5315 \begin_layout LyX-Code
5323 \begin_layout Standard
5325 \begin_inset Flex Code
5328 \begin_layout Plain Layout
5337 \begin_inset Flex Code
5340 \begin_layout Plain Layout
5358 the same character can apply to more than one string.
5360 \begin_inset Flex Code
5363 \begin_layout Plain Layout
5374 \begin_layout LyX-Code
5386 \begin_inset Newline newline
5402 \begin_layout Standard
5404 cannot find a mapping for the string produced by the keystroke or a
5405 deadkey sequence, it will check if it looks like an accented char and try
5406 to draw an accent over the character on screen.
5409 \begin_layout Subsection
5413 \begin_layout Standard
5414 There is a second way to add support for international characters through
5415 so-called dead-keys.
5416 A dead-key works in combination with a letter to produce an accented character.
5417 Here, we'll explain how to create a really simple dead-key to illustrate
5421 \begin_layout Standard
5422 Suppose you happen to need the circumflex character,
5423 \begin_inset Quotes eld
5427 \begin_inset Quotes erd
5432 \begin_inset Flex Noun
5435 \begin_layout Plain Layout
5442 \begin_inset space ~
5446 \begin_inset Flex Noun
5449 \begin_layout Plain Layout
5455 ] to the \SpecialChar LyX
5457 \begin_inset Flex Code
5460 \begin_layout Plain Layout
5467 \begin_inset Flex Code
5470 \begin_layout Plain Layout
5477 Now, whenever you type the
5478 \begin_inset Flex Noun
5481 \begin_layout Plain Layout
5487 -key followed by a letter, that letter will have a circumflex accent on
5489 For example, the sequence
5490 \begin_inset Quotes eld
5494 \begin_inset Flex Noun
5497 \begin_layout Plain Layout
5504 \begin_inset Quotes erd
5507 produces the letter:
5508 \begin_inset Quotes eld
5512 \begin_inset Quotes erd
5516 If you tried to type
5517 \begin_inset Quotes eld
5521 \begin_inset Flex Noun
5524 \begin_layout Plain Layout
5531 \begin_inset Quotes erd
5534 , however, \SpecialChar LyX
5535 will complain with a beep, since a
5536 \begin_inset Quotes eld
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5550 \begin_inset Quotes erd
5553 never takes a circumflex accent.
5555 \begin_inset Flex Noun
5558 \begin_layout Plain Layout
5564 after a dead-key produces the bare-accent.
5565 Please note this last point! If you bind a key to a dead-key, you'll need
5566 to rebind the character on that key to yet another key.
5568 \begin_inset Flex Noun
5571 \begin_layout Plain Layout
5577 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5580 \begin_layout Standard
5581 One common way to bind dead-keys is to use
5582 \begin_inset Flex Noun
5585 \begin_layout Plain Layout
5592 \begin_inset Flex Noun
5595 \begin_layout Plain Layout
5602 \begin_inset Flex Noun
5605 \begin_layout Plain Layout
5611 in combination with an accent, like
5612 \begin_inset Quotes eld
5616 \begin_inset Flex Noun
5619 \begin_layout Plain Layout
5626 \begin_inset Quotes erd
5630 \begin_inset Quotes eld
5634 \begin_inset Flex Noun
5637 \begin_layout Plain Layout
5644 \begin_inset Quotes erd
5648 \begin_inset Quotes eld
5652 \begin_inset Flex Noun
5655 \begin_layout Plain Layout
5662 \begin_inset Quotes erd
5666 Another way involves using
5667 \begin_inset Flex Code
5670 \begin_layout Plain Layout
5677 \begin_inset Flex Code
5680 \begin_layout Plain Layout
5686 to set up the special
5687 \begin_inset Flex Code
5690 \begin_layout Plain Layout
5698 \begin_inset Flex Code
5701 \begin_layout Plain Layout
5707 acts in some ways just like
5708 \begin_inset Flex Noun
5711 \begin_layout Plain Layout
5717 and permits you to bind keys to accented characters.
5718 You can also turn keys into dead-keys by binding them to something like
5720 \begin_inset Flex Code
5723 \begin_layout Plain Layout
5729 and then binding this symbolic key to the corresponding \SpecialChar LyX
5734 \begin_layout Plain Layout
5739 : This is exactly what I do in my
5740 \begin_inset Flex Code
5743 \begin_layout Plain Layout
5750 \begin_inset Flex Code
5753 \begin_layout Plain Layout
5761 \begin_inset Flex Noun
5764 \begin_layout Plain Layout
5766 \begin_inset space ~
5775 \begin_inset Flex Code
5778 \begin_layout Plain Layout
5784 and a bunch of these
5785 \begin_inset Quotes eld
5789 \begin_inset Flex Code
5792 \begin_layout Plain Layout
5799 \begin_inset Quotes erd
5802 symbolic keys bound such things as
5803 \begin_inset Flex Noun
5806 \begin_layout Plain Layout
5808 \begin_inset space ~
5817 \begin_inset Flex Noun
5820 \begin_layout Plain Layout
5822 \begin_inset space ~
5831 This is how I produce my accented characters.
5836 You can make just about anything into the
5837 \begin_inset Flex Code
5840 \begin_layout Plain Layout
5847 \begin_inset Flex Noun
5850 \begin_layout Plain Layout
5856 keys, a spare function key, etc.
5857 As for the \SpecialChar LyX
5858 commands that produce accents, check the entry for
5859 \begin_inset Flex Code
5862 \begin_layout Plain Layout
5873 You'll find the complete list there.
5876 \begin_layout Subsection
5877 Saving your Language Configuration
5880 \begin_layout Standard
5881 You can edit your preferences so that your desired language environment
5882 is automatically configured when \SpecialChar LyX
5884 \begin_inset Flex Noun
5887 \begin_layout Plain Layout
5888 Edit\SpecialChar menuseparator
5897 \begin_layout Chapter
5898 Installing New Document Classes, Layouts, and Templates
5899 \begin_inset CommandInset label
5901 name "cha:Installing-New-Document"
5906 \begin_inset Argument 1
5909 \begin_layout Plain Layout
5910 Installing New Document Classes
5918 \begin_layout Standard
5919 In this chapter, we describe the procedures for creating and installing
5920 new \SpecialChar LyX
5921 layout and template files, as well as offer a refresher on correctly
5922 installing new \SpecialChar LaTeX
5927 \begin_layout Standard
5928 First, let us a say a few words about how one ought to think about the relation
5929 between \SpecialChar LyX
5930 and \SpecialChar LaTeX
5932 The thing to understand is that, in a certain sense, \SpecialChar LyX
5933 doesn't know anything
5934 about \SpecialChar LaTeX
5936 Indeed, from \SpecialChar LyX
5937 's point of view, \SpecialChar LaTeX
5938 is just one of several
5939 \begin_inset Quotes eld
5943 \begin_inset Quotes erd
5946 in which it is capable of producing output.
5947 Other such formats are DocBook, plaintext, and XHTML.
5949 is, of course, a particularly important format, but very little of the
5950 information \SpecialChar LyX
5951 has about \SpecialChar LaTeX
5952 is actually contained in the program itself.
5956 \begin_layout Plain Layout
5957 Some commands are sufficiently complex that they are
5958 \begin_inset Quotes eld
5962 \begin_inset Quotes erd
5965 into \SpecialChar LyX
5967 But the developers generally regard this as a Bad Thing.
5972 Rather, that information, even for the standard classes like
5973 \begin_inset Flex Code
5976 \begin_layout Plain Layout
5982 , is contained in `layout files'.
5983 Similarly, \SpecialChar LyX
5984 itself does not know much about DocBook or XHTML.
5985 What it knows is contained in layout files.
5988 \begin_layout Standard
5989 You can think of the layout file for a given document class as a translation
5990 manual between \SpecialChar LyX
5991 constructs—paragraphs with their corresponding styles,
5992 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5995 Almost everything \SpecialChar LyX
5997 \begin_inset Flex Code
6000 \begin_layout Plain Layout
6006 , for example, is contained in the file
6007 \begin_inset Flex Code
6010 \begin_layout Plain Layout
6016 and in various other files it includes.
6017 For this reason, anyone intending to write layout files should plan to
6018 study the existing files.
6019 A good place to start is with
6020 \begin_inset Flex Code
6023 \begin_layout Plain Layout
6029 , which is included in
6030 \begin_inset Flex Code
6033 \begin_layout Plain Layout
6040 \begin_inset Flex Code
6043 \begin_layout Plain Layout
6049 , and many of the other layout files for document classes.
6050 This file is where sections and the like are defined:
6051 \begin_inset Flex Code
6054 \begin_layout Plain Layout
6060 tells \SpecialChar LyX
6061 how paragraphs that are marked with the Section, Subsection, etc,
6062 styles can be translated into corresponding \SpecialChar LaTeX
6063 , DocBook, and XHTML commands
6066 \begin_inset Flex Code
6069 \begin_layout Plain Layout
6075 file basically just includes several of these
6076 \begin_inset Flex Code
6079 \begin_layout Plain Layout
6088 \begin_layout Standard
6089 Defining the \SpecialChar LyX
6091 correspondence is not the only thing layout files do, though.
6092 Their other job is to define how the \SpecialChar LyX
6093 constructs themselves will appear
6095 The fact that layout files have these two jobs is often a source of confusion,
6096 because they are completely separate.
6097 Telling \SpecialChar LyX
6098 how to translate a certain paragraph style into \SpecialChar LaTeX
6101 how to display it; conversely, telling \SpecialChar LyX
6102 how to display a certain paragraph
6103 style does not tell \SpecialChar LyX
6104 how to translate it into \SpecialChar LaTeX
6105 (let alone tell \SpecialChar LaTeX
6108 So, in general, when you define a new \SpecialChar LyX
6109 construct, you must always do two
6110 quite separate things: (i)
6111 \begin_inset space ~
6114 tell \SpecialChar LyX
6115 how to translate it into \SpecialChar LaTeX
6117 \begin_inset space ~
6120 tell \SpecialChar LyX
6124 \begin_layout Standard
6125 Much the same is true, of course, as regards \SpecialChar LyX
6126 's other backend formats, though
6127 XHTML is in some ways different, because in that case \SpecialChar LyX
6132 able, to some extent, to use information about how it should display a
6133 paragraph on the screen to output information (in the form of CSS) about
6134 how the paragraph should be displayed in a browser.
6135 Even in this case, however, the distinction between what \SpecialChar LyX
6137 and how things are rendered externally remains in force, and the two can
6138 be controlled separately.
6140 \begin_inset CommandInset ref
6142 reference "sec:Tags-for-XHTML"
6149 \begin_layout Section
6150 Installing new \SpecialChar LaTeX
6154 \begin_layout Standard
6155 Some installations may not include a \SpecialChar LaTeX
6156 package or class file that you would
6157 like to use within \SpecialChar LyX
6159 For example, you might need Foil\SpecialChar TeX
6160 , a package for preparing slides for overhead
6162 Modern \SpecialChar LaTeX
6163 distributions like \SpecialChar TeX
6164 Live (2008 or newer) or MiK\SpecialChar TeX
6165 provide a user interface
6166 for installing such packages.
6167 For example, with MiK\SpecialChar TeX
6168 , you start the program
6169 \begin_inset Quotes eld
6173 \begin_inset space ~
6177 \begin_inset Quotes erd
6180 to get a list of available packages.
6181 To install one of them, right click on it or use the corresponding toolbar
6185 \begin_layout Standard
6186 If your \SpecialChar LaTeX
6187 distribution does not provide such a `package manager', or if the
6188 package is not available from your distribution, then follow these steps
6189 to install it manually:
6192 \begin_layout Enumerate
6193 Get the package from
6194 \begin_inset CommandInset href
6197 target "http://www.ctan.org/"
6205 \begin_layout Enumerate
6206 If the package contains a file with the ending
6207 \begin_inset Quotes eld
6211 \begin_inset Flex Code
6214 \begin_layout Plain Layout
6221 \begin_inset Quotes erd
6224 (is the case for Foil\SpecialChar TeX
6225 ) then open a console, change to the folder of this
6226 file and execute the command
6227 \begin_inset Flex Code
6230 \begin_layout Plain Layout
6237 You have now unpacked the package and have all files to install it.
6238 Most \SpecialChar LaTeX
6239 -packages are not packed and you can skip this step.
6242 \begin_layout Enumerate
6243 Now you need to decide if the package should be available for all users
6248 \begin_layout Enumerate
6249 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6250 for all users on your system, then install it in your `local' \SpecialChar TeX
6252 install it in your own `user' \SpecialChar TeX
6254 Where these trees should be created, if they do not already exist, depends
6256 To find this out, look in the file
6257 \begin_inset Flex Code
6260 \begin_layout Plain Layout
6270 \begin_layout Plain Layout
6271 This is usually in the directory
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6281 , though you can execute the command
6282 \begin_inset Flex Code
6285 \begin_layout Plain Layout
6296 The location of the `local' \SpecialChar TeX
6297 tree is defined by the
6298 \begin_inset Flex Code
6301 \begin_layout Plain Layout
6307 variable; this is usually somewhere like
6308 \begin_inset Flex Code
6311 \begin_layout Plain Layout
6312 /usr/local/share/texmf
6317 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6320 The location of the `user' \SpecialChar TeX
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6332 \begin_inset Flex Code
6335 \begin_layout Plain Layout
6342 \begin_inset Flex Code
6345 \begin_layout Plain Layout
6354 (If these variables are not predefined, you have to define them.) You'll
6355 probably need root permissions to create or modify the `local' tree, but
6356 not for your `user' tree.
6357 \begin_inset Newline newline
6360 In general, it is recommended to install in the user tree because your user
6361 will not be modified or even overwritten when you upgrade your system.
6362 It will typically also be backed up together with everything else when
6363 you backup your home directory (which, of course, you do on a regular basis).
6366 \begin_layout Enumerate
6367 On Windows, if you want the new package to be available for all users on
6368 your system, change to the folder where \SpecialChar LaTeX
6369 is installed and then change to
6371 \begin_inset Flex Code
6374 \begin_layout Plain Layout
6385 (For MiK\SpecialChar TeX
6386 , this would be by default the folder
6387 \begin_inset Flex Code
6390 \begin_layout Plain Layout
6408 \begin_layout Plain Layout
6409 Note that this will be the correct path only on English installations.
6410 On a German one, it would be
6411 \begin_inset Flex Code
6414 \begin_layout Plain Layout
6428 , and similarly for other languages.
6433 Create there a new folder
6434 \begin_inset Flex Code
6437 \begin_layout Plain Layout
6443 and copy all files of the package into it.
6445 \begin_inset Newline newline
6448 If the package should only available for you or you don't have admin permissions
6449 , do the same, but in the local \SpecialChar LaTeX
6452 \begin_inset space \thinspace{}
6455 g., for MiK\SpecialChar TeX
6457 \begin_inset space ~
6460 2.8 under Windows XP, this would be the folder:
6461 \begin_inset Newline newline
6467 \begin_inset Flex Code
6470 \begin_layout Plain Layout
6473 Documents and Settings
6485 \begin_inset Newline newline
6491 \begin_inset Phantom HPhantom
6494 \begin_layout Plain Layout
6505 \begin_inset Flex Code
6508 \begin_layout Plain Layout
6521 \begin_inset Newline newline
6524 On Vista, it would be:
6525 \begin_inset Newline newline
6529 \begin_inset Flex Code
6532 \begin_layout Plain Layout
6558 \begin_layout Enumerate
6559 Now one only need to tell \SpecialChar LaTeX
6560 that there are new files.
6561 This depends on the used \SpecialChar LaTeX
6566 \begin_layout Enumerate
6567 For \SpecialChar TeX
6568 Live execute the command
6569 \begin_inset Flex Code
6572 \begin_layout Plain Layout
6579 If you installed the package for all users, then you will probably need
6580 to have root permissions for that.
6583 \begin_layout Enumerate
6584 For MiK\SpecialChar TeX
6585 , if you have installed the package for all users, start the program
6587 \begin_inset Quotes eld
6591 \begin_inset space ~
6595 \begin_inset Quotes erd
6598 and press the button marked
6599 \begin_inset Quotes eld
6603 \begin_inset Quotes erd
6607 Otherwise start the program
6608 \begin_inset Quotes eld
6612 \begin_inset Quotes erd
6619 \begin_layout Enumerate
6620 Finally, you need to tell \SpecialChar LyX
6621 that there are new packages available.
6622 So, in \SpecialChar LyX
6624 \begin_inset Flex Noun
6627 \begin_layout Plain Layout
6630 \SpecialChar menuseparator
6636 and then restart \SpecialChar LyX
6640 \begin_layout Standard
6641 Now the package is installed.
6642 In our example, the document class
6643 \begin_inset Flex Code
6646 \begin_layout Plain Layout
6652 will now be available under
6653 \begin_inset Flex Noun
6656 \begin_layout Plain Layout
6657 Document\SpecialChar menuseparator
6658 Settings\SpecialChar menuseparator
6665 \begin_inset Quotes eld
6669 \begin_inset Quotes erd
6676 \begin_layout Standard
6677 If you would like to use a \SpecialChar LaTeX
6678 document class that is not even listed in the
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Document\SpecialChar menuseparator
6685 Settings\SpecialChar menuseparator
6691 , then you need to create a `layout' file for it.
6692 That is the topic of the next section.
6695 \begin_layout Section
6696 Types of layout files
6699 \begin_layout Standard
6700 This section describes the various sorts of \SpecialChar LyX
6701 files that contain layout informati
6703 These files describe various paragraph and character styles, determining
6704 how \SpecialChar LyX
6705 should display them and how they should be translated into \SpecialChar LaTeX
6707 XHTML, or whatever output format is being used.
6711 \begin_layout Standard
6712 We shall try to provide a thorough description of the process of writing
6714 However, there are so many different types of documents supported even
6715 by just \SpecialChar LaTeX
6716 that we can't hope to cover every different possibility or problem
6717 you might encounter.
6718 The \SpecialChar LyX
6719 users' list is frequented by people with lots of experience with layout
6720 design who are willing to share what they've learned, so please feel free
6721 to ask questions there.
6724 \begin_layout Standard
6725 As you prepare to write a new layout, it is extremely helpful to look at
6726 the layouts distributed with \SpecialChar LyX
6728 If you write a \SpecialChar LyX
6729 layout for a \SpecialChar LaTeX
6730 document class that might also be used by
6731 others, or write a module that might be useful to others, then you should
6732 consider posting your layout to the
6733 \begin_inset CommandInset href
6735 name "layout section on the LyX wiki"
6736 target "https://wiki.lyx.org/Layouts/Layouts"
6741 or even to the \SpecialChar LyX
6742 developers' list, so that it might be included in \SpecialChar LyX
6747 \begin_layout Plain Layout
6748 Note that \SpecialChar LyX
6749 is licensed under the General Public License, so any material
6750 that is contributed to \SpecialChar LyX
6751 must be similarly licensed.
6759 \begin_layout Subsection
6761 \begin_inset CommandInset label
6763 name "subsec:Layout-modules"
6770 \begin_layout Standard
6771 We have spoken to this point about `layout files'.
6772 But there are different sorts of files that contain layout information.
6773 Layout files, strictly so called, have the
6774 \begin_inset Flex Code
6777 \begin_layout Plain Layout
6783 extension and provide \SpecialChar LyX
6784 with information about document classes.
6785 Since \SpecialChar LyX
6786 1.6 layout information can also be contained in layout
6791 \begin_inset Flex Code
6794 \begin_layout Plain Layout
6801 Modules are to \SpecialChar LaTeX
6802 packages much as layouts are to \SpecialChar LaTeX
6803 classes, and some modules—such
6805 \begin_inset Flex Code
6808 \begin_layout Plain Layout
6814 module—specifically provide support for one package.
6815 In a sense, layout modules are similar to included
6819 \begin_layout Plain Layout
6820 These can have any extension, but by convention have the
6821 \begin_inset Flex Code
6824 \begin_layout Plain Layout
6836 \begin_inset Flex Code
6839 \begin_layout Plain Layout
6845 —in that modules are not specific to a given document class but may be used
6846 with many different classes.
6847 The difference is that using an included file with
6848 \begin_inset Flex Code
6851 \begin_layout Plain Layout
6857 requires editing that file.
6858 Modules, by contrast, are selected in the
6859 \begin_inset Flex Noun
6862 \begin_layout Plain Layout
6863 Document\SpecialChar menuseparator
6872 \begin_layout Standard
6873 Building modules is the easiest way to get started with layout editing,
6874 since it can be as simple as adding a single new paragraph style or flex
6876 But modules may, in principle, contain anything a layout file can contain.
6879 \begin_layout Standard
6880 After creating a new module and copying it to the
6881 \begin_inset Flex Code
6884 \begin_layout Plain Layout
6890 folder, you will need to reconfigure and then restart \SpecialChar LyX
6893 However, changes you make to the module will be seen immediately, if you
6895 \begin_inset Flex Noun
6898 \begin_layout Plain Layout
6899 Document\SpecialChar menuseparator
6905 , highlight something, and then hit
6906 \begin_inset Quotes eld
6910 \begin_inset Quotes erd
6916 It is strongly recommended that you save your work before doing this
6921 it is strongly recommended that you not attempt to edit modules while simultaneo
6922 usly working on actual documents
6925 Though of course the developers strive to keep \SpecialChar LyX
6926 stable in such situations,
6927 syntax errors and the like in your module file could cause strange behavior.
6930 \begin_layout Subsubsection
6934 \begin_layout Standard
6935 Modules are to \SpecialChar LyX
6936 as packages are to \SpecialChar LaTeX
6938 Sometimes, however, you find yourself wanting a specific inset or character
6939 style just for one document and writing a module that will also be available
6940 to other documents makes little sense.
6941 What you need is \SpecialChar LyX
6943 \begin_inset Quotes eld
6947 \begin_inset Quotes erd
6953 \begin_layout Standard
6954 You will find it under
6956 Document\SpecialChar menuseparator
6957 Settings\SpecialChar menuseparator
6961 The large text box allows you to enter anything that you might enter in
6962 a layout file or module.
6963 You can think of a document's local layout, in fact, as a module that belongs
6965 So, in particular, you must enter a
6966 \begin_inset Flex Code
6969 \begin_layout Plain Layout
6976 Any format is acceptable, but one would normally use the format current
6978 (In \SpecialChar LyX
6985 , the current layout format is
6994 \begin_layout Standard
6995 When you have entered something in the
6996 \begin_inset Flex Code
6999 \begin_layout Plain Layout
7005 pane, \SpecialChar LyX
7007 \begin_inset Quotes eld
7011 \begin_inset Quotes erd
7014 button at the bottom.
7015 Clicking this button will cause \SpecialChar LyX
7016 to determine whether what you have entered
7017 is valid layout information for the chosen format.
7019 will report the result but, unfortunately, will not tell you what errors
7020 there might have been.
7021 These will be written to the terminal, however, if \SpecialChar LyX
7022 is started from a terminal.
7023 You will not be permitted to save your local layout until you have entered
7027 \begin_layout Standard
7028 The warnings at the end of the previous section apply here, too.
7029 Do not play with local layout while you are actually working, especially
7030 if you have not saved your document.
7031 That said, using local layout with a test document can be a very convenient
7032 way to try out layout ideas, or even to start developing a module.
7035 \begin_layout Subsection
7037 \begin_inset Flex Noun
7040 \begin_layout Plain Layout
7049 \begin_layout Standard
7050 There are two situations you are likely to encounter when wanting to support
7051 a new \SpecialChar LaTeX
7052 document class, involving style (
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7062 ) files and \SpecialChar LaTeX2e
7064 \begin_inset Flex Code
7067 \begin_layout Plain Layout
7074 Supporting a style file is usually fairly easy.
7075 Supporting a new class file is a bit harder.
7076 We'll discuss the former in this section and the latter in the next.
7077 Similar remarks apply, of course, if you want to support a new DocBook
7081 \begin_layout Standard
7082 The easier case is the one in which your new document class is provided
7083 as a style file that is to be used in conjunction with an already supported
7085 For the sake of the example, we'll assume that the style file is called
7087 \begin_inset Flex Noun
7090 \begin_layout Plain Layout
7096 and that it is meant to be used with
7097 \begin_inset Flex Noun
7100 \begin_layout Plain Layout
7106 , which is a standard class.
7110 \begin_layout Standard
7111 Start by copying the existing class's layout file into your local directory:
7115 \begin_layout Plain Layout
7116 Of course, which directory is your local directory will vary by platform,
7117 and \SpecialChar LyX
7118 allows you to specify your local directory on startup, too, using
7120 \begin_inset Flex Code
7123 \begin_layout Plain Layout
7137 \begin_layout LyX-Code
7138 cp report.layout ~/.lyx/layouts/myclass.layout
7141 \begin_layout Standard
7143 \begin_inset Flex Code
7146 \begin_layout Plain Layout
7152 and change the line:
7155 \begin_layout LyX-Code
7158 DeclareLaTeXClass{Report (Standard Class)}
7161 \begin_layout Standard
7165 \begin_layout LyX-Code
7168 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7171 \begin_layout Standard
7175 \begin_layout LyX-Code
7177 \begin_inset Newline newline
7183 \begin_inset Newline newline
7189 \begin_layout Standard
7190 near the top of the file.
7193 \begin_layout Standard
7194 Start \SpecialChar LyX
7196 \begin_inset Flex Noun
7199 \begin_layout Plain Layout
7200 Tools\SpecialChar menuseparator
7207 Then restart \SpecialChar LyX
7208 and try creating a new document.
7210 \begin_inset Flex Noun
7213 \begin_layout Plain Layout
7219 " as a document class option in the
7220 \begin_inset Flex Noun
7223 \begin_layout Plain Layout
7224 Document\SpecialChar menuseparator
7231 It is likely that some of the sectioning commands and such in your new
7232 class will work differently from how they worked in the base class—
7233 \begin_inset Flex Code
7236 \begin_layout Plain Layout
7242 in this example—so you can fiddle around with the settings for the different
7243 sections if you wish.
7244 The layout information for sections is contained in
7245 \begin_inset Flex Code
7248 \begin_layout Plain Layout
7254 , but you do not need to copy and change this file.
7255 Instead, you can simply add your changes to your layout file, after the
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7266 , which itself includes
7267 \begin_inset Flex Code
7270 \begin_layout Plain Layout
7277 For example, you might add these lines:
7280 \begin_layout LyX-Code
7284 \begin_layout LyX-Code
7288 \begin_layout LyX-Code
7292 \begin_layout LyX-Code
7296 \begin_layout LyX-Code
7300 \begin_layout Standard
7301 to change the font for chapter headings to sans-serif.
7302 This will override (or, in this case, add to) the existing declaration
7303 for the Chapter style.
7307 \begin_layout Standard
7308 Your new package may also provide commands or environments not present in
7310 In this case, you will want to add these to the layout file.
7312 \begin_inset CommandInset ref
7314 reference "sec:TextClass"
7318 for information on how to do so.
7321 \begin_layout Standard
7323 \begin_inset Flex Noun
7326 \begin_layout Plain Layout
7332 can be used with several different document classes, and even if it cannot,
7333 you might find it easiest just to write a module that you can load with
7335 The simplest possible such module would be:
7338 \begin_layout LyX-Code
7341 DeclareLyXModule{My Class}
7344 \begin_layout LyX-Code
7348 \begin_layout LyX-Code
7349 #Support for myclass.sty.
7352 \begin_layout LyX-Code
7354 \begin_inset Newline newline
7360 \begin_layout LyX-Code
7368 \begin_inset Newline newline
7374 \begin_layout LyX-Code
7376 \begin_inset Newline newline
7382 \begin_inset Newline newline
7388 \begin_layout Standard
7389 A more complex module might modify the behavior of some existing constructs
7390 or define some new ones.
7392 \begin_inset CommandInset ref
7394 reference "sec:TextClass"
7401 \begin_layout Subsection
7403 \begin_inset Flex Noun
7406 \begin_layout Plain Layout
7415 \begin_layout Standard
7416 There are two possibilities here.
7417 One is that the class file is itself based upon an existing document class.
7418 For example, many thesis classes are based upon
7419 \begin_inset Flex Noun
7422 \begin_layout Plain Layout
7429 To see whether yours is, look for a line like
7432 \begin_layout LyX-Code
7438 \begin_layout Standard
7440 If so, then you may proceed largely as in the previous section, though
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7446 Declare\SpecialChar LaTeX
7452 line will be different.
7453 If your new class is
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7463 and it is based upon
7464 \begin_inset Flex Code
7467 \begin_layout Plain Layout
7473 , then the line should read:
7477 \begin_layout Plain Layout
7478 And it will be easiest if you save the file to
7479 \begin_inset Flex Code
7482 \begin_layout Plain Layout
7489 assumes that the document class has the same name as the layout file.
7498 \begin_layout LyX-Code
7501 DeclareLaTeXClass[thesis,book]{thesis}
7504 \begin_layout Standard
7505 If, on the other hand, the new class is not based upon an existing class,
7506 you will probably have to
7507 \begin_inset Quotes eld
7511 \begin_inset Quotes erd
7515 We strongly suggest copying an existing layout file which uses a similar
7517 class and then modifying it, if you can do so.
7518 At least use an existing file as a starting point so you can find out what
7519 items you need to worry about.
7520 Again, the specifics are covered below.
7523 \begin_layout Subsection
7525 \begin_inset CommandInset label
7527 name "subsec:Creating-Templates"
7534 \begin_layout Standard
7535 Once you have written a layout file for a new document class, you might
7536 want to consider writing a
7541 A template acts as a kind of tutorial for your layout, showing how it might
7542 be used, though containing dummy content.
7543 You can of course look at the various templates included with \SpecialChar LyX
7547 \begin_layout Standard
7548 Templates are created just like usual documents: using \SpecialChar LyX
7550 The only difference is that usual documents contain all possible settings,
7551 including the font scheme and the paper size.
7552 Usually a user doesn't want a template to overwrite his preferred settings
7553 for such parameters.
7554 For that reason, the designer of a template should remove the corresponding
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7568 \begin_inset Flex Code
7571 \begin_layout Plain Layout
7579 from the template \SpecialChar LyX
7581 This can be done with any simple text-editor, for example
7582 \begin_inset Flex Code
7585 \begin_layout Plain Layout
7592 \begin_inset Flex Code
7595 \begin_layout Plain Layout
7604 \begin_layout Standard
7605 Put the edited template files you create in
7606 \begin_inset Flex Code
7609 \begin_layout Plain Layout
7615 , copy the ones you use from the global template directory in
7616 \begin_inset Flex Code
7619 \begin_layout Plain Layout
7625 to the same place, and redefine the template path in the
7626 \begin_inset Flex Noun
7629 \begin_layout Plain Layout
7630 Tools\SpecialChar menuseparator
7631 Preferences\SpecialChar menuseparator
7640 \begin_layout Standard
7641 Note, by the way, that there is a template which has a particular meaning:
7642 \begin_inset Newline linebreak
7646 \begin_inset Flex Code
7649 \begin_layout Plain Layout
7656 This template is loaded every time you create a new document with
7657 \begin_inset Flex Noun
7660 \begin_layout Plain Layout
7661 File\SpecialChar menuseparator
7667 in order to provide useful defaults.
7668 To create this template from inside \SpecialChar LyX
7669 , all you have to do is to open a document
7670 with the correct settings, and use the
7671 \begin_inset Flex Noun
7674 \begin_layout Plain Layout
7675 Save as Document Defaults
7683 \begin_layout Subsection
7684 Upgrading old layout files
7687 \begin_layout Standard
7688 The format of layout files changes with each \SpecialChar LyX
7689 release, so old layout files
7690 need to be converted to the new format.
7692 reads a layout file in an older format, it automatically calls the
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7703 to convert it to a temporary file in current format.
7704 The original file is left untouched.
7705 If you use the layout file often, then, you may want to convert it permanently,
7706 so that \SpecialChar LyX
7707 does not have to do so itself every time.
7708 To do this, you can call the converter manually:
7711 \begin_layout Enumerate
7713 \begin_inset Flex Code
7716 \begin_layout Plain Layout
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7735 \begin_layout Enumerate
7737 \begin_inset Newline newline
7741 \begin_inset Flex Code
7744 \begin_layout Plain Layout
7745 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7751 \begin_inset Newline newline
7755 \begin_inset Flex Code
7758 \begin_layout Plain Layout
7764 is the name of your \SpecialChar LyX
7768 \begin_layout Standard
7769 Note that manual conversion does not affect included files, so these will
7770 have to be converted separately.
7773 \begin_layout Subsection
7774 \begin_inset CommandInset label
7776 name "subsec:Cite-Engine-Files"
7783 \begin_layout Standard
7784 A specific form of layout files are the so-called
7785 \begin_inset Flex Code
7788 \begin_layout Plain Layout
7794 files that are located in the
7795 \begin_inset Flex Code
7798 \begin_layout Plain Layout
7805 Their purpose is to define the specifics of \SpecialChar LaTeX
7806 packages aimed at bibliography
7819 , but also the way how normal Bib\SpecialChar TeX
7820 citations (without additional packages)
7821 are handled in \SpecialChar LyX
7822 is defined in such a file.
7826 \begin_layout Standard
7827 More specifically, it is defined which packages \SpecialChar LyX
7828 needs to load, which citation
7829 commands are available, how these are to be displayed in \SpecialChar LyX
7831 the dialogs, the context menus) as well as in the XHTML and plain text
7833 Furthermore, the files specify available style variants (author-year, numerical
7834 , etc.) and their specifics.
7835 The cite engine files are also used to generate the options that are available
7838 Document\SpecialChar menuseparator
7839 Settings\SpecialChar menuseparator
7840 Bibliography\SpecialChar menuseparator
7846 \begin_layout Standard
7847 Even though a cite engine file is essentially a normal layout file that
7848 could theoretically include any layout information, it usually primarily
7849 includes some specific parameters such as
7850 \begin_inset Flex Code
7853 \begin_layout Plain Layout
7860 \begin_inset Flex Code
7863 \begin_layout Plain Layout
7870 \begin_inset Flex Code
7873 \begin_layout Plain Layout
7880 \begin_inset Flex Code
7883 \begin_layout Plain Layout
7890 The syntax of the latter two is described in
7891 \begin_inset CommandInset ref
7893 reference "subsec:Citation-engine-description"
7901 \begin_inset CommandInset ref
7903 reference "subsec:Citation-format-description"
7907 , as well as in the files themselves.
7910 \begin_layout Section
7911 \begin_inset CommandInset label
7913 name "sec:TextClass"
7917 The layout file format
7920 \begin_layout Standard
7921 The following sections describe how layout files are structured and written.
7922 Our advice is to go slowly, save and test often.
7923 It is really not that hard, except that the multitude of options can become
7924 overwhelming, especially if you try to check out too many at once.
7925 It becomes easier if you use existing layouts of \SpecialChar LyX
7926 as examples/reference
7927 or if you modify an existing layout to your needs.
7930 \begin_layout Standard
7931 Note that all the tags used in layout files are case-insensitive.
7933 \begin_inset Flex Code
7936 \begin_layout Plain Layout
7943 \begin_inset Flex Code
7946 \begin_layout Plain Layout
7953 \begin_inset Flex Code
7956 \begin_layout Plain Layout
7962 are really the same tag.
7963 The possible arguments are printed in brackets after the tag's name.
7964 The default argument is typeset
7965 \begin_inset Flex Code
7968 \begin_layout Plain Layout
7977 If the argument has a data type like
7978 \begin_inset Quotes eld
7982 \begin_inset Quotes erd
7986 \begin_inset Quotes eld
7990 \begin_inset Quotes erd
7993 , the default is shown like this:
7994 \begin_inset Flex Code
7997 \begin_layout Plain Layout
8008 \begin_layout Subsection
8009 The document class declaration and classification
8012 \begin_layout Standard
8013 Lines in a layout file which begin with
8014 \begin_inset Flex Code
8017 \begin_layout Plain Layout
8024 There is one exception to this rule.
8026 \begin_inset Flex Code
8029 \begin_layout Plain Layout
8035 files should begin with lines like:
8038 \begin_layout LyX-Code
8041 #% Do not delete the line below; configure depends on this
8044 \begin_layout LyX-Code
8049 DeclareLaTeXClass{Article (Standard Class)}
8052 \begin_layout LyX-Code
8057 DeclareCategory{Articles}
8060 \begin_layout Standard
8061 The second and third lines are used when you (re)configure \SpecialChar LyX
8063 The layout file is read by the \SpecialChar LaTeX
8065 \begin_inset Flex Code
8068 \begin_layout Plain Layout
8074 , in a special mode where
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8085 The first line is just a \SpecialChar LaTeX
8086 comment, the second one contains the mandatory
8087 declaration of the text class and the third line contains the optional
8088 classification of the class.
8089 If these lines appear in a file named
8090 \begin_inset Flex Code
8093 \begin_layout Plain Layout
8099 , then they define a text class of name
8100 \begin_inset Flex Code
8103 \begin_layout Plain Layout
8109 (the name of the layout file) which uses the \SpecialChar LaTeX
8111 \begin_inset Flex Code
8114 \begin_layout Plain Layout
8120 (the default is to use the same name as the layout).
8122 \begin_inset Quotes eld
8125 Article (Standard Class)
8126 \begin_inset Quotes erd
8129 that appears above is used as a description of the text class in the
8130 \begin_inset Flex Noun
8133 \begin_layout Plain Layout
8134 Document\SpecialChar menuseparator
8142 \begin_inset Quotes eld
8146 \begin_inset Quotes erd
8149 in the example) is also used in the
8150 \begin_inset Flex Noun
8153 \begin_layout Plain Layout
8154 Document\SpecialChar menuseparator
8160 dialog: the text classes are grouped by these categories (which are usually
8161 genres, so typical categories are
8162 \begin_inset Quotes eld
8166 \begin_inset Quotes erd
8170 \begin_inset Quotes eld
8174 \begin_inset Quotes erd
8178 \begin_inset Quotes eld
8182 \begin_inset Quotes erd
8186 \begin_inset Quotes eld
8190 \begin_inset Quotes erd
8194 \begin_inset Quotes eld
8198 \begin_inset Quotes erd
8202 \begin_inset Quotes eld
8206 \begin_inset Quotes erd
8210 If no category has been declared, the class will be put in the
8211 \begin_inset Quotes eld
8215 \begin_inset Quotes erd
8221 \begin_layout Standard
8222 Let's assume that you wrote your own text class that uses the
8223 \begin_inset Flex Code
8226 \begin_layout Plain Layout
8232 document class, but where you changed the appearance of the section headings.
8233 If you put it in a file
8234 \begin_inset Flex Code
8237 \begin_layout Plain Layout
8243 , the header of this file should be:
8246 \begin_layout LyX-Code
8249 #% Do not delete the line below; configure depends on this
8252 \begin_layout LyX-Code
8257 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8260 \begin_layout LyX-Code
8265 DeclareCategory{Articles}
8268 \begin_layout Standard
8269 This declares a text class
8270 \begin_inset Flex Code
8273 \begin_layout Plain Layout
8279 , associated with the \SpecialChar LaTeX
8281 \begin_inset Flex Code
8284 \begin_layout Plain Layout
8291 \begin_inset Quotes eld
8294 Article (with My Own Headings)
8295 \begin_inset Quotes erd
8299 If your text class depends on several packages, you can declare it as:
8302 \begin_layout LyX-Code
8305 #% Do not delete the line below; configure depends on this
8308 \begin_layout LyX-Code
8313 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8316 \begin_layout LyX-Code
8321 DeclareCategory{Articles}
8324 \begin_layout Standard
8325 This indicates that your text class uses the
8326 \begin_inset Flex Code
8329 \begin_layout Plain Layout
8336 Finally, it is also possible to declare classes for DocBook code.
8337 Typical declarations will look like:
8340 \begin_layout LyX-Code
8343 #% Do not delete the line below; configure depends on this
8346 \begin_layout LyX-Code
8351 DeclareDocBookClass[article]{SGML (DocBook Article)}
8354 \begin_layout LyX-Code
8359 DeclareCategory{Articles (DocBook)}
8362 \begin_layout Standard
8363 Note that these declarations can also be given an optional parameter declaring
8364 the name of the document class (but not a list).
8367 \begin_layout Standard
8368 So, to be as explicit as possible, the form of the layout declaration is:
8371 \begin_layout LyX-Code
8376 DeclareLaTeXClass[class,package.sty]{layout description}
8379 \begin_layout LyX-Code
8384 DeclareCategory{category}
8387 \begin_layout Standard
8388 The class need only be specified if the name of the \SpecialChar LaTeX
8390 name of the layout file are different or if there are packages to load.
8391 If the name of the class file is not specified, then \SpecialChar LyX
8393 that it is the same as the name of the layout file.
8396 \begin_layout Standard
8397 When the text class has been modified to your taste, all you have to do
8398 is to copy it either to
8399 \begin_inset Flex Code
8402 \begin_layout Plain Layout
8409 \begin_inset Flex Code
8412 \begin_layout Plain Layout
8419 \begin_inset Flex Noun
8422 \begin_layout Plain Layout
8423 Tools\SpecialChar menuseparator
8429 , exit \SpecialChar LyX
8431 Then your new text class should be available along with the others.
8434 \begin_layout Standard
8435 Once the layout file is installed, you can edit it and see your changes
8436 without having to reconfigure or to restart \SpecialChar LyX
8441 \begin_layout Plain Layout
8442 In versions of \SpecialChar LyX
8443 prior to 1.6, this was not true.
8444 As a result, editing layout files was very time consuming, since you had
8445 constantly to restart \SpecialChar LyX
8451 You can force a reload of the current layout by using the \SpecialChar LyX
8453 \begin_inset Flex Noun
8456 \begin_layout Plain Layout
8463 There is no default binding for this function—though, of course, you can
8464 bind it to a key yourself.
8465 But you will normally use this function simply by entering it in the mini-buffe
8470 \begin_layout Standard
8476 \begin_inset Flex Noun
8479 \begin_layout Plain Layout
8485 is very much an `advanced feature'.
8490 recommended that you save your work before using this function.
8495 recommended that you not attempt to edit layout information while simultaneousl
8496 y working on a document that you care about.
8497 Use a test document.
8498 Syntax errors and the like in your layout file could cause peculiar behavior.
8499 In particular, such errors could cause \SpecialChar LyX
8500 to regard the current layout as
8501 invalid and to attempt to switch to some other layout.
8505 \begin_layout Plain Layout
8506 Really bad syntax errors may even caused \SpecialChar LyX
8508 This is because certain sorts of errors may make \SpecialChar LyX
8519 The \SpecialChar LyX
8520 team strives to keep \SpecialChar LyX
8521 stable in such situations, but safe is better
8526 \begin_layout Plain Layout
8527 While we're giving advice: make regular backups.
8528 And be nice to your mother.
8536 \begin_layout Subsection
8537 The Module declaration
8540 \begin_layout Standard
8541 A module must begin with a line like the following:
8544 \begin_layout LyX-Code
8547 DeclareLyXModule[endnotes.sty]{Endnotes}
8550 \begin_layout Standard
8551 The mandatory argument, in curly brackets, is the name of the module, as
8553 \begin_inset Flex Noun
8556 \begin_layout Plain Layout
8557 Document\SpecialChar menuseparator
8558 Settings\SpecialChar menuseparator
8565 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8567 on which the module depends.
8568 It is also possible to use the form
8569 \begin_inset Flex Noun
8572 \begin_layout Plain Layout
8578 as an optional argument, which declares that the module can only be used
8579 when there exists a conversion chain between the formats `
8580 \begin_inset Flex Code
8583 \begin_layout Plain Layout
8590 \begin_inset Flex Code
8593 \begin_layout Plain Layout
8602 \begin_layout Standard
8603 The module declaration should then be followed by lines like the following:
8607 \begin_layout Plain Layout
8608 Preferably in English if the module should be published with \SpecialChar LyX
8610 This description will appear in the list of messages to be translated and
8611 will be thus translated with the next interface update.
8619 \begin_layout LyX-Code
8623 \begin_layout LyX-Code
8624 #Adds an endnote command, in addition to footnotes.
8628 \begin_layout LyX-Code
8629 #You will need to add
8631 theendnotes in TeX code where you
8634 \begin_layout LyX-Code
8635 #want the endnotes to appear.
8639 \begin_layout LyX-Code
8643 \begin_layout LyX-Code
8644 #Requires: somemodule | othermodule
8647 \begin_layout LyX-Code
8648 #Excludes: badmodule
8651 \begin_layout Standard
8652 The description is used in
8653 \begin_inset Flex Noun
8656 \begin_layout Plain Layout
8657 Document\SpecialChar menuseparator
8658 Settings\SpecialChar menuseparator
8664 to provide the user with information about what the module does.
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8675 line is used to identify other modules with which this one must be used;
8677 \begin_inset Flex Code
8680 \begin_layout Plain Layout
8686 line is used to identify modules with which this one may not be used.
8687 Both are optional, and, as shown, multiple modules should be separated
8688 with the pipe symbol: |.
8689 Note that the required modules are treated disjunctively:
8693 of the required modules must be used.
8698 excluded module may be used.
8699 Note that modules are identified here by their filenames without the
8700 \begin_inset Flex Code
8703 \begin_layout Plain Layout
8711 \begin_inset Flex Code
8714 \begin_layout Plain Layout
8721 \begin_inset Flex Code
8724 \begin_layout Plain Layout
8733 \begin_layout Subsection
8734 The CiteEngine file declaration
8737 \begin_layout Standard
8738 A cite engine file must begin with a line like the following:
8741 \begin_layout LyX-Code
8744 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8747 \begin_layout Standard
8748 The mandatory argument, in curly brackets, is the name of the cite style,
8749 as it should appear in
8750 \begin_inset Flex Noun
8753 \begin_layout Plain Layout
8754 Document\SpecialChar menuseparator
8755 Settings\SpecialChar menuseparator
8762 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8764 on which the cite engine depends.
8767 \begin_layout Standard
8768 The cite engine declaration should then be followed by lines like the following:
8772 \begin_layout Plain Layout
8773 Preferably in English if the module should be published with \SpecialChar LyX
8775 This description will appear in the list of messages to be translated and
8776 will be thus translated with the next interface update.
8784 \begin_layout LyX-Code
8788 \begin_layout LyX-Code
8789 # Biblatex supports many author-year and numerical styles.
8792 \begin_layout LyX-Code
8793 # It is mainly aimed at the Humanities.
8797 \begin_layout LyX-Code
8798 # customizable, fully localized and provides many features
8801 \begin_layout LyX-Code
8802 # that are not possible with BibTeX.
8803 The use of 'biber' as
8806 \begin_layout LyX-Code
8807 # bibliography processor is advised.
8810 \begin_layout LyX-Code
8814 \begin_layout Standard
8815 The description is used in
8816 \begin_inset Flex Noun
8819 \begin_layout Plain Layout
8820 Document\SpecialChar menuseparator
8821 Settings\SpecialChar menuseparator
8827 to provide the user with information about the cite engine.
8830 \begin_layout Subsection
8834 \begin_layout Standard
8835 The first non-comment line of any layout file, included file, or module
8840 contain the file format number:
8843 \begin_layout Description
8844 \begin_inset Flex Code
8847 \begin_layout Plain Layout
8854 \begin_inset Flex Code
8857 \begin_layout Plain Layout
8863 ] The format number of the layout file.
8866 \begin_layout Standard
8867 This tag was introduced with \SpecialChar LyX
8869 \begin_inset space ~
8873 Layout files from older \SpecialChar LyX
8874 versions do not have an explicit file format and
8875 are considered to have
8876 \begin_inset Flex Code
8879 \begin_layout Plain Layout
8881 \begin_inset space ~
8890 The format for the present version of \SpecialChar LyX
8892 But each version of \SpecialChar LyX
8893 is capable of reading earlier versions' layout files,
8894 just as they are capable of reading files produced by earlier versions
8897 There is, however, no provision for converting to earlier formats.
8900 \begin_layout Subsection
8901 \begin_inset CommandInset label
8903 name "subsec:General-text-class"
8907 General text class parameters
8910 \begin_layout Standard
8911 These are general parameters that govern the behavior of an entire document
8917 mean that they must appear in
8918 \begin_inset Flex Code
8921 \begin_layout Plain Layout
8927 files rather than in modules.
8928 A module can contain any layout tag.)
8931 \begin_layout Description
8933 \change_inserted -712698321 1526899478
8934 \begin_inset Flex Code
8937 \begin_layout Plain Layout
8939 \change_inserted -712698321 1526898610
8940 AddToCiteEngine <engine>
8945 Extends the possibilities for displaying citation references.
8947 \begin_inset CommandInset ref
8949 reference "subsec:Citation-engine-description"
8958 \begin_inset Flex Code
8961 \begin_layout Plain Layout
8963 \change_inserted -712698321 1526898823
8974 \begin_layout Description
8975 \begin_inset Flex Code
8978 \begin_layout Plain Layout
8984 Adds information that will be output in the
8985 \begin_inset Flex Code
8988 \begin_layout Plain Layout
8994 block when the document is output to XHTML.
8995 Typically, this would be used to output CSS style information, but it can
8996 be used for anything that can appear in
8997 \begin_inset Flex Code
9000 \begin_layout Plain Layout
9008 \begin_inset Quotes eld
9012 \begin_inset Flex Code
9015 \begin_layout Plain Layout
9022 \begin_inset Quotes erd
9028 \begin_layout Description
9029 \begin_inset Flex Code
9032 \begin_layout Plain Layout
9038 Adds information to the document preamble.
9040 \begin_inset Newline newline
9044 \begin_inset Quotes eld
9048 \begin_inset Flex Code
9051 \begin_layout Plain Layout
9058 \begin_inset Quotes erd
9064 \begin_layout Description
9065 \begin_inset Flex Code
9068 \begin_layout Plain Layout
9074 Defines the possibilities for displaying citation references.
9076 \begin_inset CommandInset ref
9078 reference "subsec:Citation-engine-description"
9087 \begin_inset Quotes eld
9091 \begin_inset Flex Code
9094 \begin_layout Plain Layout
9101 \begin_inset Quotes erd
9105 Primarily used in cite engine files (see
9106 \begin_inset CommandInset ref
9108 reference "subsec:Cite-Engine-Files"
9117 \change_inserted -712698321 1526898530
9118 Note that if you specify this in a layout file or module, any cite engine
9119 definition will be overridden.
9121 \begin_inset Flex Code
9124 \begin_layout Plain Layout
9126 \change_inserted -712698321 1526898530
9139 \begin_layout Description
9140 \begin_inset Flex Code
9143 \begin_layout Plain Layout
9149 Defines formats for use in the display of bibliographic information.
9151 \begin_inset CommandInset ref
9153 reference "subsec:Citation-format-description"
9159 \begin_inset Quotes eld
9163 \begin_inset Flex Code
9166 \begin_layout Plain Layout
9173 \begin_inset Quotes erd
9177 Primarily used in cite engine files (see
9178 \begin_inset CommandInset ref
9180 reference "subsec:Cite-Engine-Files"
9189 \change_inserted -712698321 1526898585
9190 A cite format defined in a layout or module will override the cite engine
9196 \begin_layout Description
9197 \begin_inset Flex Code
9200 \begin_layout Plain Layout
9207 \begin_inset Flex Code
9210 \begin_layout Plain Layout
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9228 ] Determines whether
9232 or Bib\SpecialChar TeX
9233 is used to generate a Bibliography.
9234 Primarily used in cite engine files (see
9235 \begin_inset CommandInset ref
9237 reference "subsec:Cite-Engine-Files"
9247 \begin_layout Description
9248 \begin_inset Flex Code
9251 \begin_layout Plain Layout
9257 Describes various global options supported by the document class.
9259 \begin_inset CommandInset ref
9261 reference "subsec:ClassOptions"
9267 \begin_inset Quotes eld
9271 \begin_inset Flex Code
9274 \begin_layout Plain Layout
9281 \begin_inset Quotes erd
9287 \begin_layout Description
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9298 \begin_inset Flex Code
9301 \begin_layout Plain Layout
9310 \begin_inset space \thinspace{}
9314 \begin_inset Flex Code
9317 \begin_layout Plain Layout
9323 ] Whether the class should
9327 to having one or two columns.
9328 Can be changed in the
9329 \begin_inset Flex Noun
9332 \begin_layout Plain Layout
9333 Document\SpecialChar menuseparator
9342 \begin_layout Description
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9353 \begin_inset Flex Code
9356 \begin_layout Plain Layout
9362 ] This sequence defines the properties for a counter.
9363 If the counter does not yet exist, it is created; if it does exist, it
9366 \begin_inset Quotes eld
9370 \begin_inset Flex Code
9373 \begin_layout Plain Layout
9380 \begin_inset Quotes erd
9384 \begin_inset Newline newline
9388 \begin_inset CommandInset ref
9390 reference "subsec:Counters"
9394 for details on counters.
9397 \begin_layout Description
9398 \begin_inset Flex Code
9401 \begin_layout Plain Layout
9407 Sets the default font used to display the document.
9409 \begin_inset CommandInset ref
9411 reference "subsec:Font-description"
9415 for how to declare fonts.
9417 \begin_inset Quotes eld
9421 \begin_inset Flex Code
9424 \begin_layout Plain Layout
9431 \begin_inset Quotes erd
9437 \begin_layout Description
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9448 \begin_inset Flex Code
9451 \begin_layout Plain Layout
9457 ] Specifies a module to be included by default with this document class.
9458 The module is specified as filename without the
9459 \begin_inset Flex Code
9462 \begin_layout Plain Layout
9469 The user can still remove the module, but it will be active at the outset.
9470 (This applies only when new files are created, or when this class is chosen
9471 for an existing document.)
9474 \begin_layout Description
9475 \begin_inset Flex Code
9478 \begin_layout Plain Layout
9485 \begin_inset Flex Code
9488 \begin_layout Plain Layout
9494 ] This is the style that will be assigned to new paragraphs, usually
9495 \begin_inset Flex Noun
9498 \begin_layout Plain Layout
9505 This will default to the first defined style if not given, but you are
9506 encouraged to use this directive.
9509 \begin_layout Description
9510 \begin_inset Flex Code
9513 \begin_layout Plain Layout
9520 \begin_inset Flex Code
9523 \begin_layout Plain Layout
9529 ] This tag indicates that the module (which is specified by filename without
9531 \begin_inset Flex Code
9534 \begin_layout Plain Layout
9540 extension) cannot be used with this document class.
9541 This might be used in a journal-specific layout file to prevent, say, the
9543 \begin_inset Flex Code
9546 \begin_layout Plain Layout
9552 module that numbers theorems by section.
9557 be used in a module.
9558 Modules have their own way of excluding other modules (see
9559 \begin_inset CommandInset ref
9561 reference "subsec:Layout-modules"
9568 \begin_layout Description
9569 \begin_inset Flex Code
9572 \begin_layout Plain Layout
9578 Defines a new float.
9580 \begin_inset CommandInset ref
9582 reference "subsec:Floats"
9588 \begin_inset Quotes eld
9592 \begin_inset Flex Code
9595 \begin_layout Plain Layout
9602 \begin_inset Quotes erd
9608 \begin_layout Description
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9618 Sets the information that will be output in the
9619 \begin_inset Flex Code
9622 \begin_layout Plain Layout
9628 block when this document class is output to XHTML.
9629 Note that this will completely override any prior
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9651 \begin_inset Newline newline
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9664 if you just want to add material to the preamble.) Must end with
9665 \begin_inset Quotes eld
9669 \begin_inset Flex Code
9672 \begin_layout Plain Layout
9679 \begin_inset Quotes erd
9685 \begin_layout Description
9686 \begin_inset Flex Code
9689 \begin_layout Plain Layout
9696 \begin_inset Flex Code
9699 \begin_layout Plain Layout
9705 ] The style to use for the table of contents, bibliography, and so forth,
9706 when the document is output to HTML.
9707 For articles, this should normally be
9708 \begin_inset Flex Code
9711 \begin_layout Plain Layout
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9728 If it is not given, then \SpecialChar LyX
9729 will attempt to figure out which layout to use.
9732 \begin_layout Description
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9752 ] Modifies the properties of the given counter.
9753 If the counter does not exist, the statement is ignored.
9755 \begin_inset Quotes eld
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Quotes erd
9773 \begin_inset Newline newline
9777 \begin_inset CommandInset ref
9779 reference "subsec:Counters"
9783 for details on counters.
9786 \begin_layout Description
9787 \begin_inset Flex Code
9790 \begin_layout Plain Layout
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9806 ] This allows you to include another layout definition file within yours
9807 to avoid duplicating commands.
9808 Common examples are the standard layout files, for example,
9809 \begin_inset Flex Code
9812 \begin_layout Plain Layout
9818 , which contains most of the basic layouts.
9821 \begin_layout Description
9822 \begin_inset Flex Code
9825 \begin_layout Plain Layout
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9841 ] This section (re-)defines the layout of an inset.
9842 It can be applied to an existing inset or to a new, user-defined inset,
9843 e.g., a new character style.
9845 \begin_inset Quotes eld
9849 \begin_inset Flex Code
9852 \begin_layout Plain Layout
9859 \begin_inset Quotes erd
9863 \begin_inset Newline newline
9867 \begin_inset CommandInset ref
9869 reference "subsec:Flex-insets-and"
9873 for more information.
9877 \begin_layout Description
9878 \begin_inset Flex Code
9881 \begin_layout Plain Layout
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9897 ] A string that indicates the width of the left margin on the screen, for
9899 \begin_inset Quotes eld
9903 \begin_inset Flex Code
9906 \begin_layout Plain Layout
9913 \begin_inset Quotes erd
9917 (Note that this is not a `length', like
9918 \begin_inset Quotes eld
9922 \begin_inset Quotes erd
9928 \begin_layout Description
9929 \begin_inset Flex Code
9932 \begin_layout Plain Layout
9939 \begin_inset Flex Code
9942 \begin_layout Plain Layout
9948 ] An integer that determines the maximal number of names displayed in an
9949 author-year citation before the citation switches to
9950 \begin_inset Quotes eld
9954 \begin_inset Quotes erd
9958 Primarily used in cite engine files (see
9959 \begin_inset CommandInset ref
9961 reference "subsec:Cite-Engine-Files"
9971 \begin_layout Description
9972 \begin_inset Flex Code
9975 \begin_layout Plain Layout
9982 \begin_inset Flex Code
9985 \begin_layout Plain Layout
9991 ] Modifies the properties of the given paragraph style.
9992 If the style does not exist, this section is ignored.
9994 \begin_inset Quotes eld
9998 \begin_inset Flex Code
10001 \begin_layout Plain Layout
10008 \begin_inset Quotes erd
10014 \begin_layout Description
10015 \begin_inset Flex Code
10018 \begin_layout Plain Layout
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10034 ] Deletes an existing counter, usually one defined in an included file.
10037 \begin_layout Description
10038 \begin_inset Flex Code
10041 \begin_layout Plain Layout
10048 \begin_inset Flex Code
10051 \begin_layout Plain Layout
10057 ] Deletes an existing float.
10058 This is particularly useful when you want to suppress a float that has
10059 been defined in an input file.
10062 \begin_layout Description
10063 \begin_inset Flex Code
10066 \begin_layout Plain Layout
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 ] Deletes an existing style.
10085 \begin_layout Description
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10115 ] Define a new table of contents with type
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10126 \begin_inset Flex Code
10129 \begin_layout Plain Layout
10136 See also the AddToToc commands.
10139 \begin_layout Description
10140 \begin_inset Flex Code
10143 \begin_layout Plain Layout
10150 \begin_inset Flex Code
10153 \begin_layout Plain Layout
10159 ] The file format (as defined in the \SpecialChar LyX
10160 preferences) produced by this document
10162 It is mainly useful when
10163 \begin_inset Flex Code
10166 \begin_layout Plain Layout
10173 \begin_inset Flex Code
10176 \begin_layout Plain Layout
10182 and one wants to define a new type of literate document.
10183 The format is reset to
10184 \begin_inset Quotes eld
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10198 \begin_inset Quotes erd
10202 \begin_inset Quotes eld
10206 \begin_inset Flex Code
10209 \begin_layout Plain Layout
10216 \begin_inset Quotes erd
10219 when the corresponding
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10229 parameter is encountered.
10232 \begin_layout Description
10233 \begin_inset Flex Code
10236 \begin_layout Plain Layout
10243 \begin_inset Flex Code
10246 \begin_layout Plain Layout
10257 \begin_inset Flex Code
10260 \begin_layout Plain Layout
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10276 ] Specifies what sort of output documents using this class will produce.
10279 \begin_layout Description
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10309 ] Specifies options, given in the second string, for the package named by
10312 \begin_inset Quotes eld
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10320 PackageOptions natbib square
10326 \begin_inset Quotes erd
10330 \begin_inset Flex Code
10333 \begin_layout Plain Layout
10339 to be loaded with the
10340 \begin_inset Flex Code
10343 \begin_layout Plain Layout
10350 (For \SpecialChar TeX
10351 perts, this causes \SpecialChar LyX
10353 \begin_inset Flex Code
10356 \begin_layout Plain Layout
10359 PassOptionsToPackage{natbib}{square}
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10377 \begin_layout Description
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10388 \begin_inset Flex Code
10391 \begin_layout Plain Layout
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10410 \begin_inset Flex Code
10413 \begin_layout Plain Layout
10419 ] The default pagestyle.
10420 Can be changed in the
10421 \begin_inset Flex Noun
10424 \begin_layout Plain Layout
10425 Document\SpecialChar menuseparator
10434 \begin_layout Description
10435 \begin_inset Flex Code
10438 \begin_layout Plain Layout
10444 Sets the preamble for the \SpecialChar LaTeX
10446 Note that this will completely override any prior
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10477 if you just want to add material to the preamble.) Must end with
10478 \begin_inset Quotes eld
10482 \begin_inset Flex Code
10485 \begin_layout Plain Layout
10492 \begin_inset Quotes erd
10498 \begin_layout Description
10499 \begin_inset Flex Code
10502 \begin_layout Plain Layout
10509 \begin_inset Flex Code
10512 \begin_layout Plain Layout
10519 \begin_inset Flex Code
10522 \begin_layout Plain Layout
10531 \begin_inset space \thinspace{}
10535 \begin_inset Flex Code
10538 \begin_layout Plain Layout
10544 ] Whether the class already provides the feature
10545 \begin_inset Flex Code
10548 \begin_layout Plain Layout
10555 A feature is in general the name of a package (e.
10556 \begin_inset space \thinspace{}
10560 \begin_inset space \space{}
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10574 \begin_inset Flex Code
10577 \begin_layout Plain Layout
10584 \begin_inset space \thinspace{}
10588 \begin_inset space \space{}
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10613 \begin_inset CommandInset ref
10615 reference "chap:List-of-functions"
10619 for the list of features.
10622 \begin_layout Description
10623 \begin_inset Flex Code
10626 \begin_layout Plain Layout
10633 \begin_inset Flex Code
10636 \begin_layout Plain Layout
10642 ] Indicates that this layout provides the functionality of the module mentioned,
10643 which should be specified by the filename without the
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 This will typically be used if the layout includes the module directly,
10655 rather than using the
10656 \begin_inset Flex Code
10659 \begin_layout Plain Layout
10665 tag to indicate that it ought to be used.
10666 It could also be used in a module that provided an alternate implementation
10667 of the same functionality.
10670 \begin_layout Description
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Flex Code
10684 \begin_layout Plain Layout
10690 ] Creates a new paragraph style if it does not already exist.
10691 If the style does exist, this section is ignored.
10693 \begin_inset Quotes eld
10697 \begin_inset Flex Code
10700 \begin_layout Plain Layout
10707 \begin_inset Quotes erd
10713 \begin_layout Description
10714 \begin_inset Flex Code
10717 \begin_layout Plain Layout
10724 \begin_inset Flex Code
10727 \begin_layout Plain Layout
10733 ] Whether the class requires the feature
10734 \begin_inset Flex Code
10737 \begin_layout Plain Layout
10744 Multiple features must be separated by commas.
10745 Note that you can only request supported features.
10747 \begin_inset CommandInset ref
10749 reference "chap:List-of-functions"
10753 for the list of features.).
10754 If you require a package with specific options, you can additionally use
10756 \begin_inset Flex Code
10759 \begin_layout Plain Layout
10768 \begin_layout Description
10769 \begin_inset Flex Code
10772 \begin_layout Plain Layout
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10788 ] A string that indicates the width of the right margin on the screen, for
10790 \begin_inset Quotes eld
10794 \begin_inset Flex Code
10797 \begin_layout Plain Layout
10804 \begin_inset Quotes erd
10810 \begin_layout Description
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10821 \begin_inset Flex Code
10824 \begin_layout Plain Layout
10830 ] Sets which divisions get numbered.
10832 \begin_inset Newline newline
10836 \begin_inset Flex Code
10839 \begin_layout Plain Layout
10845 counter in \SpecialChar LaTeX
10849 \begin_layout Description
10850 \begin_inset Flex Code
10853 \begin_layout Plain Layout
10860 \begin_inset Flex Code
10863 \begin_layout Plain Layout
10872 \begin_inset space \thinspace{}
10876 \begin_inset Flex Code
10879 \begin_layout Plain Layout
10885 ] Whether the class-default should be printing on one or both sides of the
10887 Can be changed in the
10888 \begin_inset Flex Noun
10891 \begin_layout Plain Layout
10892 Document\SpecialChar menuseparator
10901 \begin_layout Description
10902 \begin_inset Flex Code
10905 \begin_layout Plain Layout
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10921 ] This sequence defines a paragraph style.
10922 If the style does not yet exist, it is created; if it does exist, its parameter
10925 \begin_inset Quotes eld
10929 \begin_inset Flex Code
10932 \begin_layout Plain Layout
10939 \begin_inset Quotes erd
10943 \begin_inset Newline newline
10947 \begin_inset CommandInset ref
10949 reference "subsec:Paragraph-Styles"
10953 for details on paragraph styles.
10956 \begin_layout Description
10957 \begin_inset Flex Code
10960 \begin_layout Plain Layout
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 ] The name of the command or environment to be used with
10977 \begin_inset Flex Code
10980 \begin_layout Plain Layout
10989 \begin_layout Description
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11012 \begin_inset Flex Code
11015 \begin_layout Plain Layout
11021 ] Indicates what kind of markup is used to define the title of a document.
11023 \begin_inset Flex Code
11026 \begin_layout Plain Layout
11032 means that the macro with name
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11042 will be inserted after the last layout which has
11043 \begin_inset Quotes eld
11047 \begin_inset Flex Code
11050 \begin_layout Plain Layout
11052 \begin_inset space ~
11061 \begin_inset Quotes erd
11066 \begin_inset Flex Code
11069 \begin_layout Plain Layout
11075 corresponds to the case where all layouts which have
11076 \begin_inset Quotes eld
11080 \begin_inset Flex Code
11083 \begin_layout Plain Layout
11085 \begin_inset space ~
11094 \begin_inset Quotes erd
11097 should be enclosed into the
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11110 \begin_layout Description
11111 \begin_inset Flex Code
11114 \begin_layout Plain Layout
11121 \begin_inset Flex Code
11124 \begin_layout Plain Layout
11130 ] Sets which divisions are included in the table of contents.
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11141 counter in \SpecialChar LaTeX
11145 \begin_layout Subsection
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11156 \begin_inset CommandInset label
11158 name "subsec:ClassOptions"
11165 \begin_layout Standard
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11176 section can contain the following entries:
11179 \begin_layout Description
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11190 \begin_inset Flex Code
11193 \begin_layout Plain Layout
11199 ] The list of available font sizes for the document's main font, separated
11201 \begin_inset Quotes eld
11205 \begin_inset Flex Code
11208 \begin_layout Plain Layout
11215 \begin_inset Quotes erd
11221 \begin_layout Description
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11231 Used to set the DTD line with XML-based output classes.
11233 \begin_inset space \thinspace{}
11237 \begin_inset Quotes eld
11240 -//OASIS//DTD DocBook V4.2//EN
11241 \begin_inset Quotes erd
11247 \begin_layout Description
11248 \begin_inset Flex Code
11251 \begin_layout Plain Layout
11258 \begin_inset Flex Code
11261 \begin_layout Plain Layout
11262 string="empty|plain|headings|fancy"
11267 ] The list of available page sty\SpecialChar softhyphen
11269 \begin_inset Quotes eld
11273 \begin_inset Flex Code
11276 \begin_layout Plain Layout
11283 \begin_inset Quotes erd
11289 \begin_layout Description
11290 \begin_inset Flex Code
11293 \begin_layout Plain Layout
11300 \begin_inset Flex Code
11303 \begin_layout Plain Layout
11309 ] Some document class options, separated by a comma, that will be added
11310 to the optional part of the
11311 \begin_inset Flex Code
11314 \begin_layout Plain Layout
11325 \begin_layout Standard
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11336 section must end with
11337 \begin_inset Quotes eld
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11351 \begin_inset Quotes erd
11357 \begin_layout Subsection
11359 \begin_inset CommandInset label
11361 name "subsec:Paragraph-Styles"
11368 \begin_layout Standard
11369 A paragraph style description looks like this:
11373 \begin_layout Plain Layout
11374 Note that this will either define a new style or modify an existing one.
11382 \begin_layout LyX-Code
11389 \begin_layout LyX-Code
11393 \begin_layout LyX-Code
11397 \begin_layout Standard
11398 where the following commands are allowed:
11401 \begin_layout Description
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11412 \begin_inset Flex Code
11415 \begin_layout Plain Layout
11421 =""] This paragraph will appear in the table of contents of the given type.
11422 An empty string disables.
11423 See also the OutlinerName and the IsTocCaption commands.
11427 \begin_layout Description
11428 \begin_inset Flex Code
11431 \begin_layout Plain Layout
11438 \begin_inset Flex Code
11441 \begin_layout Plain Layout
11446 , left, right, center
11451 ] Paragraph alignment.
11454 \begin_layout Description
11455 \begin_inset Flex Code
11458 \begin_layout Plain Layout
11465 \begin_inset Flex Code
11468 \begin_layout Plain Layout
11473 , left, right, center
11478 ] A comma separated list of permitted alignments.
11479 (Some \SpecialChar LaTeX
11480 styles prohibit certain alignments, since those wouldn't make sense.
11481 For example a right-aligned or centered enumeration isn't possible.)
11484 \begin_layout Description
11485 \begin_inset Flex Code
11488 \begin_layout Plain Layout
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11504 ] Defines argument number <int> of a command\SpecialChar breakableslash
11505 environment associated with
11507 This is useful for things like section headings, and only makes sense with
11510 Every (optional or required) argument of a command or environment – except
11511 for the required argument that is associated with the content of the paragraph
11512 itself – has a separate definition, where the number specifies the order
11514 The definition must end with
11515 \begin_inset Flex Code
11518 \begin_layout Plain Layout
11525 So a command with two optional arguments has:
11529 \begin_layout Quote
11535 \begin_layout Quote
11541 \begin_layout Quote
11547 \begin_layout Quote
11553 \begin_layout Quote
11559 \begin_layout Quote
11565 \begin_layout Standard
11567 \begin_inset Flex Code
11570 \begin_layout Plain Layout
11576 definition, the following specifications are possible:
11579 \begin_layout Itemize
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11590 \begin_inset Flex Code
11593 \begin_layout Plain Layout
11599 The string that will appear both in the menu (to insert this argument)
11600 and on the argument inset button (unless you also specify a separate
11601 \begin_inset Flex Code
11604 \begin_layout Plain Layout
11611 For the menu, you can define an accelerator by appending the respective
11612 character to the string, divided by
11613 \begin_inset Quotes eld
11617 \begin_inset Quotes erd
11621 \begin_inset space \thinspace{}
11625 \begin_inset space \space{}
11629 \begin_inset Quotes eld
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11643 \begin_inset Quotes erd
11649 \begin_layout Itemize
11650 \begin_inset Flex Code
11653 \begin_layout Plain Layout
11660 \begin_inset Flex Code
11663 \begin_layout Plain Layout
11669 A separate string for the menu.
11670 You can define an accelerator by appending the respective character to
11671 the string, divided by
11672 \begin_inset Quotes eld
11676 \begin_inset Quotes erd
11680 \begin_inset space \thinspace{}
11684 \begin_inset space \space{}
11688 \begin_inset Quotes eld
11692 \begin_inset Flex Code
11695 \begin_layout Plain Layout
11702 \begin_inset Quotes erd
11706 This specification is optional.
11707 If it is not given the
11708 \begin_inset Flex Code
11711 \begin_layout Plain Layout
11717 will be used instead for the menu.
11720 \begin_layout Itemize
11721 \begin_inset Flex Code
11724 \begin_layout Plain Layout
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11740 A longer explanatory text that appears in the tooltip when hovering over
11741 the argument inset.
11744 \begin_layout Itemize
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11767 \begin_inset space \thinspace{}
11771 \begin_inset Flex Code
11774 \begin_layout Plain Layout
11780 ] Declare if this is a mandatory (1) or an optional (0) argument.
11781 Mandatory arguments will be output empty if not given, while optional arguments
11782 will not be output at all.
11783 By default, mandatory arguments are delimited by
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11793 , while optional arguments are delimited by
11794 \begin_inset Flex Code
11797 \begin_layout Plain Layout
11806 \begin_layout Itemize
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11817 \begin_inset Flex Code
11820 \begin_layout Plain Layout
11826 defines another argument (by its number) which this argument requires to
11827 be output if it is itself output.
11829 \begin_inset space \thinspace{}
11832 g., in \SpecialChar LaTeX
11833 commands, optional arguments often require previous optional arguments
11834 to be output (at least empty), as in
11835 \begin_inset Flex Code
11838 \begin_layout Plain Layout
11841 command[][argument]{text}
11847 This can be achieved by the statement
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11870 \begin_layout Itemize
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11890 defines a custom left delimiter (instead of
11891 \begin_inset Flex Code
11894 \begin_layout Plain Layout
11901 \begin_inset Flex Code
11904 \begin_layout Plain Layout
11911 A line break in the output can be indicated by
11912 \begin_inset Flex Code
11915 \begin_layout Plain Layout
11924 \begin_layout Itemize
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11944 defines a custom right delimiter (instead of
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11955 \begin_inset Flex Code
11958 \begin_layout Plain Layout
11965 A line break in the output can be indicated by
11966 \begin_inset Flex Code
11969 \begin_layout Plain Layout
11978 \begin_layout Itemize
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11998 defines an argument that is inserted if and only if no user-specified arguments
12000 \begin_inset space \thinspace{}
12004 \begin_inset space \space{}
12007 if no argument inset has been inserted (note that also an empty argument
12008 inset omits the DefaultArg).
12009 Multiple arguments need to be separated by comma.
12012 \begin_layout Itemize
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12032 defines an argument that is inserted in any case (alone or in addition
12033 to user-specified arguments).
12034 Multiple arguments need to be separated by comma.
12037 \begin_layout Itemize
12038 \begin_inset Flex Code
12041 \begin_layout Plain Layout
12047 The font used for the argument content, see
12048 \begin_inset CommandInset ref
12050 reference "subsec:Font-description"
12057 \begin_layout Itemize
12058 \begin_inset Flex Code
12061 \begin_layout Plain Layout
12067 The font used for the label; see
12068 \begin_inset CommandInset ref
12070 reference "subsec:Font-description"
12077 \begin_layout Itemize
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12088 \begin_inset Flex Code
12091 \begin_layout Plain Layout
12096 , Minimalistic, Conglomerate
12101 ] describes the rendering style used for the inset's frame and buttons.
12104 \begin_layout Itemize
12105 \begin_inset Flex Code
12108 \begin_layout Plain Layout
12115 \begin_inset Flex Code
12118 \begin_layout Plain Layout
12125 \begin_inset Flex Code
12128 \begin_layout Plain Layout
12134 , this argument is automatically inserted when the respective style is selected.
12135 Currently, only one argument per style\SpecialChar breakableslash
12136 layout can be automatically inserted.
12139 \begin_layout Itemize
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12160 \begin_inset Flex Code
12163 \begin_layout Plain Layout
12169 , this argument will be inserted with a copy of the co-text (either selected
12170 text or the whole paragraph) as content.
12173 \begin_layout Itemize
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12184 \begin_inset Flex Code
12187 \begin_layout Plain Layout
12197 ] Whether the contents of this argument should be output in raw form, meaning
12198 without special translations that \SpecialChar LaTeX
12201 \begin_inset Flex Code
12204 \begin_layout Plain Layout
12210 status is inherited by the inset or paragraph layout the argument belongs
12211 to, true and false change the status for the given argument only.
12214 \begin_layout Itemize
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12225 \begin_inset Flex Code
12228 \begin_layout Plain Layout
12229 string of characters
12238 Defines individual characters
12239 \begin_inset Newline linebreak
12242 that should be output in raw form, meaning without special translations
12243 that \SpecialChar LaTeX
12245 Note that, contrary to PassThru, this needs to be explicitly defined for
12247 That is, arguments do not inherit PassThruChars from their parent inset
12251 \begin_layout Itemize
12252 \begin_inset Flex Code
12255 \begin_layout Plain Layout
12262 \begin_inset Flex Code
12265 \begin_layout Plain Layout
12274 \begin_inset space \thinspace{}
12278 \begin_inset Flex Code
12281 \begin_layout Plain Layout
12287 ] If this is set to 1, the argument will output its content in the corresponding
12288 item in the table of contents.
12292 \begin_layout Standard
12293 By default, the text entered in the \SpecialChar LyX
12294 workarea in the respective layout is
12295 the last (mandatory) argument of a command if the
12296 \begin_inset Flex Code
12299 \begin_layout Plain Layout
12306 \begin_inset Flex Code
12309 \begin_layout Plain Layout
12316 However, arguments with the prefix
12317 \begin_inset Flex Code
12320 \begin_layout Plain Layout
12326 are output after this workarea argument.
12327 Note that post-argument numbering restarts at 1, so the first argument
12328 following the workarea argument is
12329 \begin_inset Flex Code
12332 \begin_layout Plain Layout
12339 Post-arguments are ignored in any other
12340 \begin_inset Flex Code
12343 \begin_layout Plain Layout
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12362 \begin_layout Standard
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12376 \begin_inset Flex Code
12379 \begin_layout Plain Layout
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12397 followed by the number (e.
12398 \begin_inset space \thinspace{}
12402 \begin_inset space \space{}
12406 \begin_inset Flex Code
12409 \begin_layout Plain Layout
12416 \change_inserted -712698321 1534487781
12420 \begin_layout Standard
12422 \change_inserted -712698321 1534488561
12423 Finally, there is a special argument type with the prefix
12424 \begin_inset Flex Code
12427 \begin_layout Plain Layout
12429 \change_inserted -712698321 1534487844
12438 It is not really an argument, but uses the argument interface (thus, the
12439 prefix is also followed by a number, e.
12440 \begin_inset space \thinspace{}
12445 \begin_inset Flex Code
12448 \begin_layout Plain Layout
12450 \change_inserted -712698321 1534488412
12451 Argument listpreamble:1
12457 As the name implies, it is targeted at lists such as
12474 Its content will be output at the list start, before the first
12475 \begin_inset Flex Code
12478 \begin_layout Plain Layout
12480 \change_inserted -712698321 1534488058
12490 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12492 This way, users can insert redefinitions (of lengths etc.) to individual
12494 By default, these arguments do not have a delimiter.
12500 \begin_layout Description
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12510 Includes a comma-separated list of layouts that should be nested in and
12511 after the current layout.
12512 Only makes sense for nestable layouts (such as environments).
12514 \begin_inset Quotes eld
12518 \begin_inset Flex Code
12521 \begin_layout Plain Layout
12528 \begin_inset Quotes erd
12533 \begin_inset Flex Code
12536 \begin_layout Plain Layout
12545 \begin_layout Description
12546 \begin_inset Flex Code
12549 \begin_layout Plain Layout
12555 Note that this will completely override any prior
12556 \begin_inset Flex Code
12559 \begin_layout Plain Layout
12565 declaration for this style.
12567 \begin_inset Quotes eld
12571 \begin_inset Flex Code
12574 \begin_layout Plain Layout
12581 \begin_inset Quotes erd
12586 \begin_inset CommandInset ref
12588 reference "subsec:I18n"
12592 for details on its use.
12595 \begin_layout Description
12596 \begin_inset Flex Code
12599 \begin_layout Plain Layout
12606 \begin_inset Flex Code
12609 \begin_layout Plain Layout
12619 \begin_layout Plain Layout
12620 Note that a `float' here is a real number, such as: 1.5.
12625 The vertical space with which the last of a chain of paragraphs with this
12626 style is separated from the following paragraph.
12627 If the next paragraph has another style, the separations are not simply
12628 added, but the maximum is taken.
12631 \begin_layout Description
12632 \begin_inset Flex Code
12635 \begin_layout Plain Layout
12642 \begin_inset Flex Code
12645 \begin_layout Plain Layout
12651 ] The category for this style.
12652 This is used to group related styles in the style combobox on the toolbar.
12653 Any string can be used, but you may want to use existing categories with
12658 \begin_layout Description
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12668 Depth of XML command.
12669 Used only with XML-type formats.
12672 \begin_layout Description
12673 \begin_inset Flex Code
12676 \begin_layout Plain Layout
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12692 ] Copies all the features of an existing style into the current one.
12696 \begin_layout Description
12697 \begin_inset Flex Code
12700 \begin_layout Plain Layout
12707 \begin_inset Flex Code
12710 \begin_layout Plain Layout
12716 ] The name of a style whose preamble should be output
12721 This allows to ensure some ordering of the preamble snippets when macros
12722 definitions depend on one another.
12726 \begin_layout Plain Layout
12727 Note that, besides that functionality, there is no way to ensure any ordering
12729 The ordering that you see in a given version of \SpecialChar LyX
12730 may change without warning
12739 \begin_layout Description
12740 \begin_inset Flex Code
12743 \begin_layout Plain Layout
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12758 , Box, Filled_Box, Static
12763 ] The type of label that stands at the end of the paragraph (or sequence
12765 \begin_inset Flex Code
12768 \begin_layout Plain Layout
12775 \begin_inset Newline newline
12779 \begin_inset Flex Code
12782 \begin_layout Plain Layout
12789 \begin_inset Flex Code
12792 \begin_layout Plain Layout
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12820 \begin_inset Quotes eld
12824 \begin_inset Quotes erd
12828 \begin_inset Flex Code
12831 \begin_layout Plain Layout
12838 \begin_inset space \space{}
12842 \begin_inset Flex Code
12845 \begin_layout Plain Layout
12851 ) is a white (resp.
12852 \begin_inset space ~
12855 black) square suitable for end of proof markers,
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 is an explicit text string.
12868 \begin_layout Description
12869 \begin_inset Flex Code
12872 \begin_layout Plain Layout
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12888 ] The string used for a label with a
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12899 \begin_inset Newline newline
12903 \begin_inset Flex Code
12906 \begin_layout Plain Layout
12916 \begin_layout Description
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12926 The font used for both the text body
12932 \begin_inset CommandInset ref
12934 reference "subsec:Font-description"
12939 Note that defining this font automatically defines the
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12950 So you should define this one first if you also want to define
12951 \begin_inset Flex Code
12954 \begin_layout Plain Layout
12963 \begin_layout Description
12964 \begin_inset Flex Code
12967 \begin_layout Plain Layout
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12983 ] Used for backporting new styles to stable \SpecialChar LyX
12985 The first stable version that supports this tag is \SpecialChar LyX
12987 The argument is a number which may either be 0, -1 or any value greater
12990 \begin_inset Flex Code
12993 \begin_layout Plain Layout
12999 flag of a style is greater than zero, it will always be written to the
13001 If a .lyx file is read, the style definitions from the document header are
13002 added to the document class.
13003 Therefore even older \SpecialChar LyX
13004 versions can handle the style.
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13015 is a version number: if the style is read, and the version number is less
13016 than the version number of the already existing style in the document class,
13017 the new style is ignored.
13018 If the version number is greater, the new style replaces the existing style.
13019 A value of -1 means an infinite version number, i.
13020 \begin_inset space \thinspace{}
13024 \begin_inset space \space{}
13027 the style is always used.
13030 \begin_layout Description
13031 \begin_inset Flex Code
13034 \begin_layout Plain Layout
13041 \begin_inset Flex Code
13044 \begin_layout Plain Layout
13053 \begin_inset space \thinspace{}
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13066 ] Usually \SpecialChar LyX
13067 does not allow you to insert more than one space between words,
13068 since a space is considered as the separation between two words, not a
13069 character or symbol of its own.
13070 This is a very fine thing but sometimes annoying, for example, when typing
13071 program code or plain \SpecialChar LaTeX
13074 \begin_inset Flex Code
13077 \begin_layout Plain Layout
13085 \change_deleted -495245474 1550490105
13089 will create protected blanks for the additional blanks when in
13090 \change_inserted -495245474 1550490096
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13097 \change_inserted -495245474 1550490089
13104 \change_deleted -495245474 1550490116
13105 another mode than \SpecialChar LaTeX
13108 \change_inserted -495245474 1550247760
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13115 \change_inserted -495245474 1550247736
13122 \begin_inset Flex Code
13125 \begin_layout Plain Layout
13127 \change_inserted -495245474 1550247755
13138 \begin_layout Description
13139 \begin_inset Flex Code
13142 \begin_layout Plain Layout
13148 These tags are used with XHTML output.
13150 \begin_inset CommandInset ref
13152 reference "subsec:Paragraph-Style-XHTML"
13159 \begin_layout Description
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13169 [FIXME] (Used only with XML-type formats.)
13172 \begin_layout Description
13173 \begin_inset Flex Code
13176 \begin_layout Plain Layout
13183 \begin_inset Flex Code
13186 \begin_layout Plain Layout
13195 \begin_inset space \thinspace{}
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 \begin_inset Flex Code
13212 \begin_layout Plain Layout
13218 , marks the style as to be included in the document preamble and not in
13220 This is useful for document classes that want such information as the title
13221 and author to appear in the preamble.
13222 Note that this works only for styles for which the
13223 \begin_inset Flex Code
13226 \begin_layout Plain Layout
13233 \begin_inset Flex Code
13236 \begin_layout Plain Layout
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13255 \begin_layout Description
13256 \begin_inset Flex Code
13259 \begin_layout Plain Layout
13266 \begin_inset Flex Code
13269 \begin_layout Plain Layout
13278 \begin_inset space \thinspace{}
13282 \begin_inset Flex Code
13285 \begin_layout Plain Layout
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13301 , marks the style as being part of a title block (see also the
13302 \begin_inset Flex Code
13305 \begin_layout Plain Layout
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13324 \begin_layout Description
13325 \begin_inset Flex Code
13328 \begin_layout Plain Layout
13334 Includes a comma-separated list of layouts after which this one should
13336 Only makes sense with regard to nestable layouts (such as environments).
13338 \begin_inset Quotes eld
13342 \begin_inset Flex Code
13345 \begin_layout Plain Layout
13352 \begin_inset Quotes erd
13357 \begin_inset Flex Code
13360 \begin_layout Plain Layout
13369 \begin_layout Description
13370 \begin_inset Flex Code
13373 \begin_layout Plain Layout
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13392 \begin_inset space \thinspace{}
13396 \begin_inset Flex Code
13399 \begin_layout Plain Layout
13405 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13406 of its contents in its item in the table of contents.
13407 Otherwise, only the label, if it exists, appears.
13410 \begin_layout Description
13411 \begin_inset Flex Code
13414 \begin_layout Plain Layout
13421 \begin_inset Flex Code
13424 \begin_layout Plain Layout
13430 ] The \SpecialChar LaTeX
13431 command sequence declaring an item in a list.
13432 The command is to be defined without the preceding backslash (the default
13434 \begin_inset Quotes eld
13438 \begin_inset Quotes erd
13442 \begin_inset Flex Code
13445 \begin_layout Plain Layout
13453 in the \SpecialChar LaTeX
13457 \begin_layout Description
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13468 \begin_inset Flex Code
13471 \begin_layout Plain Layout
13477 ] This provides extra space between paragraphs that have the same style.
13478 If you put other styles into an environment, each is separated with the
13480 \begin_inset Flex Code
13483 \begin_layout Plain Layout
13490 But the whole items of the environment are additionally separated with
13492 \begin_inset Flex Code
13495 \begin_layout Plain Layout
13502 Note that this is a
13507 \begin_layout Description
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13517 [FIXME] (Used only with XML-type formats.)
13520 \begin_layout Description
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13543 \begin_inset space \thinspace{}
13547 \begin_inset Flex Code
13550 \begin_layout Plain Layout
13556 ] Usually \SpecialChar LyX
13557 does not allow you to leave a paragraph empty, since it would
13558 lead to empty \SpecialChar LaTeX
13560 There are some cases where this could be desirable however: in a letter
13561 template, the required fields can be provided as empty fields, so that
13562 people do not forget them; in some special classes, a style can be used
13563 as some kind of break, which does not contain actual text.
13566 \begin_layout Description
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13577 \begin_inset Flex Code
13580 \begin_layout Plain Layout
13586 ] The vertical space between the label and the text body.
13587 Only used for labels that are above the text body (
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13598 \begin_inset Newline newline
13602 \begin_inset Flex Code
13605 \begin_layout Plain Layout
13606 Centered_Top_Environment
13614 \begin_layout Description
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13625 \begin_inset Flex Code
13628 \begin_layout Plain Layout
13634 ] The name of the counter for automatic numbering.
13635 In order to have the counter appear with your label, you will need to reference
13637 \begin_inset Flex Code
13640 \begin_layout Plain Layout
13649 This will work with
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13660 \begin_inset Flex Code
13663 \begin_layout Plain Layout
13670 \begin_inset Flex Code
13673 \begin_layout Plain Layout
13680 \begin_inset Flex Code
13683 \begin_layout Plain Layout
13690 \begin_inset Newline newline
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13717 , though this case is a bit complicated.
13718 Suppose you declare
13719 \begin_inset Quotes eld
13723 \begin_inset Flex Code
13726 \begin_layout Plain Layout
13727 LabelCounter myenum
13733 \begin_inset Quotes erd
13737 Then the actual counters used are
13738 \begin_inset Flex Code
13741 \begin_layout Plain Layout
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13758 \begin_inset Flex Code
13761 \begin_layout Plain Layout
13768 \begin_inset Flex Code
13771 \begin_layout Plain Layout
13777 , much as in \SpecialChar LaTeX
13779 These counters must all be declared separately.
13780 \begin_inset Newline newline
13784 \begin_inset CommandInset ref
13786 reference "subsec:Counters"
13790 for details on counters.
13793 \begin_layout Description
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 The font used for the label.
13805 \begin_inset CommandInset ref
13807 reference "subsec:Font-description"
13814 \begin_layout Description
13815 \begin_inset Flex Code
13818 \begin_layout Plain Layout
13825 \begin_inset Flex Code
13828 \begin_layout Plain Layout
13834 ] Text that indicates how far a label should be indented.
13837 \begin_layout Description
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13848 \begin_inset Flex Code
13851 \begin_layout Plain Layout
13857 ] Text that indicates the amount of horizontal space between the label and
13859 Only used for labels that are not above the text body.
13862 \begin_layout Description
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13882 ] The string used for the label.
13884 \begin_inset Flex Code
13887 \begin_layout Plain Layout
13893 is set, this string can be contain the special formatting commands described
13895 \begin_inset CommandInset ref
13897 reference "subsec:Counters"
13904 \begin_layout Description
13905 \begin_inset Flex Code
13908 \begin_layout Plain Layout
13909 LabelStringAppendix
13915 \begin_inset Flex Code
13918 \begin_layout Plain Layout
13924 ] This is used inside the appendix instead of
13925 \begin_inset Newline newline
13929 \begin_inset Flex Code
13932 \begin_layout Plain Layout
13940 \begin_inset Flex Code
13943 \begin_layout Plain Layout
13950 \begin_inset Newline newline
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13958 LabelStringAppendix
13966 \begin_layout Description
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13976 [FIXME] (Used only with XML-type formats.)
13979 \begin_layout Description
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13990 \begin_inset Flex Code
13993 \begin_layout Plain Layout
13998 , Manual, Static, Above,
13999 \begin_inset Newline newline
14002 Centered, Sensitive, Enumerate,
14003 \begin_inset Newline newline
14006 Itemize, Bibliography
14015 \begin_layout Description
14016 \begin_inset Flex Code
14019 \begin_layout Plain Layout
14025 means the label is the very first word (up to the first real blank).
14026 Use protected spaces if you want more than one word as the label.
14030 \begin_layout Description
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14040 means the label is simply what is declared as
14041 \begin_inset Flex Code
14044 \begin_layout Plain Layout
14051 This will be displayed
14052 \begin_inset Quotes eld
14056 \begin_inset Quotes erd
14059 , at the beginning of the paragraph.
14061 \begin_inset Flex Code
14064 \begin_layout Plain Layout
14071 \begin_inset Flex Code
14074 \begin_layout Plain Layout
14080 , then it will be displayed only in the first paragraph of any sequence
14081 of paragraphs with the same
14082 \begin_inset Flex Code
14085 \begin_layout Plain Layout
14094 \begin_layout Description
14095 \begin_inset Flex Code
14098 \begin_layout Plain Layout
14105 \begin_inset space ~
14109 \begin_inset space ~
14113 \begin_inset Flex Code
14116 \begin_layout Plain Layout
14122 are special cases of
14123 \begin_inset Flex Code
14126 \begin_layout Plain Layout
14133 The label will be printed above the paragraph either at the beginning of
14134 the line or centered.
14137 \begin_layout Description
14138 \begin_inset Flex Code
14141 \begin_layout Plain Layout
14147 is a special case for the caption-labels
14148 \begin_inset Quotes eld
14152 \begin_inset Quotes erd
14156 \begin_inset Quotes eld
14160 \begin_inset Quotes erd
14164 \begin_inset Newline newline
14168 \begin_inset Flex Code
14171 \begin_layout Plain Layout
14177 means the (hardcoded) label string depends on the kind of float: It is
14178 hardcoded to be `FloatType N', where N is the value of the counter associated
14180 For the case that a caption is inserted outside of a float the
14181 \begin_inset Flex Code
14184 \begin_layout Plain Layout
14191 \begin_inset Quotes eld
14195 \begin_inset Quotes erd
14201 \begin_layout Description
14202 \begin_inset Flex Code
14205 \begin_layout Plain Layout
14211 produces the usual sort of enumeration labels.
14212 The number type needs to be set in the
14217 \begin_inset CommandInset ref
14219 reference "subsec:Counters"
14226 \begin_layout Description
14227 \begin_inset Flex Code
14230 \begin_layout Plain Layout
14236 produces various bullets at the different levels.
14237 The bullet types displayed can be set via
14238 \begin_inset Flex Noun
14241 \begin_layout Plain Layout
14242 Document\SpecialChar menuseparator
14243 Settings\SpecialChar menuseparator
14252 \begin_layout Description
14253 \begin_inset Flex Code
14256 \begin_layout Plain Layout
14262 should be used only with
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14267 LatexType BibEnvironment
14276 \begin_layout Description
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14286 Note that this will completely override any prior
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14296 declaration for this style.
14298 \begin_inset Quotes eld
14302 \begin_inset Flex Code
14305 \begin_layout Plain Layout
14312 \begin_inset Quotes erd
14317 \begin_inset CommandInset ref
14319 reference "subsec:I18n"
14323 for details on its use.
14326 \begin_layout Description
14327 \begin_inset Flex Code
14330 \begin_layout Plain Layout
14337 \begin_inset Flex Code
14340 \begin_layout Plain Layout
14346 ] The name of the corresponding \SpecialChar LaTeX
14348 Either the environment or command name.
14351 \begin_layout Description
14352 \begin_inset Flex Code
14355 \begin_layout Plain Layout
14362 \begin_inset Flex Code
14365 \begin_layout Plain Layout
14371 ] An optional parameter for the corresponding
14372 \begin_inset Flex Code
14375 \begin_layout Plain Layout
14382 This parameter cannot be changed from within \SpecialChar LyX
14384 \begin_inset Flex Code
14387 \begin_layout Plain Layout
14393 for customizable parameters).
14394 This will be output as is after all \SpecialChar LaTeX
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14408 \begin_layout Description
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14427 , Command, Environment, Item_Environment,
14428 \begin_inset Newline newline
14431 List_Environment, Bib_Environment
14436 ] How the style should be translated into \SpecialChar LaTeX
14441 \begin_layout Plain Layout
14442 \begin_inset Flex Code
14445 \begin_layout Plain Layout
14451 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14452 Visit the SGML class files for specific examples.
14461 \begin_layout Description
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14471 means nothing special.
14474 \begin_layout Description
14475 \begin_inset Flex Code
14478 \begin_layout Plain Layout
14485 \begin_inset Flex Code
14488 \begin_layout Plain Layout
14495 {\SpecialChar ldots
14504 \begin_layout Description
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14515 \begin_inset Flex Code
14518 \begin_layout Plain Layout
14525 }\SpecialChar ldots
14541 \begin_layout Description
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14562 \begin_inset Flex Code
14565 \begin_layout Plain Layout
14573 is generated for each paragraph of this environment.
14577 \begin_layout Description
14578 \begin_inset Flex Code
14581 \begin_layout Plain Layout
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14598 \begin_inset Newline newline
14602 \begin_inset Flex Code
14605 \begin_layout Plain Layout
14611 is passed as an argument to the environment.
14612 \begin_inset Newline newline
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14625 can be defined in the
14626 \begin_inset Flex Noun
14629 \begin_layout Plain Layout
14630 Edit\SpecialChar menuseparator
14632 \begin_inset space ~
14643 \begin_layout Description
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14663 but adds the necessary mandatory argument (the longest label) to the begin
14664 statement of the bibliography environment:
14665 \begin_inset Newline newline
14669 \begin_inset Flex Code
14672 \begin_layout Plain Layout
14675 begin{thebibliography}{99}
14681 It is therefore only useful for bibliography environments.
14682 The default longest label
14683 \begin_inset Quotes eld
14687 \begin_inset Quotes erd
14690 can be changed by the user in the paragraph settings of a bibliography
14694 \begin_layout Standard
14695 Putting the last few things together, the \SpecialChar LaTeX
14696 output will be either:
14699 \begin_layout LyX-Code
14702 LatexName[LatexParam]{\SpecialChar ldots
14706 \begin_layout Standard
14710 \begin_layout LyX-Code
14713 begin{LatexName}[LatexParam] \SpecialChar ldots
14719 \begin_layout Standard
14720 depending upon the \SpecialChar LaTeX
14725 \begin_layout Description
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14736 \begin_inset Flex Code
14739 \begin_layout Plain Layout
14745 ] A string that is put at the beginning of the style content.
14746 A line break in the output can be indicated by
14747 \begin_inset Flex Code
14750 \begin_layout Plain Layout
14759 \begin_layout Description
14760 \begin_inset Flex Code
14763 \begin_layout Plain Layout
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14779 ] If you put styles into environments, the different
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14789 are not simply added, but added with a factor
14790 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14794 Note that this parameter is also used when
14795 \begin_inset Flex Code
14798 \begin_layout Plain Layout
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14825 Then it is added to the manual or dynamic margin.
14826 \begin_inset Newline newline
14830 \begin_inset Quotes eld
14834 \begin_inset Flex Code
14837 \begin_layout Plain Layout
14844 \begin_inset Quotes erd
14847 means that the paragraph is indented with the width of
14848 \begin_inset Quotes eld
14852 \begin_inset Flex Code
14855 \begin_layout Plain Layout
14862 \begin_inset Quotes erd
14865 in the normal font.
14866 You can get a negative width by prefixing the string with
14867 \begin_inset Quotes eld
14871 \begin_inset Flex Code
14874 \begin_layout Plain Layout
14881 \begin_inset Quotes erd
14885 This way was chosen so that the look is the same with each used screen
14889 \begin_layout Description
14890 \begin_inset Flex Code
14893 \begin_layout Plain Layout
14900 \begin_inset Flex Code
14903 \begin_layout Plain Layout
14908 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14914 \begin_inset Newline newline
14917 The kind of margin that the style has on the left side.
14921 \begin_layout Description
14922 \begin_inset Flex Code
14925 \begin_layout Plain Layout
14931 just means a fixed margin.
14934 \begin_layout Description
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14944 means that the left margin depends on the string entered in the
14945 \begin_inset Flex Noun
14948 \begin_layout Plain Layout
14949 Edit\SpecialChar menuseparator
14951 \begin_inset space ~
14960 This is used to typeset nice lists without tabulators.
14963 \begin_layout Description
14964 \begin_inset Flex Code
14967 \begin_layout Plain Layout
14973 means that the margin depends on the size of the label.
14974 This is used for automatic enumerated headlines.
14975 It is obvious that the headline
14976 \begin_inset Quotes eld
14979 5.4.3.2.1 Very long headline
14980 \begin_inset Quotes erd
14983 must have a wider left margin (as wide as
14984 \begin_inset Quotes eld
14988 \begin_inset Quotes erd
14991 plus the space) than
14992 \begin_inset Quotes eld
14995 3.2 Very long headline
14996 \begin_inset Quotes erd
15000 \begin_inset Quotes eld
15004 \begin_inset Quotes erd
15007 are not able to do this.
15010 \begin_layout Description
15011 \begin_inset Flex Code
15014 \begin_layout Plain Layout
15020 is similar, but only the very first row of the paragraph is dynamic, while
15021 the others are static; this is used, for example, for descriptions.
15024 \begin_layout Description
15025 \begin_inset Flex Code
15028 \begin_layout Plain Layout
15034 means the margin is chosen in a way that the longest row of this paragraph
15035 fits to the right margin.
15036 This is used to typeset an address on the right edge of the page.
15040 \begin_layout Description
15041 \begin_inset Flex Code
15044 \begin_layout Plain Layout
15051 \begin_inset Flex Code
15054 \begin_layout Plain Layout
15063 \begin_inset space \thinspace{}
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15076 ] Whether fragile commands in this style should be
15077 \begin_inset Flex Code
15080 \begin_layout Plain Layout
15093 whether this command should itself be protected.)
15094 \change_inserted -712698321 1523696949
15098 \begin_layout Description
15100 \change_inserted -712698321 1523696969
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15106 \change_inserted -712698321 1523696950
15113 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15118 \change_inserted -712698321 1523696950
15127 \begin_inset space \thinspace{}
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15136 \change_inserted -712698321 1523696950
15142 ] This causes macros that contain this layout to be protected with
15143 \begin_inset Flex Code
15146 \begin_layout Plain Layout
15148 \change_inserted -712698321 1523696950
15161 ) if necessary and thus allows (some) verbatim stuff in macros.
15166 \begin_layout Description
15167 \begin_inset Flex Code
15170 \begin_layout Plain Layout
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15187 \begin_inset space \thinspace{}
15191 \begin_inset Flex Code
15194 \begin_layout Plain Layout
15202 ] Whether newlines are translated into \SpecialChar LaTeX
15204 \begin_inset Flex Code
15207 \begin_layout Plain Layout
15218 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15220 inside \SpecialChar LyX
15224 \begin_layout Description
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15247 \begin_inset space \thinspace{}
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15260 ] If set to true, and if
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15280 ) paragraphs are being indented, then the indentation of such a paragraph
15281 following one of this type will be suppressed.
15282 (So this will not affect the display of non-default paragraphs.)
15285 \begin_layout Description
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15305 ] Name of a style that has replaced this style.
15306 This is used to rename a style, while keeping backward compatibility.
15309 \begin_layout Description
15310 \begin_inset Flex Code
15313 \begin_layout Plain Layout
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15330 \begin_inset space \thinspace{}
15334 \begin_inset Flex Code
15337 \begin_layout Plain Layout
15343 ] Determines whether consecutive paragraphs of the same type are treated
15344 as belonging together.
15345 This has the effect that the
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15355 is only printed once before such a group.
15356 By default, this is true for
15357 \begin_inset Flex Code
15360 \begin_layout Plain Layout
15367 \begin_inset Flex Code
15370 \begin_layout Plain Layout
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15386 and false for all other types.
15389 \begin_layout Description
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15412 \begin_inset space \thinspace{}
15416 \begin_inset Flex Code
15419 \begin_layout Plain Layout
15425 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15427 but only by a line break; together with
15428 \begin_inset Flex Code
15431 \begin_layout Plain Layout
15437 , this allows to emulate a plain text editor (like the ERT inset).
15440 \begin_layout Description
15441 \begin_inset Flex Code
15444 \begin_layout Plain Layout
15451 \begin_inset Flex Code
15454 \begin_layout Plain Layout
15460 ] The indent of the very first line of a paragraph.
15462 \begin_inset Newline newline
15466 \begin_inset Flex Code
15469 \begin_layout Plain Layout
15475 will be fixed for a certain style.
15476 The exception is the default style, since the indentation for these paragraphs
15477 can be prohibited with
15478 \begin_inset Flex Code
15481 \begin_layout Plain Layout
15489 \begin_inset Flex Code
15492 \begin_layout Plain Layout
15498 style paragraphs inside environments use the
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15508 of the environment, not their native one.
15510 \begin_inset Flex Code
15513 \begin_layout Plain Layout
15519 paragraphs inside an enumeration are not indented.
15522 \begin_layout Description
15523 \begin_inset Flex Code
15526 \begin_layout Plain Layout
15533 \begin_inset Flex Code
15536 \begin_layout Plain Layout
15542 ] The vertical space between two paragraphs of this style.
15545 \begin_layout Description
15546 \begin_inset Flex Code
15549 \begin_layout Plain Layout
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15566 allows the user to choose either
15567 \begin_inset Quotes eld
15571 \begin_inset Quotes erd
15575 \begin_inset Quotes eld
15579 \begin_inset Quotes erd
15582 to separate paragraphs.
15584 \begin_inset Quotes eld
15588 \begin_inset Quotes erd
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15603 \begin_inset Quotes eld
15607 \begin_inset Quotes erd
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15620 is ignored and all paragraphs are separated by the
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15631 The vertical space is calculated with
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15637 \begin_inset space ~
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15655 is the height of a row with the normal font.
15656 This way, the look stays the same with different screen fonts.
15659 \begin_layout Description
15660 \begin_inset Flex Code
15663 \begin_layout Plain Layout
15670 \begin_inset Flex Code
15673 \begin_layout Plain Layout
15682 \begin_inset space \thinspace{}
15686 \begin_inset Flex Code
15689 \begin_layout Plain Layout
15695 ] Whether the contents of this paragraph should be output in raw form, meaning
15696 without special translations that \SpecialChar LaTeX
15700 \begin_layout Description
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15724 Defines individual characters that should be output in raw form, meaning
15725 without special translations that \SpecialChar LaTeX
15729 \begin_layout Description
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15739 Information to be included in the \SpecialChar LaTeX
15740 preamble when this style is used.
15741 Used to define macros, load packages, etc., required by this particular
15744 \begin_inset Quotes eld
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15758 \begin_inset Quotes erd
15764 \begin_layout Description
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15775 \begin_inset Flex Code
15778 \begin_layout Plain Layout
15784 ] The prefix to use when creating labels referring to paragraphs of this
15786 This allows the use of formatted references.
15789 \begin_layout Description
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15800 \begin_inset Flex Code
15803 \begin_layout Plain Layout
15809 ] Whether the style requires the feature
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15820 \begin_inset CommandInset ref
15822 reference "chap:List-of-functions"
15826 for the list of features).
15827 If you require a package with specific options, you can additionally use
15829 \begin_inset Flex Code
15832 \begin_layout Plain Layout
15838 as a general text class parameter (see
15839 \begin_inset CommandInset ref
15841 reference "subsec:General-text-class"
15848 \begin_layout Description
15849 \begin_inset Flex Code
15852 \begin_layout Plain Layout
15859 \begin_inset Flex Code
15862 \begin_layout Plain Layout
15871 \begin_inset Flex Code
15874 \begin_layout Plain Layout
15880 ] Resets the \SpecialChar LaTeX
15881 arguments of this style (as defined via the
15882 \begin_inset Flex Code
15885 \begin_layout Plain Layout
15892 This is useful if you have copied a style via
15893 \begin_inset Flex Code
15896 \begin_layout Plain Layout
15902 , but you do not want to inherit its (required and optional) arguments.
15905 \begin_layout Description
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15928 \begin_inset Flex Code
15931 \begin_layout Plain Layout
15937 ] Resumes a counter that is usually reset at each new sequence of layouts.
15938 This is currently only useful when
15939 \begin_inset Flex Code
15942 \begin_layout Plain Layout
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15961 \begin_layout Description
15962 \begin_inset Flex Code
15965 \begin_layout Plain Layout
15972 \begin_inset Flex Code
15975 \begin_layout Plain Layout
15981 ] A string that is put at the end of the layout content.
15982 A line break in the output can be indicated by
15983 \begin_inset Flex Code
15986 \begin_layout Plain Layout
15995 \begin_layout Description
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16006 \begin_inset Flex Code
16009 \begin_layout Plain Layout
16016 \begin_inset Flex Code
16019 \begin_layout Plain Layout
16028 \begin_layout Description
16029 \begin_inset Flex Code
16032 \begin_layout Plain Layout
16039 \begin_inset Flex Code
16042 \begin_layout Plain Layout
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16061 \begin_inset Flex Code
16064 \begin_layout Plain Layout
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16076 \begin_inset space ~
16084 ] This defines what the default spacing should be in the style.
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16096 \begin_inset Flex Code
16099 \begin_layout Plain Layout
16106 \begin_inset Flex Code
16109 \begin_layout Plain Layout
16115 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16116 If you specify the argument
16117 \begin_inset Flex Code
16120 \begin_layout Plain Layout
16126 , then you must also provide a value argument which will be the actual multiplie
16128 Note that, contrary to other parameters,
16129 \begin_inset Flex Code
16132 \begin_layout Plain Layout
16138 implies the generation of specific \SpecialChar LaTeX
16139 code, using the \SpecialChar LaTeX
16143 \begin_inset Flex Code
16146 \begin_layout Plain Layout
16155 \begin_layout Description
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16176 \begin_inset space \thinspace{}
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16191 ] Allow spell-checking paragraphs of this style.
16195 \begin_layout Description
16196 \begin_inset Flex Code
16199 \begin_layout Plain Layout
16206 \begin_inset Flex Code
16209 \begin_layout Plain Layout
16218 \begin_inset Flex Code
16221 \begin_layout Plain Layout
16227 ] Steps the master counter of a given counter at the beginning of a new
16228 sequence of layouts.
16229 This is currently only useful when
16230 \begin_inset Flex Code
16233 \begin_layout Plain Layout
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16252 \begin_layout Description
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16262 The font used for the text body .
16264 \begin_inset CommandInset ref
16266 reference "subsec:Font-description"
16273 \begin_layout Description
16274 \begin_inset Flex Code
16277 \begin_layout Plain Layout
16286 \begin_inset Flex Code
16289 \begin_layout Plain Layout
16299 The level of the style in the table of contents.
16300 This is used for automatic numbering of section headings.
16303 \begin_layout Description
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16316 \begin_inset Flex Code
16319 \begin_layout Plain Layout
16330 \begin_inset Flex Code
16333 \begin_layout Plain Layout
16340 \begin_inset Flex Code
16343 \begin_layout Plain Layout
16349 ] This tag determines whether the first line indentation of this paragraph
16350 can be toggled via the Paragraph settings dialog.
16354 \begin_inset Flex Code
16357 \begin_layout Plain Layout
16367 is set, indentation can be toggled if the document settings use
16368 \begin_inset Quotes eld
16372 \begin_inset Quotes erd
16375 paragraph style, with
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16385 , indentation can always be toggled, notwithstanding the document settings,
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16396 , indentation can never be toggled.
16399 \begin_layout Description
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16419 ] The vertical space with which the very first of a chain of paragraphs
16420 with this style is separated from the previous paragraph.
16421 If the previous paragraph has another style, the separations are not simply
16422 added, but the maximum is taken.
16425 \begin_layout Subsection
16426 \begin_inset CommandInset label
16432 Internationalization of Paragraph Styles
16435 \begin_layout Standard
16437 has long supported internationalization of layout information, but, until
16438 version 2.0, this applied only to the user interface and not to, say, PDF
16440 Thus, French authors were forced to resort to ugly hacks if they wanted
16445 1' instead of `Theorem 1'.
16446 Thanks to Georg Baum, that is no longer the case.
16449 \begin_layout Standard
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16460 defines text that is to appear in the typeset document, it may use
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16471 \begin_inset Flex Code
16474 \begin_layout Plain Layout
16480 to support non-English and even multi-language documents correctly.
16481 The following excerpt (from the
16482 \begin_inset Flex Code
16485 \begin_layout Plain Layout
16491 file) shows how this works:
16494 \begin_layout LyX-Code
16499 \begin_layout LyX-Code
16502 theoremstyle{remark}
16505 \begin_layout LyX-Code
16508 newtheorem{claim}[thm]{
16515 \begin_layout LyX-Code
16519 \begin_layout LyX-Code
16523 \begin_layout LyX-Code
16528 claimname}{_(Claim)}
16531 \begin_layout LyX-Code
16535 \begin_layout LyX-Code
16539 \begin_layout LyX-Code
16548 claimname}{_(Claim)}}
16551 \begin_layout LyX-Code
16556 \begin_layout Standard
16557 In principle, any legal \SpecialChar LaTeX
16559 \begin_inset Flex Code
16562 \begin_layout Plain Layout
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16578 tags, but in practice they will typically look as they do here.
16579 The key to correct translation of the typeset text is the definition of
16580 the \SpecialChar LaTeX
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16609 \begin_layout Standard
16611 \begin_inset Flex Code
16614 \begin_layout Plain Layout
16620 tag provides for internationalization based upon the overall language of
16622 The contents of the tag will be included in the preamble, just as with
16624 \begin_inset Flex Code
16627 \begin_layout Plain Layout
16634 What makes it special is the use of the
16635 \begin_inset Quotes eld
16639 \begin_inset Quotes erd
16643 \begin_inset Flex Code
16646 \begin_layout Plain Layout
16652 , which will be replaced, when \SpecialChar LyX
16653 produces \SpecialChar LaTeX
16654 output, with the translation of
16655 its argument into the document language.
16658 \begin_layout Standard
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16669 tag is more complex, since it is meant to provide support for multi-language
16670 documents and so offers an interface to the
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16681 Its contents will be added to the preamble once for each language that
16682 appears in the document.
16683 In this case, the argument to
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16693 will be replaced with its translation into the language in question; the
16695 \begin_inset Flex Code
16698 \begin_layout Plain Layout
16704 is replaced by the language name (as used by the babel package).
16707 \begin_layout Standard
16708 A German document that also included a French section would thus have the
16709 following in the preamble:
16712 \begin_layout LyX-Code
16721 claimname}{Affirmation}}
16722 \begin_inset Newline newline
16733 claimname}{Behauptung}}
16734 \begin_inset Newline newline
16741 claimname}{Behauptung}
16744 \begin_layout Standard
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16756 will then conspire to produce the correct text in the output.
16759 \begin_layout Standard
16760 One important point to note here is that the translations are provided by
16762 itself, through the file
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16773 This means, in effect, that
16774 \begin_inset Flex Code
16777 \begin_layout Plain Layout
16784 \begin_inset Flex Code
16787 \begin_layout Plain Layout
16793 are really only of use in layout files that are provided with \SpecialChar LyX
16795 entered in user-created layout files will not be seen by \SpecialChar LyX
16796 's internationalizatio
16797 n routines unless the
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16807 file is modified accordingly.
16808 That said, however, any layout created with the intention that it will
16809 be included with \SpecialChar LyX
16810 should use these tags where appropriate.
16811 Please note that the paragraph style translations provided by \SpecialChar LyX
16813 change with a minor update (e.
16814 \begin_inset space \thinspace{}
16818 \begin_inset space \space{}
16821 from version 2.1.x to 2.1.y).
16822 It is however quite likely that a major update (e.
16823 \begin_inset space \thinspace{}
16827 \begin_inset space \space{}
16830 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16833 \begin_layout Subsection
16835 \begin_inset CommandInset label
16837 name "subsec:Floats"
16844 \begin_layout Standard
16845 It is necessary to define the floats (
16846 \begin_inset Flex Noun
16849 \begin_layout Plain Layout
16856 \begin_inset Flex Noun
16859 \begin_layout Plain Layout
16865 , \SpecialChar ldots
16866 ) in the text class itself.
16867 Standard floats are included in the file
16868 \begin_inset Flex Code
16871 \begin_layout Plain Layout
16877 , so you may have to do no more than add
16880 \begin_layout LyX-Code
16881 Input stdfloats.inc
16884 \begin_layout Standard
16885 to your layout file.
16886 If you want to implement a text class that proposes some other float types
16887 (like the AGU class bundled with \SpecialChar LyX
16888 ), the information below will hopefully
16892 \begin_layout Description
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16903 \begin_inset Flex Code
16906 \begin_layout Plain Layout
16912 =!htbpH] Allowed placement options for this float type.
16913 The value is a string of placement characters.
16914 Possible characters include:
16919 \begin_inset Quotes eld
16923 \begin_inset Quotes erd
16931 \begin_inset Quotes eld
16935 \begin_inset Quotes erd
16943 \begin_inset Quotes eld
16947 \begin_inset Quotes erd
16955 \begin_inset Quotes eld
16959 \begin_inset Quotes erd
16967 \begin_inset Quotes eld
16971 \begin_inset Quotes erd
16979 \begin_inset Quotes eld
16983 \begin_inset Quotes erd
16987 The order of the characters in the string does not matter.
16988 If no placement options are allowed, use the string
16995 \begin_layout Description
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17018 \begin_inset space \thinspace{}
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17037 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17044 \begin_inset Flex Code
17047 \begin_layout Plain Layout
17053 if the float does not support this feature.
17056 \begin_layout Description
17057 \begin_inset Flex Code
17060 \begin_layout Plain Layout
17067 \begin_inset Flex Code
17070 \begin_layout Plain Layout
17079 \begin_inset space \thinspace{}
17085 \begin_inset Flex Code
17088 \begin_layout Plain Layout
17098 ] Defines whether the float has a starred variant that spans columns in
17099 a two column paragraph.
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17110 if the float does not support this feature.
17113 \begin_layout Description
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17134 \begin_inset Quotes erd
17138 \begin_inset Quotes erd
17141 ] The file name extension of an auxiliary file for the list of figures (or
17144 writes the captions to this file.
17147 \begin_layout Description
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17158 \begin_inset Flex Code
17161 \begin_layout Plain Layout
17168 \begin_inset Quotes erd
17172 \begin_inset Quotes erd
17175 ] The string that will be used in the menus and also for the caption.
17176 This is translated to the current language if babel is used.
17179 \begin_layout Description
17180 \begin_inset Flex Code
17183 \begin_layout Plain Layout
17189 These tags control the XHTML output.
17191 \begin_inset CommandInset ref
17193 reference "sec:Tags-for-XHTML"
17200 \begin_layout Description
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17213 \begin_inset Flex Code
17216 \begin_layout Plain Layout
17225 \begin_inset space \thinspace{}
17229 \begin_inset Flex Code
17232 \begin_layout Plain Layout
17238 ] Indicates whether the float is already defined in the document class or
17239 if instead the \SpecialChar LaTeX
17241 \begin_inset Flex Code
17244 \begin_layout Plain Layout
17250 needs to be loaded to define it on-the-fly.
17252 \begin_inset Flex Code
17255 \begin_layout Plain Layout
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17272 It should be set to
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17282 if the float is already defined by the \SpecialChar LaTeX
17286 \begin_layout Description
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17307 \begin_inset Quotes erd
17311 \begin_inset Quotes erd
17314 ] The command used to generate a list of floats of this type; the leading
17323 \begin_inset Flex Code
17326 \begin_layout Plain Layout
17332 is false, since there is no standard way to generate this command.
17334 \begin_inset Flex Code
17337 \begin_layout Plain Layout
17343 is true, since in that case there is a standard way to define the command.
17346 \begin_layout Description
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17367 \begin_inset Quotes erd
17371 \begin_inset Quotes erd
17374 ] A title for a list of floats of this kind (list of figures, tables, or
17376 It is used for the screen label within \SpecialChar LyX
17377 , it is used by \SpecialChar LaTeX
17379 it is used as the title in the XHTML output.
17380 It will be translated to the document language.
17383 \begin_layout Description
17384 \begin_inset Flex Code
17387 \begin_layout Plain Layout
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17404 \begin_inset Quotes erd
17408 \begin_inset Quotes erd
17411 ] This (optional) argument determines whether floats of this class will
17412 be numbered within some sectional unit of the document.
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17424 \begin_inset Quotes eld
17428 \begin_inset Flex Code
17431 \begin_layout Plain Layout
17438 \begin_inset Quotes erd
17441 , the floats will be numbered within chapters.
17445 \begin_layout Description
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17456 \begin_inset Flex Code
17459 \begin_layout Plain Layout
17466 \begin_inset Quotes erd
17470 \begin_inset Quotes erd
17473 ] The default placement for the given class of floats.
17474 The string should be as in standard \SpecialChar LaTeX
17476 \begin_inset Flex Code
17479 \begin_layout Plain Layout
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17515 for top, bottom, page, and here, respectively.
17519 \begin_layout Plain Layout
17520 Note that the order of these letters in the string is irrelevant, like in
17527 On top of that there is a new type,
17528 \begin_inset Flex Code
17531 \begin_layout Plain Layout
17537 , which does not really correspond to a float, since it means: put it
17538 \begin_inset Quotes eld
17542 \begin_inset Quotes erd
17546 Note however that the
17547 \begin_inset Flex Code
17550 \begin_layout Plain Layout
17556 specifier is special and, because of implementation details, cannot be
17557 used in non-built in float types.
17558 If you do not understand what this means, just use
17559 \begin_inset Quotes eld
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17573 \begin_inset Quotes erd
17579 \begin_layout Description
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17599 ] The prefix to use when creating labels referring to floats of this type.
17600 This allows the use of formatted references.
17601 Note that you can remove any
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17611 set by a copied style by using the special value
17612 \begin_inset Quotes eld
17616 \begin_inset Quotes erd
17619 , which must be all caps.
17622 \begin_layout Description
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17633 \begin_inset Flex Code
17636 \begin_layout Plain Layout
17643 \begin_inset Quotes erd
17647 \begin_inset Quotes erd
17650 ] The style used when defining the float using
17651 \begin_inset Flex Code
17654 \begin_layout Plain Layout
17665 \begin_layout Description
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17676 \begin_inset Flex Code
17679 \begin_layout Plain Layout
17686 \begin_inset Quotes erd
17690 \begin_inset Quotes erd
17694 \begin_inset Quotes eld
17698 \begin_inset Quotes erd
17701 of the new class of floats, like program or algorithm.
17702 After the appropriate
17703 \begin_inset Flex Code
17706 \begin_layout Plain Layout
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17741 \begin_layout Description
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17762 \begin_inset space \thinspace{}
17766 \begin_inset Flex Code
17769 \begin_layout Plain Layout
17777 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17779 \begin_inset Flex Code
17782 \begin_layout Plain Layout
17788 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17792 \begin_layout Standard
17793 Note that defining a float with type
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17805 automatically defines the corresponding counter with name
17806 \begin_inset Flex Code
17809 \begin_layout Plain Layout
17820 \begin_layout Subsection
17821 Flex insets and InsetLayout
17822 \begin_inset CommandInset label
17824 name "subsec:Flex-insets-and"
17831 \begin_layout Standard
17832 Flex insets come in three different kinds:
17835 \begin_layout Itemize
17837 \begin_inset Flex Code
17840 \begin_layout Plain Layout
17846 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17848 \begin_inset Flex Code
17851 \begin_layout Plain Layout
17860 \begin_inset Flex Code
17863 \begin_layout Plain Layout
17874 \begin_layout Itemize
17876 \begin_inset Flex Code
17879 \begin_layout Plain Layout
17885 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17887 footnote, and the like.
17888 An obvious example is an endnote inset, which is defined in the
17889 \begin_inset Flex Code
17892 \begin_layout Plain Layout
17901 \begin_layout Itemize
17903 \begin_inset Flex Code
17906 \begin_layout Plain Layout
17912 ): For use with DocBook classes.
17915 \begin_layout Standard
17916 Flex insets are defined using the
17917 \begin_inset Flex Code
17920 \begin_layout Plain Layout
17926 tag, which shall be explained in a moment.
17929 \begin_layout Standard
17931 \begin_inset Flex Code
17934 \begin_layout Plain Layout
17940 tag also serves another function: It can be used to customize the general
17941 layout of many different types of insets.
17943 \begin_inset Flex Code
17946 \begin_layout Plain Layout
17952 can be used to customize the layout parameters for footnotes, marginal
17953 notes, note insets, \SpecialChar TeX
17954 code (ERT) insets, branches, listings, indexes, boxes,
17955 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17958 \begin_layout Standard
17960 \begin_inset Flex Code
17963 \begin_layout Plain Layout
17969 definition must begin with a line of the form:
17972 \begin_layout LyX-Code
17976 \begin_layout Standard
17978 \begin_inset Flex Code
17981 \begin_layout Plain Layout
17987 indicates the inset whose layout is being defined, and here there are four
17991 \begin_layout Enumerate
17992 The layout for a pre-existing inset is being modified.
17993 In this case, can be
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18003 any one of the following:
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18014 \begin_inset Flex Code
18017 \begin_layout Plain Layout
18024 \begin_inset Flex Code
18027 \begin_layout Plain Layout
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18064 \begin_inset Flex Code
18067 \begin_layout Plain Layout
18074 \begin_inset Flex Code
18077 \begin_layout Plain Layout
18084 \begin_inset Flex Code
18087 \begin_layout Plain Layout
18094 \begin_inset Flex Code
18097 \begin_layout Plain Layout
18104 \begin_inset Flex Code
18107 \begin_layout Plain Layout
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18124 \begin_inset Flex Code
18127 \begin_layout Plain Layout
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18144 \begin_inset Flex Code
18147 \begin_layout Plain Layout
18154 \begin_inset Flex Code
18157 \begin_layout Plain Layout
18164 \begin_inset Flex Code
18167 \begin_layout Plain Layout
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18184 \begin_inset Flex Code
18187 \begin_layout Plain Layout
18194 \begin_inset Flex Code
18197 \begin_layout Plain Layout
18206 \begin_layout Enumerate
18207 The layout for a Flex inset is being defined.
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18218 must be of the form
18219 \begin_inset Quotes eld
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18233 \begin_inset Quotes erd
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18246 may be be any valid identifier not used by a pre-existing Flex inset.
18247 The identifier may include spaces, but in that case the whole thing must
18248 be wrapped in quotes.
18249 Note that the definition of a flex inset
18254 \begin_inset Flex Code
18257 \begin_layout Plain Layout
18263 entry, declaring which type of inset it defines.
18266 \begin_layout Enumerate
18267 The layout for user specific branch is being defined.
18269 \begin_inset Flex Code
18272 \begin_layout Plain Layout
18278 must be of the form
18279 \begin_inset Quotes eld
18283 \begin_inset Flex Code
18286 \begin_layout Plain Layout
18293 \begin_inset Quotes erd
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 may be be any valid identifier of branch defined in user's document.
18307 The identifier may include spaces, but in that case the whole thing must
18308 be wrapped in quotes.
18309 The main purpose of this feature is to allow \SpecialChar LaTeX
18310 wrapping around specific
18311 branches as user needs.
18314 \begin_layout Enumerate
18315 The layout of a user (or class) specific caption is being defined.
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18326 must be of the form
18327 \begin_inset Quotes eld
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18341 \begin_inset Quotes erd
18345 \begin_inset Flex Code
18348 \begin_layout Plain Layout
18354 specifies the name of the caption as it appears in the menu.
18355 Have a look at the standard caption (
18356 \begin_inset Flex Code
18359 \begin_layout Plain Layout
18365 ), the specific captions of the KOMA-Script classes (
18366 \begin_inset Flex Code
18369 \begin_layout Plain Layout
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18388 \begin_inset space ~
18392 \begin_inset Newline linebreak
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18407 ) for applications.
18410 \begin_layout Standard
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18421 definition can contain the following entries:
18424 \begin_layout Description
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18435 \begin_inset Flex Code
18438 \begin_layout Plain Layout
18444 =""] This inset will appear in the table of contents of the given type.
18445 An empty string disables.
18446 See also the OutlinerName and the IsTocCaption commands.
18447 This is only implemented for Flex insets.
18451 \begin_layout Description
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18471 ] Defines argument number of a command\SpecialChar breakableslash
18472 environment associated with the current
18474 The definition must end with
18475 \begin_inset Flex Code
18478 \begin_layout Plain Layout
18486 \begin_inset CommandInset ref
18488 reference "subsec:Paragraph-Styles"
18495 \begin_layout Description
18496 \begin_inset Flex Code
18499 \begin_layout Plain Layout
18505 Preamble for changing language commands; see
18506 \begin_inset CommandInset ref
18508 reference "subsec:I18n"
18515 \begin_layout Description
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18526 \begin_inset Flex Code
18529 \begin_layout Plain Layout
18535 ] The color for the inset's background.
18537 \begin_inset CommandInset ref
18539 reference "chap:Names-of-colors"
18543 for a list of the available color names.
18546 \begin_layout Description
18547 \begin_inset Flex Code
18550 \begin_layout Plain Layout
18557 \begin_inset Flex Code
18560 \begin_layout Plain Layout
18569 \begin_inset space \thinspace{}
18573 \begin_inset Flex Code
18576 \begin_layout Plain Layout
18582 ] Whether to use the content of the inset as the label, when the inset is
18587 \begin_layout Description
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18607 ] As with paragraph styles, see
18608 \begin_inset CommandInset ref
18610 reference "subsec:Paragraph-Styles"
18615 Note that you need to specify the complete type, e.
18616 \begin_inset space \thinspace{}
18620 \begin_inset space ~
18624 \begin_inset Flex Code
18627 \begin_layout Plain Layout
18628 CopyStyle Flex:<name>
18636 \begin_layout Description
18637 \begin_inset Flex Code
18640 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18659 \begin_inset space \thinspace{}
18663 \begin_inset Flex Code
18666 \begin_layout Plain Layout
18672 ] Indicates whether the user may employ the Paragraph Settings dialog to
18673 customize the paragraph.
18676 \begin_layout Description
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18687 \begin_inset Flex Code
18690 \begin_layout Plain Layout
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18716 , describing the rendering style used for the inset's frame and buttons.
18717 Footnotes generally use
18718 \begin_inset Flex Code
18721 \begin_layout Plain Layout
18727 , ERT insets generally
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18737 , and character styles
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18750 \begin_layout Description
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18773 \begin_inset space \thinspace{}
18779 \begin_inset Flex Code
18782 \begin_layout Plain Layout
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18811 Indicates whether the environment will stand on its own in the output or
18812 will appear inline with the surrounding text.
18813 If set to false, it is supposed that the \SpecialChar LaTeX
18814 environment ignores white space
18815 (including one newline character) after the
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18832 \begin_inset Flex Code
18835 \begin_layout Plain Layout
18849 \change_inserted 731793113 1538674858
18853 \begin_layout Description
18855 \change_inserted 731793113 1538674891
18856 \begin_inset Flex Code
18859 \begin_layout Plain Layout
18861 \change_inserted 731793113 1538674863
18873 ,1] Allow the contents of the inset to be edited externally (using whatever
18874 editor is defined for the document's output format).
18879 \begin_layout Description
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18889 Required at the end of the
18890 \begin_inset Flex Code
18893 \begin_layout Plain Layout
18902 \begin_layout Description
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18912 The font used for both the text body
18918 \begin_inset CommandInset ref
18920 reference "subsec:Font-description"
18925 Note that defining this font automatically defines the
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 to the same value, so define this first and define
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18945 later if you want them to be different.
18948 \begin_layout Description
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18953 FixedWidthPreambleEncoding
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18971 \begin_inset space \thinspace{}
18975 \begin_inset Flex Code
18978 \begin_layout Plain Layout
18984 ] Force a fixed width encoding for the translated contents of
18985 \begin_inset Flex Code
18988 \begin_layout Plain Layout
18995 \begin_inset Flex Code
18998 \begin_layout Plain Layout
19004 code generated by this layout.
19005 This is needed for special \SpecialChar LaTeX
19010 that do not work with variable width encodings such as
19015 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19016 backends such as Xe\SpecialChar TeX
19018 Lua\SpecialChar TeX
19022 \begin_layout Description
19023 \begin_inset Flex Code
19026 \begin_layout Plain Layout
19027 ForceLocalFontSwitch
19033 \begin_inset Flex Code
19036 \begin_layout Plain Layout
19045 \begin_inset space \thinspace{}
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19058 ] When using babel, always use a local font switch (
19059 \begin_inset Flex Code
19062 \begin_layout Plain Layout
19070 ), never a global one (such as
19071 \begin_inset Flex Code
19074 \begin_layout Plain Layout
19085 \begin_layout Description
19086 \begin_inset Flex Code
19089 \begin_layout Plain Layout
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19108 \begin_inset space \thinspace{}
19112 \begin_inset Flex Code
19115 \begin_layout Plain Layout
19122 \begin_inset Quotes eld
19126 \begin_inset Quotes erd
19129 language, leading to Left-to-Right (Latin) output, e.
19130 \begin_inset space \thinspace{}
19134 \begin_inset space \space{}
19137 in \SpecialChar TeX
19142 \begin_layout Description
19143 \begin_inset Flex Code
19146 \begin_layout Plain Layout
19153 \begin_inset Flex Code
19156 \begin_layout Plain Layout
19165 \begin_inset space \thinspace{}
19169 \begin_inset Flex Code
19172 \begin_layout Plain Layout
19178 ] Force a a line break in the \SpecialChar LaTeX
19179 output before the inset starts and after
19181 This assures the inset itself is output on its own lines, for parsing purposes.
19184 \begin_layout Description
19185 \begin_inset Flex Code
19188 \begin_layout Plain Layout
19195 \begin_inset Flex Code
19198 \begin_layout Plain Layout
19207 \begin_inset space \thinspace{}
19211 \begin_inset Flex Code
19214 \begin_layout Plain Layout
19220 ] Indicates whether the
19221 \begin_inset Flex Code
19224 \begin_layout Plain Layout
19230 should be used or, instead, the user can change the paragraph style used
19235 \begin_layout Description
19236 \begin_inset Flex Code
19239 \begin_layout Plain Layout
19246 \begin_inset Flex Code
19249 \begin_layout Plain Layout
19258 \begin_inset space \thinspace{}
19262 \begin_inset Flex Code
19265 \begin_layout Plain Layout
19271 ] As with paragraph styles, see
19272 \begin_inset CommandInset ref
19274 reference "subsec:Paragraph-Styles"
19281 \begin_layout Description
19282 \begin_inset Flex Code
19285 \begin_layout Plain Layout
19291 These tags control the XHTML output.
19293 \begin_inset CommandInset ref
19295 reference "sec:Tags-for-XHTML"
19302 \begin_layout Description
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19325 \begin_inset space \thinspace{}
19329 \begin_inset Flex Code
19332 \begin_layout Plain Layout
19338 ] Whether to include the contents of this inset in the strings generated
19339 for the `Outline' pane for all table of contents, regardless of the AddToToc
19341 One would not, for example, want the content of a footnote in a section
19342 header to be included in the TOC displayed in the outline, but one would
19343 normally want the content of a character style displayed.
19344 Default is false: not to include.
19347 \begin_layout Description
19348 \begin_inset Flex Code
19351 \begin_layout Plain Layout
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19370 \begin_inset space \thinspace{}
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19383 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19384 of its contents in its item in the table of contents.
19385 Otherwise, only the label appears.
19388 \begin_layout Description
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19413 \begin_inset space \thinspace{}
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19426 ] As with paragraph styles, see
19427 \begin_inset CommandInset ref
19429 reference "subsec:Paragraph-Styles"
19436 \begin_layout Description
19437 \begin_inset Flex Code
19440 \begin_layout Plain Layout
19446 The font used for the label.
19448 \begin_inset CommandInset ref
19450 reference "subsec:Font-description"
19455 Note that this definition can never appear before
19456 \begin_inset Flex Code
19459 \begin_layout Plain Layout
19465 , lest it be ineffective.
19468 \begin_layout Description
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19489 \begin_inset Quotes erd
19493 \begin_inset Quotes erd
19496 ] What will be displayed on the button or elsewhere as the inset label.
19498 \begin_inset Flex Code
19501 \begin_layout Plain Layout
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19518 ) modify this label on the fly.
19521 \begin_layout Description
19522 \begin_inset Flex Code
19525 \begin_layout Plain Layout
19531 Language dependent preamble; see
19532 \begin_inset CommandInset ref
19534 reference "subsec:I18n"
19541 \begin_layout Description
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19561 ] The name of the corresponding \SpecialChar LaTeX
19563 Either the environment or command name.
19566 \begin_layout Description
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19586 ] The optional parameter for the corresponding
19587 \begin_inset Flex Code
19590 \begin_layout Plain Layout
19596 stuff, including possible bracket pairs like
19597 \begin_inset Flex Code
19600 \begin_layout Plain Layout
19607 This parameter cannot be changed from within \SpecialChar LyX
19609 \begin_inset Flex Code
19612 \begin_layout Plain Layout
19618 for customizable parameters).
19619 It will be output as is after all \SpecialChar LaTeX
19621 \begin_inset Flex Code
19624 \begin_layout Plain Layout
19633 \begin_layout Description
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19648 Command, Environment, None
19653 ] How the style should be translated into \SpecialChar LaTeX
19658 \begin_layout Plain Layout
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19668 is perhaps a bit misleading, since these rules apply to SGML classes too.
19669 Visit the SGML class files for specific examples.
19678 \begin_layout Description
19679 \begin_inset Flex Code
19682 \begin_layout Plain Layout
19688 means nothing special
19691 \begin_layout Description
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19712 {\SpecialChar ldots
19721 \begin_layout Description
19722 \begin_inset Flex Code
19725 \begin_layout Plain Layout
19732 \begin_inset Flex Code
19735 \begin_layout Plain Layout
19742 }\SpecialChar ldots
19757 \begin_layout Standard
19758 Putting the last few things together, the \SpecialChar LaTeX
19759 output will be either:
19762 \begin_layout LyX-Code
19765 LatexName[LatexParam]{\SpecialChar ldots
19769 \begin_layout Standard
19773 \begin_layout LyX-Code
19776 begin{LatexName}[LatexParam] \SpecialChar ldots
19782 \begin_layout Standard
19783 depending upon the \SpecialChar LaTeX
19788 \begin_layout Description
19789 \begin_inset Flex Code
19792 \begin_layout Plain Layout
19799 \begin_inset Flex Code
19802 \begin_layout Plain Layout
19808 ] A string that is put at the beginning of the layout content.
19809 A line break in the output can be indicated by
19810 \begin_inset Flex Code
19813 \begin_layout Plain Layout
19822 \begin_layout Description
19823 \begin_inset Flex Code
19826 \begin_layout Plain Layout
19833 \begin_inset Flex Code
19836 \begin_layout Plain Layout
19843 \begin_inset Flex Code
19846 \begin_layout Plain Layout
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19863 \begin_inset Flex Code
19866 \begin_layout Plain Layout
19872 (indicating a dummy definition ending definitions of charstyles, etc).
19873 This entry is required in and is only meaningful for Flex insets.
19874 Among other things, it determines on which menu this inset will appear.
19876 \begin_inset Flex Code
19879 \begin_layout Plain Layout
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19895 will automatically set
19896 \begin_inset Flex Code
19899 \begin_layout Plain Layout
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 can be set to true, or
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19937 \begin_inset Flex Code
19940 \begin_layout Plain Layout
19946 insets by setting it
19951 \begin_inset Flex Code
19954 \begin_layout Plain Layout
19963 \begin_layout Description
19964 \begin_inset Flex Code
19967 \begin_layout Plain Layout
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19986 \begin_inset space \thinspace{}
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19999 ] Whether multiple paragraphs are permitted in this inset.
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20010 to the same value and
20011 \begin_inset Flex Code
20014 \begin_layout Plain Layout
20020 to the opposite value.
20021 These can be reset to other values, if they are used
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20039 \begin_layout Description
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20062 \begin_inset space \thinspace{}
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 ] Whether fragile commands in this inset should be
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20092 whether the command should itself be protected.) Default is false.
20093 \change_inserted -712698321 1523633958
20097 \begin_layout Description
20099 \change_inserted -712698321 1523634088
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20105 \change_inserted -712698321 1523633961
20112 \begin_inset Flex Code
20115 \begin_layout Plain Layout
20117 \change_inserted -712698321 1523633958
20126 \begin_inset space \thinspace{}
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20135 \change_inserted -712698321 1523633958
20141 ] This causes macros that contain this inset to be protected with
20142 \begin_inset Flex Code
20145 \begin_layout Plain Layout
20147 \change_inserted -712698321 1523634038
20162 ) if necessary and thus allows (some) verbatim stuff in macros.
20168 \begin_layout Description
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20188 ] Deletes an existing
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20201 \begin_layout Description
20202 \begin_inset Flex Code
20205 \begin_layout Plain Layout
20212 \begin_inset Flex Code
20215 \begin_layout Plain Layout
20222 \begin_inset Flex Code
20225 \begin_layout Plain Layout
20231 that has replaced this
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20242 This is used to rename an
20243 \begin_inset Flex Code
20246 \begin_layout Plain Layout
20252 , while keeping backward compatibility.
20255 \begin_layout Description
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20278 \begin_inset space \thinspace{}
20282 \begin_inset Flex Code
20285 \begin_layout Plain Layout
20291 ] As with paragraph styles, see
20292 \begin_inset CommandInset ref
20294 reference "subsec:Paragraph-Styles"
20302 \begin_layout Description
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20325 \begin_inset space \thinspace{}
20329 \begin_inset Flex Code
20332 \begin_layout Plain Layout
20338 ] As with paragraph styles, see
20339 \begin_inset CommandInset ref
20341 reference "subsec:Paragraph-Styles"
20349 \begin_layout Description
20350 \begin_inset Flex Code
20353 \begin_layout Plain Layout
20359 As with paragraph styles, see
20360 \begin_inset CommandInset ref
20362 reference "subsec:Paragraph-Styles"
20369 \begin_layout Description
20370 \begin_inset Flex Code
20373 \begin_layout Plain Layout
20380 \begin_inset Flex Code
20383 \begin_layout Plain Layout
20389 ] The prefix to use when creating labels referring to insets of this type.
20390 This allows the use of formatted references.
20393 \begin_layout Description
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20413 ] As with paragraph styles, see
20414 \begin_inset CommandInset ref
20416 reference "subsec:Paragraph-Styles"
20423 \begin_layout Description
20424 \begin_inset Flex Code
20427 \begin_layout Plain Layout
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20446 \begin_inset space \thinspace{}
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20459 ] Resets the \SpecialChar LaTeX
20460 arguments of this layout (as defined via the
20461 \begin_inset Flex Code
20464 \begin_layout Plain Layout
20471 This is useful if you have copied a style via
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20481 , but you do not want to inherit its (required and optional) arguments.
20484 \begin_layout Description
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20495 \begin_inset Flex Code
20498 \begin_layout Plain Layout
20505 \begin_inset space \thinspace{}
20509 \begin_inset Flex Code
20512 \begin_layout Plain Layout
20520 ] Whether this inset should use the font of its surrounding environment
20522 Default is false: use the font of the surrounding environment.
20525 \begin_layout Description
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20545 ] A string that is put at the end of the layout content.
20546 A line break in the output can be indicated by
20547 \begin_inset Flex Code
20550 \begin_layout Plain Layout
20559 \begin_layout Description
20560 \begin_inset Flex Code
20563 \begin_layout Plain Layout
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20580 \begin_inset space \thinspace{}
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20595 ] Allow spell-checking the contents of this inset.
20599 \begin_layout Subsection
20601 \begin_inset CommandInset label
20603 name "subsec:Counters"
20610 \begin_layout Standard
20611 It is necessary to define the counters (
20612 \begin_inset Flex Noun
20615 \begin_layout Plain Layout
20622 \begin_inset Flex Noun
20625 \begin_layout Plain Layout
20631 , \SpecialChar ldots
20632 ) in the text class itself.
20633 The standard counters are defined in the file
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20643 , so you may have to do no more than add
20646 \begin_layout LyX-Code
20647 Input stdcounters.inc
20650 \begin_layout Standard
20651 to your layout file to get them to work.
20652 But if you want to define custom counters, then you can do so.
20653 The counter declaration must begin with:
20656 \begin_layout LyX-Code
20657 Counter CounterName
20660 \begin_layout Standard
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20671 ' is replaced by the name of the counter.
20672 And it must end with
20673 \begin_inset Quotes eld
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20687 \begin_inset Quotes erd
20691 The following parameters can also be used:
20694 \begin_layout Description
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20714 ] Sets the initial value for the counter, to which it will be reset whenever
20716 Normally, one will want the default, 1.
20719 \begin_layout Description
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20740 \begin_inset Quotes erd
20744 \begin_inset Quotes erd
20747 ] When defined, this string defines how the counter is displayed.
20748 Setting this value sets
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20753 LabelStringAppendix
20759 The following special constructs can be used in the string:
20763 \begin_layout Itemize
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20775 will be replaced by the expansion of the
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20790 LabelStringAppendix
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20809 \begin_layout Itemize
20810 counter values can be expressed using \SpecialChar LaTeX
20812 \begin_inset Newline newline
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20851 \begin_layout Plain Layout
20861 Actually, the situation is a bit more complicated: any
20880 other than those described below will produce arabic numerals.
20881 It would not be surprising to see this change in the future.
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20896 : 1, 2, 3,\SpecialChar ldots
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20907 for lower-case letters: a, b, c, \SpecialChar ldots
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20918 for upper-case letters: A, B, C, \SpecialChar ldots
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20929 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20931 \begin_inset Flex Code
20934 \begin_layout Plain Layout
20940 for upper-case roman numerals: I, II, III\SpecialChar ldots
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20951 for hebrew numerals.
20955 \begin_layout Standard
20956 If LabelString is not defined, a default value is constructed as follows:
20957 if the counter has a master counter
20958 \begin_inset Flex Code
20961 \begin_layout Plain Layout
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20978 \begin_inset Newline newline
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20995 is used; otherwise the string
20996 \begin_inset Flex Code
20999 \begin_layout Plain Layout
21010 \begin_layout Description
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21015 LabelStringAppendix
21021 \begin_inset Flex Code
21024 \begin_layout Plain Layout
21031 \begin_inset Quotes erd
21035 \begin_inset Quotes erd
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21048 , but for use in the Appendix.
21051 \begin_layout Description
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21062 \begin_inset Flex Code
21065 \begin_layout Plain Layout
21072 \begin_inset Quotes erd
21076 \begin_inset Quotes erd
21079 ] A format for use with formatted references to this counter.
21080 For example, one might want to have references to section numbers appear
21082 \begin_inset Quotes eld
21086 \begin_inset Quotes erd
21090 The string should contain
21091 \begin_inset Quotes eld
21095 \begin_inset Quotes erd
21099 This will be replaced by the counter number itself.
21100 So, for sections, it would be: Section ##.
21103 \begin_layout Description
21104 \begin_inset Flex Code
21107 \begin_layout Plain Layout
21114 \begin_inset Flex Code
21117 \begin_layout Plain Layout
21124 \begin_inset Quotes erd
21128 \begin_inset Quotes erd
21131 ] If this is set to the name of another counter, the present counter will
21132 be reset every time the other one is increased.
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21144 \begin_inset Flex Code
21147 \begin_layout Plain Layout
21156 \begin_layout Subsection
21158 \begin_inset CommandInset label
21160 name "subsec:Font-description"
21167 \begin_layout Standard
21168 A font description looks like this:
21171 \begin_layout LyX-Code
21188 \begin_layout LyX-Code
21192 \begin_layout LyX-Code
21196 \begin_layout Standard
21197 The following commands are available:
21200 \begin_layout Description
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21211 \begin_inset Flex Code
21214 \begin_layout Plain Layout
21223 \begin_inset Flex Code
21226 \begin_layout Plain Layout
21233 \begin_inset Flex Code
21236 \begin_layout Plain Layout
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21253 \begin_inset Flex Code
21256 \begin_layout Plain Layout
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21273 \begin_inset Flex Code
21276 \begin_layout Plain Layout
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21293 \begin_inset Flex Code
21296 \begin_layout Plain Layout
21303 \begin_inset Flex Code
21306 \begin_layout Plain Layout
21313 \begin_inset Flex Code
21316 \begin_layout Plain Layout
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21333 \begin_inset Flex Code
21336 \begin_layout Plain Layout
21343 \begin_inset Flex Code
21346 \begin_layout Plain Layout
21353 \begin_inset Flex Code
21356 \begin_layout Plain Layout
21363 \begin_inset Flex Code
21366 \begin_layout Plain Layout
21373 \begin_inset Flex Code
21376 \begin_layout Plain Layout
21383 \begin_inset Flex Code
21386 \begin_layout Plain Layout
21393 \begin_inset Flex Code
21396 \begin_layout Plain Layout
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21415 \begin_layout Description
21416 \begin_inset Flex Code
21419 \begin_layout Plain Layout
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21438 \begin_inset Flex Code
21441 \begin_layout Plain Layout
21448 \begin_inset Flex Code
21451 \begin_layout Plain Layout
21460 \begin_layout Description
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21471 \begin_inset Flex Code
21474 \begin_layout Plain Layout
21480 ] Valid arguments are:
21481 \begin_inset Flex Code
21484 \begin_layout Plain Layout
21491 \begin_inset Flex Code
21494 \begin_layout Plain Layout
21501 \begin_inset Flex Code
21504 \begin_layout Plain Layout
21511 \begin_inset Flex Code
21514 \begin_layout Plain Layout
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21531 \begin_inset Flex Code
21534 \begin_layout Plain Layout
21541 \begin_inset Flex Code
21544 \begin_layout Plain Layout
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21561 \begin_inset Flex Code
21564 \begin_layout Plain Layout
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21591 \begin_inset Flex Code
21594 \begin_layout Plain Layout
21601 Each of these turns on or off the corresponding attribute.
21603 \begin_inset Flex Code
21606 \begin_layout Plain Layout
21612 turns on emphasis, and
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21624 \begin_inset Newline newline
21627 If the latter seems puzzling, remember that the font settings for the present
21628 context are generally inherited from the surrounding context.
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21639 would turn off the emphasis that was anyway in effect, say, in a theorem
21643 \begin_layout Description
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21678 \begin_layout Description
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21733 \begin_layout Description
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21764 \begin_inset Flex Code
21767 \begin_layout Plain Layout
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21786 \begin_inset Flex Code
21789 \begin_layout Plain Layout
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21806 \begin_inset Flex Code
21809 \begin_layout Plain Layout
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21828 \begin_layout Subsection
21829 \begin_inset CommandInset label
21831 name "subsec:Citation-engine-description"
21835 Cite engine description
21838 \begin_layout Standard
21840 \begin_inset Flex Code
21843 \begin_layout Plain Layout
21849 blocks, as used mainly in cite engine files (see
21850 \begin_inset CommandInset ref
21852 reference "subsec:Cite-Engine-Files"
21859 ), define the citation commands provided by a specific
21860 \begin_inset Quotes eld
21864 \begin_inset Quotes erd
21868 A cite engine, in \SpecialChar LyX
21869 terms, is way specific way to format citations, using
21870 numbers, author names and/or years.
21871 Currently, \SpecialChar LyX
21872 supports three such engine types, namely:
21875 \begin_layout Enumerate
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21885 : the default Bib\SpecialChar TeX
21886 way to format citations, a simple numeric style (e.
21887 \begin_inset space \thinspace{}
21891 \begin_inset Quotes eld
21895 \begin_inset Quotes erd
21901 \begin_layout Enumerate
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21911 : Harvard-styled citations using author names and publication year (e.
21912 \begin_inset space \thinspace{}
21916 \begin_inset Quotes eld
21919 Smith and Miller (2017b)
21920 \begin_inset Quotes erd
21926 \begin_layout Enumerate
21927 \begin_inset Flex Code
21930 \begin_layout Plain Layout
21936 : extended numerical citations that also allow for author or title next
21938 \begin_inset space \thinspace{}
21942 \begin_inset Quotes eld
21945 Smith and Miller [1]
21946 \begin_inset Quotes erd
21952 \begin_layout Standard
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21962 blocks look like this:
21965 \begin_layout LyX-Code
21969 \begin_layout LyX-Code
21973 \begin_layout LyX-Code
21977 \begin_layout LyX-Code
21978 citeyearpar[][]=parencite*
21981 \begin_layout LyX-Code
21985 \begin_layout LyX-Code
21989 \begin_layout Standard
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
22000 denotes the engine.
22001 The individual lines respectively define a cite command or cite command
22002 paradigm supported by this engine.
22003 The line can be as simple as a cite command that is used both to name the
22004 respective \SpecialChar LyX
22005 command and the \SpecialChar LaTeX
22006 output or more complex in order to differentiate
22008 The full syntax is:
22011 \begin_layout LyX-Code
22012 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22015 \begin_layout Itemize
22016 \begin_inset Flex Code
22019 \begin_layout Plain Layout
22025 : The name as used in the
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22039 \begin_layout Standard
22040 For portability reasons, we try to use the same name for same-formatted
22041 commands in different cite packages (thus many names stem from natbib,
22042 and thus we need to differentiate a
22043 \begin_inset Flex Code
22046 \begin_layout Plain Layout
22052 sometimes, if the \SpecialChar LaTeX
22053 command names differ).
22057 \begin_layout Itemize
22058 \begin_inset Flex Code
22061 \begin_layout Plain Layout
22067 : a (comma-separated) list of commands that fall back to the given
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22077 in the current engine.
22078 This eases the switch of citation packages and engines.
22080 \begin_inset Flex Code
22083 \begin_layout Plain Layout
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22099 in layout definitions.
22102 \begin_layout Itemize
22103 \begin_inset Flex Code
22106 \begin_layout Plain Layout
22112 : The actual \SpecialChar LaTeX
22113 command that is output.
22117 \begin_layout Standard
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22149 \begin_inset Flex Code
22152 \begin_layout Plain Layout
22158 will be output to \SpecialChar LaTeX
22162 \begin_layout Standard
22166 \begin_layout Itemize
22167 Capitalization indicates that the command also has a capitalized form (
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22181 \begin_inset Flex Code
22184 \begin_layout Plain Layout
22193 These usually enforce up-casing of name prefixes (
22198 \begin_inset Formula $\Rightarrow$
22208 \begin_layout Itemize
22210 \begin_inset Flex Code
22213 \begin_layout Plain Layout
22219 indicate the number of optional arguments (there can be 0–2).
22222 \begin_layout Itemize
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22233 indicates there is a starred version of the command (
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22247 \begin_inset Flex Code
22250 \begin_layout Plain Layout
22263 \begin_layout Standard
22264 By default, the starred version means: Output all authors even if it should
22266 \begin_inset Quotes eld
22270 \begin_inset Quotes erd
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22286 \begin_layout Standard
22287 If the star has a different meaning for a given command, it can be specified
22289 \begin_inset Flex Code
22292 \begin_layout Plain Layout
22293 <!_stardesc!_stardesctooltip>
22299 Maximal two translatable macro keywords, marked by the prefix
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22310 The first points to the string that replaces the
22311 \begin_inset Quotes eld
22315 \begin_inset Quotes erd
22318 checkbox label in the citation dialog, the second one to an optional tool
22319 tip for this checkbox.
22323 \begin_layout Standard
22324 Note that these two macros have to be defined in a
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22334 (see next section), dropping the
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22344 from the prefix, like this:
22347 \begin_layout LyX-Code
22348 _stardesc Sta&rred command label
22351 \begin_layout LyX-Code
22352 _stardesctooltip Tooltip for the starred command checkbox.
22356 \begin_layout Itemize
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22367 indicates that this command features
22368 \begin_inset Quotes eld
22371 qualified citation lists
22372 \begin_inset Quotes erd
22380 -specific feature for multi-reference citations where an individual pre-
22381 and postnote can be given to each reference in the list.
22382 Please refer to the
22386 manual for details.
22387 \change_inserted -712698321 1526898670
22391 \begin_layout Standard
22393 \change_inserted -712698321 1526899524
22394 If you want to add a cite command to a cite engine (e.
22395 \begin_inset space \thinspace{}
22398 g., add a specific command provided by a class), you can use
22399 \begin_inset Flex Code
22402 \begin_layout Plain Layout
22404 \change_inserted -712698321 1526898768
22405 AddToCiteEngine <engine type> \SpecialChar ldots
22414 Note that only cite commands that do not exist yet are added.
22419 \begin_layout Subsection
22420 \begin_inset CommandInset label
22422 name "subsec:Citation-format-description"
22426 Cite format description
22429 \begin_layout Standard
22431 \begin_inset Flex Code
22434 \begin_layout Plain Layout
22440 blocks are used to describe how bibliographic information should be displayed,
22441 both within \SpecialChar LyX
22442 itself (in the citation dialog and in tooltips, for example)
22443 and in XHTML output.
22444 Such a block might look like this:
22447 \begin_layout LyX-Code
22451 \begin_layout LyX-Code
22455 \begin_layout LyX-Code
22459 \begin_layout LyX-Code
22463 \begin_layout Standard
22467 \begin_layout LyX-Code
22471 \begin_layout LyX-Code
22475 \begin_layout LyX-Code
22479 \begin_layout LyX-Code
22483 \begin_layout Standard
22484 In the first case, the individual lines define how the bibliographic information
22485 associated with an article or book, respectively, is to be displayed, and
22486 such a definition can be given for any
22487 \begin_inset Quotes els
22491 \begin_inset Quotes ers
22494 that might be present in a Bib\SpecialChar TeX
22497 defines a default format in the source code that will be used if no specific
22498 definition has been given.
22500 predefines several formats in the file
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22510 , which is included in most of \SpecialChar LyX
22511 's document classes.
22514 \begin_layout Standard
22515 In the second case, the lines define how a specific citation command (in
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22540 ) is to be displayed on the citation inset label, in the citation dialog,
22541 menu or XHTML output.
22543 defines such formats for the citation style variants it supports via
22545 Document\SpecialChar menuseparator
22546 Setting\SpecialChar menuseparator
22547 Bibliography\SpecialChar ldots
22551 \begin_inset Flex Code
22554 \begin_layout Plain Layout
22560 files that are shipped with \SpecialChar LyX
22562 \begin_inset CommandInset ref
22564 reference "subsec:Cite-Engine-Files"
22574 \begin_layout Standard
22575 The definitions use a simple language that allows Bib\SpecialChar TeX
22576 keys to be replaced
22578 Keys should be enclosed in
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22599 So a simple definition might look like this:
22602 \begin_layout LyX-Code
22604 \begin_inset Quotes eld
22608 \begin_inset Quotes erd
22614 \begin_layout Standard
22615 This would print the author, followed by a comma, followed by the title,
22616 in quotes, followed by a period.
22619 \begin_layout Standard
22620 Of course, sometimes you may want to print a key only if it exists.
22621 This can be done by using a conditional construction, such as:
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22627 \begin_inset space ~
22637 \begin_inset Flex Code
22640 \begin_layout Plain Layout
22646 key exists, then print
22647 \begin_inset Quotes eld
22651 \begin_inset space ~
22655 \begin_inset Quotes erd
22658 followed by the volume key.
22659 It is also possible to have an else clause in the conditional, such as:
22660 \begin_inset Newline newline
22664 \begin_inset Flex Code
22667 \begin_layout Plain Layout
22668 {%author%[[%author%]][[%editor%, ed.]]}
22674 \begin_inset Newline newline
22678 \begin_inset Flex Code
22681 \begin_layout Plain Layout
22687 key is printed if it exists; otherwise, the editor key is printed, followed
22689 \begin_inset Quotes eld
22693 \begin_inset space ~
22697 \begin_inset Quotes erd
22700 Note that the key is again enclosed in
22701 \begin_inset Flex Code
22704 \begin_layout Plain Layout
22710 signs; the entire conditional is enclosed in braces; and the if and else
22711 clauses are enclosed in double brackets,
22712 \begin_inset Quotes eld
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22726 \begin_inset Quotes eld
22730 \begin_inset Quotes eld
22734 \begin_inset Flex Code
22737 \begin_layout Plain Layout
22744 \begin_inset Quotes erd
22748 There must be no space between any of these.
22751 \begin_layout Standard
22752 Next to the entry keys, there are some special keys that can be used for
22753 these conditionals:
22756 \begin_layout Itemize
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22761 {%dialog%[[true]][[false]]}
22767 \begin_inset Quotes eld
22771 \begin_inset Quotes erd
22774 part for dialogs and menus, the
22775 \begin_inset Quotes eld
22779 \begin_inset Quotes erd
22782 part for other contexts (workarea, export)
22785 \begin_layout Itemize
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22790 {%export%[[true]][[false]]}
22796 \begin_inset Quotes eld
22800 \begin_inset Quotes erd
22803 part for export and menus, the
22804 \begin_inset Quotes eld
22808 \begin_inset Quotes erd
22811 part for other contexts (workarea, dialog)
22814 \begin_layout Itemize
22815 \begin_inset Flex Code
22818 \begin_layout Plain Layout
22825 \begin_inset Quotes eld
22829 \begin_inset Quotes erd
22832 part if another item follows (e.
22833 \begin_inset space \thinspace{}
22836 g., in a citation with multiple keys)
22839 \begin_layout Itemize
22840 \begin_inset Flex Code
22843 \begin_layout Plain Layout
22844 {%second%[[true]][[false]]}
22850 \begin_inset Quotes eld
22854 \begin_inset Quotes erd
22857 if this is the second of multiple items, else the
22858 \begin_inset Quotes eld
22862 \begin_inset Quotes erd
22868 \begin_layout Itemize
22869 \begin_inset Flex Code
22872 \begin_layout Plain Layout
22873 {%ifstar%[[true]][[false]]}
22879 \begin_inset Quotes eld
22883 \begin_inset Quotes erd
22886 part for starred citation commands (such as
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22898 ), the false part for unstarred
22901 \begin_layout Itemize
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22906 {%ifentrytype:<type>%[[true]][[false]]}
22912 \begin_inset Quotes eld
22916 \begin_inset Quotes erd
22919 if the current entry type matches
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22929 , else the false part (e.g., in a citation definition:
22930 \begin_inset Flex Code
22933 \begin_layout Plain Layout
22934 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22942 \begin_layout Itemize
22943 \begin_inset Flex Code
22946 \begin_layout Plain Layout
22947 {%ifmultiple:<authortype>%[[true]][[false]]}
22953 \begin_inset Quotes eld
22957 \begin_inset Quotes erd
22960 if the current author type (author, editor etc.) has multiple authors, else
22961 the false part (e.g., in a bibliography definition:
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22966 {%ifmultiple:editor%[[eds.]][[ed.]]}
22974 \begin_layout Itemize
22975 \begin_inset Flex Code
22978 \begin_layout Plain Layout
22979 {%ifqualified%[[true]][[false]]}
22985 \begin_inset Quotes eld
22989 \begin_inset Quotes erd
22992 part if the current citation is a qualified citation list (a specific
22996 format for multi-reference citations), the false part if this is not the
23000 \begin_layout Standard
23002 \begin_inset Flex Code
23005 \begin_layout Plain Layout
23011 prints the author key as it is recorded in the bibliography file.
23012 This might not be what you want, since it will result in a string such
23014 \begin_inset Quotes eld
23017 Miller, Peter and Smith, Mary and White, Jane
23018 \begin_inset Quotes erd
23022 \begin_inset Quotes eld
23026 \begin_inset Quotes erd
23029 is used by Bib\SpecialChar TeX
23030 to delimit authors).
23032 therefore provides some methods to get properly formatted name lists (which
23033 will also get translated).
23034 The following keys are provided:
23037 \begin_layout Enumerate
23038 For name lists with pre- and surname, suitable for the main authors/editors
23039 of a bibliography item.
23041 \begin_inset Flex Code
23044 \begin_layout Plain Layout
23050 part denotes the kind of list that is requested (e.g.
23052 \begin_inset Flex Code
23055 \begin_layout Plain Layout
23065 \begin_layout Itemize
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23070 %abbrvnames:<nametype>%
23075 : Provides a name list which is abbreviated (with
23076 \begin_inset Quotes eld
23080 \begin_inset Quotes erd
23084 \begin_inset Flex Code
23087 \begin_layout Plain Layout
23096 \begin_layout Itemize
23097 \begin_inset Flex Code
23100 \begin_layout Plain Layout
23101 %fullnames:<nametype>%
23106 : Provides a full name list (never abbreviated with
23107 \begin_inset Quotes eld
23111 \begin_inset Quotes erd
23117 \begin_layout Itemize
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23122 %forceabbrvnames:<nametype>%
23127 : Provides a name list which is always abbreviated (with
23128 \begin_inset Quotes eld
23132 \begin_inset Quotes erd
23136 \begin_inset Flex Code
23139 \begin_layout Plain Layout
23149 \begin_layout Enumerate
23150 Alternative name lists with pre- and surname, if the order of pre- and surname
23151 inside the bibliography item differs (as in:
23152 \begin_inset Quotes eld
23155 Miller, John: Some text, in: Mary Smith, ed.: A volume
23156 \begin_inset Quotes erd
23163 \begin_layout Itemize
23164 \begin_inset Flex Code
23167 \begin_layout Plain Layout
23168 %abbrvbynames:<nametype>%
23173 : Provides a name list which is abbreviated (with
23174 \begin_inset Quotes eld
23178 \begin_inset Quotes erd
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23194 \begin_layout Itemize
23195 \begin_inset Flex Code
23198 \begin_layout Plain Layout
23199 %fullbynames:<nametype>%
23204 : Provides a full name list (never abbreviated with
23205 \begin_inset Quotes eld
23209 \begin_inset Quotes erd
23215 \begin_layout Itemize
23216 \begin_inset Flex Code
23219 \begin_layout Plain Layout
23220 %forceabbrvbynames:<nametype>%
23225 : Provides a name list which is always abbreviated (with
23226 \begin_inset Quotes eld
23230 \begin_inset Quotes erd
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23247 \begin_layout Enumerate
23248 And finally name lists which consist of family names only, as used in author-yea
23250 These do not take a
23251 \begin_inset Flex Code
23254 \begin_layout Plain Layout
23260 part, but always return either an author list or, if this does not exist,
23261 an editor list (as common in author-year labels):
23265 \begin_layout Itemize
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23275 : Provides a name list which is abbreviated (with
23276 \begin_inset Quotes eld
23280 \begin_inset Quotes erd
23284 \begin_inset Flex Code
23287 \begin_layout Plain Layout
23296 \begin_layout Itemize
23297 \begin_inset Flex Code
23300 \begin_layout Plain Layout
23306 : Provides a full name list (never abbreviated with
23307 \begin_inset Quotes eld
23311 \begin_inset Quotes erd
23317 \begin_layout Itemize
23318 \begin_inset Flex Code
23321 \begin_layout Plain Layout
23322 %forceabbrvciteauthor%
23327 : Provides a name list which is always abbreviated (with
23328 \begin_inset Quotes eld
23332 \begin_inset Quotes erd
23336 \begin_inset Flex Code
23339 \begin_layout Plain Layout
23349 \begin_layout Standard
23350 The order of pre- and surname in the former two lists can be adjusted by
23354 \begin_layout Itemize
23355 \begin_inset Flex Code
23358 \begin_layout Plain Layout
23359 !firstnameform %surname%, %prename%
23364 (first author in lists of type 1)
23367 \begin_layout Itemize
23368 \begin_inset Flex Code
23371 \begin_layout Plain Layout
23372 !othernameform %surname%, %prename%
23377 (other authors in lists of type 1)
23380 \begin_layout Itemize
23381 \begin_inset Flex Code
23384 \begin_layout Plain Layout
23385 !firstbynameform %prename% %surname%
23390 (first author in lists of type 2)
23393 \begin_layout Itemize
23394 \begin_inset Flex Code
23397 \begin_layout Plain Layout
23398 !otherbynameform %prename% %surname%
23403 (other authors in lists of type 2)
23406 \begin_layout Standard
23407 This allows you to configure namings like
23408 \begin_inset Quotes eld
23411 Miller, Peter and Mary Smith: \SpecialChar ldots
23412 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23414 \begin_inset Quotes erd
23420 \begin_layout Standard
23421 There is one other piece of syntax available in definitions, which looks
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23433 This defines a piece of formatting information that is to be used when
23435 \begin_inset Quotes eld
23439 \begin_inset Quotes erd
23443 Obviously, we do not want to output HTML tags when writing plain text,
23444 so they should be wrapped in
23445 \begin_inset Quotes eld
23449 \begin_inset Quotes erd
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23463 \begin_layout Standard
23464 Two special sorts of definitions are also possible in a
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23475 An example of the first would be:
23478 \begin_layout LyX-Code
23480 \begin_inset Quotes eld
23484 \begin_inset Quotes erd
23490 \begin_layout Standard
23491 This is an abbreviation, or macro, and it can be used by treating it as
23493 \begin_inset Flex Code
23496 \begin_layout Plain Layout
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23514 exactly as it would treat its definition.
23515 So, let us issue the obvious
23523 \begin_layout LyX-Code
23527 \begin_layout Standard
23528 or anything like it.
23530 shouldn't go into an infinite loop, but it may go into a long one before
23534 \begin_layout Standard
23535 The second sort of special definition might look like this:
23538 \begin_layout LyX-Code
23542 \begin_layout Standard
23543 This defines a translatable piece of text, which allows relevant parts of
23544 the bibliography or citation to be translated.
23545 It can be included in a definition by treating it as a key:
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23556 Note that there are two different translation paths: All definitions starting
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23567 , such as in the example above, will be translated to the currently active
23568 buffer language (so the translation will match the generated document).
23569 All definitions starting with underscore only will be translated to the
23571 This is the proper translation for strings that only occur in the dialogs
23572 or on buttons, such as this one:
23575 \begin_layout LyX-Code
23576 _addtobib Add to bibliography only.
23579 \begin_layout Standard
23580 Several of these translatable strings are predefined in
23581 \begin_inset Flex Code
23584 \begin_layout Plain Layout
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23601 Note that these are not macros, in the sense just defined.
23602 They will not be expanded.
23605 \begin_layout Standard
23606 So here then is an example that uses several of these features:
23607 \begin_inset VSpace defskip
23613 \begin_layout Standard
23617 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23620 \begin_layout Standard
23621 \begin_inset VSpace defskip
23624 This defines a macro that prints the author, followed by a comma, if the
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23635 key is defined, or else prints the name of the editor, followed by the
23637 \begin_inset Flex Code
23640 \begin_layout Plain Layout
23646 or its translation (it is by default
23647 \begin_inset Quotes eld
23651 \begin_inset Quotes erd
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23665 Note that this is in fact defined in
23666 \begin_inset Flex Code
23669 \begin_layout Plain Layout
23675 , so you can use it in your own definitions, or re-definitions, if you load
23679 \begin_layout Section
23680 \begin_inset CommandInset label
23682 name "sec:Tags-for-XHTML"
23686 Tags for XHTML output
23689 \begin_layout Standard
23690 As with \SpecialChar LaTeX
23691 or DocBook, the format of \SpecialChar LyX
23692 's XHTML output is also controlled by
23693 layout information.
23694 In general, \SpecialChar LyX
23695 provides sensible defaults and, as mentioned earlier, it will
23696 even construct default CSS style rules from the other layout tags.
23697 For example, \SpecialChar LyX
23698 will attempt to use the information provided in the
23699 \begin_inset Flex Code
23702 \begin_layout Plain Layout
23708 declaration for the Chapter style to write CSS that will appropriately
23709 format chapter headings.
23712 \begin_layout Standard
23713 In many cases, then, you may not have to do anything at all to get acceptable
23714 XHTML output for your own environments, custom insets, and so forth.
23715 But in some cases you will, and so \SpecialChar LyX
23716 provides a number of layout tags that
23717 can be used to customize the XHTML and CSS that are generated.
23720 \begin_layout Standard
23721 Note that there are two tags,
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23732 \begin_inset Flex Code
23735 \begin_layout Plain Layout
23741 that may appear outside style and inset declarations.
23743 \begin_inset CommandInset ref
23745 reference "subsec:General-text-class"
23749 for details on these.
23752 \begin_layout Subsection
23753 \begin_inset CommandInset label
23755 name "subsec:Paragraph-Style-XHTML"
23762 \begin_layout Standard
23763 The sort of XHTML \SpecialChar LyX
23764 outputs for a paragraph depends upon whether we are dealing
23765 with a normal paragraph, a command, or an environment, where this is itself
23766 determined by the contents of the corresponding
23767 \begin_inset Flex Code
23770 \begin_layout Plain Layout
23781 \begin_layout Standard
23782 For a command or normal paragraph, the output XHTML has the following form:
23785 \begin_layout LyX-Code
23789 \begin_inset Quotes erd
23793 \begin_inset Quotes erd
23799 \begin_layout LyX-Code
23803 \begin_inset Quotes erd
23807 \begin_inset Quotes erd
23813 \begin_layout LyX-Code
23816 Contents of the paragraph.
23819 \begin_layout LyX-Code
23825 \begin_layout Standard
23826 The label tags are of course omitted if the paragraph does not have a label.
23829 \begin_layout Standard
23830 For an environment that is not some sort of list, the XHTML takes this form:
23833 \begin_layout LyX-Code
23837 \begin_inset Quotes erd
23841 \begin_inset Quotes erd
23847 \begin_layout LyX-Code
23851 \begin_inset Quotes erd
23855 \begin_inset Quotes erd
23859 \begin_inset Quotes erd
23863 \begin_inset Quotes erd
23866 >Environment Label</labeltag>First paragraph.</itemtag>
23869 \begin_layout LyX-Code
23872 <itemtag>Second paragraph.</itemtag>
23875 \begin_layout LyX-Code
23881 \begin_layout Standard
23882 Note that the label is output only for the first paragraph, as it should
23883 be for a theorem, for example.
23887 \begin_layout Standard
23888 For a list, we have one of these forms:
23891 \begin_layout LyX-Code
23895 \begin_inset Quotes erd
23899 \begin_inset Quotes erd
23905 \begin_layout LyX-Code
23909 \begin_inset Quotes erd
23913 \begin_inset Quotes erd
23917 \begin_inset Quotes erd
23921 \begin_inset Quotes erd
23924 >List Label</labeltag>First item.</itemtag>
23927 \begin_layout LyX-Code
23931 \begin_inset Quotes erd
23935 \begin_inset Quotes erd
23939 \begin_inset Quotes erd
23943 \begin_inset Quotes erd
23946 >List Label</labeltag>Second item.</itemtag>
23949 \begin_layout LyX-Code
23955 \begin_layout LyX-Code
23959 \begin_layout LyX-Code
23963 \begin_inset Quotes erd
23967 \begin_inset Quotes erd
23973 \begin_layout LyX-Code
23977 \begin_inset Quotes erd
23981 \begin_inset Quotes erd
23984 >List Label</labeltag><itemtag attr=
23985 \begin_inset Quotes erd
23989 \begin_inset Quotes erd
23992 >First item.</itemtag>
23995 \begin_layout LyX-Code
23999 \begin_inset Quotes erd
24003 \begin_inset Quotes erd
24006 >List Label</labeltag><itemtag attr=
24007 \begin_inset Quotes erd
24011 \begin_inset Quotes erd
24014 >Second item.</itemtag>
24017 \begin_layout LyX-Code
24023 \begin_layout Standard
24024 Note the different orders of
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24035 \begin_inset Flex Code
24038 \begin_layout Plain Layout
24045 Which order we get depends upon the setting of
24046 \begin_inset Flex Code
24049 \begin_layout Plain Layout
24056 \begin_inset Flex Code
24059 \begin_layout Plain Layout
24065 is false (the default), you get the first of these, with the label within
24066 the item; if true, you get the second, with the label outside the item.
24069 \begin_layout Standard
24070 The specific tags and attributes output for each paragraph type can be controlle
24071 d by means of the layout tags we are about to describe.
24072 As mentioned earlier, however, \SpecialChar LyX
24073 uses sensible defaults for many of these,
24074 so you often may not need to do very much to get good XHTML output.
24075 Think of the available tags as there so you can tweak things to your liking.
24078 \begin_layout Description
24079 \begin_inset Flex Code
24082 \begin_layout Plain Layout
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24098 ] Specifies attribute information to be output with the main tag.
24100 \begin_inset Quotes eld
24104 \begin_inset Flex Code
24107 \begin_layout Plain Layout
24114 \begin_inset Quotes erd
24118 By default, \SpecialChar LyX
24120 \begin_inset Quotes eld
24124 \begin_inset Flex Code
24127 \begin_layout Plain Layout
24134 \begin_inset Quotes erd
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24147 is the \SpecialChar LyX
24148 name of the layout, made lowercase, for example: chapter.
24153 contain any style information.
24155 \begin_inset Flex Code
24158 \begin_layout Plain Layout
24167 \begin_layout Description
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24191 ] Whether to output the default CSS information \SpecialChar LyX
24192 generates for this layout,
24193 even if additional information is explicitly provided via
24194 \begin_inset Flex Code
24197 \begin_layout Plain Layout
24205 \begin_inset Flex Code
24208 \begin_layout Plain Layout
24214 allows you to alter or augment the generated CSS, rather than to override
24217 \begin_inset Flex Code
24220 \begin_layout Plain Layout
24229 \begin_layout Description
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24249 ] The tag to be used for individual paragraphs of environments, replacing
24251 \begin_inset Flex Code
24254 \begin_layout Plain Layout
24260 in the examples above.
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24274 \begin_layout Description
24275 \begin_inset Flex Code
24278 \begin_layout Plain Layout
24285 \begin_inset Flex Code
24288 \begin_layout Plain Layout
24294 ] Attributes for the item tag.
24296 \begin_inset Newline newline
24300 \begin_inset Quotes eld
24304 \begin_inset Flex Code
24307 \begin_layout Plain Layout
24308 class=`layoutname_item'
24314 \begin_inset Quotes erd
24322 contain any style information.
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24336 \begin_layout Description
24337 \begin_inset Flex Code
24340 \begin_layout Plain Layout
24347 \begin_inset Flex Code
24350 \begin_layout Plain Layout
24356 ] The tag to be used for paragraph and item labels, replacing
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24366 in the examples above.
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24378 \begin_inset Flex Code
24381 \begin_layout Plain Layout
24388 \begin_inset Flex Code
24391 \begin_layout Plain Layout
24398 \begin_inset Flex Code
24401 \begin_layout Plain Layout
24402 Centered_Top_Environment
24407 , in which case it defaults to
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24420 \begin_layout Description
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24440 ] Attributes for the label tag.
24442 \begin_inset Newline newline
24446 \begin_inset Quotes eld
24450 \begin_inset Flex Code
24453 \begin_layout Plain Layout
24454 class=`layoutname_label'
24460 \begin_inset Quotes erd
24468 contain any style information.
24470 \begin_inset Flex Code
24473 \begin_layout Plain Layout
24482 \begin_layout Description
24483 \begin_inset Flex Code
24486 \begin_layout Plain Layout
24493 \begin_inset Flex Code
24496 \begin_layout Plain Layout
24506 ] Meaningful only for list-like environments, this tag controls whether
24507 the label tag is output before or inside the item tag.
24508 This is used, for example, in the description environment, where we want
24510 \begin_inset Flex Code
24513 \begin_layout Plain Layout
24514 <dt>\SpecialChar ldots
24515 </dt><dd>\SpecialChar ldots
24523 \begin_inset Flex Code
24526 \begin_layout Plain Layout
24532 : The label tag is output inside the item tag.
24535 \begin_layout Description
24536 \begin_inset Flex Code
24539 \begin_layout Plain Layout
24545 Information to be output in the
24546 \begin_inset Flex Code
24549 \begin_layout Plain Layout
24555 section when this style is used.
24556 This might, for example, be used to include a
24557 \begin_inset Flex Code
24560 \begin_layout Plain Layout
24567 \begin_inset Flex Code
24570 \begin_layout Plain Layout
24579 \begin_layout Description
24580 \begin_inset Flex Code
24583 \begin_layout Plain Layout
24589 CSS style information to be included when this style is used.
24590 Note that this will automatically be wrapped in a layout-generated
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24600 block, so only the CSS itself need be included.
24602 \begin_inset Flex Code
24605 \begin_layout Plain Layout
24614 \begin_layout Description
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24634 ] The tag to be used for the main label, replacing
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24644 in the examples above.
24646 \begin_inset Flex Code
24649 \begin_layout Plain Layout
24658 \begin_layout Description
24659 \begin_inset Flex Code
24662 \begin_layout Plain Layout
24669 \begin_inset Flex Code
24672 \begin_layout Plain Layout
24682 ] Marks this style as the one to be used to generate the
24683 \begin_inset Flex Code
24686 \begin_layout Plain Layout
24692 tag for the XHTML file.
24693 By default, it is false.
24695 \begin_inset Flex Code
24698 \begin_layout Plain Layout
24704 file sets it to true for the
24705 \begin_inset Flex Code
24708 \begin_layout Plain Layout
24718 \begin_layout Subsection
24722 \begin_layout Standard
24723 The XHTML output of insets can also be controlled by information in layout
24728 \begin_layout Plain Layout
24729 At present, this is true only for
24730 \begin_inset Quotes eld
24734 \begin_inset Quotes erd
24737 insets (insets you can type into) and is not true for
24738 \begin_inset Quotes eld
24742 \begin_inset Quotes erd
24745 insets (insets that are associated with dialog boxes).
24750 Here, too, \SpecialChar LyX
24751 tries to provide sensible defaults, and it constructs default
24753 But everything can be customized.
24756 \begin_layout Standard
24757 The XHTML \SpecialChar LyX
24758 outputs for an inset has the following form:
24761 \begin_layout LyX-Code
24763 \begin_inset Quotes erd
24767 \begin_inset Quotes erd
24773 \begin_layout LyX-Code
24774 <labeltag>Label</labeltag>
24777 \begin_layout LyX-Code
24779 \begin_inset Quotes erd
24783 \begin_inset Quotes erd
24786 >Contents of the inset.</innertag>
24789 \begin_layout LyX-Code
24793 \begin_layout Standard
24794 If the inset permits multiple paragraphs—that is, if
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24804 is true—then the contents of the inset will itself be output as paragraphs
24805 formatted according to the styles used for those paragraphs (standard,
24806 quote, and the like).
24807 The label tag is of course omitted if the paragraph does not have a label
24808 and, at present, is always
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24819 The inner tag is optional and, by default, does not appear.
24822 \begin_layout Standard
24823 The specific tags and attributes output for each inset can be controlled
24824 by means of the following layout tags.
24827 \begin_layout Description
24828 \begin_inset Flex Code
24831 \begin_layout Plain Layout
24838 \begin_inset Flex Code
24841 \begin_layout Plain Layout
24847 ] Specifies attribute information to be output with the main tag.
24849 \begin_inset Quotes eld
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24857 class=`myinset' onclick=`\SpecialChar ldots
24864 \begin_inset Quotes erd
24868 By default, \SpecialChar LyX
24870 \begin_inset Quotes eld
24874 \begin_inset Flex Code
24877 \begin_layout Plain Layout
24884 \begin_inset Quotes erd
24888 \begin_inset Flex Code
24891 \begin_layout Plain Layout
24897 is the \SpecialChar LyX
24898 name of the inset, made lowercase and with non-alphanumeric characters
24899 converted to underscores, for example: footnote.
24902 \begin_layout Description
24903 \begin_inset Flex Code
24906 \begin_layout Plain Layout
24913 \begin_inset Flex Code
24916 \begin_layout Plain Layout
24926 ] Whether to output the default CSS information \SpecialChar LyX
24927 generates for this layout,
24928 even if additional information is explicitly provided via
24929 \begin_inset Flex Code
24932 \begin_layout Plain Layout
24940 \begin_inset Flex Code
24943 \begin_layout Plain Layout
24949 allows you to alter or augment the generated CSS, rather than to override
24954 \begin_layout Description
24955 \begin_inset Flex Code
24958 \begin_layout Plain Layout
24965 \begin_inset Flex Code
24968 \begin_layout Plain Layout
24974 ] Attributes for the inner tag.
24976 \begin_inset Newline newline
24980 \begin_inset Quotes eld
24984 \begin_inset Flex Code
24987 \begin_layout Plain Layout
24988 class=`insetname_inner'
24994 \begin_inset Quotes erd
25000 \begin_layout Description
25001 \begin_inset Flex Code
25004 \begin_layout Plain Layout
25011 \begin_inset Flex Code
25014 \begin_layout Plain Layout
25020 ] The inner tag, replacing
25021 \begin_inset Flex Code
25024 \begin_layout Plain Layout
25030 in the examples above.
25031 By default, there is none.
25034 \begin_layout Description
25035 \begin_inset Flex Code
25038 \begin_layout Plain Layout
25045 \begin_inset Flex Code
25048 \begin_layout Plain Layout
25056 ] Whether this inset represents a standalone block of text (such as a footnote)
25057 or instead represents material that is included in the surrounding text
25058 (such as a branch).
25062 \begin_layout Description
25063 \begin_inset Flex Code
25066 \begin_layout Plain Layout
25073 \begin_inset Flex Code
25076 \begin_layout Plain Layout
25082 ] A label for this inset, possibly including a reference to a counter.
25083 For example, for footnote, it might be:
25084 \begin_inset Flex Code
25087 \begin_layout Plain Layout
25096 This is optional, and there is no default.
25099 \begin_layout Description
25100 \begin_inset Flex Code
25103 \begin_layout Plain Layout
25109 Information to be output in the
25110 \begin_inset Flex Code
25113 \begin_layout Plain Layout
25119 section when this style is used.
25120 This might, for example, be used to include a
25121 \begin_inset Flex Code
25124 \begin_layout Plain Layout
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25143 \begin_layout Description
25144 \begin_inset Flex Code
25147 \begin_layout Plain Layout
25153 CSS style information to be included when this style is used.
25154 Note that this will automatically be wrapped in a layout-generated
25155 \begin_inset Flex Code
25158 \begin_layout Plain Layout
25164 block, so only the CSS itself need be included.
25167 \begin_layout Description
25168 \begin_inset Flex Code
25171 \begin_layout Plain Layout
25178 \begin_inset Flex Code
25181 \begin_layout Plain Layout
25187 ] The tag to be used for the main label, replacing
25188 \begin_inset Flex Code
25191 \begin_layout Plain Layout
25197 in the examples above.
25198 The default depends upon the setting of
25199 \begin_inset Flex Code
25202 \begin_layout Plain Layout
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25218 is true, the default is
25219 \begin_inset Flex Code
25222 \begin_layout Plain Layout
25228 ; if it is false, the default is
25229 \begin_inset Flex Code
25232 \begin_layout Plain Layout
25241 \begin_layout Subsection
25245 \begin_layout Standard
25246 The XHTML output for floats too can be controlled by layout information.
25247 The output has the following form:
25250 \begin_layout LyX-Code
25252 \begin_inset Quotes erd
25256 \begin_inset Quotes erd
25262 \begin_layout LyX-Code
25263 Contents of the float.
25266 \begin_layout LyX-Code
25270 \begin_layout Standard
25271 The caption, if there is one, is a separate inset and will be output as
25273 Its appearance can be controlled via the InsetLayout for caption insets.
25277 \begin_layout Description
25278 \begin_inset Flex Code
25281 \begin_layout Plain Layout
25288 \begin_inset Flex Code
25291 \begin_layout Plain Layout
25297 ] Specifies attribute information to be output with the main tag.
25299 \begin_inset Quotes eld
25303 \begin_inset Flex Code
25306 \begin_layout Plain Layout
25307 class=`myfloat' onclick=`\SpecialChar ldots
25314 \begin_inset Quotes erd
25318 By default, \SpecialChar LyX
25320 \begin_inset Quotes eld
25324 \begin_inset Flex Code
25327 \begin_layout Plain Layout
25328 class=`float float-floattype'
25334 \begin_inset Quotes erd
25338 \begin_inset Flex Code
25341 \begin_layout Plain Layout
25347 is \SpecialChar LyX
25348 's name for this type of float, as determined by the float declaration
25350 \begin_inset CommandInset ref
25352 reference "subsec:Floats"
25356 ), though made lowercase and with non-alphanumeric characters converted
25357 to underscores, for example: float-table.
25360 \begin_layout Description
25361 \begin_inset Flex Code
25364 \begin_layout Plain Layout
25370 CSS style information to be included when this float is used.
25371 Note that this will automatically be wrapped in a layout-generated
25372 \begin_inset Flex Code
25375 \begin_layout Plain Layout
25381 block, so only the CSS itself need be included.
25384 \begin_layout Description
25385 \begin_inset Flex Code
25388 \begin_layout Plain Layout
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25404 ] The tag to be used for this float, replacing
25405 \begin_inset Quotes eld
25409 \begin_inset Flex Code
25412 \begin_layout Plain Layout
25419 \begin_inset Quotes erd
25422 in the example above.
25424 \begin_inset Flex Code
25427 \begin_layout Plain Layout
25433 and will rarely need changing.
25436 \begin_layout Subsection
25437 Bibliography formatting
25440 \begin_layout Standard
25441 The bibliography can be formatted using
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25453 \begin_inset CommandInset ref
25455 reference "subsec:Citation-format-description"
25462 \begin_layout Subsection
25467 \begin_layout Standard
25468 We have several times mentioned that \SpecialChar LyX
25469 will generate default CSS style rules
25470 for both insets and paragraph styles, based upon the other layout information
25472 In this section, we shall say a word about which layout information \SpecialChar LyX
25477 \begin_layout Standard
25478 At present, \SpecialChar LyX
25479 auto-generates CSS only for font information, making use of
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25491 \begin_inset Flex Code
25494 \begin_layout Plain Layout
25501 \begin_inset Flex Code
25504 \begin_layout Plain Layout
25511 \begin_inset Flex Code
25514 \begin_layout Plain Layout
25521 \begin_inset Flex Code
25524 \begin_layout Plain Layout
25531 \begin_inset CommandInset ref
25533 reference "subsec:Font-description"
25538 The translation is mostly straightforward and obvious.
25540 \begin_inset Quotes eld
25544 \begin_inset Flex Code
25547 \begin_layout Plain Layout
25554 \begin_inset Quotes erd
25558 \begin_inset Quotes eld
25562 \begin_inset Flex Code
25565 \begin_layout Plain Layout
25566 font-family: sans-serif;
25572 \begin_inset Quotes erd
25576 The correspondence of \SpecialChar LyX
25577 sizes and CSS sizes is a little less obvious but
25578 nonetheless intuitive.
25580 \begin_inset Flex Code
25583 \begin_layout Plain Layout
25590 \begin_inset Flex URL
25593 \begin_layout Plain Layout
25603 \begin_layout Chapter
25604 Including External Material
25605 \begin_inset CommandInset label
25607 name "chap:Including-External-Material"
25614 \begin_layout Standard
25615 \begin_inset Box Shadowbox
25625 height_special "totalheight"
25630 backgroundcolor "none"
25633 \begin_layout Plain Layout
25634 WARNING: This portion of the documentation has not been updated for some
25636 We certainly hope that it is still accurate, but there are no guarantees.
25644 \begin_layout Standard
25645 The use of material from sources external to \SpecialChar LyX
25646 is covered in detail in the
25652 This part of the manual covers what needs to happen behind the scenes for
25653 new sorts of material to be included.
25656 \begin_layout Section
25660 \begin_layout Standard
25661 The external material feature is based on the concept of a
25666 A template is a specification of how \SpecialChar LyX
25667 should interface with a certain kind
25669 As bundled, \SpecialChar LyX
25670 comes with predefined templates for Xfig figures, various
25671 raster format images, chess diagrams, and LilyPond music notation.
25672 You can check the actual list by using the menu
25673 \begin_inset Flex Noun
25676 \begin_layout Plain Layout
25677 Insert\SpecialChar menuseparator
25678 File\SpecialChar menuseparator
25685 Furthermore, it is possible to roll your own template to support a specific
25687 Later we'll describe in more detail what is involved, and hopefully you
25688 will submit all the templates you create so we can include them in a later
25693 \begin_layout Standard
25694 Another basic idea of the external material feature is to distinguish between
25695 the original file that serves as a base for final material and the produced
25696 file that is included in your exported or printed document.
25697 For example, consider the case of a figure produced with
25698 \begin_inset Flex Code
25701 \begin_layout Plain Layout
25708 The Xfig application itself works on an original file with the
25709 \begin_inset Flex Code
25712 \begin_layout Plain Layout
25719 Within Xfig, you create and change your figure, and when you are done,
25721 \begin_inset Flex Code
25724 \begin_layout Plain Layout
25731 When you want to include the figure in your document, you invoke
25732 \begin_inset Flex Code
25735 \begin_layout Plain Layout
25741 in order to create a PostScript file that can readily be included in your
25745 \begin_inset Flex Code
25748 \begin_layout Plain Layout
25754 file is the original file, and the PostScript file is the produced file.
25757 \begin_layout Standard
25758 This distinction is important in order to allow updating of the material
25759 while you are in the process of writing the document.
25760 Furthermore, it provides us with the flexibility that is needed to support
25761 multiple export formats.
25762 For instance, in the case of a plain text file, it is not exactly an award-winn
25763 ing idea to include the figure as raw PostScript.
25764 Instead, you would either prefer to just include a reference to the figure
25765 or try to invoke some graphics to ASCII converter to make the final result
25766 look similar to the real graphics.
25767 The external material management allows you to do this, because it is parametri
25768 zed on the different export formats that \SpecialChar LyX
25772 \begin_layout Standard
25773 Besides supporting the production of different products according to the
25774 exported format, it supports tight integration with editing and viewing
25776 In the case of an Xfig figure, you are able to invoke Xfig on the original
25777 file with a single click from within the external material dialog in \SpecialChar LyX
25779 and also preview the produced PostScript file with Ghostview with another
25781 No more fiddling around with the command line and/or file browsers to locate
25782 and manipulate the original or produced files.
25783 In this way, you are finally able to take full advantage of the many different
25784 applications that are relevant to use when you write your documents, and
25785 ultimately be more productive.
25788 \begin_layout Section
25789 The external template configuration files
25792 \begin_layout Standard
25793 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25795 However, be aware that doing this in an careless manner most probably
25799 introduce an easily exploitable security hole.
25800 So before you do this, please read the discussion about security in
25801 \begin_inset CommandInset ref
25803 reference "sec:Security-discussion"
25810 \begin_layout Standard
25811 Having said that, we encourage you to submit any interesting templates that
25816 \begin_layout Standard
25817 The external templates are defined in the
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25827 files that are stored in the
25828 \begin_inset Flex Code
25831 \begin_layout Plain Layout
25832 LyXDir/lib/xtemplates/
25838 Each template is defined in a file of its own.
25839 You can place your own templates in
25840 \begin_inset Flex Code
25843 \begin_layout Plain Layout
25844 UserDir/xtemplates/
25849 or copy existing templates to that directory in order to modify them.
25852 \begin_layout Standard
25853 A typical template looks like this:
25856 \begin_layout LyX-Code
25860 \begin_layout LyX-Code
25861 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25864 \begin_layout LyX-Code
25868 \begin_layout LyX-Code
25872 \begin_layout LyX-Code
25876 \begin_layout LyX-Code
25880 \begin_layout LyX-Code
25884 \begin_layout LyX-Code
25885 AutomaticProduction true
25888 \begin_layout LyX-Code
25892 \begin_layout LyX-Code
25896 \begin_layout LyX-Code
25900 \begin_layout LyX-Code
25901 TransformCommand Rotate RotationLatexCommand
25904 \begin_layout LyX-Code
25905 TransformCommand Resize ResizeLatexCommand
25908 \begin_layout LyX-Code
25909 Product "$$RotateFront$$ResizeFront
25912 \begin_layout LyX-Code
25917 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25920 \begin_layout LyX-Code
25921 $$ResizeBack$$RotateBack"
25924 \begin_layout LyX-Code
25928 \begin_layout LyX-Code
25929 UpdateResult "$$AbsPath$$Basename.pstex_t"
25932 \begin_layout LyX-Code
25933 Requirement "graphicx"
25936 \begin_layout LyX-Code
25937 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25940 \begin_layout LyX-Code
25941 ReferencedFile latex "$$AbsPath$$Basename.eps"
25944 \begin_layout LyX-Code
25945 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25948 \begin_layout LyX-Code
25952 \begin_layout LyX-Code
25956 \begin_layout LyX-Code
25957 TransformCommand Rotate RotationLatexCommand
25960 \begin_layout LyX-Code
25961 TransformCommand Resize ResizeLatexCommand
25964 \begin_layout LyX-Code
25965 Product "$$RotateFront$$ResizeFront
25968 \begin_layout LyX-Code
25973 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25976 \begin_layout LyX-Code
25977 $$ResizeBack$$RotateBack"
25980 \begin_layout LyX-Code
25981 UpdateFormat pdftex
25984 \begin_layout LyX-Code
25985 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25988 \begin_layout LyX-Code
25989 Requirement "graphicx"
25992 \begin_layout LyX-Code
25993 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25996 \begin_layout LyX-Code
25997 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26000 \begin_layout LyX-Code
26004 \begin_layout LyX-Code
26008 \begin_layout LyX-Code
26009 Product "[XFig: $$FName]"
26012 \begin_layout LyX-Code
26016 \begin_layout LyX-Code
26020 \begin_layout LyX-Code
26021 Product "<graphic fileref=
26023 "$$AbsOrRelPathMaster$$Basename.eps
26028 \begin_layout LyX-Code
26032 \begin_layout LyX-Code
26036 \begin_layout LyX-Code
26037 UpdateResult "$$AbsPath$$Basename.eps"
26040 \begin_layout LyX-Code
26041 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26044 \begin_layout LyX-Code
26045 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26048 \begin_layout LyX-Code
26052 \begin_layout LyX-Code
26056 \begin_layout Standard
26057 As you can see, the template is enclosed in
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26069 \begin_inset Flex Code
26072 \begin_layout Plain Layout
26079 It contains a header specifying some general settings and, for each supported
26080 primary document file format, a section
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26104 \begin_layout Subsection
26105 The template header
26108 \begin_layout Description
26109 \begin_inset Flex Code
26112 \begin_layout Plain Layout
26113 AutomaticProduction
26114 \begin_inset space ~
26122 Whether the file represented by the template must be generated by \SpecialChar LyX
26124 This command must occur exactly once.
26127 \begin_layout Description
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26133 \begin_inset space ~
26141 A glob pattern that is used in the file dialog to filter out the desired
26143 If there is more than one possible file extension (e.
26144 \begin_inset space \thinspace{}
26148 \begin_inset space \space{}
26152 \begin_inset Flex Code
26155 \begin_layout Plain Layout
26162 \begin_inset Flex Code
26165 \begin_layout Plain Layout
26171 ), use something like
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26182 This command must occur exactly once.
26185 \begin_layout Description
26186 \begin_inset Flex Code
26189 \begin_layout Plain Layout
26191 \begin_inset space ~
26199 The text that is displayed on the button.
26200 This command must occur exactly once.
26203 \begin_layout Description
26204 \begin_inset Flex Code
26207 \begin_layout Plain Layout
26209 \begin_inset space ~
26213 \begin_inset space ~
26221 The help text that is used in the External dialog.
26222 Provide enough information to explain to the user just what the template
26223 can provide him with.
26224 This command must occur exactly once.
26227 \begin_layout Description
26228 \begin_inset Flex Code
26231 \begin_layout Plain Layout
26233 \begin_inset space ~
26241 The file format of the original file.
26242 This must be the name of a format that is known to \SpecialChar LyX
26244 \begin_inset CommandInset ref
26246 reference "sec:Formats"
26252 \begin_inset Quotes eld
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26266 \begin_inset Quotes erd
26269 if the template can handle original files of more than one format.
26271 will attempt to interrogate the file itself in order to deduce its format
26273 This command must occur exactly once.
26276 \begin_layout Description
26277 \begin_inset Flex Code
26280 \begin_layout Plain Layout
26282 \begin_inset space ~
26290 A unique name for the template.
26291 It must not contain substitution macros (see below).
26294 \begin_layout Description
26295 \begin_inset Flex Code
26298 \begin_layout Plain Layout
26300 \begin_inset space ~
26303 Rotate|Resize|Clip|Extra
26308 This command specifies which transformations are supported by this template.
26309 It may occur zero or more times.
26310 This command enables the corresponding tabs in the external dialog.
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26321 command must have either a corresponding
26322 \begin_inset Flex Code
26325 \begin_layout Plain Layout
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26352 Otherwise the transformation will not be supported by that format.
26355 \begin_layout Subsection
26359 \begin_layout Description
26360 \begin_inset Flex Code
26363 \begin_layout Plain Layout
26365 \begin_inset space ~
26368 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26373 The primary document file format that this format definition is for.
26374 Not every template has a sensible representation in all document file formats.
26375 Please define nevertheless a
26376 \begin_inset Flex Code
26379 \begin_layout Plain Layout
26385 section for all templates.
26386 Use a dummy text when no representation is available.
26387 Then you can at least see a reference to the external material in the exported
26391 \begin_layout Description
26392 \begin_inset Flex Code
26395 \begin_layout Plain Layout
26397 \begin_inset space ~
26401 \begin_inset space ~
26409 This command defines an additional macro
26410 \begin_inset Flex Code
26413 \begin_layout Plain Layout
26419 for substitution in
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26440 itself may contain substitution macros.
26441 The advantage over using
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26452 \begin_inset Flex Code
26455 \begin_layout Plain Layout
26461 is that the substituted value of
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26471 is sanitized so that it is a valid optional argument in the document format.
26472 This command may occur zero or more times.
26475 \begin_layout Description
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26481 \begin_inset space ~
26489 The text that is inserted in the exported document.
26490 This is actually the most important command and can be quite complex.
26491 This command must occur exactly once.
26494 \begin_layout Description
26495 \begin_inset Flex Code
26498 \begin_layout Plain Layout
26500 \begin_inset space ~
26508 This command specifies a preamble snippet that will be included in the
26511 It has to be defined using
26512 \begin_inset Flex Code
26515 \begin_layout Plain Layout
26523 \begin_inset Flex Code
26526 \begin_layout Plain Layout
26533 This command may occur zero or more times.
26536 \begin_layout Description
26537 \begin_inset Flex Code
26540 \begin_layout Plain Layout
26542 \begin_inset space ~
26546 \begin_inset space ~
26554 This command denotes files that are created by the conversion process and
26555 are needed for a particular export format.
26556 If the filename is relative, it is interpreted relative to the master document.
26557 This command may be given zero or more times.
26560 \begin_layout Description
26561 \begin_inset Flex Code
26564 \begin_layout Plain Layout
26566 \begin_inset space ~
26574 The name of a required \SpecialChar LaTeX
26576 The package is included via
26577 \begin_inset Flex Code
26580 \begin_layout Plain Layout
26588 in the \SpecialChar LaTeX
26590 This command may occur zero or more times.
26593 \begin_layout Description
26594 \begin_inset Flex Code
26597 \begin_layout Plain Layout
26599 \begin_inset space ~
26603 \begin_inset space ~
26606 RotationLatexCommand
26611 This command specifies that the built in \SpecialChar LaTeX
26612 command should be used for rotation.
26613 This command may occur once or not at all.
26616 \begin_layout Description
26617 \begin_inset Flex Code
26620 \begin_layout Plain Layout
26622 \begin_inset space ~
26626 \begin_inset space ~
26634 This command specifies that the built in \SpecialChar LaTeX
26635 command should be used for resizing.
26636 This command may occur once or not at all.
26639 \begin_layout Description
26640 \begin_inset Flex Code
26643 \begin_layout Plain Layout
26645 \begin_inset space ~
26649 \begin_inset space ~
26652 RotationLatexOption
26657 This command specifies that rotation is done via an optional argument.
26658 This command may occur once or not at all.
26661 \begin_layout Description
26662 \begin_inset Flex Code
26665 \begin_layout Plain Layout
26667 \begin_inset space ~
26671 \begin_inset space ~
26679 This command specifies that resizing is done via an optional argument.
26680 This command may occur once or not at all.
26683 \begin_layout Description
26684 \begin_inset Flex Code
26687 \begin_layout Plain Layout
26689 \begin_inset space ~
26693 \begin_inset space ~
26701 This command specifies that clipping is done via an optional argument.
26702 This command may occur once or not at all.
26705 \begin_layout Description
26706 \begin_inset Flex Code
26709 \begin_layout Plain Layout
26711 \begin_inset space ~
26715 \begin_inset space ~
26723 This command specifies that an extra optional argument is used.
26724 This command may occur once or not at all.
26727 \begin_layout Description
26728 \begin_inset Flex Code
26731 \begin_layout Plain Layout
26733 \begin_inset space ~
26741 The file format of the converted file.
26742 This must be the name of a format that is known to \SpecialChar LyX
26744 \begin_inset Flex Noun
26747 \begin_layout Plain Layout
26748 Tools\SpecialChar menuseparator
26749 Preferences\SpecialChar menuseparator
26750 File Handling\SpecialChar menuseparator
26757 This command must occur exactly once.
26758 If the resulting file format is PDF, you need to specify the format
26759 \begin_inset Flex Code
26762 \begin_layout Plain Layout
26769 This is the PDF format used for including graphics.
26770 The other defined PDF formats are for document export.
26773 \begin_layout Description
26774 \begin_inset Flex Code
26777 \begin_layout Plain Layout
26779 \begin_inset space ~
26787 The file name of the converted file.
26788 The file name must be absolute.
26789 This command must occur exactly once.
26792 \begin_layout Subsection
26793 Preamble definitions
26796 \begin_layout Standard
26797 The external template configuration file may contain additional preamble
26798 definitions enclosed by
26799 \begin_inset Flex Code
26802 \begin_layout Plain Layout
26810 \begin_inset Flex Code
26813 \begin_layout Plain Layout
26820 They can be used by the templates in the
26821 \begin_inset Flex Code
26824 \begin_layout Plain Layout
26833 \begin_layout Section
26834 The substitution mechanism
26837 \begin_layout Standard
26838 When the external material facility invokes an external program, it is done
26839 on the basis of a command defined in the template configuration file.
26840 These commands can contain various macros that are expanded before execution.
26841 Execution always take place in the directory of the containing document.
26844 \begin_layout Standard
26845 Also, whenever external material is to be displayed, the name will be produced
26846 by the substitution mechanism, and most other commands in the template
26847 definition support substitution as well.
26850 \begin_layout Standard
26851 The available macros are the following:
26854 \begin_layout Description
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26859 $$AbsOrRelPathMaster
26864 The file path, absolute or relative to the master \SpecialChar LyX
26868 \begin_layout Description
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26873 $$AbsOrRelPathParent
26878 The file path, absolute or relative to the \SpecialChar LyX
26882 \begin_layout Description
26883 \begin_inset Flex Code
26886 \begin_layout Plain Layout
26892 The absolute file path.
26895 \begin_layout Description
26896 \begin_inset Flex Code
26899 \begin_layout Plain Layout
26905 The filename without path and without the extension.
26908 \begin_layout Description
26909 \begin_inset Flex Code
26912 \begin_layout Plain Layout
26914 \begin_inset Quotes eld
26918 \begin_inset Quotes erd
26926 This macro will expand to the contents of the file with the name
26927 \begin_inset Flex Code
26930 \begin_layout Plain Layout
26939 \begin_layout Description
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26949 The file extension (including the dot).
26952 \begin_layout Description
26953 \begin_inset Flex Code
26956 \begin_layout Plain Layout
26962 This will be the string
26963 \begin_inset Quotes eld
26967 \begin_inset Quotes erd
26970 if the file is in JPEG format, otherwise it will be the string
26971 \begin_inset Quotes eld
26975 \begin_inset Quotes erd
26979 This is useful to avoid uneeded conversions for output formats that support
26980 both PNG and JPEG fomats.
26981 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26986 \begin_layout Description
26987 \begin_inset Flex Code
26990 \begin_layout Plain Layout
26996 The filename of the file specified in the external material dialog.
26997 This is either an absolute name, or it is relative to the \SpecialChar LyX
27001 \begin_layout Description
27002 \begin_inset Flex Code
27005 \begin_layout Plain Layout
27012 \begin_inset Flex Code
27015 \begin_layout Plain Layout
27021 (absolute name or relative to the \SpecialChar LyX
27025 \begin_layout Description
27026 \begin_inset Flex Code
27029 \begin_layout Plain Layout
27035 The file path, relative to the master \SpecialChar LyX
27039 \begin_layout Description
27040 \begin_inset Flex Code
27043 \begin_layout Plain Layout
27049 The file path, relative to the \SpecialChar LyX
27053 \begin_layout Description
27054 \begin_inset Flex Code
27057 \begin_layout Plain Layout
27063 This macro will expand to the absolute path of the system directory.
27064 This is typically used to point to the various helper scripts that are
27065 bundled with \SpecialChar LyX
27069 \begin_layout Description
27070 \begin_inset Flex Code
27073 \begin_layout Plain Layout
27079 A name and full path to a temporary file which will be automatically deleted
27080 whenever the containing document is closed, or the external material insertion
27084 \begin_layout Standard
27085 All path macros contain a trailing directory separator, so you can construct
27087 \begin_inset space \thinspace{}
27091 \begin_inset space \space{}
27094 the absolute filename with
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27099 $$AbsPath$$Basename$$Extension
27107 \begin_layout Standard
27108 The macros above are substituted in all commands unless otherwise noted.
27110 \begin_inset Flex Code
27113 \begin_layout Plain Layout
27119 supports additionally the following substitutions if they are enabled by
27121 \begin_inset Flex Code
27124 \begin_layout Plain Layout
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27143 \begin_layout Description
27144 \begin_inset Flex Code
27147 \begin_layout Plain Layout
27153 The front part of the resize command.
27156 \begin_layout Description
27157 \begin_inset Flex Code
27160 \begin_layout Plain Layout
27166 The back part of the resize command.
27169 \begin_layout Description
27170 \begin_inset Flex Code
27173 \begin_layout Plain Layout
27179 The front part of the rotation command.
27182 \begin_layout Description
27183 \begin_inset Flex Code
27186 \begin_layout Plain Layout
27192 The back part of the rotation command.
27195 \begin_layout Standard
27196 The value string of the
27197 \begin_inset Flex Code
27200 \begin_layout Plain Layout
27206 command supports additionally the following substitutions if they are enabled
27208 \begin_inset Flex Code
27211 \begin_layout Plain Layout
27218 \begin_inset Flex Code
27221 \begin_layout Plain Layout
27230 \begin_layout Description
27231 \begin_inset Flex Code
27234 \begin_layout Plain Layout
27243 \begin_layout Description
27244 \begin_inset Flex Code
27247 \begin_layout Plain Layout
27256 \begin_layout Description
27257 \begin_inset Flex Code
27260 \begin_layout Plain Layout
27269 \begin_layout Description
27270 \begin_inset Flex Code
27273 \begin_layout Plain Layout
27279 The rotation option.
27282 \begin_layout Standard
27283 You may ask why there are so many path macros.
27284 There are mainly two reasons:
27287 \begin_layout Enumerate
27288 Relative and absolute file names should remain relative or absolute, respectivel
27290 Users may have reasons to prefer either form.
27291 Relative names are useful for portable documents that should work on different
27292 machines, for example.
27293 Absolute names may be required by some programs.
27296 \begin_layout Enumerate
27298 treats relative file names differently than \SpecialChar LyX
27299 and other programs in nested
27301 For \SpecialChar LyX
27302 , a relative file name is always relative to the document that contains
27304 For \SpecialChar LaTeX
27305 , it is always relative to the master document.
27306 These two definitions are identical if you have only one document, but
27307 differ if you have a master document that includes part documents.
27308 That means that relative filenames must be transformed when presented to
27311 Fortunately \SpecialChar LyX
27312 does this automatically for you if you choose the right macros.
27315 \begin_layout Standard
27316 So which path macro should be used in new template definitions? The rule
27320 \begin_layout Itemize
27322 \begin_inset Flex Code
27325 \begin_layout Plain Layout
27331 if an absolute path is required.
27334 \begin_layout Itemize
27336 \begin_inset Flex Code
27339 \begin_layout Plain Layout
27340 $$AbsOrRelPathMaster
27345 if the substituted string is some kind of \SpecialChar LaTeX
27349 \begin_layout Itemize
27351 \begin_inset Flex Code
27354 \begin_layout Plain Layout
27355 $$AbsOrRelPathParent
27360 in order to preserve the user's choice.
27363 \begin_layout Standard
27364 There are special cases where this rule does not work and e.
27365 \begin_inset space \thinspace{}
27369 \begin_inset space \space{}
27372 relative names are needed, but normally it will work just fine.
27373 One example for such a case is the command
27374 \begin_inset Flex Code
27377 \begin_layout Plain Layout
27378 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27383 in the XFig template above: We can't use the absolute name because the
27385 \begin_inset Flex Code
27388 \begin_layout Plain Layout
27394 files needs the relative name in order to rewrite the file content.
27397 \begin_layout Section
27398 Security discussion
27399 \begin_inset CommandInset label
27401 name "sec:Security-discussion"
27408 \begin_layout Standard
27409 The external material feature interfaces with a lot of external programs
27410 and does so automatically, so we have to consider the security implications
27412 In particular, since you have the option of including your own filenames
27413 and/or parameter strings and those are expanded into a command, it seems
27414 that it would be possible to create a malicious document which executes
27415 arbitrary commands when a user views or prints the document.
27416 This is something we definitely want to avoid.
27419 \begin_layout Standard
27420 However, since the external program commands are specified in the template
27421 configuration file only, there are no security issues if \SpecialChar LyX
27422 is properly configure
27423 d with safe templates only.
27424 This is so because the external programs are invoked with the
27425 \begin_inset Flex Code
27428 \begin_layout Plain Layout
27434 -system call rather than the
27435 \begin_inset Flex Code
27438 \begin_layout Plain Layout
27444 system-call, so it's not possible to execute arbitrary commands from the
27445 filename or parameter section via the shell.
27448 \begin_layout Standard
27449 This also implies that you are restricted in what command strings you can
27450 use in the external material templates.
27451 In particular, pipes and redirection are not readily available.
27452 This has to be so if \SpecialChar LyX
27453 should remain safe.
27454 If you want to use some of the shell features, you should write a safe
27455 script to do this in a controlled manner, and then invoke the script from
27456 the command string.
27460 \begin_layout Standard
27461 It is possible to design a template that interacts directly with the shell,
27462 but since this would allow a malicious user to execute arbitrary commands
27463 by writing clever filenames and/or parameters, we generally recommend that
27464 you only use safe scripts that work with the
27465 \begin_inset Flex Code
27468 \begin_layout Plain Layout
27474 system call in a controlled manner.
27475 Of course, for use in a controlled environment, it can be tempting to just
27476 fall back to use ordinary shell scripts.
27477 If you do so, be aware that you
27481 provide an easily exploitable security hole in your system.
27482 Of course it stands to reason that such unsafe templates will never be
27483 included in the standard \SpecialChar LyX
27484 distribution, although we do encourage people
27485 to submit new templates in the open source tradition.
27486 But \SpecialChar LyX
27487 as shipped from the official distribution channels will never have
27491 \begin_layout Standard
27492 Including external material provides a lot of power, and you have to be
27493 careful not to introduce security hazards with this power.
27494 A subtle error in a single line in an innocent looking script can open
27495 the door to huge security problems.
27496 So if you do not fully understand the issues, we recommend that you consult
27497 a knowledgeable security professional or the \SpecialChar LyX
27498 development team if you have
27499 any questions about whether a given template is safe or not.
27500 And do this before you use it in an uncontrolled environment.
27503 \begin_layout Chapter
27505 List of supported \SpecialChar LyX
27506 functions to be used in layouts
27507 \begin_inset CommandInset label
27509 name "chap:List-of-functions"
27516 \begin_layout Standard
27518 \begin_inset Tabular
27519 <lyxtabular version="3" rows="11" columns="8">
27520 <features tabularvalignment="middle">
27521 <column alignment="left" valignment="top">
27522 <column alignment="left" valignment="top">
27523 <column alignment="left" valignment="top">
27524 <column alignment="left" valignment="top">
27525 <column alignment="left" valignment="top">
27526 <column alignment="left" valignment="top">
27527 <column alignment="left" valignment="top">
27528 <column alignment="left" valignment="top">
27530 <cell alignment="left" valignment="top" usebox="none">
27533 \begin_layout Plain Layout
27539 <cell alignment="left" valignment="top" usebox="none">
27542 \begin_layout Plain Layout
27548 <cell alignment="left" valignment="top" usebox="none">
27551 \begin_layout Plain Layout
27557 <cell alignment="left" valignment="top" usebox="none">
27560 \begin_layout Plain Layout
27566 <cell alignment="center" valignment="top" usebox="none">
27569 \begin_layout Plain Layout
27575 <cell alignment="center" valignment="top" usebox="none">
27578 \begin_layout Plain Layout
27584 <cell alignment="center" valignment="top" usebox="none">
27587 \begin_layout Plain Layout
27593 <cell alignment="center" valignment="top" usebox="none">
27596 \begin_layout Plain Layout
27604 <cell alignment="left" valignment="top" usebox="none">
27607 \begin_layout Plain Layout
27613 <cell alignment="left" valignment="top" usebox="none">
27616 \begin_layout Plain Layout
27622 <cell alignment="left" valignment="top" usebox="none">
27625 \begin_layout Plain Layout
27631 <cell alignment="left" valignment="top" usebox="none">
27634 \begin_layout Plain Layout
27640 <cell alignment="center" valignment="top" usebox="none">
27643 \begin_layout Plain Layout
27649 <cell alignment="center" valignment="top" usebox="none">
27652 \begin_layout Plain Layout
27658 <cell alignment="center" valignment="top" usebox="none">
27661 \begin_layout Plain Layout
27667 <cell alignment="center" valignment="top" usebox="none">
27670 \begin_layout Plain Layout
27678 <cell alignment="left" valignment="top" usebox="none">
27681 \begin_layout Plain Layout
27687 <cell alignment="left" valignment="top" usebox="none">
27690 \begin_layout Plain Layout
27696 <cell alignment="left" valignment="top" usebox="none">
27699 \begin_layout Plain Layout
27705 <cell alignment="left" valignment="top" usebox="none">
27708 \begin_layout Plain Layout
27714 <cell alignment="center" valignment="top" usebox="none">
27717 \begin_layout Plain Layout
27723 <cell alignment="center" valignment="top" usebox="none">
27726 \begin_layout Plain Layout
27732 <cell alignment="center" valignment="top" usebox="none">
27735 \begin_layout Plain Layout
27741 <cell alignment="center" valignment="top" usebox="none">
27744 \begin_layout Plain Layout
27752 <cell alignment="left" valignment="top" usebox="none">
27755 \begin_layout Plain Layout
27761 <cell alignment="left" valignment="top" usebox="none">
27764 \begin_layout Plain Layout
27770 <cell alignment="left" valignment="top" usebox="none">
27773 \begin_layout Plain Layout
27779 <cell alignment="left" valignment="top" usebox="none">
27782 \begin_layout Plain Layout
27788 <cell alignment="center" valignment="top" usebox="none">
27791 \begin_layout Plain Layout
27797 <cell alignment="center" valignment="top" usebox="none">
27800 \begin_layout Plain Layout
27806 <cell alignment="center" valignment="top" usebox="none">
27809 \begin_layout Plain Layout
27815 <cell alignment="center" valignment="top" usebox="none">
27818 \begin_layout Plain Layout
27826 <cell alignment="left" valignment="top" usebox="none">
27829 \begin_layout Plain Layout
27835 <cell alignment="left" valignment="top" usebox="none">
27838 \begin_layout Plain Layout
27844 <cell alignment="left" valignment="top" usebox="none">
27847 \begin_layout Plain Layout
27853 <cell alignment="left" valignment="top" usebox="none">
27856 \begin_layout Plain Layout
27862 <cell alignment="center" valignment="top" usebox="none">
27865 \begin_layout Plain Layout
27871 <cell alignment="center" valignment="top" usebox="none">
27874 \begin_layout Plain Layout
27880 <cell alignment="center" valignment="top" usebox="none">
27883 \begin_layout Plain Layout
27889 <cell alignment="center" valignment="top" usebox="none">
27892 \begin_layout Plain Layout
27900 <cell alignment="left" valignment="top" usebox="none">
27903 \begin_layout Plain Layout
27909 <cell alignment="left" valignment="top" usebox="none">
27912 \begin_layout Plain Layout
27918 <cell alignment="left" valignment="top" usebox="none">
27921 \begin_layout Plain Layout
27927 <cell alignment="left" valignment="top" usebox="none">
27930 \begin_layout Plain Layout
27936 <cell alignment="center" valignment="top" usebox="none">
27939 \begin_layout Plain Layout
27945 <cell alignment="center" valignment="top" usebox="none">
27948 \begin_layout Plain Layout
27954 <cell alignment="center" valignment="top" usebox="none">
27957 \begin_layout Plain Layout
27963 <cell alignment="center" valignment="top" usebox="none">
27966 \begin_layout Plain Layout
27974 <cell alignment="left" valignment="top" usebox="none">
27977 \begin_layout Plain Layout
27983 <cell alignment="left" valignment="top" usebox="none">
27986 \begin_layout Plain Layout
27992 <cell alignment="left" valignment="top" usebox="none">
27995 \begin_layout Plain Layout
28001 <cell alignment="left" valignment="top" usebox="none">
28004 \begin_layout Plain Layout
28010 <cell alignment="center" valignment="top" usebox="none">
28013 \begin_layout Plain Layout
28019 <cell alignment="center" valignment="top" usebox="none">
28022 \begin_layout Plain Layout
28028 <cell alignment="center" valignment="top" usebox="none">
28031 \begin_layout Plain Layout
28037 <cell alignment="center" valignment="top" usebox="none">
28040 \begin_layout Plain Layout
28048 <cell alignment="left" valignment="top" usebox="none">
28051 \begin_layout Plain Layout
28057 <cell alignment="left" valignment="top" usebox="none">
28060 \begin_layout Plain Layout
28066 <cell alignment="left" valignment="top" usebox="none">
28069 \begin_layout Plain Layout
28075 <cell alignment="left" valignment="top" usebox="none">
28078 \begin_layout Plain Layout
28084 <cell alignment="center" valignment="top" usebox="none">
28087 \begin_layout Plain Layout
28093 <cell alignment="center" valignment="top" usebox="none">
28096 \begin_layout Plain Layout
28102 <cell alignment="center" valignment="top" usebox="none">
28105 \begin_layout Plain Layout
28111 <cell alignment="center" valignment="top" usebox="none">
28114 \begin_layout Plain Layout
28122 <cell alignment="left" valignment="top" usebox="none">
28125 \begin_layout Plain Layout
28131 <cell alignment="left" valignment="top" usebox="none">
28134 \begin_layout Plain Layout
28140 <cell alignment="left" valignment="top" usebox="none">
28143 \begin_layout Plain Layout
28149 <cell alignment="left" valignment="top" usebox="none">
28152 \begin_layout Plain Layout
28158 <cell alignment="center" valignment="top" usebox="none">
28161 \begin_layout Plain Layout
28167 <cell alignment="center" valignment="top" usebox="none">
28170 \begin_layout Plain Layout
28176 <cell alignment="center" valignment="top" usebox="none">
28179 \begin_layout Plain Layout
28185 <cell alignment="center" valignment="top" usebox="none">
28188 \begin_layout Plain Layout
28196 <cell alignment="left" valignment="top" usebox="none">
28199 \begin_layout Plain Layout
28205 <cell alignment="left" valignment="top" usebox="none">
28208 \begin_layout Plain Layout
28214 <cell alignment="left" valignment="top" usebox="none">
28217 \begin_layout Plain Layout
28223 <cell alignment="left" valignment="top" usebox="none">
28226 \begin_layout Plain Layout
28232 <cell alignment="center" valignment="top" usebox="none">
28235 \begin_layout Plain Layout
28241 <cell alignment="center" valignment="top" usebox="none">
28244 \begin_layout Plain Layout
28250 <cell alignment="center" valignment="top" usebox="none">
28253 \begin_layout Plain Layout
28259 <cell alignment="center" valignment="top" usebox="none">
28262 \begin_layout Plain Layout
28270 <cell alignment="center" valignment="top" usebox="none">
28273 \begin_layout Plain Layout
28279 <cell alignment="center" valignment="top" usebox="none">
28282 \begin_layout Plain Layout
28288 <cell alignment="center" valignment="top" usebox="none">
28291 \begin_layout Plain Layout
28297 <cell alignment="center" valignment="top" usebox="none">
28300 \begin_layout Plain Layout
28306 <cell alignment="center" valignment="top" usebox="none">
28309 \begin_layout Plain Layout
28315 <cell alignment="center" valignment="top" usebox="none">
28318 \begin_layout Plain Layout
28324 <cell alignment="center" valignment="top" usebox="none">
28327 \begin_layout Plain Layout
28333 <cell alignment="center" valignment="top" usebox="none">
28336 \begin_layout Plain Layout
28350 \begin_layout Chapter
28351 Names of available colors to be used in layouts
28352 \begin_inset CommandInset label
28354 name "chap:Names-of-colors"
28361 \begin_layout Standard
28362 The colors listed below are the standard colors and those that you can adjust
28363 in the \SpecialChar LyX
28367 \begin_layout Section
28371 \begin_layout Standard
28372 The following are no real colors, but rather act on color definitions:
28375 \begin_layout Description
28376 ignore The color is ignored
28379 \begin_layout Description
28380 inherit The color is inherited
28383 \begin_layout Description
28396 No particular color – clear or default
28399 \begin_layout Section
28403 \begin_layout Standard
28404 These are fixed colors that cannot me customized:
28407 \begin_layout Description
28411 \begin_layout Description
28415 \begin_layout Description
28419 \begin_layout Description
28423 \begin_layout Description
28427 \begin_layout Description
28431 \begin_layout Description
28435 \begin_layout Description
28439 \begin_layout Description
28443 \begin_layout Description
28447 \begin_layout Description
28451 \begin_layout Description
28455 \begin_layout Description
28459 \begin_layout Description
28463 \begin_layout Description
28467 \begin_layout Description
28471 \begin_layout Description
28475 \begin_layout Description
28479 \begin_layout Description
28483 \begin_layout Section
28487 \begin_layout Standard
28488 These are the colors allocated to specific elements in
28491 arg "dialog-show prefs"
28497 \begin_layout Description
28498 added_space Added space color
28501 \begin_layout Description
28502 addedtext Added text color
28505 \begin_layout Description
28506 appendix Appendix marker color
28509 \begin_layout Description
28510 background Background color
28513 \begin_layout Description
28514 bottomarea Bottom area color
28517 \begin_layout Description
28518 branchlabel Label color for branches
28521 \begin_layout Description
28522 buttonbg Color used for button background
28525 \begin_layout Description
28526 buttonframe Color for inset button frames
28529 \begin_layout Description
28530 buttonhoverbg Color used for button background under focus
28533 \begin_layout Description
28534 changebar Changebar color
28537 \begin_layout Description
28538 changedtextauthor1 Changed text color author 1
28541 \begin_layout Description
28542 changedtextauthor2 Changed text color author 2
28545 \begin_layout Description
28546 changedtextauthor3 Changed text color author 3
28549 \begin_layout Description
28550 changedtextauthor4 Changed text color author 4
28553 \begin_layout Description
28554 changedtextauthor5 Changed text color author 5
28557 \begin_layout Description
28558 collapsible Collapsible insets text color
28561 \begin_layout Description
28562 collapsibleframe Collapsible insets framecolor
28565 \begin_layout Description
28566 command Text color for command insets
28569 \begin_layout Description
28570 commandbg Background color for command insets
28573 \begin_layout Description
28574 commandframe Frame color for command insets
28577 \begin_layout Description
28578 comment Label color for comments
28581 \begin_layout Description
28582 commentbg Background color of comments
28585 \begin_layout Description
28586 cursor Cursor color
28589 \begin_layout Description
28590 deletedtext Deleted text color
28593 \begin_layout Description
28594 deletedtextmodifier Deleted text modifying color
28597 \begin_layout Description
28598 depthbar Color for the depth bars in the margin
28601 \begin_layout Description
28602 eolmarker End of line marker color
28605 \begin_layout Description
28606 error Color of the \SpecialChar LaTeX
28610 \begin_layout Description
28611 footlabel Label color for footnotes
28614 \begin_layout Description
28615 foreground Foreground color
28618 \begin_layout Description
28619 graphicsbg Graphics inset background color
28622 \begin_layout Description
28623 greyedoutbg Background color of greyedout inset
28626 \begin_layout Description
28627 greyedoutlabel Label color for greyedout insets
28630 \begin_layout Description
28631 greyedouttext Color for greyedout inset text
28634 \begin_layout Description
28635 indexlabel Label color for index insets
28638 \begin_layout Description
28639 inlinecompletion Inline completion color
28642 \begin_layout Description
28643 insetbg Inset marker background color
28646 \begin_layout Description
28647 insetframe Inset marker frame color
28650 \begin_layout Description
28651 language Color for marking foreign language words
28654 \begin_layout Description
28655 latex Text color in \SpecialChar LaTeX
28659 \begin_layout Description
28660 listingsbg Background color of listings inset
28663 \begin_layout Description
28664 marginlabel Label color for margin notes
28667 \begin_layout Description
28668 math Math inset text color
28671 \begin_layout Description
28672 mathbg Math inset background color
28675 \begin_layout Description
28676 mathcorners Math inset frame color not under focus
28679 \begin_layout Description
28680 mathframe Math inset frame color under focus
28683 \begin_layout Description
28684 mathline Math line color
28687 \begin_layout Description
28688 mathmacrobg Macro math inset background color
28691 \begin_layout Description
28692 mathmacroblend Macro math blended color
28695 \begin_layout Description
28696 mathmacroframe Macro math frame color
28699 \begin_layout Description
28700 mathmacrohoverbg Macro math inset background color hovered
28703 \begin_layout Description
28704 mathmacrolabel Macro math label color
28707 \begin_layout Description
28708 mathmacronewarg Macro template color for new parameters
28711 \begin_layout Description
28712 mathmacrooldarg Macro template color for old parameters
28715 \begin_layout Description
28716 newpage New page color
28719 \begin_layout Description
28720 nonunique_inlinecompletion Inline completion color for the non-unique part
28723 \begin_layout Description
28724 note Label color for notes
28727 \begin_layout Description
28728 notebg Background color of notes
28731 \begin_layout Description
28732 pagebreak Page break/line break color
28735 \begin_layout Description
28736 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28739 \begin_layout Description
28740 phantomtext Text color for phantom insets
28743 \begin_layout Description
28744 preview The color used for previews
28747 \begin_layout Description
28748 previewframe Preview frame color
28751 \begin_layout Description
28752 regexpframe Color for regexp frame
28755 \begin_layout Description
28756 scroll Color that indicates when a row can be scrolled
28759 \begin_layout Description
28760 selection Background color of selected text
28763 \begin_layout Description
28764 selectiontext Foreground color of selected text
28767 \begin_layout Description
28768 shadedbg Background color of shaded box
28771 \begin_layout Description
28772 special Special chars text color
28775 \begin_layout Description
28776 tabularline Table line color
28779 \begin_layout Description
28780 tabularonoffline Table line color
28783 \begin_layout Description
28784 urllabel Label color for URL insets
28787 \begin_layout Description
28788 urltext Color for URL inset text