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 1552395557
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.
15164 \begin_layout Description
15166 \change_inserted -712698321 1552395844
15167 \begin_inset Flex Code
15170 \begin_layout Plain Layout
15172 \change_inserted -712698321 1552395561
15179 \begin_inset Flex Code
15182 \begin_layout Plain Layout
15184 \change_inserted -712698321 1552395557
15193 \begin_inset space \thinspace{}
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15202 \change_inserted -712698321 1552395557
15208 ] Whether specific commands in this style (such as
15209 \begin_inset Flex Code
15212 \begin_layout Plain Layout
15214 \change_inserted -712698321 1552395655
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15230 \change_inserted -712698321 1552395661
15240 ) should be protected in an
15241 \begin_inset Flex Code
15244 \begin_layout Plain Layout
15246 \change_inserted -712698321 1552395631
15257 This is particularly needed for styles that draw on
15265 commands which parse their content in complex ways.
15270 \begin_layout Description
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15281 \begin_inset Flex Code
15284 \begin_layout Plain Layout
15291 \begin_inset space \thinspace{}
15295 \begin_inset Flex Code
15298 \begin_layout Plain Layout
15306 ] Whether newlines are translated into \SpecialChar LaTeX
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15322 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15324 inside \SpecialChar LyX
15328 \begin_layout Description
15329 \begin_inset Flex Code
15332 \begin_layout Plain Layout
15339 \begin_inset Flex Code
15342 \begin_layout Plain Layout
15351 \begin_inset space \thinspace{}
15355 \begin_inset Flex Code
15358 \begin_layout Plain Layout
15364 ] If set to true, and if
15365 \begin_inset Flex Code
15368 \begin_layout Plain Layout
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15384 ) paragraphs are being indented, then the indentation of such a paragraph
15385 following one of this type will be suppressed.
15386 (So this will not affect the display of non-default paragraphs.)
15389 \begin_layout Description
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15409 ] Name of a style that has replaced this style.
15410 This is used to rename a style, while keeping backward compatibility.
15413 \begin_layout Description
15414 \begin_inset Flex Code
15417 \begin_layout Plain Layout
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15434 \begin_inset space \thinspace{}
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15447 ] Determines whether consecutive paragraphs of the same type are treated
15448 as belonging together.
15449 This has the effect that the
15450 \begin_inset Flex Code
15453 \begin_layout Plain Layout
15459 is only printed once before such a group.
15460 By default, this is true for
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15481 \begin_inset Flex Code
15484 \begin_layout Plain Layout
15490 and false for all other types.
15493 \begin_layout Description
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15516 \begin_inset space \thinspace{}
15520 \begin_inset Flex Code
15523 \begin_layout Plain Layout
15529 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15531 but only by a line break; together with
15532 \begin_inset Flex Code
15535 \begin_layout Plain Layout
15541 , this allows to emulate a plain text editor (like the ERT inset).
15544 \begin_layout Description
15545 \begin_inset Flex Code
15548 \begin_layout Plain Layout
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15564 ] The indent of the very first line of a paragraph.
15566 \begin_inset Newline newline
15570 \begin_inset Flex Code
15573 \begin_layout Plain Layout
15579 will be fixed for a certain style.
15580 The exception is the default style, since the indentation for these paragraphs
15581 can be prohibited with
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15593 \begin_inset Flex Code
15596 \begin_layout Plain Layout
15602 style paragraphs inside environments use the
15603 \begin_inset Flex Code
15606 \begin_layout Plain Layout
15612 of the environment, not their native one.
15614 \begin_inset Flex Code
15617 \begin_layout Plain Layout
15623 paragraphs inside an enumeration are not indented.
15626 \begin_layout Description
15627 \begin_inset Flex Code
15630 \begin_layout Plain Layout
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15646 ] The vertical space between two paragraphs of this style.
15649 \begin_layout Description
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15660 \begin_inset Flex Code
15663 \begin_layout Plain Layout
15670 allows the user to choose either
15671 \begin_inset Quotes eld
15675 \begin_inset Quotes erd
15679 \begin_inset Quotes eld
15683 \begin_inset Quotes erd
15686 to separate paragraphs.
15688 \begin_inset Quotes eld
15692 \begin_inset Quotes erd
15696 \begin_inset Flex Code
15699 \begin_layout Plain Layout
15707 \begin_inset Quotes eld
15711 \begin_inset Quotes erd
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15724 is ignored and all paragraphs are separated by the
15725 \begin_inset Flex Code
15728 \begin_layout Plain Layout
15735 The vertical space is calculated with
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15741 \begin_inset space ~
15750 \begin_inset Flex Code
15753 \begin_layout Plain Layout
15759 is the height of a row with the normal font.
15760 This way, the look stays the same with different screen fonts.
15763 \begin_layout Description
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15786 \begin_inset space \thinspace{}
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15799 ] Whether the contents of this paragraph should be output in raw form, meaning
15800 without special translations that \SpecialChar LaTeX
15804 \begin_layout Description
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15828 Defines individual characters that should be output in raw form, meaning
15829 without special translations that \SpecialChar LaTeX
15833 \begin_layout Description
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15843 Information to be included in the \SpecialChar LaTeX
15844 preamble when this style is used.
15845 Used to define macros, load packages, etc., required by this particular
15848 \begin_inset Quotes eld
15852 \begin_inset Flex Code
15855 \begin_layout Plain Layout
15862 \begin_inset Quotes erd
15868 \begin_layout Description
15869 \begin_inset Flex Code
15872 \begin_layout Plain Layout
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 ] The prefix to use when creating labels referring to paragraphs of this
15890 This allows the use of formatted references.
15893 \begin_layout Description
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15904 \begin_inset Flex Code
15907 \begin_layout Plain Layout
15913 ] Whether the style requires the feature
15914 \begin_inset Flex Code
15917 \begin_layout Plain Layout
15924 \begin_inset CommandInset ref
15926 reference "chap:List-of-functions"
15930 for the list of features).
15931 If you require a package with specific options, you can additionally use
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15942 as a general text class parameter (see
15943 \begin_inset CommandInset ref
15945 reference "subsec:General-text-class"
15952 \begin_layout Description
15953 \begin_inset Flex Code
15956 \begin_layout Plain Layout
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15984 ] Resets the \SpecialChar LaTeX
15985 arguments of this style (as defined via the
15986 \begin_inset Flex Code
15989 \begin_layout Plain Layout
15996 This is useful if you have copied a style via
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16006 , but you do not want to inherit its (required and optional) arguments.
16009 \begin_layout Description
16010 \begin_inset Flex Code
16013 \begin_layout Plain Layout
16020 \begin_inset Flex Code
16023 \begin_layout Plain Layout
16032 \begin_inset Flex Code
16035 \begin_layout Plain Layout
16041 ] Resumes a counter that is usually reset at each new sequence of layouts.
16042 This is currently only useful when
16043 \begin_inset Flex Code
16046 \begin_layout Plain Layout
16053 \begin_inset Flex Code
16056 \begin_layout Plain Layout
16065 \begin_layout Description
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16085 ] A string that is put at the end of the layout content.
16086 A line break in the output can be indicated by
16087 \begin_inset Flex Code
16090 \begin_layout Plain Layout
16099 \begin_layout Description
16100 \begin_inset Flex Code
16103 \begin_layout Plain Layout
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16120 \begin_inset Flex Code
16123 \begin_layout Plain Layout
16132 \begin_layout Description
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16143 \begin_inset Flex Code
16146 \begin_layout Plain Layout
16155 \begin_inset Flex Code
16158 \begin_layout Plain Layout
16165 \begin_inset Flex Code
16168 \begin_layout Plain Layout
16175 \begin_inset Flex Code
16178 \begin_layout Plain Layout
16180 \begin_inset space ~
16188 ] This defines what the default spacing should be in the style.
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16200 \begin_inset Flex Code
16203 \begin_layout Plain Layout
16210 \begin_inset Flex Code
16213 \begin_layout Plain Layout
16219 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16220 If you specify the argument
16221 \begin_inset Flex Code
16224 \begin_layout Plain Layout
16230 , then you must also provide a value argument which will be the actual multiplie
16232 Note that, contrary to other parameters,
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 implies the generation of specific \SpecialChar LaTeX
16243 code, using the \SpecialChar LaTeX
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16259 \begin_layout Description
16260 \begin_inset Flex Code
16263 \begin_layout Plain Layout
16270 \begin_inset Flex Code
16273 \begin_layout Plain Layout
16280 \begin_inset space \thinspace{}
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16295 ] Allow spell-checking paragraphs of this style.
16299 \begin_layout Description
16300 \begin_inset Flex Code
16303 \begin_layout Plain Layout
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16322 \begin_inset Flex Code
16325 \begin_layout Plain Layout
16331 ] Steps the master counter of a given counter at the beginning of a new
16332 sequence of layouts.
16333 This is currently only useful when
16334 \begin_inset Flex Code
16337 \begin_layout Plain Layout
16344 \begin_inset Flex Code
16347 \begin_layout Plain Layout
16356 \begin_layout Description
16357 \begin_inset Flex Code
16360 \begin_layout Plain Layout
16366 The font used for the text body .
16368 \begin_inset CommandInset ref
16370 reference "subsec:Font-description"
16377 \begin_layout Description
16378 \begin_inset Flex Code
16381 \begin_layout Plain Layout
16390 \begin_inset Flex Code
16393 \begin_layout Plain Layout
16403 The level of the style in the table of contents.
16404 This is used for automatic numbering of section headings.
16407 \begin_layout Description
16408 \begin_inset Flex Code
16411 \begin_layout Plain Layout
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16434 \begin_inset Flex Code
16437 \begin_layout Plain Layout
16444 \begin_inset Flex Code
16447 \begin_layout Plain Layout
16453 ] This tag determines whether the first line indentation of this paragraph
16454 can be toggled via the Paragraph settings dialog.
16458 \begin_inset Flex Code
16461 \begin_layout Plain Layout
16471 is set, indentation can be toggled if the document settings use
16472 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16479 paragraph style, with
16480 \begin_inset Flex Code
16483 \begin_layout Plain Layout
16489 , indentation can always be toggled, notwithstanding the document settings,
16491 \begin_inset Flex Code
16494 \begin_layout Plain Layout
16500 , indentation can never be toggled.
16503 \begin_layout Description
16504 \begin_inset Flex Code
16507 \begin_layout Plain Layout
16514 \begin_inset Flex Code
16517 \begin_layout Plain Layout
16523 ] The vertical space with which the very first of a chain of paragraphs
16524 with this style is separated from the previous paragraph.
16525 If the previous paragraph has another style, the separations are not simply
16526 added, but the maximum is taken.
16529 \begin_layout Subsection
16530 \begin_inset CommandInset label
16536 Internationalization of Paragraph Styles
16539 \begin_layout Standard
16541 has long supported internationalization of layout information, but, until
16542 version 2.0, this applied only to the user interface and not to, say, PDF
16544 Thus, French authors were forced to resort to ugly hacks if they wanted
16549 1' instead of `Theorem 1'.
16550 Thanks to Georg Baum, that is no longer the case.
16553 \begin_layout Standard
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16564 defines text that is to appear in the typeset document, it may use
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16584 to support non-English and even multi-language documents correctly.
16585 The following excerpt (from the
16586 \begin_inset Flex Code
16589 \begin_layout Plain Layout
16595 file) shows how this works:
16598 \begin_layout LyX-Code
16603 \begin_layout LyX-Code
16606 theoremstyle{remark}
16609 \begin_layout LyX-Code
16612 newtheorem{claim}[thm]{
16619 \begin_layout LyX-Code
16623 \begin_layout LyX-Code
16627 \begin_layout LyX-Code
16632 claimname}{_(Claim)}
16635 \begin_layout LyX-Code
16639 \begin_layout LyX-Code
16643 \begin_layout LyX-Code
16652 claimname}{_(Claim)}}
16655 \begin_layout LyX-Code
16660 \begin_layout Standard
16661 In principle, any legal \SpecialChar LaTeX
16663 \begin_inset Flex Code
16666 \begin_layout Plain Layout
16673 \begin_inset Flex Code
16676 \begin_layout Plain Layout
16682 tags, but in practice they will typically look as they do here.
16683 The key to correct translation of the typeset text is the definition of
16684 the \SpecialChar LaTeX
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16698 \begin_inset Flex Code
16701 \begin_layout Plain Layout
16713 \begin_layout Standard
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16724 tag provides for internationalization based upon the overall language of
16726 The contents of the tag will be included in the preamble, just as with
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16738 What makes it special is the use of the
16739 \begin_inset Quotes eld
16743 \begin_inset Quotes erd
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16756 , which will be replaced, when \SpecialChar LyX
16757 produces \SpecialChar LaTeX
16758 output, with the translation of
16759 its argument into the document language.
16762 \begin_layout Standard
16764 \begin_inset Flex Code
16767 \begin_layout Plain Layout
16773 tag is more complex, since it is meant to provide support for multi-language
16774 documents and so offers an interface to the
16775 \begin_inset Flex Code
16778 \begin_layout Plain Layout
16785 Its contents will be added to the preamble once for each language that
16786 appears in the document.
16787 In this case, the argument to
16788 \begin_inset Flex Code
16791 \begin_layout Plain Layout
16797 will be replaced with its translation into the language in question; the
16799 \begin_inset Flex Code
16802 \begin_layout Plain Layout
16808 is replaced by the language name (as used by the babel package).
16811 \begin_layout Standard
16812 A German document that also included a French section would thus have the
16813 following in the preamble:
16816 \begin_layout LyX-Code
16825 claimname}{Affirmation}}
16826 \begin_inset Newline newline
16837 claimname}{Behauptung}}
16838 \begin_inset Newline newline
16845 claimname}{Behauptung}
16848 \begin_layout Standard
16851 \begin_inset Flex Code
16854 \begin_layout Plain Layout
16860 will then conspire to produce the correct text in the output.
16863 \begin_layout Standard
16864 One important point to note here is that the translations are provided by
16866 itself, through the file
16867 \begin_inset Flex Code
16870 \begin_layout Plain Layout
16877 This means, in effect, that
16878 \begin_inset Flex Code
16881 \begin_layout Plain Layout
16888 \begin_inset Flex Code
16891 \begin_layout Plain Layout
16897 are really only of use in layout files that are provided with \SpecialChar LyX
16899 entered in user-created layout files will not be seen by \SpecialChar LyX
16900 's internationalizatio
16901 n routines unless the
16902 \begin_inset Flex Code
16905 \begin_layout Plain Layout
16911 file is modified accordingly.
16912 That said, however, any layout created with the intention that it will
16913 be included with \SpecialChar LyX
16914 should use these tags where appropriate.
16915 Please note that the paragraph style translations provided by \SpecialChar LyX
16917 change with a minor update (e.
16918 \begin_inset space \thinspace{}
16922 \begin_inset space \space{}
16925 from version 2.1.x to 2.1.y).
16926 It is however quite likely that a major update (e.
16927 \begin_inset space \thinspace{}
16931 \begin_inset space \space{}
16934 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16937 \begin_layout Subsection
16939 \begin_inset CommandInset label
16941 name "subsec:Floats"
16948 \begin_layout Standard
16949 It is necessary to define the floats (
16950 \begin_inset Flex Noun
16953 \begin_layout Plain Layout
16960 \begin_inset Flex Noun
16963 \begin_layout Plain Layout
16969 , \SpecialChar ldots
16970 ) in the text class itself.
16971 Standard floats are included in the file
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16981 , so you may have to do no more than add
16984 \begin_layout LyX-Code
16985 Input stdfloats.inc
16988 \begin_layout Standard
16989 to your layout file.
16990 If you want to implement a text class that proposes some other float types
16991 (like the AGU class bundled with \SpecialChar LyX
16992 ), the information below will hopefully
16996 \begin_layout Description
16997 \begin_inset Flex Code
17000 \begin_layout Plain Layout
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17016 =!htbpH] Allowed placement options for this float type.
17017 The value is a string of placement characters.
17018 Possible characters include:
17023 \begin_inset Quotes eld
17027 \begin_inset Quotes erd
17035 \begin_inset Quotes eld
17039 \begin_inset Quotes erd
17047 \begin_inset Quotes eld
17051 \begin_inset Quotes erd
17059 \begin_inset Quotes eld
17063 \begin_inset Quotes erd
17071 \begin_inset Quotes eld
17075 \begin_inset Quotes erd
17083 \begin_inset Quotes eld
17087 \begin_inset Quotes erd
17091 The order of the characters in the string does not matter.
17092 If no placement options are allowed, use the string
17099 \begin_layout Description
17100 \begin_inset Flex Code
17103 \begin_layout Plain Layout
17110 \begin_inset Flex Code
17113 \begin_layout Plain Layout
17122 \begin_inset space \thinspace{}
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17141 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 if the float does not support this feature.
17160 \begin_layout Description
17161 \begin_inset Flex Code
17164 \begin_layout Plain Layout
17171 \begin_inset Flex Code
17174 \begin_layout Plain Layout
17183 \begin_inset space \thinspace{}
17189 \begin_inset Flex Code
17192 \begin_layout Plain Layout
17202 ] Defines whether the float has a starred variant that spans columns in
17203 a two column paragraph.
17205 \begin_inset Flex Code
17208 \begin_layout Plain Layout
17214 if the float does not support this feature.
17217 \begin_layout Description
17218 \begin_inset Flex Code
17221 \begin_layout Plain Layout
17228 \begin_inset Flex Code
17231 \begin_layout Plain Layout
17238 \begin_inset Quotes erd
17242 \begin_inset Quotes erd
17245 ] The file name extension of an auxiliary file for the list of figures (or
17248 writes the captions to this file.
17251 \begin_layout Description
17252 \begin_inset Flex Code
17255 \begin_layout Plain Layout
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17272 \begin_inset Quotes erd
17276 \begin_inset Quotes erd
17279 ] The string that will be used in the menus and also for the caption.
17280 This is translated to the current language if babel is used.
17283 \begin_layout Description
17284 \begin_inset Flex Code
17287 \begin_layout Plain Layout
17293 These tags control the XHTML output.
17295 \begin_inset CommandInset ref
17297 reference "sec:Tags-for-XHTML"
17304 \begin_layout Description
17305 \begin_inset Flex Code
17308 \begin_layout Plain Layout
17317 \begin_inset Flex Code
17320 \begin_layout Plain Layout
17329 \begin_inset space \thinspace{}
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17342 ] Indicates whether the float is already defined in the document class or
17343 if instead the \SpecialChar LaTeX
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17354 needs to be loaded to define it on-the-fly.
17356 \begin_inset Flex Code
17359 \begin_layout Plain Layout
17366 \begin_inset Flex Code
17369 \begin_layout Plain Layout
17376 It should be set to
17377 \begin_inset Flex Code
17380 \begin_layout Plain Layout
17386 if the float is already defined by the \SpecialChar LaTeX
17390 \begin_layout Description
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17401 \begin_inset Flex Code
17404 \begin_layout Plain Layout
17411 \begin_inset Quotes erd
17415 \begin_inset Quotes erd
17418 ] The command used to generate a list of floats of this type; the leading
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17436 is false, since there is no standard way to generate this command.
17438 \begin_inset Flex Code
17441 \begin_layout Plain Layout
17447 is true, since in that case there is a standard way to define the command.
17450 \begin_layout Description
17451 \begin_inset Flex Code
17454 \begin_layout Plain Layout
17461 \begin_inset Flex Code
17464 \begin_layout Plain Layout
17471 \begin_inset Quotes erd
17475 \begin_inset Quotes erd
17478 ] A title for a list of floats of this kind (list of figures, tables, or
17480 It is used for the screen label within \SpecialChar LyX
17481 , it is used by \SpecialChar LaTeX
17483 it is used as the title in the XHTML output.
17484 It will be translated to the document language.
17487 \begin_layout Description
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17508 \begin_inset Quotes erd
17512 \begin_inset Quotes erd
17515 ] This (optional) argument determines whether floats of this class will
17516 be numbered within some sectional unit of the document.
17518 \begin_inset Flex Code
17521 \begin_layout Plain Layout
17528 \begin_inset Quotes eld
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17542 \begin_inset Quotes erd
17545 , the floats will be numbered within chapters.
17549 \begin_layout Description
17550 \begin_inset Flex Code
17553 \begin_layout Plain Layout
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17570 \begin_inset Quotes erd
17574 \begin_inset Quotes erd
17577 ] The default placement for the given class of floats.
17578 The string should be as in standard \SpecialChar LaTeX
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17619 for top, bottom, page, and here, respectively.
17623 \begin_layout Plain Layout
17624 Note that the order of these letters in the string is irrelevant, like in
17631 On top of that there is a new type,
17632 \begin_inset Flex Code
17635 \begin_layout Plain Layout
17641 , which does not really correspond to a float, since it means: put it
17642 \begin_inset Quotes eld
17646 \begin_inset Quotes erd
17650 Note however that the
17651 \begin_inset Flex Code
17654 \begin_layout Plain Layout
17660 specifier is special and, because of implementation details, cannot be
17661 used in non-built in float types.
17662 If you do not understand what this means, just use
17663 \begin_inset Quotes eld
17667 \begin_inset Flex Code
17670 \begin_layout Plain Layout
17677 \begin_inset Quotes erd
17683 \begin_layout Description
17684 \begin_inset Flex Code
17687 \begin_layout Plain Layout
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17703 ] The prefix to use when creating labels referring to floats of this type.
17704 This allows the use of formatted references.
17705 Note that you can remove any
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17715 set by a copied style by using the special value
17716 \begin_inset Quotes eld
17720 \begin_inset Quotes erd
17723 , which must be all caps.
17726 \begin_layout Description
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17747 \begin_inset Quotes erd
17751 \begin_inset Quotes erd
17754 ] The style used when defining the float using
17755 \begin_inset Flex Code
17758 \begin_layout Plain Layout
17769 \begin_layout Description
17770 \begin_inset Flex Code
17773 \begin_layout Plain Layout
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Quotes erd
17794 \begin_inset Quotes erd
17798 \begin_inset Quotes eld
17802 \begin_inset Quotes erd
17805 of the new class of floats, like program or algorithm.
17806 After the appropriate
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17845 \begin_layout Description
17846 \begin_inset Flex Code
17849 \begin_layout Plain Layout
17856 \begin_inset Flex Code
17859 \begin_layout Plain Layout
17866 \begin_inset space \thinspace{}
17870 \begin_inset Flex Code
17873 \begin_layout Plain Layout
17881 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17892 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17896 \begin_layout Standard
17897 Note that defining a float with type
17898 \begin_inset Flex Code
17901 \begin_layout Plain Layout
17909 automatically defines the corresponding counter with name
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17924 \begin_layout Subsection
17925 Flex insets and InsetLayout
17926 \begin_inset CommandInset label
17928 name "subsec:Flex-insets-and"
17935 \begin_layout Standard
17936 Flex insets come in three different kinds:
17939 \begin_layout Itemize
17941 \begin_inset Flex Code
17944 \begin_layout Plain Layout
17950 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17952 \begin_inset Flex Code
17955 \begin_layout Plain Layout
17964 \begin_inset Flex Code
17967 \begin_layout Plain Layout
17978 \begin_layout Itemize
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17989 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17991 footnote, and the like.
17992 An obvious example is an endnote inset, which is defined in the
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
18005 \begin_layout Itemize
18007 \begin_inset Flex Code
18010 \begin_layout Plain Layout
18016 ): For use with DocBook classes.
18019 \begin_layout Standard
18020 Flex insets are defined using the
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18030 tag, which shall be explained in a moment.
18033 \begin_layout Standard
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18044 tag also serves another function: It can be used to customize the general
18045 layout of many different types of insets.
18047 \begin_inset Flex Code
18050 \begin_layout Plain Layout
18056 can be used to customize the layout parameters for footnotes, marginal
18057 notes, note insets, \SpecialChar TeX
18058 code (ERT) insets, branches, listings, indexes, boxes,
18059 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18062 \begin_layout Standard
18064 \begin_inset Flex Code
18067 \begin_layout Plain Layout
18073 definition must begin with a line of the form:
18076 \begin_layout LyX-Code
18080 \begin_layout Standard
18082 \begin_inset Flex Code
18085 \begin_layout Plain Layout
18091 indicates the inset whose layout is being defined, and here there are four
18095 \begin_layout Enumerate
18096 The layout for a pre-existing inset is being modified.
18097 In this case, can be
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18107 any one of the following:
18108 \begin_inset Flex Code
18111 \begin_layout Plain Layout
18118 \begin_inset Flex Code
18121 \begin_layout Plain Layout
18128 \begin_inset Flex Code
18131 \begin_layout Plain Layout
18138 \begin_inset Flex Code
18141 \begin_layout Plain Layout
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18158 \begin_inset Flex Code
18161 \begin_layout Plain Layout
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18178 \begin_inset Flex Code
18181 \begin_layout Plain Layout
18188 \begin_inset Flex Code
18191 \begin_layout Plain Layout
18198 \begin_inset Flex Code
18201 \begin_layout Plain Layout
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18228 \begin_inset Flex Code
18231 \begin_layout Plain Layout
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18248 \begin_inset Flex Code
18251 \begin_layout Plain Layout
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18288 \begin_inset Flex Code
18291 \begin_layout Plain Layout
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18310 \begin_layout Enumerate
18311 The layout for a Flex inset is being defined.
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18322 must be of the form
18323 \begin_inset Quotes eld
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18337 \begin_inset Quotes erd
18341 \begin_inset Flex Code
18344 \begin_layout Plain Layout
18350 may be be any valid identifier not used by a pre-existing Flex inset.
18351 The identifier may include spaces, but in that case the whole thing must
18352 be wrapped in quotes.
18353 Note that the definition of a flex inset
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18367 entry, declaring which type of inset it defines.
18370 \begin_layout Enumerate
18371 The layout for user specific branch is being defined.
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18382 must be of the form
18383 \begin_inset Quotes eld
18387 \begin_inset Flex Code
18390 \begin_layout Plain Layout
18397 \begin_inset Quotes erd
18401 \begin_inset Flex Code
18404 \begin_layout Plain Layout
18410 may be be any valid identifier of branch defined in user's document.
18411 The identifier may include spaces, but in that case the whole thing must
18412 be wrapped in quotes.
18413 The main purpose of this feature is to allow \SpecialChar LaTeX
18414 wrapping around specific
18415 branches as user needs.
18418 \begin_layout Enumerate
18419 The layout of a user (or class) specific caption is being defined.
18421 \begin_inset Flex Code
18424 \begin_layout Plain Layout
18430 must be of the form
18431 \begin_inset Quotes eld
18435 \begin_inset Flex Code
18438 \begin_layout Plain Layout
18445 \begin_inset Quotes erd
18449 \begin_inset Flex Code
18452 \begin_layout Plain Layout
18458 specifies the name of the caption as it appears in the menu.
18459 Have a look at the standard caption (
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18469 ), the specific captions of the KOMA-Script classes (
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18492 \begin_inset space ~
18496 \begin_inset Newline linebreak
18502 \begin_inset Flex Code
18505 \begin_layout Plain Layout
18511 ) for applications.
18514 \begin_layout Standard
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18525 definition can contain the following entries:
18528 \begin_layout Description
18529 \begin_inset Flex Code
18532 \begin_layout Plain Layout
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18548 =""] This inset will appear in the table of contents of the given type.
18549 An empty string disables.
18550 See also the OutlinerName and the IsTocCaption commands.
18551 This is only implemented for Flex insets.
18555 \begin_layout Description
18556 \begin_inset Flex Code
18559 \begin_layout Plain Layout
18566 \begin_inset Flex Code
18569 \begin_layout Plain Layout
18575 ] Defines argument number of a command\SpecialChar breakableslash
18576 environment associated with the current
18578 The definition must end with
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18590 \begin_inset CommandInset ref
18592 reference "subsec:Paragraph-Styles"
18599 \begin_layout Description
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18609 Preamble for changing language commands; see
18610 \begin_inset CommandInset ref
18612 reference "subsec:I18n"
18619 \begin_layout Description
18620 \begin_inset Flex Code
18623 \begin_layout Plain Layout
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18639 ] The color for the inset's background.
18641 \begin_inset CommandInset ref
18643 reference "chap:Names-of-colors"
18647 for a list of the available color names.
18650 \begin_layout Description
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18661 \begin_inset Flex Code
18664 \begin_layout Plain Layout
18673 \begin_inset space \thinspace{}
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18686 ] Whether to use the content of the inset as the label, when the inset is
18691 \begin_layout Description
18692 \begin_inset Flex Code
18695 \begin_layout Plain Layout
18702 \begin_inset Flex Code
18705 \begin_layout Plain Layout
18711 ] As with paragraph styles, see
18712 \begin_inset CommandInset ref
18714 reference "subsec:Paragraph-Styles"
18719 Note that you need to specify the complete type, e.
18720 \begin_inset space \thinspace{}
18724 \begin_inset space ~
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18732 CopyStyle Flex:<name>
18740 \begin_layout Description
18741 \begin_inset Flex Code
18744 \begin_layout Plain Layout
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18763 \begin_inset space \thinspace{}
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18776 ] Indicates whether the user may employ the Paragraph Settings dialog to
18777 customize the paragraph.
18780 \begin_layout Description
18781 \begin_inset Flex Code
18784 \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 \begin_inset Flex Code
18814 \begin_layout Plain Layout
18820 , describing the rendering style used for the inset's frame and buttons.
18821 Footnotes generally use
18822 \begin_inset Flex Code
18825 \begin_layout Plain Layout
18831 , ERT insets generally
18832 \begin_inset Flex Code
18835 \begin_layout Plain Layout
18841 , and character styles
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18854 \begin_layout Description
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18877 \begin_inset space \thinspace{}
18883 \begin_inset Flex Code
18886 \begin_layout Plain Layout
18895 \begin_inset Flex Code
18898 \begin_layout Plain Layout
18905 \begin_inset Flex Code
18908 \begin_layout Plain Layout
18915 Indicates whether the environment will stand on its own in the output or
18916 will appear inline with the surrounding text.
18917 If set to false, it is supposed that the \SpecialChar LaTeX
18918 environment ignores white space
18919 (including one newline character) after the
18920 \begin_inset Flex Code
18923 \begin_layout Plain Layout
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18953 \change_inserted 731793113 1538674858
18957 \begin_layout Description
18959 \change_inserted 731793113 1538674891
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18965 \change_inserted 731793113 1538674863
18977 ,1] Allow the contents of the inset to be edited externally (using whatever
18978 editor is defined for the document's output format).
18983 \begin_layout Description
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18993 Required at the end of the
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19006 \begin_layout Description
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19016 The font used for both the text body
19022 \begin_inset CommandInset ref
19024 reference "subsec:Font-description"
19029 Note that defining this font automatically defines the
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19039 to the same value, so define this first and define
19040 \begin_inset Flex Code
19043 \begin_layout Plain Layout
19049 later if you want them to be different.
19052 \begin_layout Description
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19057 FixedWidthPreambleEncoding
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19075 \begin_inset space \thinspace{}
19079 \begin_inset Flex Code
19082 \begin_layout Plain Layout
19088 ] Force a fixed width encoding for the translated contents of
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19099 \begin_inset Flex Code
19102 \begin_layout Plain Layout
19108 code generated by this layout.
19109 This is needed for special \SpecialChar LaTeX
19114 that do not work with variable width encodings such as
19119 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19120 backends such as Xe\SpecialChar TeX
19122 Lua\SpecialChar TeX
19126 \begin_layout Description
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19131 ForceLocalFontSwitch
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19149 \begin_inset space \thinspace{}
19153 \begin_inset Flex Code
19156 \begin_layout Plain Layout
19162 ] When using babel, always use a local font switch (
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19174 ), never a global one (such as
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19189 \begin_layout Description
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19212 \begin_inset space \thinspace{}
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19226 \begin_inset Quotes eld
19230 \begin_inset Quotes erd
19233 language, leading to Left-to-Right (Latin) output, e.
19234 \begin_inset space \thinspace{}
19238 \begin_inset space \space{}
19241 in \SpecialChar TeX
19246 \begin_layout Description
19247 \begin_inset Flex Code
19250 \begin_layout Plain Layout
19257 \begin_inset Flex Code
19260 \begin_layout Plain Layout
19269 \begin_inset space \thinspace{}
19273 \begin_inset Flex Code
19276 \begin_layout Plain Layout
19282 ] Force a a line break in the \SpecialChar LaTeX
19283 output before the inset starts and after
19285 This assures the inset itself is output on its own lines, for parsing purposes.
19288 \begin_layout Description
19289 \begin_inset Flex Code
19292 \begin_layout Plain Layout
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19311 \begin_inset space \thinspace{}
19315 \begin_inset Flex Code
19318 \begin_layout Plain Layout
19324 ] Indicates whether the
19325 \begin_inset Flex Code
19328 \begin_layout Plain Layout
19334 should be used or, instead, the user can change the paragraph style used
19339 \begin_layout Description
19340 \begin_inset Flex Code
19343 \begin_layout Plain Layout
19350 \begin_inset Flex Code
19353 \begin_layout Plain Layout
19362 \begin_inset space \thinspace{}
19366 \begin_inset Flex Code
19369 \begin_layout Plain Layout
19375 ] As with paragraph styles, see
19376 \begin_inset CommandInset ref
19378 reference "subsec:Paragraph-Styles"
19385 \begin_layout Description
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19395 These tags control the XHTML output.
19397 \begin_inset CommandInset ref
19399 reference "sec:Tags-for-XHTML"
19406 \begin_layout Description
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19429 \begin_inset space \thinspace{}
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19442 ] Whether to include the contents of this inset in the strings generated
19443 for the `Outline' pane for all table of contents, regardless of the AddToToc
19445 One would not, for example, want the content of a footnote in a section
19446 header to be included in the TOC displayed in the outline, but one would
19447 normally want the content of a character style displayed.
19448 Default is false: not to include.
19451 \begin_layout Description
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19474 \begin_inset space \thinspace{}
19478 \begin_inset Flex Code
19481 \begin_layout Plain Layout
19487 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19488 of its contents in its item in the table of contents.
19489 Otherwise, only the label appears.
19492 \begin_layout Description
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19517 \begin_inset space \thinspace{}
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19530 ] As with paragraph styles, see
19531 \begin_inset CommandInset ref
19533 reference "subsec:Paragraph-Styles"
19540 \begin_layout Description
19541 \begin_inset Flex Code
19544 \begin_layout Plain Layout
19550 The font used for the label.
19552 \begin_inset CommandInset ref
19554 reference "subsec:Font-description"
19559 Note that this definition can never appear before
19560 \begin_inset Flex Code
19563 \begin_layout Plain Layout
19569 , lest it be ineffective.
19572 \begin_layout Description
19573 \begin_inset Flex Code
19576 \begin_layout Plain Layout
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19593 \begin_inset Quotes erd
19597 \begin_inset Quotes erd
19600 ] What will be displayed on the button or elsewhere as the inset label.
19602 \begin_inset Flex Code
19605 \begin_layout Plain Layout
19613 \begin_inset Flex Code
19616 \begin_layout Plain Layout
19622 ) modify this label on the fly.
19625 \begin_layout Description
19626 \begin_inset Flex Code
19629 \begin_layout Plain Layout
19635 Language dependent preamble; see
19636 \begin_inset CommandInset ref
19638 reference "subsec:I18n"
19645 \begin_layout Description
19646 \begin_inset Flex Code
19649 \begin_layout Plain Layout
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19665 ] The name of the corresponding \SpecialChar LaTeX
19667 Either the environment or command name.
19670 \begin_layout Description
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19681 \begin_inset Flex Code
19684 \begin_layout Plain Layout
19690 ] The optional parameter for the corresponding
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19700 stuff, including possible bracket pairs like
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19711 This parameter cannot be changed from within \SpecialChar LyX
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19722 for customizable parameters).
19723 It will be output as is after all \SpecialChar LaTeX
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19737 \begin_layout Description
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19752 Command, Environment, None
19757 ] How the style should be translated into \SpecialChar LaTeX
19762 \begin_layout Plain Layout
19763 \begin_inset Flex Code
19766 \begin_layout Plain Layout
19772 is perhaps a bit misleading, since these rules apply to SGML classes too.
19773 Visit the SGML class files for specific examples.
19782 \begin_layout Description
19783 \begin_inset Flex Code
19786 \begin_layout Plain Layout
19792 means nothing special
19795 \begin_layout Description
19796 \begin_inset Flex Code
19799 \begin_layout Plain Layout
19806 \begin_inset Flex Code
19809 \begin_layout Plain Layout
19816 {\SpecialChar ldots
19825 \begin_layout Description
19826 \begin_inset Flex Code
19829 \begin_layout Plain Layout
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19846 }\SpecialChar ldots
19861 \begin_layout Standard
19862 Putting the last few things together, the \SpecialChar LaTeX
19863 output will be either:
19866 \begin_layout LyX-Code
19869 LatexName[LatexParam]{\SpecialChar ldots
19873 \begin_layout Standard
19877 \begin_layout LyX-Code
19880 begin{LatexName}[LatexParam] \SpecialChar ldots
19886 \begin_layout Standard
19887 depending upon the \SpecialChar LaTeX
19892 \begin_layout Description
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19903 \begin_inset Flex Code
19906 \begin_layout Plain Layout
19912 ] A string that is put at the beginning of the layout content.
19913 A line break in the output can be indicated by
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19926 \begin_layout Description
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19937 \begin_inset Flex Code
19940 \begin_layout Plain Layout
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19976 (indicating a dummy definition ending definitions of charstyles, etc).
19977 This entry is required in and is only meaningful for Flex insets.
19978 Among other things, it determines on which menu this inset will appear.
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19999 will automatically set
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20021 \begin_inset Flex Code
20024 \begin_layout Plain Layout
20030 can be set to true, or
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20050 insets by setting it
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20067 \begin_layout Description
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20078 \begin_inset Flex Code
20081 \begin_layout Plain Layout
20090 \begin_inset space \thinspace{}
20094 \begin_inset Flex Code
20097 \begin_layout Plain Layout
20103 ] Whether multiple paragraphs are permitted in this inset.
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20114 to the same value and
20115 \begin_inset Flex Code
20118 \begin_layout Plain Layout
20124 to the opposite value.
20125 These can be reset to other values, if they are used
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20143 \begin_layout Description
20144 \begin_inset Flex Code
20147 \begin_layout Plain Layout
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20166 \begin_inset space \thinspace{}
20170 \begin_inset Flex Code
20173 \begin_layout Plain Layout
20179 ] Whether fragile commands in this inset should be
20180 \begin_inset Flex Code
20183 \begin_layout Plain Layout
20196 whether the command should itself be protected.) Default is false.
20197 \change_inserted -712698321 1523633958
20201 \begin_layout Description
20203 \change_inserted -712698321 1552395786
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20209 \change_inserted -712698321 1523633961
20216 \begin_inset Flex Code
20219 \begin_layout Plain Layout
20221 \change_inserted -712698321 1523633958
20230 \begin_inset space \thinspace{}
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20239 \change_inserted -712698321 1523633958
20245 ] This causes macros that contain this inset to be protected with
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20251 \change_inserted -712698321 1523634038
20266 ) if necessary and thus allows (some) verbatim stuff in macros.
20270 \begin_layout Description
20272 \change_inserted -712698321 1552395824
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20278 \change_inserted -712698321 1552395787
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20290 \change_inserted -712698321 1552395787
20299 \begin_inset space \thinspace{}
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20308 \change_inserted -712698321 1552395787
20314 ] Whether specific commands in this inset (such as
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20320 \change_inserted -712698321 1552395787
20329 \begin_inset Flex Code
20332 \begin_layout Plain Layout
20334 \change_inserted -712698321 1552395787
20342 ) should be protected in an
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20348 \change_inserted -712698321 1552395787
20357 This is particularly needed for insets that draw on
20365 commands which parse their content in complex ways.
20371 \begin_layout Description
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20391 ] Deletes an existing
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20404 \begin_layout Description
20405 \begin_inset Flex Code
20408 \begin_layout Plain Layout
20415 \begin_inset Flex Code
20418 \begin_layout Plain Layout
20425 \begin_inset Flex Code
20428 \begin_layout Plain Layout
20434 that has replaced this
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20445 This is used to rename an
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20455 , while keeping backward compatibility.
20458 \begin_layout Description
20459 \begin_inset Flex Code
20462 \begin_layout Plain Layout
20469 \begin_inset Flex Code
20472 \begin_layout Plain Layout
20481 \begin_inset space \thinspace{}
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20494 ] As with paragraph styles, see
20495 \begin_inset CommandInset ref
20497 reference "subsec:Paragraph-Styles"
20505 \begin_layout Description
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20528 \begin_inset space \thinspace{}
20532 \begin_inset Flex Code
20535 \begin_layout Plain Layout
20541 ] As with paragraph styles, see
20542 \begin_inset CommandInset ref
20544 reference "subsec:Paragraph-Styles"
20552 \begin_layout Description
20553 \begin_inset Flex Code
20556 \begin_layout Plain Layout
20562 As with paragraph styles, see
20563 \begin_inset CommandInset ref
20565 reference "subsec:Paragraph-Styles"
20572 \begin_layout Description
20573 \begin_inset Flex Code
20576 \begin_layout Plain Layout
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20592 ] The prefix to use when creating labels referring to insets of this type.
20593 This allows the use of formatted references.
20596 \begin_layout Description
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20607 \begin_inset Flex Code
20610 \begin_layout Plain Layout
20616 ] As with paragraph styles, see
20617 \begin_inset CommandInset ref
20619 reference "subsec:Paragraph-Styles"
20626 \begin_layout Description
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20649 \begin_inset space \thinspace{}
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 ] Resets the \SpecialChar LaTeX
20663 arguments of this layout (as defined via the
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20674 This is useful if you have copied a style via
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20684 , but you do not want to inherit its (required and optional) arguments.
20687 \begin_layout Description
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 \begin_inset space \thinspace{}
20712 \begin_inset Flex Code
20715 \begin_layout Plain Layout
20723 ] Whether this inset should use the font of its surrounding environment
20725 Default is false: use the font of the surrounding environment.
20728 \begin_layout Description
20729 \begin_inset Flex Code
20732 \begin_layout Plain Layout
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20748 ] A string that is put at the end of the layout content.
20749 A line break in the output can be indicated by
20750 \begin_inset Flex Code
20753 \begin_layout Plain Layout
20762 \begin_layout Description
20763 \begin_inset Flex Code
20766 \begin_layout Plain Layout
20773 \begin_inset Flex Code
20776 \begin_layout Plain Layout
20783 \begin_inset space \thinspace{}
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20798 ] Allow spell-checking the contents of this inset.
20802 \begin_layout Subsection
20804 \begin_inset CommandInset label
20806 name "subsec:Counters"
20813 \begin_layout Standard
20814 It is necessary to define the counters (
20815 \begin_inset Flex Noun
20818 \begin_layout Plain Layout
20825 \begin_inset Flex Noun
20828 \begin_layout Plain Layout
20834 , \SpecialChar ldots
20835 ) in the text class itself.
20836 The standard counters are defined in the file
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20846 , so you may have to do no more than add
20849 \begin_layout LyX-Code
20850 Input stdcounters.inc
20853 \begin_layout Standard
20854 to your layout file to get them to work.
20855 But if you want to define custom counters, then you can do so.
20856 The counter declaration must begin with:
20859 \begin_layout LyX-Code
20860 Counter CounterName
20863 \begin_layout Standard
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20874 ' is replaced by the name of the counter.
20875 And it must end with
20876 \begin_inset Quotes eld
20880 \begin_inset Flex Code
20883 \begin_layout Plain Layout
20890 \begin_inset Quotes erd
20894 The following parameters can also be used:
20897 \begin_layout Description
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20908 \begin_inset Flex Code
20911 \begin_layout Plain Layout
20917 ] Sets the initial value for the counter, to which it will be reset whenever
20919 Normally, one will want the default, 1.
20922 \begin_layout Description
20923 \begin_inset Flex Code
20926 \begin_layout Plain Layout
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20943 \begin_inset Quotes erd
20947 \begin_inset Quotes erd
20950 ] When defined, this string defines how the counter is displayed.
20951 Setting this value sets
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20956 LabelStringAppendix
20962 The following special constructs can be used in the string:
20966 \begin_layout Itemize
20967 \begin_inset Flex Code
20970 \begin_layout Plain Layout
20978 will be replaced by the expansion of the
20979 \begin_inset Flex Code
20982 \begin_layout Plain Layout
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20993 LabelStringAppendix
20999 \begin_inset Flex Code
21002 \begin_layout Plain Layout
21012 \begin_layout Itemize
21013 counter values can be expressed using \SpecialChar LaTeX
21015 \begin_inset Newline newline
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21054 \begin_layout Plain Layout
21064 Actually, the situation is a bit more complicated: any
21083 other than those described below will produce arabic numerals.
21084 It would not be surprising to see this change in the future.
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21099 : 1, 2, 3,\SpecialChar ldots
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21110 for lower-case letters: a, b, c, \SpecialChar ldots
21112 \begin_inset Flex Code
21115 \begin_layout Plain Layout
21121 for upper-case letters: A, B, C, \SpecialChar ldots
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21132 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21143 for upper-case roman numerals: I, II, III\SpecialChar ldots
21145 \begin_inset Flex Code
21148 \begin_layout Plain Layout
21154 for hebrew numerals.
21158 \begin_layout Standard
21159 If LabelString is not defined, a default value is constructed as follows:
21160 if the counter has a master counter
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21181 \begin_inset Newline newline
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21198 is used; otherwise the string
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21213 \begin_layout Description
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21218 LabelStringAppendix
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21234 \begin_inset Quotes erd
21238 \begin_inset Quotes erd
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21251 , but for use in the Appendix.
21254 \begin_layout Description
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21275 \begin_inset Quotes erd
21279 \begin_inset Quotes erd
21282 ] A format for use with formatted references to this counter.
21283 For example, one might want to have references to section numbers appear
21285 \begin_inset Quotes eld
21289 \begin_inset Quotes erd
21293 The string should contain
21294 \begin_inset Quotes eld
21298 \begin_inset Quotes erd
21302 This will be replaced by the counter number itself.
21303 So, for sections, it would be: Section ##.
21306 \begin_layout Description
21307 \begin_inset Flex Code
21310 \begin_layout Plain Layout
21317 \begin_inset Flex Code
21320 \begin_layout Plain Layout
21327 \begin_inset Quotes erd
21331 \begin_inset Quotes erd
21334 ] If this is set to the name of another counter, the present counter will
21335 be reset every time the other one is increased.
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21359 \begin_layout Subsection
21361 \begin_inset CommandInset label
21363 name "subsec:Font-description"
21370 \begin_layout Standard
21371 A font description looks like this:
21374 \begin_layout LyX-Code
21391 \begin_layout LyX-Code
21395 \begin_layout LyX-Code
21399 \begin_layout Standard
21400 The following commands are available:
21403 \begin_layout Description
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21446 \begin_inset Flex Code
21449 \begin_layout Plain Layout
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21486 \begin_inset Flex Code
21489 \begin_layout Plain Layout
21496 \begin_inset Flex Code
21499 \begin_layout Plain Layout
21506 \begin_inset Flex Code
21509 \begin_layout Plain Layout
21516 \begin_inset Flex Code
21519 \begin_layout Plain Layout
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21556 \begin_inset Flex Code
21559 \begin_layout Plain Layout
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21576 \begin_inset Flex Code
21579 \begin_layout Plain Layout
21586 \begin_inset Flex Code
21589 \begin_layout Plain Layout
21596 \begin_inset Flex Code
21599 \begin_layout Plain Layout
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21618 \begin_layout Description
21619 \begin_inset Flex Code
21622 \begin_layout Plain Layout
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21641 \begin_inset Flex Code
21644 \begin_layout Plain Layout
21651 \begin_inset Flex Code
21654 \begin_layout Plain Layout
21663 \begin_layout Description
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21674 \begin_inset Flex Code
21677 \begin_layout Plain Layout
21683 ] Valid arguments are:
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21714 \begin_inset Flex Code
21717 \begin_layout Plain Layout
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
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
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21794 \begin_inset Flex Code
21797 \begin_layout Plain Layout
21804 Each of these turns on or off the corresponding attribute.
21806 \begin_inset Flex Code
21809 \begin_layout Plain Layout
21815 turns on emphasis, and
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21827 \begin_inset Newline newline
21830 If the latter seems puzzling, remember that the font settings for the present
21831 context are generally inherited from the surrounding context.
21833 \begin_inset Flex Code
21836 \begin_layout Plain Layout
21842 would turn off the emphasis that was anyway in effect, say, in a theorem
21846 \begin_layout Description
21847 \begin_inset Flex Code
21850 \begin_layout Plain Layout
21857 \begin_inset Flex Code
21860 \begin_layout Plain Layout
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21881 \begin_layout Description
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21924 \begin_inset Flex Code
21927 \begin_layout Plain Layout
21936 \begin_layout Description
21937 \begin_inset Flex Code
21940 \begin_layout Plain Layout
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21967 \begin_inset Flex Code
21970 \begin_layout Plain Layout
21979 \begin_inset Flex Code
21982 \begin_layout Plain Layout
21989 \begin_inset Flex Code
21992 \begin_layout Plain Layout
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22019 \begin_inset Flex Code
22022 \begin_layout Plain Layout
22031 \begin_layout Subsection
22032 \begin_inset CommandInset label
22034 name "subsec:Citation-engine-description"
22038 Cite engine description
22041 \begin_layout Standard
22043 \begin_inset Flex Code
22046 \begin_layout Plain Layout
22052 blocks, as used mainly in cite engine files (see
22053 \begin_inset CommandInset ref
22055 reference "subsec:Cite-Engine-Files"
22062 ), define the citation commands provided by a specific
22063 \begin_inset Quotes eld
22067 \begin_inset Quotes erd
22071 A cite engine, in \SpecialChar LyX
22072 terms, is way specific way to format citations, using
22073 numbers, author names and/or years.
22074 Currently, \SpecialChar LyX
22075 supports three such engine types, namely:
22078 \begin_layout Enumerate
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22088 : the default Bib\SpecialChar TeX
22089 way to format citations, a simple numeric style (e.
22090 \begin_inset space \thinspace{}
22094 \begin_inset Quotes eld
22098 \begin_inset Quotes erd
22104 \begin_layout Enumerate
22105 \begin_inset Flex Code
22108 \begin_layout Plain Layout
22114 : Harvard-styled citations using author names and publication year (e.
22115 \begin_inset space \thinspace{}
22119 \begin_inset Quotes eld
22122 Smith and Miller (2017b)
22123 \begin_inset Quotes erd
22129 \begin_layout Enumerate
22130 \begin_inset Flex Code
22133 \begin_layout Plain Layout
22139 : extended numerical citations that also allow for author or title next
22141 \begin_inset space \thinspace{}
22145 \begin_inset Quotes eld
22148 Smith and Miller [1]
22149 \begin_inset Quotes erd
22155 \begin_layout Standard
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22165 blocks look like this:
22168 \begin_layout LyX-Code
22172 \begin_layout LyX-Code
22176 \begin_layout LyX-Code
22180 \begin_layout LyX-Code
22181 citeyearpar[][]=parencite*
22184 \begin_layout LyX-Code
22188 \begin_layout LyX-Code
22192 \begin_layout Standard
22194 \begin_inset Flex Code
22197 \begin_layout Plain Layout
22203 denotes the engine.
22204 The individual lines respectively define a cite command or cite command
22205 paradigm supported by this engine.
22206 The line can be as simple as a cite command that is used both to name the
22207 respective \SpecialChar LyX
22208 command and the \SpecialChar LaTeX
22209 output or more complex in order to differentiate
22211 The full syntax is:
22214 \begin_layout LyX-Code
22215 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22218 \begin_layout Itemize
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22228 : The name as used in the
22229 \begin_inset Flex Code
22232 \begin_layout Plain Layout
22242 \begin_layout Standard
22243 For portability reasons, we try to use the same name for same-formatted
22244 commands in different cite packages (thus many names stem from natbib,
22245 and thus we need to differentiate a
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22255 sometimes, if the \SpecialChar LaTeX
22256 command names differ).
22260 \begin_layout Itemize
22261 \begin_inset Flex Code
22264 \begin_layout Plain Layout
22270 : a (comma-separated) list of commands that fall back to the given
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22280 in the current engine.
22281 This eases the switch of citation packages and engines.
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22293 \begin_inset Flex Code
22296 \begin_layout Plain Layout
22302 in layout definitions.
22305 \begin_layout Itemize
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22315 : The actual \SpecialChar LaTeX
22316 command that is output.
22320 \begin_layout Standard
22321 \begin_inset Flex Code
22324 \begin_layout Plain Layout
22331 \begin_inset Flex Code
22334 \begin_layout Plain Layout
22342 \begin_inset Flex Code
22345 \begin_layout Plain Layout
22352 \begin_inset Flex Code
22355 \begin_layout Plain Layout
22361 will be output to \SpecialChar LaTeX
22365 \begin_layout Standard
22369 \begin_layout Itemize
22370 Capitalization indicates that the command also has a capitalized form (
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22384 \begin_inset Flex Code
22387 \begin_layout Plain Layout
22396 These usually enforce up-casing of name prefixes (
22401 \begin_inset Formula $\Rightarrow$
22411 \begin_layout Itemize
22413 \begin_inset Flex Code
22416 \begin_layout Plain Layout
22422 indicate the number of optional arguments (there can be 0–2).
22425 \begin_layout Itemize
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22436 indicates there is a starred version of the command (
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22466 \begin_layout Standard
22467 By default, the starred version means: Output all authors even if it should
22469 \begin_inset Quotes eld
22473 \begin_inset Quotes erd
22477 \begin_inset Flex Code
22480 \begin_layout Plain Layout
22489 \begin_layout Standard
22490 If the star has a different meaning for a given command, it can be specified
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22496 <!_stardesc!_stardesctooltip>
22502 Maximal two translatable macro keywords, marked by the prefix
22503 \begin_inset Flex Code
22506 \begin_layout Plain Layout
22513 The first points to the string that replaces the
22514 \begin_inset Quotes eld
22518 \begin_inset Quotes erd
22521 checkbox label in the citation dialog, the second one to an optional tool
22522 tip for this checkbox.
22526 \begin_layout Standard
22527 Note that these two macros have to be defined in a
22528 \begin_inset Flex Code
22531 \begin_layout Plain Layout
22537 (see next section), dropping the
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22547 from the prefix, like this:
22550 \begin_layout LyX-Code
22551 _stardesc Sta&rred command label
22554 \begin_layout LyX-Code
22555 _stardesctooltip Tooltip for the starred command checkbox.
22559 \begin_layout Itemize
22561 \begin_inset Flex Code
22564 \begin_layout Plain Layout
22570 indicates that this command features
22571 \begin_inset Quotes eld
22574 qualified citation lists
22575 \begin_inset Quotes erd
22583 -specific feature for multi-reference citations where an individual pre-
22584 and postnote can be given to each reference in the list.
22585 Please refer to the
22589 manual for details.
22590 \change_inserted -712698321 1526898670
22594 \begin_layout Standard
22596 \change_inserted -712698321 1526899524
22597 If you want to add a cite command to a cite engine (e.
22598 \begin_inset space \thinspace{}
22601 g., add a specific command provided by a class), you can use
22602 \begin_inset Flex Code
22605 \begin_layout Plain Layout
22607 \change_inserted -712698321 1526898768
22608 AddToCiteEngine <engine type> \SpecialChar ldots
22617 Note that only cite commands that do not exist yet are added.
22622 \begin_layout Subsection
22623 \begin_inset CommandInset label
22625 name "subsec:Citation-format-description"
22629 Cite format description
22632 \begin_layout Standard
22634 \begin_inset Flex Code
22637 \begin_layout Plain Layout
22643 blocks are used to describe how bibliographic information should be displayed,
22644 both within \SpecialChar LyX
22645 itself (in the citation dialog and in tooltips, for example)
22646 and in XHTML output.
22647 Such a block might look like this:
22650 \begin_layout LyX-Code
22654 \begin_layout LyX-Code
22658 \begin_layout LyX-Code
22662 \begin_layout LyX-Code
22666 \begin_layout Standard
22670 \begin_layout LyX-Code
22674 \begin_layout LyX-Code
22678 \begin_layout LyX-Code
22682 \begin_layout LyX-Code
22686 \begin_layout Standard
22687 In the first case, the individual lines define how the bibliographic information
22688 associated with an article or book, respectively, is to be displayed, and
22689 such a definition can be given for any
22690 \begin_inset Quotes els
22694 \begin_inset Quotes ers
22697 that might be present in a Bib\SpecialChar TeX
22700 defines a default format in the source code that will be used if no specific
22701 definition has been given.
22703 predefines several formats in the file
22704 \begin_inset Flex Code
22707 \begin_layout Plain Layout
22713 , which is included in most of \SpecialChar LyX
22714 's document classes.
22717 \begin_layout Standard
22718 In the second case, the lines define how a specific citation command (in
22720 \begin_inset Flex Code
22723 \begin_layout Plain Layout
22732 \begin_inset Flex Code
22735 \begin_layout Plain Layout
22743 ) is to be displayed on the citation inset label, in the citation dialog,
22744 menu or XHTML output.
22746 defines such formats for the citation style variants it supports via
22748 Document\SpecialChar menuseparator
22749 Setting\SpecialChar menuseparator
22750 Bibliography\SpecialChar ldots
22754 \begin_inset Flex Code
22757 \begin_layout Plain Layout
22763 files that are shipped with \SpecialChar LyX
22765 \begin_inset CommandInset ref
22767 reference "subsec:Cite-Engine-Files"
22777 \begin_layout Standard
22778 The definitions use a simple language that allows Bib\SpecialChar TeX
22779 keys to be replaced
22781 Keys should be enclosed in
22782 \begin_inset Flex Code
22785 \begin_layout Plain Layout
22792 \begin_inset Flex Code
22795 \begin_layout Plain Layout
22802 So a simple definition might look like this:
22805 \begin_layout LyX-Code
22807 \begin_inset Quotes eld
22811 \begin_inset Quotes erd
22817 \begin_layout Standard
22818 This would print the author, followed by a comma, followed by the title,
22819 in quotes, followed by a period.
22822 \begin_layout Standard
22823 Of course, sometimes you may want to print a key only if it exists.
22824 This can be done by using a conditional construction, such as:
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22830 \begin_inset space ~
22840 \begin_inset Flex Code
22843 \begin_layout Plain Layout
22849 key exists, then print
22850 \begin_inset Quotes eld
22854 \begin_inset space ~
22858 \begin_inset Quotes erd
22861 followed by the volume key.
22862 It is also possible to have an else clause in the conditional, such as:
22863 \begin_inset Newline newline
22867 \begin_inset Flex Code
22870 \begin_layout Plain Layout
22871 {%author%[[%author%]][[%editor%, ed.]]}
22877 \begin_inset Newline newline
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22890 key is printed if it exists; otherwise, the editor key is printed, followed
22892 \begin_inset Quotes eld
22896 \begin_inset space ~
22900 \begin_inset Quotes erd
22903 Note that the key is again enclosed in
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22913 signs; the entire conditional is enclosed in braces; and the if and else
22914 clauses are enclosed in double brackets,
22915 \begin_inset Quotes eld
22919 \begin_inset Flex Code
22922 \begin_layout Plain Layout
22929 \begin_inset Quotes eld
22933 \begin_inset Quotes eld
22937 \begin_inset Flex Code
22940 \begin_layout Plain Layout
22947 \begin_inset Quotes erd
22951 There must be no space between any of these.
22954 \begin_layout Standard
22955 Next to the entry keys, there are some special keys that can be used for
22956 these conditionals:
22959 \begin_layout Itemize
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22964 {%dialog%[[true]][[false]]}
22970 \begin_inset Quotes eld
22974 \begin_inset Quotes erd
22977 part for dialogs and menus, the
22978 \begin_inset Quotes eld
22982 \begin_inset Quotes erd
22985 part for other contexts (workarea, export)
22988 \begin_layout Itemize
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22993 {%export%[[true]][[false]]}
22999 \begin_inset Quotes eld
23003 \begin_inset Quotes erd
23006 part for export and menus, the
23007 \begin_inset Quotes eld
23011 \begin_inset Quotes erd
23014 part for other contexts (workarea, dialog)
23017 \begin_layout Itemize
23018 \begin_inset Flex Code
23021 \begin_layout Plain Layout
23028 \begin_inset Quotes eld
23032 \begin_inset Quotes erd
23035 part if another item follows (e.
23036 \begin_inset space \thinspace{}
23039 g., in a citation with multiple keys)
23042 \begin_layout Itemize
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23047 {%second%[[true]][[false]]}
23053 \begin_inset Quotes eld
23057 \begin_inset Quotes erd
23060 if this is the second of multiple items, else the
23061 \begin_inset Quotes eld
23065 \begin_inset Quotes erd
23071 \begin_layout Itemize
23072 \begin_inset Flex Code
23075 \begin_layout Plain Layout
23076 {%ifstar%[[true]][[false]]}
23082 \begin_inset Quotes eld
23086 \begin_inset Quotes erd
23089 part for starred citation commands (such as
23090 \begin_inset Flex Code
23093 \begin_layout Plain Layout
23101 ), the false part for unstarred
23104 \begin_layout Itemize
23105 \begin_inset Flex Code
23108 \begin_layout Plain Layout
23109 {%ifentrytype:<type>%[[true]][[false]]}
23115 \begin_inset Quotes eld
23119 \begin_inset Quotes erd
23122 if the current entry type matches
23123 \begin_inset Flex Code
23126 \begin_layout Plain Layout
23132 , else the false part (e.g., in a citation definition:
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23137 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23145 \begin_layout Itemize
23146 \begin_inset Flex Code
23149 \begin_layout Plain Layout
23150 {%ifmultiple:<authortype>%[[true]][[false]]}
23156 \begin_inset Quotes eld
23160 \begin_inset Quotes erd
23163 if the current author type (author, editor etc.) has multiple authors, else
23164 the false part (e.g., in a bibliography definition:
23165 \begin_inset Flex Code
23168 \begin_layout Plain Layout
23169 {%ifmultiple:editor%[[eds.]][[ed.]]}
23177 \begin_layout Itemize
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23182 {%ifqualified%[[true]][[false]]}
23188 \begin_inset Quotes eld
23192 \begin_inset Quotes erd
23195 part if the current citation is a qualified citation list (a specific
23199 format for multi-reference citations), the false part if this is not the
23203 \begin_layout Standard
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23214 prints the author key as it is recorded in the bibliography file.
23215 This might not be what you want, since it will result in a string such
23217 \begin_inset Quotes eld
23220 Miller, Peter and Smith, Mary and White, Jane
23221 \begin_inset Quotes erd
23225 \begin_inset Quotes eld
23229 \begin_inset Quotes erd
23232 is used by Bib\SpecialChar TeX
23233 to delimit authors).
23235 therefore provides some methods to get properly formatted name lists (which
23236 will also get translated).
23237 The following keys are provided:
23240 \begin_layout Enumerate
23241 For name lists with pre- and surname, suitable for the main authors/editors
23242 of a bibliography item.
23244 \begin_inset Flex Code
23247 \begin_layout Plain Layout
23253 part denotes the kind of list that is requested (e.g.
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23268 \begin_layout Itemize
23269 \begin_inset Flex Code
23272 \begin_layout Plain Layout
23273 %abbrvnames:<nametype>%
23278 : Provides a name list which is abbreviated (with
23279 \begin_inset Quotes eld
23283 \begin_inset Quotes erd
23287 \begin_inset Flex Code
23290 \begin_layout Plain Layout
23299 \begin_layout Itemize
23300 \begin_inset Flex Code
23303 \begin_layout Plain Layout
23304 %fullnames:<nametype>%
23309 : Provides a full name list (never abbreviated with
23310 \begin_inset Quotes eld
23314 \begin_inset Quotes erd
23320 \begin_layout Itemize
23321 \begin_inset Flex Code
23324 \begin_layout Plain Layout
23325 %forceabbrvnames:<nametype>%
23330 : Provides a name list which is always abbreviated (with
23331 \begin_inset Quotes eld
23335 \begin_inset Quotes erd
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23352 \begin_layout Enumerate
23353 Alternative name lists with pre- and surname, if the order of pre- and surname
23354 inside the bibliography item differs (as in:
23355 \begin_inset Quotes eld
23358 Miller, John: Some text, in: Mary Smith, ed.: A volume
23359 \begin_inset Quotes erd
23366 \begin_layout Itemize
23367 \begin_inset Flex Code
23370 \begin_layout Plain Layout
23371 %abbrvbynames:<nametype>%
23376 : Provides a name list which is abbreviated (with
23377 \begin_inset Quotes eld
23381 \begin_inset Quotes erd
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23397 \begin_layout Itemize
23398 \begin_inset Flex Code
23401 \begin_layout Plain Layout
23402 %fullbynames:<nametype>%
23407 : Provides a full name list (never abbreviated with
23408 \begin_inset Quotes eld
23412 \begin_inset Quotes erd
23418 \begin_layout Itemize
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23423 %forceabbrvbynames:<nametype>%
23428 : Provides a name list which is always abbreviated (with
23429 \begin_inset Quotes eld
23433 \begin_inset Quotes erd
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23450 \begin_layout Enumerate
23451 And finally name lists which consist of family names only, as used in author-yea
23453 These do not take a
23454 \begin_inset Flex Code
23457 \begin_layout Plain Layout
23463 part, but always return either an author list or, if this does not exist,
23464 an editor list (as common in author-year labels):
23468 \begin_layout Itemize
23469 \begin_inset Flex Code
23472 \begin_layout Plain Layout
23478 : Provides a name list which is abbreviated (with
23479 \begin_inset Quotes eld
23483 \begin_inset Quotes erd
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23499 \begin_layout Itemize
23500 \begin_inset Flex Code
23503 \begin_layout Plain Layout
23509 : Provides a full name list (never abbreviated with
23510 \begin_inset Quotes eld
23514 \begin_inset Quotes erd
23520 \begin_layout Itemize
23521 \begin_inset Flex Code
23524 \begin_layout Plain Layout
23525 %forceabbrvciteauthor%
23530 : Provides a name list which is always abbreviated (with
23531 \begin_inset Quotes eld
23535 \begin_inset Quotes erd
23539 \begin_inset Flex Code
23542 \begin_layout Plain Layout
23552 \begin_layout Standard
23553 The order of pre- and surname in the former two lists can be adjusted by
23557 \begin_layout Itemize
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23562 !firstnameform %surname%, %prename%
23567 (first author in lists of type 1)
23570 \begin_layout Itemize
23571 \begin_inset Flex Code
23574 \begin_layout Plain Layout
23575 !othernameform %surname%, %prename%
23580 (other authors in lists of type 1)
23583 \begin_layout Itemize
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23588 !firstbynameform %prename% %surname%
23593 (first author in lists of type 2)
23596 \begin_layout Itemize
23597 \begin_inset Flex Code
23600 \begin_layout Plain Layout
23601 !otherbynameform %prename% %surname%
23606 (other authors in lists of type 2)
23609 \begin_layout Standard
23610 This allows you to configure namings like
23611 \begin_inset Quotes eld
23614 Miller, Peter and Mary Smith: \SpecialChar ldots
23615 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23617 \begin_inset Quotes erd
23623 \begin_layout Standard
23624 There is one other piece of syntax available in definitions, which looks
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23636 This defines a piece of formatting information that is to be used when
23638 \begin_inset Quotes eld
23642 \begin_inset Quotes erd
23646 Obviously, we do not want to output HTML tags when writing plain text,
23647 so they should be wrapped in
23648 \begin_inset Quotes eld
23652 \begin_inset Quotes erd
23656 \begin_inset Quotes eld
23660 \begin_inset Quotes erd
23666 \begin_layout Standard
23667 Two special sorts of definitions are also possible in a
23668 \begin_inset Flex Code
23671 \begin_layout Plain Layout
23678 An example of the first would be:
23681 \begin_layout LyX-Code
23683 \begin_inset Quotes eld
23687 \begin_inset Quotes erd
23693 \begin_layout Standard
23694 This is an abbreviation, or macro, and it can be used by treating it as
23696 \begin_inset Flex Code
23699 \begin_layout Plain Layout
23708 \begin_inset Flex Code
23711 \begin_layout Plain Layout
23717 exactly as it would treat its definition.
23718 So, let us issue the obvious
23726 \begin_layout LyX-Code
23730 \begin_layout Standard
23731 or anything like it.
23733 shouldn't go into an infinite loop, but it may go into a long one before
23737 \begin_layout Standard
23738 The second sort of special definition might look like this:
23741 \begin_layout LyX-Code
23745 \begin_layout Standard
23746 This defines a translatable piece of text, which allows relevant parts of
23747 the bibliography or citation to be translated.
23748 It can be included in a definition by treating it as a key:
23749 \begin_inset Flex Code
23752 \begin_layout Plain Layout
23759 Note that there are two different translation paths: All definitions starting
23761 \begin_inset Flex Code
23764 \begin_layout Plain Layout
23770 , such as in the example above, will be translated to the currently active
23771 buffer language (so the translation will match the generated document).
23772 All definitions starting with underscore only will be translated to the
23774 This is the proper translation for strings that only occur in the dialogs
23775 or on buttons, such as this one:
23778 \begin_layout LyX-Code
23779 _addtobib Add to bibliography only.
23782 \begin_layout Standard
23783 Several of these translatable strings are predefined in
23784 \begin_inset Flex Code
23787 \begin_layout Plain Layout
23794 \begin_inset Flex Code
23797 \begin_layout Plain Layout
23804 Note that these are not macros, in the sense just defined.
23805 They will not be expanded.
23808 \begin_layout Standard
23809 So here then is an example that uses several of these features:
23810 \begin_inset VSpace defskip
23816 \begin_layout Standard
23820 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23823 \begin_layout Standard
23824 \begin_inset VSpace defskip
23827 This defines a macro that prints the author, followed by a comma, if the
23829 \begin_inset Flex Code
23832 \begin_layout Plain Layout
23838 key is defined, or else prints the name of the editor, followed by the
23840 \begin_inset Flex Code
23843 \begin_layout Plain Layout
23849 or its translation (it is by default
23850 \begin_inset Quotes eld
23854 \begin_inset Quotes erd
23858 \begin_inset Flex Code
23861 \begin_layout Plain Layout
23868 Note that this is in fact defined in
23869 \begin_inset Flex Code
23872 \begin_layout Plain Layout
23878 , so you can use it in your own definitions, or re-definitions, if you load
23882 \begin_layout Section
23883 \begin_inset CommandInset label
23885 name "sec:Tags-for-XHTML"
23889 Tags for XHTML output
23892 \begin_layout Standard
23893 As with \SpecialChar LaTeX
23894 or DocBook, the format of \SpecialChar LyX
23895 's XHTML output is also controlled by
23896 layout information.
23897 In general, \SpecialChar LyX
23898 provides sensible defaults and, as mentioned earlier, it will
23899 even construct default CSS style rules from the other layout tags.
23900 For example, \SpecialChar LyX
23901 will attempt to use the information provided in the
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23911 declaration for the Chapter style to write CSS that will appropriately
23912 format chapter headings.
23915 \begin_layout Standard
23916 In many cases, then, you may not have to do anything at all to get acceptable
23917 XHTML output for your own environments, custom insets, and so forth.
23918 But in some cases you will, and so \SpecialChar LyX
23919 provides a number of layout tags that
23920 can be used to customize the XHTML and CSS that are generated.
23923 \begin_layout Standard
23924 Note that there are two tags,
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23935 \begin_inset Flex Code
23938 \begin_layout Plain Layout
23944 that may appear outside style and inset declarations.
23946 \begin_inset CommandInset ref
23948 reference "subsec:General-text-class"
23952 for details on these.
23955 \begin_layout Subsection
23956 \begin_inset CommandInset label
23958 name "subsec:Paragraph-Style-XHTML"
23965 \begin_layout Standard
23966 The sort of XHTML \SpecialChar LyX
23967 outputs for a paragraph depends upon whether we are dealing
23968 with a normal paragraph, a command, or an environment, where this is itself
23969 determined by the contents of the corresponding
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23984 \begin_layout Standard
23985 For a command or normal paragraph, the output XHTML has the following form:
23988 \begin_layout LyX-Code
23992 \begin_inset Quotes erd
23996 \begin_inset Quotes erd
24002 \begin_layout LyX-Code
24006 \begin_inset Quotes erd
24010 \begin_inset Quotes erd
24016 \begin_layout LyX-Code
24019 Contents of the paragraph.
24022 \begin_layout LyX-Code
24028 \begin_layout Standard
24029 The label tags are of course omitted if the paragraph does not have a label.
24032 \begin_layout Standard
24033 For an environment that is not some sort of list, the XHTML takes this form:
24036 \begin_layout LyX-Code
24040 \begin_inset Quotes erd
24044 \begin_inset Quotes erd
24050 \begin_layout LyX-Code
24054 \begin_inset Quotes erd
24058 \begin_inset Quotes erd
24062 \begin_inset Quotes erd
24066 \begin_inset Quotes erd
24069 >Environment Label</labeltag>First paragraph.</itemtag>
24072 \begin_layout LyX-Code
24075 <itemtag>Second paragraph.</itemtag>
24078 \begin_layout LyX-Code
24084 \begin_layout Standard
24085 Note that the label is output only for the first paragraph, as it should
24086 be for a theorem, for example.
24090 \begin_layout Standard
24091 For a list, we have one of these forms:
24094 \begin_layout LyX-Code
24098 \begin_inset Quotes erd
24102 \begin_inset Quotes erd
24108 \begin_layout LyX-Code
24112 \begin_inset Quotes erd
24116 \begin_inset Quotes erd
24120 \begin_inset Quotes erd
24124 \begin_inset Quotes erd
24127 >List Label</labeltag>First item.</itemtag>
24130 \begin_layout LyX-Code
24134 \begin_inset Quotes erd
24138 \begin_inset Quotes erd
24142 \begin_inset Quotes erd
24146 \begin_inset Quotes erd
24149 >List Label</labeltag>Second item.</itemtag>
24152 \begin_layout LyX-Code
24158 \begin_layout LyX-Code
24162 \begin_layout LyX-Code
24166 \begin_inset Quotes erd
24170 \begin_inset Quotes erd
24176 \begin_layout LyX-Code
24180 \begin_inset Quotes erd
24184 \begin_inset Quotes erd
24187 >List Label</labeltag><itemtag attr=
24188 \begin_inset Quotes erd
24192 \begin_inset Quotes erd
24195 >First item.</itemtag>
24198 \begin_layout LyX-Code
24202 \begin_inset Quotes erd
24206 \begin_inset Quotes erd
24209 >List Label</labeltag><itemtag attr=
24210 \begin_inset Quotes erd
24214 \begin_inset Quotes erd
24217 >Second item.</itemtag>
24220 \begin_layout LyX-Code
24226 \begin_layout Standard
24227 Note the different orders of
24228 \begin_inset Flex Code
24231 \begin_layout Plain Layout
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24248 Which order we get depends upon the setting of
24249 \begin_inset Flex Code
24252 \begin_layout Plain Layout
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24268 is false (the default), you get the first of these, with the label within
24269 the item; if true, you get the second, with the label outside the item.
24272 \begin_layout Standard
24273 The specific tags and attributes output for each paragraph type can be controlle
24274 d by means of the layout tags we are about to describe.
24275 As mentioned earlier, however, \SpecialChar LyX
24276 uses sensible defaults for many of these,
24277 so you often may not need to do very much to get good XHTML output.
24278 Think of the available tags as there so you can tweak things to your liking.
24281 \begin_layout Description
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24301 ] Specifies attribute information to be output with the main tag.
24303 \begin_inset Quotes eld
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24317 \begin_inset Quotes erd
24321 By default, \SpecialChar LyX
24323 \begin_inset Quotes eld
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24337 \begin_inset Quotes erd
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24350 is the \SpecialChar LyX
24351 name of the layout, made lowercase, for example: chapter.
24356 contain any style information.
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24370 \begin_layout Description
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24381 \begin_inset Flex Code
24384 \begin_layout Plain Layout
24394 ] Whether to output the default CSS information \SpecialChar LyX
24395 generates for this layout,
24396 even if additional information is explicitly provided via
24397 \begin_inset Flex Code
24400 \begin_layout Plain Layout
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24417 allows you to alter or augment the generated CSS, rather than to override
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24432 \begin_layout Description
24433 \begin_inset Flex Code
24436 \begin_layout Plain Layout
24443 \begin_inset Flex Code
24446 \begin_layout Plain Layout
24452 ] The tag to be used for individual paragraphs of environments, replacing
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24463 in the examples above.
24465 \begin_inset Flex Code
24468 \begin_layout Plain Layout
24477 \begin_layout Description
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24497 ] Attributes for the item tag.
24499 \begin_inset Newline newline
24503 \begin_inset Quotes eld
24507 \begin_inset Flex Code
24510 \begin_layout Plain Layout
24511 class=`layoutname_item'
24517 \begin_inset Quotes erd
24525 contain any style information.
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24539 \begin_layout Description
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24550 \begin_inset Flex Code
24553 \begin_layout Plain Layout
24559 ] The tag to be used for paragraph and item labels, replacing
24560 \begin_inset Flex Code
24563 \begin_layout Plain Layout
24569 in the examples above.
24571 \begin_inset Flex Code
24574 \begin_layout Plain Layout
24581 \begin_inset Flex Code
24584 \begin_layout Plain Layout
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24605 Centered_Top_Environment
24610 , in which case it defaults to
24611 \begin_inset Flex Code
24614 \begin_layout Plain Layout
24623 \begin_layout Description
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24643 ] Attributes for the label tag.
24645 \begin_inset Newline newline
24649 \begin_inset Quotes eld
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24657 class=`layoutname_label'
24663 \begin_inset Quotes erd
24671 contain any style information.
24673 \begin_inset Flex Code
24676 \begin_layout Plain Layout
24685 \begin_layout Description
24686 \begin_inset Flex Code
24689 \begin_layout Plain Layout
24696 \begin_inset Flex Code
24699 \begin_layout Plain Layout
24709 ] Meaningful only for list-like environments, this tag controls whether
24710 the label tag is output before or inside the item tag.
24711 This is used, for example, in the description environment, where we want
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24717 <dt>\SpecialChar ldots
24718 </dt><dd>\SpecialChar ldots
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24735 : The label tag is output inside the item tag.
24738 \begin_layout Description
24739 \begin_inset Flex Code
24742 \begin_layout Plain Layout
24748 Information to be output in the
24749 \begin_inset Flex Code
24752 \begin_layout Plain Layout
24758 section when this style is used.
24759 This might, for example, be used to include a
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24770 \begin_inset Flex Code
24773 \begin_layout Plain Layout
24782 \begin_layout Description
24783 \begin_inset Flex Code
24786 \begin_layout Plain Layout
24792 CSS style information to be included when this style is used.
24793 Note that this will automatically be wrapped in a layout-generated
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24803 block, so only the CSS itself need be included.
24805 \begin_inset Flex Code
24808 \begin_layout Plain Layout
24817 \begin_layout Description
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24828 \begin_inset Flex Code
24831 \begin_layout Plain Layout
24837 ] The tag to be used for the main label, replacing
24838 \begin_inset Flex Code
24841 \begin_layout Plain Layout
24847 in the examples above.
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24861 \begin_layout Description
24862 \begin_inset Flex Code
24865 \begin_layout Plain Layout
24872 \begin_inset Flex Code
24875 \begin_layout Plain Layout
24885 ] Marks this style as the one to be used to generate the
24886 \begin_inset Flex Code
24889 \begin_layout Plain Layout
24895 tag for the XHTML file.
24896 By default, it is false.
24898 \begin_inset Flex Code
24901 \begin_layout Plain Layout
24907 file sets it to true for the
24908 \begin_inset Flex Code
24911 \begin_layout Plain Layout
24921 \begin_layout Subsection
24925 \begin_layout Standard
24926 The XHTML output of insets can also be controlled by information in layout
24931 \begin_layout Plain Layout
24932 At present, this is true only for
24933 \begin_inset Quotes eld
24937 \begin_inset Quotes erd
24940 insets (insets you can type into) and is not true for
24941 \begin_inset Quotes eld
24945 \begin_inset Quotes erd
24948 insets (insets that are associated with dialog boxes).
24953 Here, too, \SpecialChar LyX
24954 tries to provide sensible defaults, and it constructs default
24956 But everything can be customized.
24959 \begin_layout Standard
24960 The XHTML \SpecialChar LyX
24961 outputs for an inset has the following form:
24964 \begin_layout LyX-Code
24966 \begin_inset Quotes erd
24970 \begin_inset Quotes erd
24976 \begin_layout LyX-Code
24977 <labeltag>Label</labeltag>
24980 \begin_layout LyX-Code
24982 \begin_inset Quotes erd
24986 \begin_inset Quotes erd
24989 >Contents of the inset.</innertag>
24992 \begin_layout LyX-Code
24996 \begin_layout Standard
24997 If the inset permits multiple paragraphs—that is, if
24998 \begin_inset Flex Code
25001 \begin_layout Plain Layout
25007 is true—then the contents of the inset will itself be output as paragraphs
25008 formatted according to the styles used for those paragraphs (standard,
25009 quote, and the like).
25010 The label tag is of course omitted if the paragraph does not have a label
25011 and, at present, is always
25012 \begin_inset Flex Code
25015 \begin_layout Plain Layout
25022 The inner tag is optional and, by default, does not appear.
25025 \begin_layout Standard
25026 The specific tags and attributes output for each inset can be controlled
25027 by means of the following layout tags.
25030 \begin_layout Description
25031 \begin_inset Flex Code
25034 \begin_layout Plain Layout
25041 \begin_inset Flex Code
25044 \begin_layout Plain Layout
25050 ] Specifies attribute information to be output with the main tag.
25052 \begin_inset Quotes eld
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25060 class=`myinset' onclick=`\SpecialChar ldots
25067 \begin_inset Quotes erd
25071 By default, \SpecialChar LyX
25073 \begin_inset Quotes eld
25077 \begin_inset Flex Code
25080 \begin_layout Plain Layout
25087 \begin_inset Quotes erd
25091 \begin_inset Flex Code
25094 \begin_layout Plain Layout
25100 is the \SpecialChar LyX
25101 name of the inset, made lowercase and with non-alphanumeric characters
25102 converted to underscores, for example: footnote.
25105 \begin_layout Description
25106 \begin_inset Flex Code
25109 \begin_layout Plain Layout
25116 \begin_inset Flex Code
25119 \begin_layout Plain Layout
25129 ] Whether to output the default CSS information \SpecialChar LyX
25130 generates for this layout,
25131 even if additional information is explicitly provided via
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25143 \begin_inset Flex Code
25146 \begin_layout Plain Layout
25152 allows you to alter or augment the generated CSS, rather than to override
25157 \begin_layout Description
25158 \begin_inset Flex Code
25161 \begin_layout Plain Layout
25168 \begin_inset Flex Code
25171 \begin_layout Plain Layout
25177 ] Attributes for the inner tag.
25179 \begin_inset Newline newline
25183 \begin_inset Quotes eld
25187 \begin_inset Flex Code
25190 \begin_layout Plain Layout
25191 class=`insetname_inner'
25197 \begin_inset Quotes erd
25203 \begin_layout Description
25204 \begin_inset Flex Code
25207 \begin_layout Plain Layout
25214 \begin_inset Flex Code
25217 \begin_layout Plain Layout
25223 ] The inner tag, replacing
25224 \begin_inset Flex Code
25227 \begin_layout Plain Layout
25233 in the examples above.
25234 By default, there is none.
25237 \begin_layout Description
25238 \begin_inset Flex Code
25241 \begin_layout Plain Layout
25248 \begin_inset Flex Code
25251 \begin_layout Plain Layout
25259 ] Whether this inset represents a standalone block of text (such as a footnote)
25260 or instead represents material that is included in the surrounding text
25261 (such as a branch).
25265 \begin_layout Description
25266 \begin_inset Flex Code
25269 \begin_layout Plain Layout
25276 \begin_inset Flex Code
25279 \begin_layout Plain Layout
25285 ] A label for this inset, possibly including a reference to a counter.
25286 For example, for footnote, it might be:
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25299 This is optional, and there is no default.
25302 \begin_layout Description
25303 \begin_inset Flex Code
25306 \begin_layout Plain Layout
25312 Information to be output in the
25313 \begin_inset Flex Code
25316 \begin_layout Plain Layout
25322 section when this style is used.
25323 This might, for example, be used to include a
25324 \begin_inset Flex Code
25327 \begin_layout Plain Layout
25334 \begin_inset Flex Code
25337 \begin_layout Plain Layout
25346 \begin_layout Description
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25356 CSS style information to be included when this style is used.
25357 Note that this will automatically be wrapped in a layout-generated
25358 \begin_inset Flex Code
25361 \begin_layout Plain Layout
25367 block, so only the CSS itself need be included.
25370 \begin_layout Description
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25381 \begin_inset Flex Code
25384 \begin_layout Plain Layout
25390 ] The tag to be used for the main label, replacing
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25400 in the examples above.
25401 The default depends upon the setting of
25402 \begin_inset Flex Code
25405 \begin_layout Plain Layout
25412 \begin_inset Flex Code
25415 \begin_layout Plain Layout
25421 is true, the default is
25422 \begin_inset Flex Code
25425 \begin_layout Plain Layout
25431 ; if it is false, the default is
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25444 \begin_layout Subsection
25448 \begin_layout Standard
25449 The XHTML output for floats too can be controlled by layout information.
25450 The output has the following form:
25453 \begin_layout LyX-Code
25455 \begin_inset Quotes erd
25459 \begin_inset Quotes erd
25465 \begin_layout LyX-Code
25466 Contents of the float.
25469 \begin_layout LyX-Code
25473 \begin_layout Standard
25474 The caption, if there is one, is a separate inset and will be output as
25476 Its appearance can be controlled via the InsetLayout for caption insets.
25480 \begin_layout Description
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25491 \begin_inset Flex Code
25494 \begin_layout Plain Layout
25500 ] Specifies attribute information to be output with the main tag.
25502 \begin_inset Quotes eld
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25510 class=`myfloat' onclick=`\SpecialChar ldots
25517 \begin_inset Quotes erd
25521 By default, \SpecialChar LyX
25523 \begin_inset Quotes eld
25527 \begin_inset Flex Code
25530 \begin_layout Plain Layout
25531 class=`float float-floattype'
25537 \begin_inset Quotes erd
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25550 is \SpecialChar LyX
25551 's name for this type of float, as determined by the float declaration
25553 \begin_inset CommandInset ref
25555 reference "subsec:Floats"
25559 ), though made lowercase and with non-alphanumeric characters converted
25560 to underscores, for example: float-table.
25563 \begin_layout Description
25564 \begin_inset Flex Code
25567 \begin_layout Plain Layout
25573 CSS style information to be included when this float is used.
25574 Note that this will automatically be wrapped in a layout-generated
25575 \begin_inset Flex Code
25578 \begin_layout Plain Layout
25584 block, so only the CSS itself need be included.
25587 \begin_layout Description
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25598 \begin_inset Flex Code
25601 \begin_layout Plain Layout
25607 ] The tag to be used for this float, replacing
25608 \begin_inset Quotes eld
25612 \begin_inset Flex Code
25615 \begin_layout Plain Layout
25622 \begin_inset Quotes erd
25625 in the example above.
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25636 and will rarely need changing.
25639 \begin_layout Subsection
25640 Bibliography formatting
25643 \begin_layout Standard
25644 The bibliography can be formatted using
25645 \begin_inset Flex Code
25648 \begin_layout Plain Layout
25656 \begin_inset CommandInset ref
25658 reference "subsec:Citation-format-description"
25665 \begin_layout Subsection
25670 \begin_layout Standard
25671 We have several times mentioned that \SpecialChar LyX
25672 will generate default CSS style rules
25673 for both insets and paragraph styles, based upon the other layout information
25675 In this section, we shall say a word about which layout information \SpecialChar LyX
25680 \begin_layout Standard
25681 At present, \SpecialChar LyX
25682 auto-generates CSS only for font information, making use of
25684 \begin_inset Flex Code
25687 \begin_layout Plain Layout
25694 \begin_inset Flex Code
25697 \begin_layout Plain Layout
25704 \begin_inset Flex Code
25707 \begin_layout Plain Layout
25714 \begin_inset Flex Code
25717 \begin_layout Plain Layout
25724 \begin_inset Flex Code
25727 \begin_layout Plain Layout
25734 \begin_inset CommandInset ref
25736 reference "subsec:Font-description"
25741 The translation is mostly straightforward and obvious.
25743 \begin_inset Quotes eld
25747 \begin_inset Flex Code
25750 \begin_layout Plain Layout
25757 \begin_inset Quotes erd
25761 \begin_inset Quotes eld
25765 \begin_inset Flex Code
25768 \begin_layout Plain Layout
25769 font-family: sans-serif;
25775 \begin_inset Quotes erd
25779 The correspondence of \SpecialChar LyX
25780 sizes and CSS sizes is a little less obvious but
25781 nonetheless intuitive.
25783 \begin_inset Flex Code
25786 \begin_layout Plain Layout
25793 \begin_inset Flex URL
25796 \begin_layout Plain Layout
25806 \begin_layout Chapter
25807 Including External Material
25808 \begin_inset CommandInset label
25810 name "chap:Including-External-Material"
25817 \begin_layout Standard
25818 \begin_inset Box Shadowbox
25828 height_special "totalheight"
25833 backgroundcolor "none"
25836 \begin_layout Plain Layout
25837 WARNING: This portion of the documentation has not been updated for some
25839 We certainly hope that it is still accurate, but there are no guarantees.
25847 \begin_layout Standard
25848 The use of material from sources external to \SpecialChar LyX
25849 is covered in detail in the
25855 This part of the manual covers what needs to happen behind the scenes for
25856 new sorts of material to be included.
25859 \begin_layout Section
25863 \begin_layout Standard
25864 The external material feature is based on the concept of a
25869 A template is a specification of how \SpecialChar LyX
25870 should interface with a certain kind
25872 As bundled, \SpecialChar LyX
25873 comes with predefined templates for Xfig figures, various
25874 raster format images, chess diagrams, and LilyPond music notation.
25875 You can check the actual list by using the menu
25876 \begin_inset Flex Noun
25879 \begin_layout Plain Layout
25880 Insert\SpecialChar menuseparator
25881 File\SpecialChar menuseparator
25888 Furthermore, it is possible to roll your own template to support a specific
25890 Later we'll describe in more detail what is involved, and hopefully you
25891 will submit all the templates you create so we can include them in a later
25896 \begin_layout Standard
25897 Another basic idea of the external material feature is to distinguish between
25898 the original file that serves as a base for final material and the produced
25899 file that is included in your exported or printed document.
25900 For example, consider the case of a figure produced with
25901 \begin_inset Flex Code
25904 \begin_layout Plain Layout
25911 The Xfig application itself works on an original file with the
25912 \begin_inset Flex Code
25915 \begin_layout Plain Layout
25922 Within Xfig, you create and change your figure, and when you are done,
25924 \begin_inset Flex Code
25927 \begin_layout Plain Layout
25934 When you want to include the figure in your document, you invoke
25935 \begin_inset Flex Code
25938 \begin_layout Plain Layout
25944 in order to create a PostScript file that can readily be included in your
25948 \begin_inset Flex Code
25951 \begin_layout Plain Layout
25957 file is the original file, and the PostScript file is the produced file.
25960 \begin_layout Standard
25961 This distinction is important in order to allow updating of the material
25962 while you are in the process of writing the document.
25963 Furthermore, it provides us with the flexibility that is needed to support
25964 multiple export formats.
25965 For instance, in the case of a plain text file, it is not exactly an award-winn
25966 ing idea to include the figure as raw PostScript.
25967 Instead, you would either prefer to just include a reference to the figure
25968 or try to invoke some graphics to ASCII converter to make the final result
25969 look similar to the real graphics.
25970 The external material management allows you to do this, because it is parametri
25971 zed on the different export formats that \SpecialChar LyX
25975 \begin_layout Standard
25976 Besides supporting the production of different products according to the
25977 exported format, it supports tight integration with editing and viewing
25979 In the case of an Xfig figure, you are able to invoke Xfig on the original
25980 file with a single click from within the external material dialog in \SpecialChar LyX
25982 and also preview the produced PostScript file with Ghostview with another
25984 No more fiddling around with the command line and/or file browsers to locate
25985 and manipulate the original or produced files.
25986 In this way, you are finally able to take full advantage of the many different
25987 applications that are relevant to use when you write your documents, and
25988 ultimately be more productive.
25991 \begin_layout Section
25992 The external template configuration files
25995 \begin_layout Standard
25996 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25998 However, be aware that doing this in an careless manner most probably
26002 introduce an easily exploitable security hole.
26003 So before you do this, please read the discussion about security in
26004 \begin_inset CommandInset ref
26006 reference "sec:Security-discussion"
26013 \begin_layout Standard
26014 Having said that, we encourage you to submit any interesting templates that
26019 \begin_layout Standard
26020 The external templates are defined in the
26021 \begin_inset Flex Code
26024 \begin_layout Plain Layout
26030 files that are stored in the
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26035 LyXDir/lib/xtemplates/
26041 Each template is defined in a file of its own.
26042 You can place your own templates in
26043 \begin_inset Flex Code
26046 \begin_layout Plain Layout
26047 UserDir/xtemplates/
26052 or copy existing templates to that directory in order to modify them.
26055 \begin_layout Standard
26056 A typical template looks like this:
26059 \begin_layout LyX-Code
26063 \begin_layout LyX-Code
26064 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26067 \begin_layout LyX-Code
26071 \begin_layout LyX-Code
26075 \begin_layout LyX-Code
26079 \begin_layout LyX-Code
26083 \begin_layout LyX-Code
26087 \begin_layout LyX-Code
26088 AutomaticProduction true
26091 \begin_layout LyX-Code
26095 \begin_layout LyX-Code
26099 \begin_layout LyX-Code
26103 \begin_layout LyX-Code
26104 TransformCommand Rotate RotationLatexCommand
26107 \begin_layout LyX-Code
26108 TransformCommand Resize ResizeLatexCommand
26111 \begin_layout LyX-Code
26112 Product "$$RotateFront$$ResizeFront
26115 \begin_layout LyX-Code
26120 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26123 \begin_layout LyX-Code
26124 $$ResizeBack$$RotateBack"
26127 \begin_layout LyX-Code
26131 \begin_layout LyX-Code
26132 UpdateResult "$$AbsPath$$Basename.pstex_t"
26135 \begin_layout LyX-Code
26136 Requirement "graphicx"
26139 \begin_layout LyX-Code
26140 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26143 \begin_layout LyX-Code
26144 ReferencedFile latex "$$AbsPath$$Basename.eps"
26147 \begin_layout LyX-Code
26148 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26151 \begin_layout LyX-Code
26155 \begin_layout LyX-Code
26159 \begin_layout LyX-Code
26160 TransformCommand Rotate RotationLatexCommand
26163 \begin_layout LyX-Code
26164 TransformCommand Resize ResizeLatexCommand
26167 \begin_layout LyX-Code
26168 Product "$$RotateFront$$ResizeFront
26171 \begin_layout LyX-Code
26176 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26179 \begin_layout LyX-Code
26180 $$ResizeBack$$RotateBack"
26183 \begin_layout LyX-Code
26184 UpdateFormat pdftex
26187 \begin_layout LyX-Code
26188 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26191 \begin_layout LyX-Code
26192 Requirement "graphicx"
26195 \begin_layout LyX-Code
26196 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26199 \begin_layout LyX-Code
26200 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26203 \begin_layout LyX-Code
26207 \begin_layout LyX-Code
26211 \begin_layout LyX-Code
26212 Product "[XFig: $$FName]"
26215 \begin_layout LyX-Code
26219 \begin_layout LyX-Code
26223 \begin_layout LyX-Code
26224 Product "<graphic fileref=
26226 "$$AbsOrRelPathMaster$$Basename.eps
26231 \begin_layout LyX-Code
26235 \begin_layout LyX-Code
26239 \begin_layout LyX-Code
26240 UpdateResult "$$AbsPath$$Basename.eps"
26243 \begin_layout LyX-Code
26244 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26247 \begin_layout LyX-Code
26248 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26251 \begin_layout LyX-Code
26255 \begin_layout LyX-Code
26259 \begin_layout Standard
26260 As you can see, the template is enclosed in
26261 \begin_inset Flex Code
26264 \begin_layout Plain Layout
26272 \begin_inset Flex Code
26275 \begin_layout Plain Layout
26282 It contains a header specifying some general settings and, for each supported
26283 primary document file format, a section
26284 \begin_inset Flex Code
26287 \begin_layout Plain Layout
26295 \begin_inset Flex Code
26298 \begin_layout Plain Layout
26307 \begin_layout Subsection
26308 The template header
26311 \begin_layout Description
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26316 AutomaticProduction
26317 \begin_inset space ~
26325 Whether the file represented by the template must be generated by \SpecialChar LyX
26327 This command must occur exactly once.
26330 \begin_layout Description
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26336 \begin_inset space ~
26344 A glob pattern that is used in the file dialog to filter out the desired
26346 If there is more than one possible file extension (e.
26347 \begin_inset space \thinspace{}
26351 \begin_inset space \space{}
26355 \begin_inset Flex Code
26358 \begin_layout Plain Layout
26365 \begin_inset Flex Code
26368 \begin_layout Plain Layout
26374 ), use something like
26375 \begin_inset Flex Code
26378 \begin_layout Plain Layout
26385 This command must occur exactly once.
26388 \begin_layout Description
26389 \begin_inset Flex Code
26392 \begin_layout Plain Layout
26394 \begin_inset space ~
26402 The text that is displayed on the button.
26403 This command must occur exactly once.
26406 \begin_layout Description
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26412 \begin_inset space ~
26416 \begin_inset space ~
26424 The help text that is used in the External dialog.
26425 Provide enough information to explain to the user just what the template
26426 can provide him with.
26427 This command must occur exactly once.
26430 \begin_layout Description
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26436 \begin_inset space ~
26444 The file format of the original file.
26445 This must be the name of a format that is known to \SpecialChar LyX
26447 \begin_inset CommandInset ref
26449 reference "sec:Formats"
26455 \begin_inset Quotes eld
26459 \begin_inset Flex Code
26462 \begin_layout Plain Layout
26469 \begin_inset Quotes erd
26472 if the template can handle original files of more than one format.
26474 will attempt to interrogate the file itself in order to deduce its format
26476 This command must occur exactly once.
26479 \begin_layout Description
26480 \begin_inset Flex Code
26483 \begin_layout Plain Layout
26485 \begin_inset space ~
26493 A unique name for the template.
26494 It must not contain substitution macros (see below).
26497 \begin_layout Description
26498 \begin_inset Flex Code
26501 \begin_layout Plain Layout
26503 \begin_inset space ~
26506 Rotate|Resize|Clip|Extra
26511 This command specifies which transformations are supported by this template.
26512 It may occur zero or more times.
26513 This command enables the corresponding tabs in the external dialog.
26515 \begin_inset Flex Code
26518 \begin_layout Plain Layout
26524 command must have either a corresponding
26525 \begin_inset Flex Code
26528 \begin_layout Plain Layout
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26555 Otherwise the transformation will not be supported by that format.
26558 \begin_layout Subsection
26562 \begin_layout Description
26563 \begin_inset Flex Code
26566 \begin_layout Plain Layout
26568 \begin_inset space ~
26571 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26576 The primary document file format that this format definition is for.
26577 Not every template has a sensible representation in all document file formats.
26578 Please define nevertheless a
26579 \begin_inset Flex Code
26582 \begin_layout Plain Layout
26588 section for all templates.
26589 Use a dummy text when no representation is available.
26590 Then you can at least see a reference to the external material in the exported
26594 \begin_layout Description
26595 \begin_inset Flex Code
26598 \begin_layout Plain Layout
26600 \begin_inset space ~
26604 \begin_inset space ~
26612 This command defines an additional macro
26613 \begin_inset Flex Code
26616 \begin_layout Plain Layout
26622 for substitution in
26623 \begin_inset Flex Code
26626 \begin_layout Plain Layout
26634 \begin_inset Flex Code
26637 \begin_layout Plain Layout
26643 itself may contain substitution macros.
26644 The advantage over using
26645 \begin_inset Flex Code
26648 \begin_layout Plain Layout
26655 \begin_inset Flex Code
26658 \begin_layout Plain Layout
26664 is that the substituted value of
26665 \begin_inset Flex Code
26668 \begin_layout Plain Layout
26674 is sanitized so that it is a valid optional argument in the document format.
26675 This command may occur zero or more times.
26678 \begin_layout Description
26679 \begin_inset Flex Code
26682 \begin_layout Plain Layout
26684 \begin_inset space ~
26692 The text that is inserted in the exported document.
26693 This is actually the most important command and can be quite complex.
26694 This command must occur exactly once.
26697 \begin_layout Description
26698 \begin_inset Flex Code
26701 \begin_layout Plain Layout
26703 \begin_inset space ~
26711 This command specifies a preamble snippet that will be included in the
26714 It has to be defined using
26715 \begin_inset Flex Code
26718 \begin_layout Plain Layout
26726 \begin_inset Flex Code
26729 \begin_layout Plain Layout
26736 This command may occur zero or more times.
26739 \begin_layout Description
26740 \begin_inset Flex Code
26743 \begin_layout Plain Layout
26745 \begin_inset space ~
26749 \begin_inset space ~
26757 This command denotes files that are created by the conversion process and
26758 are needed for a particular export format.
26759 If the filename is relative, it is interpreted relative to the master document.
26760 This command may be given zero or more times.
26763 \begin_layout Description
26764 \begin_inset Flex Code
26767 \begin_layout Plain Layout
26769 \begin_inset space ~
26777 The name of a required \SpecialChar LaTeX
26779 The package is included via
26780 \begin_inset Flex Code
26783 \begin_layout Plain Layout
26791 in the \SpecialChar LaTeX
26793 This command may occur zero or more times.
26796 \begin_layout Description
26797 \begin_inset Flex Code
26800 \begin_layout Plain Layout
26802 \begin_inset space ~
26806 \begin_inset space ~
26809 RotationLatexCommand
26814 This command specifies that the built in \SpecialChar LaTeX
26815 command should be used for rotation.
26816 This command may occur once or not at all.
26819 \begin_layout Description
26820 \begin_inset Flex Code
26823 \begin_layout Plain Layout
26825 \begin_inset space ~
26829 \begin_inset space ~
26837 This command specifies that the built in \SpecialChar LaTeX
26838 command should be used for resizing.
26839 This command may occur once or not at all.
26842 \begin_layout Description
26843 \begin_inset Flex Code
26846 \begin_layout Plain Layout
26848 \begin_inset space ~
26852 \begin_inset space ~
26855 RotationLatexOption
26860 This command specifies that rotation is done via an optional argument.
26861 This command may occur once or not at all.
26864 \begin_layout Description
26865 \begin_inset Flex Code
26868 \begin_layout Plain Layout
26870 \begin_inset space ~
26874 \begin_inset space ~
26882 This command specifies that resizing is done via an optional argument.
26883 This command may occur once or not at all.
26886 \begin_layout Description
26887 \begin_inset Flex Code
26890 \begin_layout Plain Layout
26892 \begin_inset space ~
26896 \begin_inset space ~
26904 This command specifies that clipping is done via an optional argument.
26905 This command may occur once or not at all.
26908 \begin_layout Description
26909 \begin_inset Flex Code
26912 \begin_layout Plain Layout
26914 \begin_inset space ~
26918 \begin_inset space ~
26926 This command specifies that an extra optional argument is used.
26927 This command may occur once or not at all.
26930 \begin_layout Description
26931 \begin_inset Flex Code
26934 \begin_layout Plain Layout
26936 \begin_inset space ~
26944 The file format of the converted file.
26945 This must be the name of a format that is known to \SpecialChar LyX
26947 \begin_inset Flex Noun
26950 \begin_layout Plain Layout
26951 Tools\SpecialChar menuseparator
26952 Preferences\SpecialChar menuseparator
26953 File Handling\SpecialChar menuseparator
26960 This command must occur exactly once.
26961 If the resulting file format is PDF, you need to specify the format
26962 \begin_inset Flex Code
26965 \begin_layout Plain Layout
26972 This is the PDF format used for including graphics.
26973 The other defined PDF formats are for document export.
26976 \begin_layout Description
26977 \begin_inset Flex Code
26980 \begin_layout Plain Layout
26982 \begin_inset space ~
26990 The file name of the converted file.
26991 The file name must be absolute.
26992 This command must occur exactly once.
26995 \begin_layout Subsection
26996 Preamble definitions
26999 \begin_layout Standard
27000 The external template configuration file may contain additional preamble
27001 definitions enclosed by
27002 \begin_inset Flex Code
27005 \begin_layout Plain Layout
27013 \begin_inset Flex Code
27016 \begin_layout Plain Layout
27023 They can be used by the templates in the
27024 \begin_inset Flex Code
27027 \begin_layout Plain Layout
27036 \begin_layout Section
27037 The substitution mechanism
27040 \begin_layout Standard
27041 When the external material facility invokes an external program, it is done
27042 on the basis of a command defined in the template configuration file.
27043 These commands can contain various macros that are expanded before execution.
27044 Execution always take place in the directory of the containing document.
27047 \begin_layout Standard
27048 Also, whenever external material is to be displayed, the name will be produced
27049 by the substitution mechanism, and most other commands in the template
27050 definition support substitution as well.
27053 \begin_layout Standard
27054 The available macros are the following:
27057 \begin_layout Description
27058 \begin_inset Flex Code
27061 \begin_layout Plain Layout
27062 $$AbsOrRelPathMaster
27067 The file path, absolute or relative to the master \SpecialChar LyX
27071 \begin_layout Description
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27076 $$AbsOrRelPathParent
27081 The file path, absolute or relative to the \SpecialChar LyX
27085 \begin_layout Description
27086 \begin_inset Flex Code
27089 \begin_layout Plain Layout
27095 The absolute file path.
27098 \begin_layout Description
27099 \begin_inset Flex Code
27102 \begin_layout Plain Layout
27108 The filename without path and without the extension.
27111 \begin_layout Description
27112 \begin_inset Flex Code
27115 \begin_layout Plain Layout
27117 \begin_inset Quotes eld
27121 \begin_inset Quotes erd
27129 This macro will expand to the contents of the file with the name
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27142 \begin_layout Description
27143 \begin_inset Flex Code
27146 \begin_layout Plain Layout
27152 The file extension (including the dot).
27155 \begin_layout Description
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27165 This will be the string
27166 \begin_inset Quotes eld
27170 \begin_inset Quotes erd
27173 if the file is in JPEG format, otherwise it will be the string
27174 \begin_inset Quotes eld
27178 \begin_inset Quotes erd
27182 This is useful to avoid uneeded conversions for output formats that support
27183 both PNG and JPEG fomats.
27184 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27189 \begin_layout Description
27190 \begin_inset Flex Code
27193 \begin_layout Plain Layout
27199 The filename of the file specified in the external material dialog.
27200 This is either an absolute name, or it is relative to the \SpecialChar LyX
27204 \begin_layout Description
27205 \begin_inset Flex Code
27208 \begin_layout Plain Layout
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27224 (absolute name or relative to the \SpecialChar LyX
27228 \begin_layout Description
27229 \begin_inset Flex Code
27232 \begin_layout Plain Layout
27238 The file path, relative to the master \SpecialChar LyX
27242 \begin_layout Description
27243 \begin_inset Flex Code
27246 \begin_layout Plain Layout
27252 The file path, relative to the \SpecialChar LyX
27256 \begin_layout Description
27257 \begin_inset Flex Code
27260 \begin_layout Plain Layout
27266 This macro will expand to the absolute path of the system directory.
27267 This is typically used to point to the various helper scripts that are
27268 bundled with \SpecialChar LyX
27272 \begin_layout Description
27273 \begin_inset Flex Code
27276 \begin_layout Plain Layout
27282 A name and full path to a temporary file which will be automatically deleted
27283 whenever the containing document is closed, or the external material insertion
27287 \begin_layout Standard
27288 All path macros contain a trailing directory separator, so you can construct
27290 \begin_inset space \thinspace{}
27294 \begin_inset space \space{}
27297 the absolute filename with
27298 \begin_inset Flex Code
27301 \begin_layout Plain Layout
27302 $$AbsPath$$Basename$$Extension
27310 \begin_layout Standard
27311 The macros above are substituted in all commands unless otherwise noted.
27313 \begin_inset Flex Code
27316 \begin_layout Plain Layout
27322 supports additionally the following substitutions if they are enabled by
27324 \begin_inset Flex Code
27327 \begin_layout Plain Layout
27334 \begin_inset Flex Code
27337 \begin_layout Plain Layout
27346 \begin_layout Description
27347 \begin_inset Flex Code
27350 \begin_layout Plain Layout
27356 The front part of the resize command.
27359 \begin_layout Description
27360 \begin_inset Flex Code
27363 \begin_layout Plain Layout
27369 The back part of the resize command.
27372 \begin_layout Description
27373 \begin_inset Flex Code
27376 \begin_layout Plain Layout
27382 The front part of the rotation command.
27385 \begin_layout Description
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27395 The back part of the rotation command.
27398 \begin_layout Standard
27399 The value string of the
27400 \begin_inset Flex Code
27403 \begin_layout Plain Layout
27409 command supports additionally the following substitutions if they are enabled
27411 \begin_inset Flex Code
27414 \begin_layout Plain Layout
27421 \begin_inset Flex Code
27424 \begin_layout Plain Layout
27433 \begin_layout Description
27434 \begin_inset Flex Code
27437 \begin_layout Plain Layout
27446 \begin_layout Description
27447 \begin_inset Flex Code
27450 \begin_layout Plain Layout
27459 \begin_layout Description
27460 \begin_inset Flex Code
27463 \begin_layout Plain Layout
27472 \begin_layout Description
27473 \begin_inset Flex Code
27476 \begin_layout Plain Layout
27482 The rotation option.
27485 \begin_layout Standard
27486 You may ask why there are so many path macros.
27487 There are mainly two reasons:
27490 \begin_layout Enumerate
27491 Relative and absolute file names should remain relative or absolute, respectivel
27493 Users may have reasons to prefer either form.
27494 Relative names are useful for portable documents that should work on different
27495 machines, for example.
27496 Absolute names may be required by some programs.
27499 \begin_layout Enumerate
27501 treats relative file names differently than \SpecialChar LyX
27502 and other programs in nested
27504 For \SpecialChar LyX
27505 , a relative file name is always relative to the document that contains
27507 For \SpecialChar LaTeX
27508 , it is always relative to the master document.
27509 These two definitions are identical if you have only one document, but
27510 differ if you have a master document that includes part documents.
27511 That means that relative filenames must be transformed when presented to
27514 Fortunately \SpecialChar LyX
27515 does this automatically for you if you choose the right macros.
27518 \begin_layout Standard
27519 So which path macro should be used in new template definitions? The rule
27523 \begin_layout Itemize
27525 \begin_inset Flex Code
27528 \begin_layout Plain Layout
27534 if an absolute path is required.
27537 \begin_layout Itemize
27539 \begin_inset Flex Code
27542 \begin_layout Plain Layout
27543 $$AbsOrRelPathMaster
27548 if the substituted string is some kind of \SpecialChar LaTeX
27552 \begin_layout Itemize
27554 \begin_inset Flex Code
27557 \begin_layout Plain Layout
27558 $$AbsOrRelPathParent
27563 in order to preserve the user's choice.
27566 \begin_layout Standard
27567 There are special cases where this rule does not work and e.
27568 \begin_inset space \thinspace{}
27572 \begin_inset space \space{}
27575 relative names are needed, but normally it will work just fine.
27576 One example for such a case is the command
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27581 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27586 in the XFig template above: We can't use the absolute name because the
27588 \begin_inset Flex Code
27591 \begin_layout Plain Layout
27597 files needs the relative name in order to rewrite the file content.
27600 \begin_layout Section
27601 Security discussion
27602 \begin_inset CommandInset label
27604 name "sec:Security-discussion"
27611 \begin_layout Standard
27612 The external material feature interfaces with a lot of external programs
27613 and does so automatically, so we have to consider the security implications
27615 In particular, since you have the option of including your own filenames
27616 and/or parameter strings and those are expanded into a command, it seems
27617 that it would be possible to create a malicious document which executes
27618 arbitrary commands when a user views or prints the document.
27619 This is something we definitely want to avoid.
27622 \begin_layout Standard
27623 However, since the external program commands are specified in the template
27624 configuration file only, there are no security issues if \SpecialChar LyX
27625 is properly configure
27626 d with safe templates only.
27627 This is so because the external programs are invoked with the
27628 \begin_inset Flex Code
27631 \begin_layout Plain Layout
27637 -system call rather than the
27638 \begin_inset Flex Code
27641 \begin_layout Plain Layout
27647 system-call, so it's not possible to execute arbitrary commands from the
27648 filename or parameter section via the shell.
27651 \begin_layout Standard
27652 This also implies that you are restricted in what command strings you can
27653 use in the external material templates.
27654 In particular, pipes and redirection are not readily available.
27655 This has to be so if \SpecialChar LyX
27656 should remain safe.
27657 If you want to use some of the shell features, you should write a safe
27658 script to do this in a controlled manner, and then invoke the script from
27659 the command string.
27663 \begin_layout Standard
27664 It is possible to design a template that interacts directly with the shell,
27665 but since this would allow a malicious user to execute arbitrary commands
27666 by writing clever filenames and/or parameters, we generally recommend that
27667 you only use safe scripts that work with the
27668 \begin_inset Flex Code
27671 \begin_layout Plain Layout
27677 system call in a controlled manner.
27678 Of course, for use in a controlled environment, it can be tempting to just
27679 fall back to use ordinary shell scripts.
27680 If you do so, be aware that you
27684 provide an easily exploitable security hole in your system.
27685 Of course it stands to reason that such unsafe templates will never be
27686 included in the standard \SpecialChar LyX
27687 distribution, although we do encourage people
27688 to submit new templates in the open source tradition.
27689 But \SpecialChar LyX
27690 as shipped from the official distribution channels will never have
27694 \begin_layout Standard
27695 Including external material provides a lot of power, and you have to be
27696 careful not to introduce security hazards with this power.
27697 A subtle error in a single line in an innocent looking script can open
27698 the door to huge security problems.
27699 So if you do not fully understand the issues, we recommend that you consult
27700 a knowledgeable security professional or the \SpecialChar LyX
27701 development team if you have
27702 any questions about whether a given template is safe or not.
27703 And do this before you use it in an uncontrolled environment.
27706 \begin_layout Chapter
27708 List of supported \SpecialChar LyX
27709 functions to be used in layouts
27710 \begin_inset CommandInset label
27712 name "chap:List-of-functions"
27719 \begin_layout Standard
27721 \begin_inset Tabular
27722 <lyxtabular version="3" rows="11" columns="8">
27723 <features tabularvalignment="middle">
27724 <column alignment="left" valignment="top">
27725 <column alignment="left" valignment="top">
27726 <column alignment="left" valignment="top">
27727 <column alignment="left" valignment="top">
27728 <column alignment="left" valignment="top">
27729 <column alignment="left" valignment="top">
27730 <column alignment="left" valignment="top">
27731 <column alignment="left" valignment="top">
27733 <cell alignment="left" valignment="top" usebox="none">
27736 \begin_layout Plain Layout
27742 <cell alignment="left" valignment="top" usebox="none">
27745 \begin_layout Plain Layout
27751 <cell alignment="left" valignment="top" usebox="none">
27754 \begin_layout Plain Layout
27760 <cell alignment="left" valignment="top" usebox="none">
27763 \begin_layout Plain Layout
27769 <cell alignment="center" valignment="top" usebox="none">
27772 \begin_layout Plain Layout
27778 <cell alignment="center" valignment="top" usebox="none">
27781 \begin_layout Plain Layout
27787 <cell alignment="center" valignment="top" usebox="none">
27790 \begin_layout Plain Layout
27796 <cell alignment="center" valignment="top" usebox="none">
27799 \begin_layout Plain Layout
27807 <cell alignment="left" valignment="top" usebox="none">
27810 \begin_layout Plain Layout
27816 <cell alignment="left" valignment="top" usebox="none">
27819 \begin_layout Plain Layout
27825 <cell alignment="left" valignment="top" usebox="none">
27828 \begin_layout Plain Layout
27834 <cell alignment="left" valignment="top" usebox="none">
27837 \begin_layout Plain Layout
27843 <cell alignment="center" valignment="top" usebox="none">
27846 \begin_layout Plain Layout
27852 <cell alignment="center" valignment="top" usebox="none">
27855 \begin_layout Plain Layout
27861 <cell alignment="center" valignment="top" usebox="none">
27864 \begin_layout Plain Layout
27870 <cell alignment="center" valignment="top" usebox="none">
27873 \begin_layout Plain Layout
27881 <cell alignment="left" valignment="top" usebox="none">
27884 \begin_layout Plain Layout
27890 <cell alignment="left" valignment="top" usebox="none">
27893 \begin_layout Plain Layout
27899 <cell alignment="left" valignment="top" usebox="none">
27902 \begin_layout Plain Layout
27908 <cell alignment="left" valignment="top" usebox="none">
27911 \begin_layout Plain Layout
27917 <cell alignment="center" valignment="top" usebox="none">
27920 \begin_layout Plain Layout
27926 <cell alignment="center" valignment="top" usebox="none">
27929 \begin_layout Plain Layout
27935 <cell alignment="center" valignment="top" usebox="none">
27938 \begin_layout Plain Layout
27944 <cell alignment="center" valignment="top" usebox="none">
27947 \begin_layout Plain Layout
27955 <cell alignment="left" valignment="top" usebox="none">
27958 \begin_layout Plain Layout
27964 <cell alignment="left" valignment="top" usebox="none">
27967 \begin_layout Plain Layout
27973 <cell alignment="left" valignment="top" usebox="none">
27976 \begin_layout Plain Layout
27982 <cell alignment="left" valignment="top" usebox="none">
27985 \begin_layout Plain Layout
27991 <cell alignment="center" valignment="top" usebox="none">
27994 \begin_layout Plain Layout
28000 <cell alignment="center" valignment="top" usebox="none">
28003 \begin_layout Plain Layout
28009 <cell alignment="center" valignment="top" usebox="none">
28012 \begin_layout Plain Layout
28018 <cell alignment="center" valignment="top" usebox="none">
28021 \begin_layout Plain Layout
28029 <cell alignment="left" valignment="top" usebox="none">
28032 \begin_layout Plain Layout
28038 <cell alignment="left" valignment="top" usebox="none">
28041 \begin_layout Plain Layout
28047 <cell alignment="left" valignment="top" usebox="none">
28050 \begin_layout Plain Layout
28056 <cell alignment="left" valignment="top" usebox="none">
28059 \begin_layout Plain Layout
28065 <cell alignment="center" valignment="top" usebox="none">
28068 \begin_layout Plain Layout
28074 <cell alignment="center" valignment="top" usebox="none">
28077 \begin_layout Plain Layout
28083 <cell alignment="center" valignment="top" usebox="none">
28086 \begin_layout Plain Layout
28092 <cell alignment="center" valignment="top" usebox="none">
28095 \begin_layout Plain Layout
28103 <cell alignment="left" valignment="top" usebox="none">
28106 \begin_layout Plain Layout
28112 <cell alignment="left" valignment="top" usebox="none">
28115 \begin_layout Plain Layout
28121 <cell alignment="left" valignment="top" usebox="none">
28124 \begin_layout Plain Layout
28130 <cell alignment="left" valignment="top" usebox="none">
28133 \begin_layout Plain Layout
28139 <cell alignment="center" valignment="top" usebox="none">
28142 \begin_layout Plain Layout
28148 <cell alignment="center" valignment="top" usebox="none">
28151 \begin_layout Plain Layout
28157 <cell alignment="center" valignment="top" usebox="none">
28160 \begin_layout Plain Layout
28166 <cell alignment="center" valignment="top" usebox="none">
28169 \begin_layout Plain Layout
28177 <cell alignment="left" valignment="top" usebox="none">
28180 \begin_layout Plain Layout
28186 <cell alignment="left" valignment="top" usebox="none">
28189 \begin_layout Plain Layout
28195 <cell alignment="left" valignment="top" usebox="none">
28198 \begin_layout Plain Layout
28204 <cell alignment="left" valignment="top" usebox="none">
28207 \begin_layout Plain Layout
28213 <cell alignment="center" valignment="top" usebox="none">
28216 \begin_layout Plain Layout
28222 <cell alignment="center" valignment="top" usebox="none">
28225 \begin_layout Plain Layout
28231 <cell alignment="center" valignment="top" usebox="none">
28234 \begin_layout Plain Layout
28240 <cell alignment="center" valignment="top" usebox="none">
28243 \begin_layout Plain Layout
28251 <cell alignment="left" valignment="top" usebox="none">
28254 \begin_layout Plain Layout
28260 <cell alignment="left" valignment="top" usebox="none">
28263 \begin_layout Plain Layout
28269 <cell alignment="left" valignment="top" usebox="none">
28272 \begin_layout Plain Layout
28278 <cell alignment="left" valignment="top" usebox="none">
28281 \begin_layout Plain Layout
28287 <cell alignment="center" valignment="top" usebox="none">
28290 \begin_layout Plain Layout
28296 <cell alignment="center" valignment="top" usebox="none">
28299 \begin_layout Plain Layout
28305 <cell alignment="center" valignment="top" usebox="none">
28308 \begin_layout Plain Layout
28314 <cell alignment="center" valignment="top" usebox="none">
28317 \begin_layout Plain Layout
28325 <cell alignment="left" valignment="top" usebox="none">
28328 \begin_layout Plain Layout
28334 <cell alignment="left" valignment="top" usebox="none">
28337 \begin_layout Plain Layout
28343 <cell alignment="left" valignment="top" usebox="none">
28346 \begin_layout Plain Layout
28352 <cell alignment="left" valignment="top" usebox="none">
28355 \begin_layout Plain Layout
28361 <cell alignment="center" valignment="top" usebox="none">
28364 \begin_layout Plain Layout
28370 <cell alignment="center" valignment="top" usebox="none">
28373 \begin_layout Plain Layout
28379 <cell alignment="center" valignment="top" usebox="none">
28382 \begin_layout Plain Layout
28388 <cell alignment="center" valignment="top" usebox="none">
28391 \begin_layout Plain Layout
28399 <cell alignment="left" valignment="top" usebox="none">
28402 \begin_layout Plain Layout
28408 <cell alignment="left" valignment="top" usebox="none">
28411 \begin_layout Plain Layout
28417 <cell alignment="left" valignment="top" usebox="none">
28420 \begin_layout Plain Layout
28426 <cell alignment="left" valignment="top" usebox="none">
28429 \begin_layout Plain Layout
28435 <cell alignment="center" valignment="top" usebox="none">
28438 \begin_layout Plain Layout
28444 <cell alignment="center" valignment="top" usebox="none">
28447 \begin_layout Plain Layout
28453 <cell alignment="center" valignment="top" usebox="none">
28456 \begin_layout Plain Layout
28462 <cell alignment="center" valignment="top" usebox="none">
28465 \begin_layout Plain Layout
28473 <cell alignment="center" valignment="top" usebox="none">
28476 \begin_layout Plain Layout
28482 <cell alignment="center" valignment="top" usebox="none">
28485 \begin_layout Plain Layout
28491 <cell alignment="center" valignment="top" usebox="none">
28494 \begin_layout Plain Layout
28500 <cell alignment="center" valignment="top" usebox="none">
28503 \begin_layout Plain Layout
28509 <cell alignment="center" valignment="top" usebox="none">
28512 \begin_layout Plain Layout
28518 <cell alignment="center" valignment="top" usebox="none">
28521 \begin_layout Plain Layout
28527 <cell alignment="center" valignment="top" usebox="none">
28530 \begin_layout Plain Layout
28536 <cell alignment="center" valignment="top" usebox="none">
28539 \begin_layout Plain Layout
28553 \begin_layout Chapter
28554 Names of available colors to be used in layouts
28555 \begin_inset CommandInset label
28557 name "chap:Names-of-colors"
28564 \begin_layout Standard
28565 The colors listed below are the standard colors and those that you can adjust
28566 in the \SpecialChar LyX
28570 \begin_layout Section
28574 \begin_layout Standard
28575 The following are no real colors, but rather act on color definitions:
28578 \begin_layout Description
28579 ignore The color is ignored
28582 \begin_layout Description
28583 inherit The color is inherited
28586 \begin_layout Description
28599 No particular color – clear or default
28602 \begin_layout Section
28606 \begin_layout Standard
28607 These are fixed colors that cannot me customized:
28610 \begin_layout Description
28614 \begin_layout Description
28618 \begin_layout Description
28622 \begin_layout Description
28626 \begin_layout Description
28630 \begin_layout Description
28634 \begin_layout Description
28638 \begin_layout Description
28642 \begin_layout Description
28646 \begin_layout Description
28650 \begin_layout Description
28654 \begin_layout Description
28658 \begin_layout Description
28662 \begin_layout Description
28666 \begin_layout Description
28670 \begin_layout Description
28674 \begin_layout Description
28678 \begin_layout Description
28682 \begin_layout Description
28686 \begin_layout Section
28690 \begin_layout Standard
28691 These are the colors allocated to specific elements in
28694 arg "dialog-show prefs"
28700 \begin_layout Description
28701 added_space Added space color
28704 \begin_layout Description
28705 addedtext Added text color
28708 \begin_layout Description
28709 appendix Appendix marker color
28712 \begin_layout Description
28713 background Background color
28716 \begin_layout Description
28717 bottomarea Bottom area color
28720 \begin_layout Description
28721 branchlabel Label color for branches
28724 \begin_layout Description
28725 buttonbg Color used for button background
28728 \begin_layout Description
28729 buttonframe Color for inset button frames
28732 \begin_layout Description
28733 buttonhoverbg Color used for button background under focus
28736 \begin_layout Description
28737 changebar Changebar color
28740 \begin_layout Description
28741 changedtextauthor1 Changed text color author 1
28744 \begin_layout Description
28745 changedtextauthor2 Changed text color author 2
28748 \begin_layout Description
28749 changedtextauthor3 Changed text color author 3
28752 \begin_layout Description
28753 changedtextauthor4 Changed text color author 4
28756 \begin_layout Description
28757 changedtextauthor5 Changed text color author 5
28760 \begin_layout Description
28761 collapsible Collapsible insets text color
28764 \begin_layout Description
28765 collapsibleframe Collapsible insets framecolor
28768 \begin_layout Description
28769 command Text color for command insets
28772 \begin_layout Description
28773 commandbg Background color for command insets
28776 \begin_layout Description
28777 commandframe Frame color for command insets
28780 \begin_layout Description
28781 comment Label color for comments
28784 \begin_layout Description
28785 commentbg Background color of comments
28788 \begin_layout Description
28789 cursor Cursor color
28792 \begin_layout Description
28793 deletedtext Deleted text color
28796 \begin_layout Description
28797 deletedtextmodifier Deleted text modifying color
28800 \begin_layout Description
28801 depthbar Color for the depth bars in the margin
28804 \begin_layout Description
28805 eolmarker End of line marker color
28808 \begin_layout Description
28809 error Color of the \SpecialChar LaTeX
28813 \begin_layout Description
28814 footlabel Label color for footnotes
28817 \begin_layout Description
28818 foreground Foreground color
28821 \begin_layout Description
28822 graphicsbg Graphics inset background color
28825 \begin_layout Description
28826 greyedoutbg Background color of greyedout inset
28829 \begin_layout Description
28830 greyedoutlabel Label color for greyedout insets
28833 \begin_layout Description
28834 greyedouttext Color for greyedout inset text
28837 \begin_layout Description
28838 indexlabel Label color for index insets
28841 \begin_layout Description
28842 inlinecompletion Inline completion color
28845 \begin_layout Description
28846 insetbg Inset marker background color
28849 \begin_layout Description
28850 insetframe Inset marker frame color
28853 \begin_layout Description
28854 language Color for marking foreign language words
28857 \begin_layout Description
28858 latex Text color in \SpecialChar LaTeX
28862 \begin_layout Description
28863 listingsbg Background color of listings inset
28866 \begin_layout Description
28867 marginlabel Label color for margin notes
28870 \begin_layout Description
28871 math Math inset text color
28874 \begin_layout Description
28875 mathbg Math inset background color
28878 \begin_layout Description
28879 mathcorners Math inset frame color not under focus
28882 \begin_layout Description
28883 mathframe Math inset frame color under focus
28886 \begin_layout Description
28887 mathline Math line color
28890 \begin_layout Description
28891 mathmacrobg Macro math inset background color
28894 \begin_layout Description
28895 mathmacroblend Macro math blended color
28898 \begin_layout Description
28899 mathmacroframe Macro math frame color
28902 \begin_layout Description
28903 mathmacrohoverbg Macro math inset background color hovered
28906 \begin_layout Description
28907 mathmacrolabel Macro math label color
28910 \begin_layout Description
28911 mathmacronewarg Macro template color for new parameters
28914 \begin_layout Description
28915 mathmacrooldarg Macro template color for old parameters
28918 \begin_layout Description
28919 newpage New page color
28922 \begin_layout Description
28923 nonunique_inlinecompletion Inline completion color for the non-unique part
28926 \begin_layout Description
28927 note Label color for notes
28930 \begin_layout Description
28931 notebg Background color of notes
28934 \begin_layout Description
28935 pagebreak Page break/line break color
28938 \begin_layout Description
28939 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28942 \begin_layout Description
28943 phantomtext Text color for phantom insets
28946 \begin_layout Description
28947 preview The color used for previews
28950 \begin_layout Description
28951 previewframe Preview frame color
28954 \begin_layout Description
28955 regexpframe Color for regexp frame
28958 \begin_layout Description
28959 scroll Color that indicates when a row can be scrolled
28962 \begin_layout Description
28963 selection Background color of selected text
28966 \begin_layout Description
28967 selectiontext Foreground color of selected text
28970 \begin_layout Description
28971 shadedbg Background color of shaded box
28974 \begin_layout Description
28975 special Special chars text color
28978 \begin_layout Description
28979 tabularline Table line color
28982 \begin_layout Description
28983 tabularonoffline Table line color
28986 \begin_layout Description
28987 urllabel Label color for URL insets
28990 \begin_layout Description
28991 urltext Color for URL inset text