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
128 \tracking_changes true
129 \output_changes false
133 \author -712698321 "Jürgen Spitzmüller"
134 \author -495245474 "Jean-Marc Lasgouttes"
135 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
141 Customizing \SpecialChar LyX
142 : Features for the Advanced User
146 by the \SpecialChar LyX
151 \begin_layout Plain Layout
153 If you have comments or error corrections, please send them to the \SpecialChar LyX
156 \begin_inset CommandInset href
158 target "lyx-docs@lists.lyx.org"
166 \begin_inset Quotes eld
170 \begin_inset Quotes erd
173 in the subject header, and please cc the current maintainer of this file,
174 Richard Heck <rgheck@comcast.net>.
180 \begin_inset Newline newline
184 \begin_inset Newline newline
190 \begin_layout Standard
191 \begin_inset CommandInset toc
192 LatexCommand tableofcontents
199 \begin_layout Standard
200 \begin_inset Note Note
203 \begin_layout Plain Layout
204 Please use change tracking when modifying this document.
205 This makes it easier for our translators to recognize things that have
206 been changed, and it helps the maintainer keep up-to-date with what's been
215 \begin_layout Chapter
219 \begin_layout Standard
220 This manual covers the customization features present in \SpecialChar LyX
222 In it, we discuss issues like keyboard shortcuts, screen previewing options,
223 printer options, sending commands to \SpecialChar LyX
224 via the \SpecialChar LyX
225 Server, internationalization,
226 installing new \SpecialChar LaTeX
227 classes and \SpecialChar LyX
229 We can't possibly hope to touch on everything you can change—our developers
230 add new features faster than we can document them—but we will explain the
231 most common customizations and hopefully point you in the right direction
232 for some of the more obscure ones.
235 \begin_layout Standard
236 \begin_inset Branch OutDated
240 \begin_layout Standard
241 Information from previous versions of this document that now seems to be
242 outdated is contained in the OutDated branch of this document.
243 By default, this information will not appear in the \SpecialChar LaTeX
252 \begin_layout Chapter
257 \begin_layout Standard
258 This chapter aims to help you to find your way through the \SpecialChar LyX
261 Before continuing to read this chapter, you should find out where your
263 library and user directories are by using
264 \begin_inset Flex Noun
267 \begin_layout Plain Layout
268 Help\SpecialChar menuseparator
279 The library directory is the place where \SpecialChar LyX
280 places its system-wide configuration
281 files; the user directory is where you can place your modified versions.
282 We will call the former
283 \begin_inset Flex Code
286 \begin_layout Plain Layout
293 \begin_inset Flex Noun
296 \begin_layout Plain Layout
302 in the remainder of this document.
306 \begin_layout Section
308 \begin_inset Flex Code
311 \begin_layout Plain Layout
320 \begin_layout Standard
321 \begin_inset Flex Code
324 \begin_layout Plain Layout
330 and its sub-directories contain a number of files and that can be used
331 to customize \SpecialChar LyX
333 You can change many of these files from within \SpecialChar LyX
335 \begin_inset Flex Noun
338 \begin_layout Plain Layout
339 Tools\SpecialChar menuseparator
346 Most customization that you will want to do in \SpecialChar LyX
347 is possible through this
349 However, many other inner aspects of \SpecialChar LyX
350 can be customized by modifying the
352 \begin_inset Flex Code
355 \begin_layout Plain Layout
362 These files fall in different categories, described in the following subsection
366 \begin_layout Subsection
367 Automatically generated files
370 \begin_layout Standard
371 The files, which are to be found in
372 \begin_inset Flex Noun
375 \begin_layout Plain Layout
381 , are generated when you configure \SpecialChar LyX
383 They contain various default values that are guessed by inspection.
384 In general, it is not a good idea to modify them, since they might be overwritt
388 \begin_layout Labeling
389 \labelwidthstring 00.00.0000
390 \begin_inset Flex Code
393 \begin_layout Plain Layout
399 contains defaults for various commands.
402 \begin_layout Labeling
403 \labelwidthstring 00.00.0000
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
413 contains the list of packages that have been recognized by \SpecialChar LyX
415 It is currently unused by the \SpecialChar LyX
416 program itself, but the information extracted,
417 and more, is made available with
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 Help\SpecialChar menuseparator
436 \begin_layout Labeling
437 \labelwidthstring 00.00.0000
438 \begin_inset Flex Code
441 \begin_layout Plain Layout
447 the list of text classes that have been found in your
448 \begin_inset Flex Code
451 \begin_layout Plain Layout
457 directories, along with the associated \SpecialChar LaTeX
458 document class and their description.
461 \begin_layout Labeling
462 \labelwidthstring 00.00.0000
463 \begin_inset Flex Code
466 \begin_layout Plain Layout
472 the list of layout modules found in your
473 \begin_inset Flex Code
476 \begin_layout Plain Layout
485 \begin_layout Labeling
486 \labelwidthstring 00.00.0000
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 lists of various sorts of \SpecialChar LaTeX
497 -related files found on your system
500 \begin_layout Labeling
501 \labelwidthstring 00.00.0000
502 \begin_inset Flex Code
505 \begin_layout Plain Layout
506 doc/\SpecialChar LaTeX
512 is automatically generated during configuration from the file
513 \begin_inset Flex Code
516 \begin_layout Plain Layout
524 It contains information on your \SpecialChar LaTeX
528 \begin_layout Subsection
532 \begin_layout Standard
533 These directories are duplicated between
534 \begin_inset Flex Code
537 \begin_layout Plain Layout
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
554 If a particular files exists in both places, the one in
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
567 \begin_layout Labeling
568 \labelwidthstring 00.00.0000
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
578 this directory contains files with the extension
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 that define the keybindings used in \SpecialChar LyX
590 If there exists an internationalized version of the bind file named
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 , that will be used first.
603 \begin_layout Labeling
604 \labelwidthstring 00.00.0000
605 \begin_inset Flex Code
608 \begin_layout Plain Layout
614 contains files with the extension
615 \begin_inset Flex Code
618 \begin_layout Plain Layout
624 which define the diverse citation possibilities (natbib, biblatex etc.).
626 \begin_inset CommandInset ref
628 reference "subsec:Cite-Engine-Files"
638 \begin_layout Labeling
639 \labelwidthstring 00.00.0000
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
649 contains graphics files that can be included in documents.
653 \begin_layout Labeling
654 \labelwidthstring 00.00.0000
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
664 contains \SpecialChar LyX
665 documentation files (including the one you are currently reading).
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
677 deserves special attention, as noted above.
678 The internationalized help docs are in subdirectories
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
689 \begin_inset Quotes eld
693 \begin_inset Quotes erd
696 is the ISO language code.
698 \begin_inset CommandInset ref
700 reference "cha:Internationalizing-LyX"
707 \begin_layout Labeling
708 \labelwidthstring 00.00.0000
709 \begin_inset Flex Code
712 \begin_layout Plain Layout
718 contains example files that explain how to use some features.
719 In the file browser, press the
720 \begin_inset Flex Noun
723 \begin_layout Plain Layout
732 \begin_layout Labeling
733 \labelwidthstring 00.00.0000
734 \begin_inset Flex Code
737 \begin_layout Plain Layout
743 contains image files that are used by the
744 \begin_inset Flex Noun
747 \begin_layout Plain Layout
754 In addition, it also contains the individual icons used in the toolbar
755 and the banners that can be shown when \SpecialChar LyX
759 \begin_layout Labeling
760 \labelwidthstring 00.00.0000
761 \begin_inset Flex Code
764 \begin_layout Plain Layout
770 contains keyboard keymapping files.
772 \begin_inset CommandInset ref
774 reference "sec:International-Keymap-Stuff"
781 \begin_layout Labeling
782 \labelwidthstring 00.00.0000
783 \begin_inset Flex Code
786 \begin_layout Plain Layout
792 contains the text class and module files described in
793 \begin_inset CommandInset ref
795 reference "cha:Installing-New-Document"
802 \begin_layout Labeling
803 \labelwidthstring 00.00.0000
804 \begin_inset Flex Code
807 \begin_layout Plain Layout
814 \begin_inset Flex Code
817 \begin_layout Plain Layout
823 Python scripts used to convert between \SpecialChar LyX
825 These can be run from the command line if, say, you want to batch-convert
829 \begin_layout Labeling
830 \labelwidthstring 00.00.0000
831 \begin_inset Flex Code
834 \begin_layout Plain Layout
840 contains some files that demonstrate the capabilities of the
841 \begin_inset Flex Noun
844 \begin_layout Plain Layout
855 Also contains some scripts used by \SpecialChar LyX
859 \begin_layout Labeling
860 \labelwidthstring 00.00.0000
861 \begin_inset Flex Code
864 \begin_layout Plain Layout
870 contains the standard \SpecialChar LyX
871 template files described in
872 \begin_inset CommandInset ref
874 reference "subsec:Creating-Templates"
881 \begin_layout Labeling
882 \labelwidthstring 00.00.0000
883 \begin_inset Flex Code
886 \begin_layout Plain Layout
892 contains files with the extension
893 \begin_inset Flex Code
896 \begin_layout Plain Layout
902 that define the user interface to \SpecialChar LyX
904 That is, the files define which items appear in which menus and the items
905 appearing on the toolbar.
908 \begin_layout Labeling
909 \labelwidthstring 00.00.0000
910 \begin_inset Flex Code
913 \begin_layout Plain Layout
919 contains files with the extension
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
929 which define the templates for the insertion of external material to a
932 \begin_inset CommandInset ref
934 reference "chap:Including-External-Material"
941 \begin_layout Subsection
942 Files you don't want to modify
945 \begin_layout Standard
946 These files are used internally by \SpecialChar LyX
947 and you generally do not need to modify
948 them unless you are a developer.
951 \begin_layout Labeling
952 \labelwidthstring 00.00.0000
953 \begin_inset Flex Code
956 \begin_layout Plain Layout
962 this file contains the list of \SpecialChar LyX
964 The contents are displayed with the menu entry
965 \begin_inset Flex Noun
968 \begin_layout Plain Layout
969 Help\SpecialChar menuseparator
982 \begin_layout Labeling
983 \labelwidthstring 00.00.0000
984 \begin_inset Flex Code
987 \begin_layout Plain Layout
993 this is a \SpecialChar LaTeX
994 script used during the configuration process.
998 \begin_layout Labeling
999 \labelwidthstring 00.00.0000
1000 \begin_inset Flex Code
1003 \begin_layout Plain Layout
1009 this is a Python script that is used to re-configure \SpecialChar LyX
1011 It creates configuration files in the directory it was run from.
1014 \begin_layout Subsection
1015 Other files needing a line or two
1018 \begin_layout Labeling
1019 \labelwidthstring 00.00.0000
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1029 this contains tables describing how different character encodings can be
1033 \begin_layout Labeling
1034 \labelwidthstring 00.00.0000
1035 \begin_inset Flex Code
1038 \begin_layout Plain Layout
1044 this file contains a list of all the languages currently supported by \SpecialChar LyX
1048 \begin_layout Labeling
1049 \labelwidthstring 00.00.0000
1050 \begin_inset Flex Code
1053 \begin_layout Plain Layout
1059 contains information about the supported fonts.
1062 \begin_layout Labeling
1063 \labelwidthstring 00.00.0000
1064 \begin_inset Flex Code
1067 \begin_layout Plain Layout
1073 this file contains translations for internationalized paragraph styles
1075 \begin_inset CommandInset ref
1077 reference "subsec:I18n"
1084 \begin_layout Labeling
1085 \labelwidthstring 00.00.0000
1086 \begin_inset Flex Code
1089 \begin_layout Plain Layout
1095 this file contains information about Unicode-encoded glyphs and the way
1096 they are supported by \SpecialChar LyX
1097 via \SpecialChar LaTeX
1101 \begin_layout Section
1102 Your local configuration directory
1105 \begin_layout Standard
1106 Even if you are using \SpecialChar LyX
1107 as an unprivileged user, you might want to change
1109 configuration for your own use.
1111 \begin_inset Flex Code
1114 \begin_layout Plain Layout
1120 directory contains all your personal configuration files.
1121 This is the directory described as
1122 \begin_inset Quotes eld
1126 \begin_inset Quotes erd
1130 \begin_inset Flex Noun
1133 \begin_layout Plain Layout
1134 Help\SpecialChar menuseparator
1136 \begin_inset space ~
1145 This directory is used as a mirror of
1146 \begin_inset Flex Code
1149 \begin_layout Plain Layout
1155 , which means that every file in
1156 \begin_inset Flex Code
1159 \begin_layout Plain Layout
1165 is a replacement for the corresponding file in
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1176 Any configuration file described in the above sections can be placed either
1177 in the system-wide directory, in which case it will affect all users, or
1178 in your local directory for your own use.
1181 \begin_layout Standard
1182 To make things clearer, let's provide a few examples:
1185 \begin_layout Itemize
1186 The preferences set in the
1187 \begin_inset Flex Noun
1190 \begin_layout Plain Layout
1191 Tools\SpecialChar menuseparator
1197 dialog are saved to a file
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1208 \begin_inset Flex Code
1211 \begin_layout Plain Layout
1220 \begin_layout Itemize
1221 When you reconfigure using
1222 \begin_inset Flex Noun
1225 \begin_layout Plain Layout
1226 Tools\SpecialChar menuseparator
1234 \begin_inset Flex Code
1237 \begin_layout Plain Layout
1243 script, and the resulting files are written in your local configuration
1245 This means that any additional text class file that you might have added
1247 \begin_inset Flex Code
1250 \begin_layout Plain Layout
1256 will be added to the list of classes in the
1257 \begin_inset Flex Noun
1260 \begin_layout Plain Layout
1261 Document\SpecialChar menuseparator
1270 \begin_layout Itemize
1271 If you get some updated documentation from \SpecialChar LyX
1272 ftp site and cannot install
1273 it because you do not have sysadmin rights on your system, you can just
1275 \begin_inset Flex Code
1278 \begin_layout Plain Layout
1284 and the items in the
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1294 menu will open them!
1297 \begin_layout Section
1298 Running \SpecialChar LyX
1299 with multiple configurations
1302 \begin_layout Standard
1303 The configuration freedom of the local configuration directory may not suffice
1304 if you want to have more than one configuration at your disposal.
1305 For example, you may want to be use different key bindings or printer settings
1307 You can achieve this by having several such directories.
1308 You then specify which directory to use at run-time.
1311 \begin_layout Standard
1312 Invoking \SpecialChar LyX
1313 with the command line switch
1314 \begin_inset Flex Code
1317 \begin_layout Plain Layout
1327 instructs the program to read the configuration from that directory, and
1328 not from the default directory.
1329 (You can determine the default directory by running \SpecialChar LyX
1331 \begin_inset Flex Code
1334 \begin_layout Plain Layout
1340 switch.) If the specified directory does not exist, \SpecialChar LyX
1342 for you, just like it does for the default directory on the first time
1343 you run the program.
1344 You can modify the configuration options in this additional user directory
1345 exactly as you would for the default directory.
1346 These directories are completely independent (but read on).
1347 Note that setting the environment variable
1348 \begin_inset Flex Code
1351 \begin_layout Plain Layout
1357 to some value has exactly the same effect.
1360 \begin_layout Standard
1361 Having several configurations also requires more maintenance: if you want
1362 to add a new layout to
1363 \begin_inset Flex Code
1366 \begin_layout Plain Layout
1372 which you want available from all your configurations, you must add it
1373 to each directory separately.
1374 You can avoid this with the following trick: after \SpecialChar LyX
1375 creates the additional
1376 directory, most of the subdirectories (see above) are empty.
1377 If you want the new configuration to mirror an existing one, replace the
1378 empty subdirectory with a symbolic link to the matching subdirectory in
1379 the existing configuration.
1381 \begin_inset Flex Code
1384 \begin_layout Plain Layout
1390 subdirectory, however, since it contains a file written by the configuration
1391 script (also accessible through
1392 \begin_inset Flex Noun
1395 \begin_layout Plain Layout
1396 Tools\SpecialChar menuseparator
1402 ) which is configuration-specific.
1405 \begin_layout Chapter
1406 The Preferences dialog
1409 \begin_layout Standard
1410 All options of the preferences dialog are described in the Appendix
1412 The Preferences Dialog
1419 For some options you might find here more details.
1422 \begin_layout Section
1424 \begin_inset CommandInset label
1433 \begin_layout Standard
1434 The first step is to define your file formats if they are not already defined.
1436 \begin_inset Flex Noun
1439 \begin_layout Plain Layout
1440 Tools\SpecialChar menuseparator
1448 \begin_inset Flex Noun
1451 \begin_layout Plain Layout
1452 File Handling\SpecialChar menuseparator
1459 \begin_inset Flex Noun
1462 \begin_layout Plain Layout
1468 button to define your new format.
1470 \begin_inset Flex Noun
1473 \begin_layout Plain Layout
1479 field contains the name used to identify the format in the GUI.
1481 \begin_inset Flex Noun
1484 \begin_layout Plain Layout
1490 is used to identify the format internally.
1491 You will also need to enter a file extension.
1492 These are all required.
1494 \begin_inset Flex Noun
1497 \begin_layout Plain Layout
1503 field is used to provide a keyboard shortcut on the menus.
1504 (For example, pressing
1505 \begin_inset Flex Noun
1508 \begin_layout Plain Layout
1515 \begin_inset Flex Noun
1518 \begin_layout Plain Layout
1519 Document\SpecialChar menuseparator
1520 View (Other Formats)\SpecialChar menuseparator
1529 \begin_layout Standard
1531 \begin_inset Flex Noun
1534 \begin_layout Plain Layout
1541 \begin_inset Flex Noun
1544 \begin_layout Plain Layout
1551 For example, you might want to use
1552 \begin_inset Flex Noun
1555 \begin_layout Plain Layout
1561 to view PostScript files.
1562 You can enter the command needed to start the program in the corresponding
1564 In defining this command, you can use the four variables listed in the
1566 The viewer is launched when you view an image in \SpecialChar LyX
1568 \begin_inset Flex Noun
1571 \begin_layout Plain Layout
1572 Document\SpecialChar menuseparator
1579 The editor is for example launched when you right-click on an image and
1581 \begin_inset Flex Noun
1584 \begin_layout Plain Layout
1590 in the appearing context menu.
1593 \begin_layout Standard
1595 \begin_inset Flex Noun
1598 \begin_layout Plain Layout
1604 type of a format is optional, but if it is specified, it must be unique
1606 It is used to detect files of this format from the file contents.
1607 For some important file formats there is no MIME type officially registered
1609 \begin_inset CommandInset href
1612 target "http://www.iana.org/assignments/media-types/"
1618 Therefore \SpecialChar LyX
1619 uses the extended list of MIME types as specified by
1620 \begin_inset CommandInset href
1622 name "freedesktop.org"
1623 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1631 \begin_layout Standard
1633 \begin_inset Flex Noun
1636 \begin_layout Plain Layout
1642 option tells \SpecialChar LyX
1643 that a format is suitable for document export.
1644 If this is set and if a suitable conversion route exists (see
1645 \begin_inset CommandInset ref
1647 reference "sec:Converters"
1651 ), the format will appear in the
1652 \begin_inset Flex Noun
1655 \begin_layout Plain Layout
1656 File\SpecialChar menuseparator
1663 The format will also appear in the
1664 \begin_inset Flex Noun
1667 \begin_layout Plain Layout
1668 Document\SpecialChar menuseparator
1674 menu if a viewer is specified for the format.
1675 Pure image formats, such as
1676 \begin_inset Flex Code
1679 \begin_layout Plain Layout
1685 , should not use this option.
1686 Formats that can both represent vector graphics and documents like
1687 \begin_inset Flex Code
1690 \begin_layout Plain Layout
1699 \begin_layout Standard
1701 \begin_inset Flex Noun
1704 \begin_layout Plain Layout
1705 Vector graphics format
1710 tells \SpecialChar LyX
1711 that a format can contain vector graphics.
1712 This information is used to determine the target format of included graphics
1714 \begin_inset Flex Noun
1717 \begin_layout Plain Layout
1724 Included graphics may need to be converted to either
1725 \begin_inset Flex Noun
1728 \begin_layout Plain Layout
1735 \begin_inset Flex Noun
1738 \begin_layout Plain Layout
1745 \begin_inset Flex Noun
1748 \begin_layout Plain Layout
1755 \begin_inset Flex Noun
1758 \begin_layout Plain Layout
1764 cannot handle other image formats.
1765 If an included graphic is not already in
1766 \begin_inset Flex Noun
1769 \begin_layout Plain Layout
1776 \begin_inset Flex Noun
1779 \begin_layout Plain Layout
1786 \begin_inset Flex Noun
1789 \begin_layout Plain Layout
1795 format, it is converted to
1796 \begin_inset Flex Noun
1799 \begin_layout Plain Layout
1805 if the vector format option is set, and otherwise to
1806 \begin_inset Flex Noun
1809 \begin_layout Plain Layout
1818 \begin_layout Section
1822 \begin_layout Standard
1823 Since all conversions from one format to another take place in \SpecialChar LyX
1825 directory, it is sometimes necessary to modify a file before copying it
1826 to the temporary directory in order that the conversion may be performed.
1830 \begin_layout Plain Layout
1831 For example, the file may refer to other files—images, for example—using
1832 relative file names, and these may become invalid when the file is copied
1833 to the temporary directory.
1838 This is done by a Copier: It copies a file to (or from) the temporary directory
1839 and may modify it in the process.
1842 \begin_layout Standard
1843 The definitions of the copiers may use eight variables:
1846 \begin_layout Labeling
1847 \labelwidthstring 00.00.0000
1848 \begin_inset Flex Code
1851 \begin_layout Plain Layout
1857 The \SpecialChar LyX
1858 system directory (e.
1859 \begin_inset space \thinspace{}
1863 \begin_inset space \space{}
1867 \begin_inset Flex Noun
1870 \begin_layout Plain Layout
1879 \begin_layout Labeling
1880 \labelwidthstring 00.00.0000
1881 \begin_inset Flex Code
1884 \begin_layout Plain Layout
1893 \begin_layout Labeling
1894 \labelwidthstring 00.00.0000
1895 \begin_inset Flex Code
1898 \begin_layout Plain Layout
1907 \begin_layout Labeling
1908 \labelwidthstring 00.00.0000
1909 \begin_inset Flex Code
1912 \begin_layout Plain Layout
1918 The base name (without filename extension) in the \SpecialChar LyX
1922 \begin_layout Labeling
1923 \labelwidthstring 00.00.0000
1924 \begin_inset Flex Code
1927 \begin_layout Plain Layout
1933 The full directory path of the \SpecialChar LyX
1937 \begin_layout Labeling
1938 \labelwidthstring 00.00.0000
1939 \begin_inset Flex Code
1942 \begin_layout Plain Layout
1948 The full pathname to the original \SpecialChar LyX
1949 file being processed
1952 \begin_layout Labeling
1953 \labelwidthstring 00.00.0000
1954 \begin_inset Flex Code
1957 \begin_layout Plain Layout
1963 The filename (without any directory path) of the \SpecialChar LyX
1967 \begin_layout Labeling
1968 \labelwidthstring 00.00.0000
1969 \begin_inset Flex Code
1972 \begin_layout Plain Layout
1978 The `\SpecialChar LaTeX
1982 \begin_layout Standard
1983 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1991 It is relevant only when exporting files suitable for such inclusion.
1994 \begin_layout Standard
1995 Copiers can be used to do almost anything with output files.
1996 For example, suppose you want generated pdf files to be copied to a special
1998 \begin_inset Flex Code
2001 \begin_layout Plain Layout
2008 Then you could write a shell script such as this one:
2011 \begin_layout Standard
2012 \begin_inset listings
2016 \begin_layout Plain Layout
2021 \begin_layout Plain Layout
2026 \begin_layout Plain Layout
2028 TOFILE=`basename $2`
2031 \begin_layout Plain Layout
2033 cp $FROMFILE /home/you/pdf/$TOFILE
2038 Save it in your local \SpecialChar LyX
2040 \begin_inset Flex Code
2043 \begin_layout Plain Layout
2044 /home/you/.lyx/scripts/pdfcopier.sh
2049 —and make it executable, if you need to do so on your platform.
2051 \begin_inset Flex Noun
2054 \begin_layout Plain Layout
2055 Tools\SpecialChar menuseparator
2061 dialog, select under
2062 \begin_inset Flex Noun
2065 \begin_layout Plain Layout
2066 File Handling\SpecialChar menuseparator
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2082 format—or one of the other pdf formats—and enter
2083 \begin_inset Flex Code
2086 \begin_layout Plain Layout
2087 pdfcopier.sh $$i $$o
2093 \begin_inset Flex Noun
2096 \begin_layout Plain Layout
2106 \begin_layout Standard
2107 Copiers are used by \SpecialChar LyX
2108 in various of its own conversions.
2109 For example, if appropriate programs are found, \SpecialChar LyX
2110 will automatically install
2112 \begin_inset Flex Noun
2115 \begin_layout Plain Layout
2122 \begin_inset Flex Noun
2125 \begin_layout Plain Layout
2127 \begin_inset space ~
2136 When these formats are exported, the copier sees that not just the main
2137 HTML file but various associated files (style files, images, etc.) are also
2139 All these files are written to a subdirectory of the directory in which
2140 the original \SpecialChar LyX
2145 \begin_layout Plain Layout
2146 This copier can be customized.
2148 \begin_inset Quotes eld
2152 \begin_inset Quotes erd
2155 argument takes a comma-separated list of extensions to be copied; if it
2156 is omitted, all files will be copied.
2158 \begin_inset Quotes eld
2162 \begin_inset Quotes erd
2165 argument determines the extension added to the generated directory.
2167 \begin_inset Quotes eld
2171 \begin_inset Flex Noun
2174 \begin_layout Plain Layout
2181 \begin_inset Quotes erd
2184 , so HTML generated from
2185 \begin_inset Flex Noun
2188 \begin_layout Plain Layout
2189 /path/to/filename.lyx
2195 \begin_inset Flex Noun
2198 \begin_layout Plain Layout
2199 /path/to/filename.html.LyXconv
2213 \begin_layout Section
2215 \begin_inset CommandInset label
2217 name "sec:Converters"
2224 \begin_layout Standard
2225 You can define your own Converters to convert files between different formats.
2227 \begin_inset Flex Noun
2230 \begin_layout Plain Layout
2231 Tools\SpecialChar menuseparator
2232 Preferences\SpecialChar menuseparator
2233 File Handling\SpecialChar menuseparator
2242 \begin_layout Standard
2243 To define a new converter, select the
2244 \begin_inset Flex Noun
2247 \begin_layout Plain Layout
2249 \begin_inset space ~
2258 \begin_inset Flex Noun
2261 \begin_layout Plain Layout
2263 \begin_inset space ~
2271 from the drop-down lists, enter the command needed for the conversion,
2273 \begin_inset Flex Noun
2276 \begin_layout Plain Layout
2283 Several variables can be used in the definition of converters:
2286 \begin_layout Labeling
2287 \labelwidthstring 00.00.0000
2288 \begin_inset Flex Code
2291 \begin_layout Plain Layout
2297 The \SpecialChar LyX
2301 \begin_layout Labeling
2302 \labelwidthstring 00.00.0000
2303 \begin_inset Flex Code
2306 \begin_layout Plain Layout
2315 \begin_layout Labeling
2316 \labelwidthstring 00.00.0000
2317 \begin_inset Flex Code
2320 \begin_layout Plain Layout
2329 \begin_layout Labeling
2330 \labelwidthstring 00.00.0000
2331 \begin_inset Flex Code
2334 \begin_layout Plain Layout
2340 The base filename of the input file (i.
2341 \begin_inset space \thinspace{}
2344 g., without the extension)
2347 \begin_layout Labeling
2348 \labelwidthstring 00.00.0000
2349 \begin_inset Flex Code
2352 \begin_layout Plain Layout
2358 The path to the input file
2361 \begin_layout Labeling
2362 \labelwidthstring 00.00.0000
2363 \begin_inset Flex Code
2366 \begin_layout Plain Layout
2372 The path to the original input file (this is different from $$p when a
2373 chain of converters is called)
2376 \begin_layout Labeling
2377 \labelwidthstring 00.00.0000
2378 \begin_inset Flex Code
2381 \begin_layout Plain Layout
2387 The iconv name for the encoding of the document.
2390 \begin_layout Standard
2392 \begin_inset Flex Noun
2395 \begin_layout Plain Layout
2397 \begin_inset space ~
2405 field you can enter the following flags, separated by commas:
2408 \begin_layout Labeling
2409 \labelwidthstring 00.00.0000
2410 \begin_inset Flex Code
2413 \begin_layout Plain Layout
2415 \change_inserted -712698321 1524656940
2423 This converter runs some form of \SpecialChar LaTeX
2425 This will make \SpecialChar LyX
2426 's \SpecialChar LaTeX
2427 error logs available.
2429 \change_inserted -712698321 1524657018
2431 \begin_inset Flex Code
2434 \begin_layout Plain Layout
2436 \change_inserted -712698321 1524657012
2444 value specifies the form of \SpecialChar LaTeX
2446 \begin_inset Flex Code
2449 \begin_layout Plain Layout
2451 \change_inserted -712698321 1524657005
2452 latex, pdflatex, platex, xetex, luatex
2460 If no value is specified,
2461 \begin_inset Flex Code
2464 \begin_layout Plain Layout
2466 \change_inserted -712698321 1524657018
2479 \begin_layout Labeling
2480 \labelwidthstring 00.00.0000
2481 \begin_inset Flex Code
2484 \begin_layout Plain Layout
2486 \change_inserted -712698321 1524656935
2494 Needs the \SpecialChar LaTeX
2496 \begin_inset Flex Noun
2499 \begin_layout Plain Layout
2505 file for the conversion.
2507 \change_inserted -712698321 1524657047
2509 \begin_inset Flex Code
2512 \begin_layout Plain Layout
2514 \change_inserted -712698321 1524657030
2520 value specifies the form of \SpecialChar LaTeX
2521 that is run in order to generate the
2522 \begin_inset Flex Noun
2525 \begin_layout Plain Layout
2527 \change_inserted -712698321 1524657047
2534 \begin_inset Flex Code
2537 \begin_layout Plain Layout
2539 \change_inserted -712698321 1524657030
2540 latex, pdflatex, platex, xetex, luatex
2546 If no value is specified,
2547 \begin_inset Flex Code
2550 \begin_layout Plain Layout
2552 \change_inserted -712698321 1524657030
2563 \begin_layout Labeling
2564 \labelwidthstring 00.00.0000
2565 \begin_inset Flex Code
2568 \begin_layout Plain Layout
2575 \begin_inset Quotes eld
2579 \begin_inset Quotes erd
2582 file from the backend, which in practice means a \SpecialChar LaTeX
2583 file like the one we
2584 would export, without
2585 \begin_inset Flex Code
2588 \begin_layout Plain Layout
2597 \begin_layout Labeling
2598 \labelwidthstring 00.00.0000
2599 \begin_inset Flex Code
2602 \begin_layout Plain Layout
2611 \begin_layout Standard
2612 The following three flags are not really flags at all because they take
2614 \begin_inset Flex Noun
2617 \begin_layout Plain Layout
2619 \begin_inset space ~
2623 \begin_inset space ~
2634 \begin_layout Labeling
2635 \labelwidthstring 00.00.0000
2637 \change_inserted -712698321 1523206314
2638 \begin_inset Flex Code
2641 \begin_layout Plain Layout
2643 \change_inserted -712698321 1523206193
2649 The name of the driver that needs to be loaded with the
2653 package for this converter.
2654 The loading of the correct driver is necessary to get some PDF-specific
2663 \begin_layout Labeling
2664 \labelwidthstring 00.00.0000
2665 \begin_inset Flex Code
2668 \begin_layout Plain Layout
2674 If set, the converter's standard error will be redirected to a file
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2684 , and the script given as argument will be run as:
2685 \begin_inset Flex Code
2688 \begin_layout Plain Layout
2689 script < infile.out > infile.log
2695 The argument may contain
2696 \begin_inset Flex Code
2699 \begin_layout Plain Layout
2708 \begin_layout Labeling
2709 \labelwidthstring 00.00.0000
2710 \begin_inset Flex Code
2713 \begin_layout Plain Layout
2719 The name of the directory in which the converter will dump the generated
2722 will not create this directory, and it does not copy anything into it,
2723 though it will copy this directory to the destination.
2724 The argument may contain
2725 \begin_inset Flex Code
2728 \begin_layout Plain Layout
2734 , which will be replaced by the base name of the input and output files,
2735 respectively, when the directory is copied.
2736 \begin_inset Newline newline
2739 Note that resultdir and usetempdir make no sense together.
2740 The latter will be ignored if the former is given.
2743 \begin_layout Labeling
2744 \labelwidthstring 00.00.0000
2745 \begin_inset Flex Code
2748 \begin_layout Plain Layout
2754 Determines the output file name and may, contain
2755 \begin_inset Flex Code
2758 \begin_layout Plain Layout
2765 Sensible only with resultdir and optional even then; if not given, it defaults
2769 \begin_layout Standard
2771 \change_inserted -712698321 1523206384
2772 A suitable hyperref-driver is set for some converters that are installed
2773 with \SpecialChar LyX
2776 \change_deleted -712698321 1523206388
2778 \change_inserted -712698321 1523206389
2782 \change_inserted -712698321 1523206400
2786 \change_inserted -712698321 1523206407
2790 \change_inserted -712698321 1523206437
2794 \change_deleted -712698321 1523206442
2795 that are installed with \SpecialChar LyX
2802 \begin_layout Standard
2803 You do not have to define converters for all formats between which you want
2805 For example, you will note that there is no `\SpecialChar LyX
2806 to PostScript' converter,
2807 but \SpecialChar LyX
2808 will export PostScript.
2809 It does so by first creating a \SpecialChar LaTeX
2810 file (no converter needs to be defined
2811 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2813 and finally converting the resulting DVI file to PostScript.
2815 finds such `chains' of converters automatically, and it will always choose
2816 the shortest possible chain.
2817 You can, though, still define multiple conversion methods between file
2819 For example, the standard \SpecialChar LyX
2820 configuration provides five ways to convert
2825 \begin_layout Enumerate
2827 \begin_inset Flex Noun
2830 \begin_layout Plain Layout
2839 \begin_layout Enumerate
2840 via (DVI and) PostScript, using
2841 \begin_inset Flex Noun
2844 \begin_layout Plain Layout
2853 \begin_layout Enumerate
2855 \begin_inset Flex Noun
2858 \begin_layout Plain Layout
2867 \begin_layout Enumerate
2869 \begin_inset Flex Noun
2872 \begin_layout Plain Layout
2882 \begin_layout Enumerate
2884 \begin_inset Flex Noun
2887 \begin_layout Plain Layout
2897 \begin_layout Standard
2898 To define such alternate chains, you must define multiple target `file formats',
2900 \begin_inset CommandInset ref
2902 reference "sec:Formats"
2907 For example, in the standard configuration, the formats named
2908 \begin_inset Flex Noun
2911 \begin_layout Plain Layout
2918 \begin_inset Flex Noun
2921 \begin_layout Plain Layout
2928 \begin_inset Flex Noun
2931 \begin_layout Plain Layout
2938 \begin_inset Flex Noun
2941 \begin_layout Plain Layout
2948 \begin_inset Flex Noun
2951 \begin_layout Plain Layout
2958 \begin_inset Flex Noun
2961 \begin_layout Plain Layout
2968 \begin_inset Flex Noun
2971 \begin_layout Plain Layout
2978 \begin_inset Flex Noun
2981 \begin_layout Plain Layout
2989 \begin_inset Flex Noun
2992 \begin_layout Plain Layout
2999 \begin_inset Flex Noun
3002 \begin_layout Plain Layout
3009 ) are defined, all of which share the extension
3010 \begin_inset Flex Noun
3013 \begin_layout Plain Layout
3019 , and which correspond to the conversion methods just mentioned.
3022 \begin_layout Chapter
3023 Internationalizing \SpecialChar LyX
3025 \begin_inset CommandInset label
3027 name "cha:Internationalizing-LyX"
3034 \begin_layout Standard
3036 supports using a translated interface.
3037 Last time we checked, \SpecialChar LyX
3038 provided text in thirty languages.
3039 The language of choice is called your
3044 (For further reading on locale settings, see also the documentation for
3045 locale that comes with your operating system.
3046 For Linux, the manual page for
3047 \begin_inset Flex Code
3050 \begin_layout Plain Layout
3056 could be a good place to start).
3059 \begin_layout Standard
3060 Notice that these translations will work, but do contain a few flaws.
3061 In particular, all dialogs have been designed with the English text in
3062 mind, which means that some of the translated text will be too large to
3063 fit within the space allocated.
3064 This is only a display problem and will not cause any harm.
3065 Also, you will find that some of the translations do not define shortcut
3066 keys for everything.
3067 Sometimes, there are simply not enough free letters to do it.
3068 Other times, the translator just hasn't got around to doing it yet.
3069 Our localization team, which you may wish to join,
3073 \begin_layout Plain Layout
3074 If you are a fluent speaker of a language other than English, joining these
3075 teams is a great way to give back to the \SpecialChar LyX
3081 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3085 \begin_layout Section
3086 Translating \SpecialChar LyX
3090 \begin_layout Subsection
3091 Translating the graphical user interface (text messages).
3094 \begin_layout Standard
3097 \begin_inset Flex Code
3100 \begin_layout Plain Layout
3106 library to handle the internationalization of the interface.
3107 To have \SpecialChar LyX
3108 speak your favorite language in all menus and dialogs, you need
3110 \begin_inset Flex Code
3113 \begin_layout Plain Layout
3119 -file for that language.
3120 When this is available, you'll have to generate a
3121 \begin_inset Flex Code
3124 \begin_layout Plain Layout
3130 -file from it and install the
3131 \begin_inset Flex Code
3134 \begin_layout Plain Layout
3141 The process of doing all of this is explained in the documentation for
3143 \begin_inset Flex Code
3146 \begin_layout Plain Layout
3153 It is possible to do this just for yourself, but if you're going to do
3154 it, you might as well share the results of your labors with the rest of
3155 the \SpecialChar LyX
3157 Send a message to the \SpecialChar LyX
3158 developers' list for more information about how
3162 \begin_layout Standard
3163 In short, this is what you should do (xx denotes the language code):
3166 \begin_layout Itemize
3167 Check out the \SpecialChar LyX
3170 \begin_inset CommandInset href
3172 name "information on the web"
3173 target "https://www.lyx.org/HowToUseGIT"
3181 \begin_layout Itemize
3183 \begin_inset Flex Code
3186 \begin_layout Plain Layout
3192 to the folder of the
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3204 \begin_inset Flex Code
3207 \begin_layout Plain Layout
3215 \begin_inset Flex Code
3218 \begin_layout Plain Layout
3224 doesn't exist anywhere, it can be remade with the console command
3225 \begin_inset Flex Code
3228 \begin_layout Plain Layout
3234 in that directory, or you can use an existing po-file for some other language
3238 \begin_layout Itemize
3240 \begin_inset Flex Code
3243 \begin_layout Plain Layout
3253 \begin_layout Plain Layout
3254 This is just a text file, so it can be edited in any text editor.
3255 But there are also specialized programs that support such editing, such
3260 (for all platforms) or
3269 contains a `mode' for editing
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3280 \begin_inset Flex URL
3283 \begin_layout Plain Layout
3285 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3295 For some menu- and widget-labels, there are also shortcut keys that should
3297 Those keys are marked after a `|', and should be translated according to
3298 the words and phrases of the language.
3299 You should also fill also out the information at the beginning of the new
3301 \begin_inset Flex Code
3304 \begin_layout Plain Layout
3310 -file with your email-address, etc., so people know where to reach you with
3311 suggestions and entertaining flames.
3314 \begin_layout Standard
3315 If you are just doing this on your own, then:
3318 \begin_layout Itemize
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3330 This can be done with
3331 \begin_inset Flex Code
3334 \begin_layout Plain Layout
3335 msgfmt -o xx.mo < xx.po
3343 \begin_layout Itemize
3345 \begin_inset Flex Code
3348 \begin_layout Plain Layout
3354 -file to your locale-tree, at the correct directory for application messages
3359 xx, and under the name
3360 \begin_inset Flex Code
3363 \begin_layout Plain Layout
3370 \begin_inset space \thinspace{}
3374 \begin_inset space \space{}
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3382 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3392 \begin_layout Standard
3393 As said, however, it would be best if the new
3394 \begin_inset Flex Code
3397 \begin_layout Plain Layout
3403 file could be added to the \SpecialChar LyX
3404 distribution, so others can use it.
3405 Adding it involves making additional changes to \SpecialChar LyX
3407 So send an email to the developers' mailing list if you're interested in
3411 \begin_layout Subsubsection
3415 \begin_layout Standard
3416 Sometimes it turns out that one English message needs to be translated into
3417 different messages in the target language.
3418 One example is the message
3419 \begin_inset Flex Code
3422 \begin_layout Plain Layout
3428 which has the German translation
3436 , depending upon exactly what the English
3437 \begin_inset Quotes eld
3441 \begin_inset Quotes erd
3446 \begin_inset Flex Code
3449 \begin_layout Plain Layout
3455 does not handle such ambiguous translations.
3456 Therefore you have to add some context information to the message: Instead
3458 \begin_inset Flex Code
3461 \begin_layout Plain Layout
3468 \begin_inset Flex Code
3471 \begin_layout Plain Layout
3472 To[[as in 'From format x to format y']]
3478 \begin_inset Flex Code
3481 \begin_layout Plain Layout
3482 To[[as in 'From page x to page y']].
3487 Now the two occurrences of
3488 \begin_inset Flex Code
3491 \begin_layout Plain Layout
3498 \begin_inset Flex Code
3501 \begin_layout Plain Layout
3507 and can be translated correctly to
3518 \begin_layout Standard
3519 Of course the context information needs to be stripped off the original
3520 message when no translation is used.
3521 Therefore you have to put it in double square brackets at the end of the
3522 message (see the example above).
3523 The translation mechanism of \SpecialChar LyX
3524 ensures that everything in double square
3525 brackets at the end of messages is removed before displaying the message.
3528 \begin_layout Subsection
3529 Translating the documentation.
3532 \begin_layout Standard
3533 The online documentation (in the
3534 \begin_inset Flex Noun
3537 \begin_layout Plain Layout
3543 -menu) can (and should!) be translated.
3544 If there are translated versions of the documentation available
3548 \begin_layout Plain Layout
3549 As of March 2008, at least some of the documents have been translated into
3550 fourteen languages, with the Tutorial available in a few more.
3555 and the locale is set accordingly, these will be used automagically by
3559 looks for translated versions as
3560 \begin_inset Flex Code
3563 \begin_layout Plain Layout
3564 LyXDir/doc/xx/DocName.lyx
3570 \begin_inset Flex Code
3573 \begin_layout Plain Layout
3579 is the code for the language currently in use.
3580 If there are no translated documents, the default English versions will
3582 Note that the translated versions must have the same filenames (
3583 \begin_inset Flex Code
3586 \begin_layout Plain Layout
3592 above) as the original.
3593 If you feel up to translating the documentation (an excellent way to proof-read
3594 the original documentation by the way!), there are a few things you should
3598 \begin_layout Itemize
3599 Check out the documentation translation web page at
3600 \begin_inset CommandInset href
3602 name "https://www.lyx.org/Translation"
3603 target "https://www.lyx.org/Translation"
3609 That way, you can find out which (if any) documents have already been translate
3610 d into your language.
3611 You can also find out who (if anyone) is organizing the effort to translate
3612 the documentation into your language.
3613 If no one is organizing the effort, please let us know that you're interested.
3616 \begin_layout Standard
3617 Once you get to actually translating, here's a few hints for you that may
3621 \begin_layout Itemize
3622 Join the documentation team! There is information on how to do that in
3623 \begin_inset Flex Code
3626 \begin_layout Plain Layout
3633 \begin_inset Flex Noun
3636 \begin_layout Plain Layout
3637 Help\SpecialChar menuseparator
3643 ), which by the way is the first document you should translate.
3646 \begin_layout Itemize
3647 Learn the typographic conventions for the language you are translating to.
3648 Typography is an ancient art and over the centuries, a great variety of
3649 conventions have developed throughout different parts of the world.
3650 Also study the professional terminology amongst typographers in your country.
3651 Inventing your own terminology will only confuse the users.
3654 (Warning! Typography is addictive!)
3657 \begin_layout Itemize
3658 Make a copy of the document.
3659 This will be your working copy.
3660 You can use this as your personal translated help-file by placing it in
3662 \begin_inset Flex Code
3665 \begin_layout Plain Layout
3672 \begin_inset Note Greyedout
3675 \begin_layout Plain Layout
3680 For a complex document with external material (images, etc.), if you make
3682 \begin_inset space \thinspace{}
3686 \begin_inset space \space{}
3689 in a temp dir, beware that the links to external material may be broken
3690 when the document is moved to a different place.
3691 The best way is to retrieve the \SpecialChar LyX
3693 \begin_inset Flex URL
3696 \begin_layout Plain Layout
3698 https://www.lyx.org/HowToUseGIT
3703 ) and to edit the doc file in place.
3711 \begin_layout Itemize
3712 Sometimes the original document (from the \SpecialChar LyX
3713 team) will be updated.
3714 Use the source viewer at
3715 \begin_inset CommandInset href
3717 name "https://www.lyx.org/trac/timeline"
3718 target "https://www.lyx.org/trac/timeline"
3723 to see what has been changed.
3724 That way you can easily see which parts of the translated document need
3728 \begin_layout Standard
3729 If you ever find an error in the original document, fix it and notify the
3730 rest of the documentation team of the changes! (You didn't forget to join
3731 the documentation team, did you?)
3734 \begin_layout Standard
3735 \begin_inset Branch OutDated
3739 \begin_layout Section
3740 International Keyboard Support
3743 \begin_layout Standard
3746 [Editor's Note: The following section is by
3754 It needs to be fixed to conform to the new Documentation Style sheet and
3755 to make use of the new v1.0 features.
3756 The whole thing also needs to be merged with the section following it.-jw
3757 It may also be badly out of date.-rh (2008)]
3760 \begin_layout Subsection
3761 Defining Own Keymaps: Keymap File Format
3764 \begin_layout Standard
3765 Let's look at a keyboard definition file a little closer.
3766 It is a plain text file defining
3769 \begin_layout Itemize
3770 key-to-key or key-to-string translations
3773 \begin_layout Itemize
3777 \begin_layout Itemize
3778 dead keys exceptions
3781 \begin_layout Standard
3782 To define key-to-key or key-to-string translation, use this command:
3785 \begin_layout Quotation
3786 \begin_inset Flex Code
3789 \begin_layout Plain Layout
3798 \begin_inset Flex Code
3801 \begin_layout Plain Layout
3810 \begin_layout Standard
3812 \begin_inset Flex Code
3815 \begin_layout Plain Layout
3821 is the key to be translated and
3822 \begin_inset Flex Code
3825 \begin_layout Plain Layout
3831 is the string to be inserted into the document.
3832 To define dead keys, use:
3835 \begin_layout Quotation
3836 \begin_inset Flex Code
3839 \begin_layout Plain Layout
3848 \begin_inset Flex Code
3851 \begin_layout Plain Layout
3860 \begin_layout Standard
3862 \begin_inset Flex Code
3865 \begin_layout Plain Layout
3871 is a keyboard key and
3872 \begin_inset Flex Code
3875 \begin_layout Plain Layout
3882 The following dead keys are supported (shortcut name is in parentheses):
3885 \begin_layout Quotation
3889 \begin_inset space \hfill{}
3895 \begin_layout Quotation
3897 \begin_inset space \hfill{}
3903 \begin_layout Quotation
3905 \begin_inset space \hfill{}
3911 \begin_layout Quotation
3913 \begin_inset space \hfill{}
3919 \begin_layout Quotation
3921 \begin_inset space \hfill{}
3927 \begin_layout Quotation
3929 \begin_inset space \hfill{}
3936 \begin_layout Plain Layout
3948 \begin_layout Quotation
3950 \begin_inset space \hfill{}
3956 \begin_layout Quotation
3958 \begin_inset space \hfill{}
3965 \begin_layout Plain Layout
3977 \begin_layout Quotation
3979 \begin_inset space \hfill{}
3985 \begin_layout Quotation
3987 \begin_inset space \hfill{}
3993 \begin_layout Quotation
3995 \begin_inset space \hfill{}
4002 \begin_layout Plain Layout
4014 \begin_layout Quotation
4016 \begin_inset space \hfill{}
4023 \begin_layout Plain Layout
4035 \begin_layout Quotation
4037 \begin_inset space \hfill{}
4043 \begin_layout Quotation
4044 hungarian umlaut (hug)
4045 \begin_inset space \hfill{}
4051 \begin_layout Quotation
4053 \begin_inset space \hfill{}
4059 \begin_layout Quotation
4061 \begin_inset space \hfill{}
4068 \begin_layout Plain Layout
4080 \begin_layout Standard
4081 Since in many international keyboards there are exceptions to what some
4082 dead keys should do, you can define them using
4085 \begin_layout Quotation
4086 \begin_inset Flex Code
4089 \begin_layout Plain Layout
4097 deadkey key outstring
4100 \begin_layout Standard
4101 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4105 \begin_layout Quotation
4106 \begin_inset Flex Code
4109 \begin_layout Plain Layout
4122 \begin_layout Standard
4123 to make it work correctly.
4124 Also, you have to define as exceptions dead keys over i and j, to remove
4125 the dot from them before inserting an accent mark.
4126 I will change this when the time comes, but so far I haven't had time.
4129 \begin_layout Standard
4130 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4133 \begin_inset Flex Code
4136 \begin_layout Plain Layout
4142 have different meaning.
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4153 marks comments, quotes start and end \SpecialChar LaTeX
4155 To enter quote, you'll need to use
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4178 \begin_inset Flex Code
4181 \begin_layout Plain Layout
4192 \begin_layout Standard
4193 If you make a keyboard description file that works for your language, please
4194 mail it to me, so I can include it in the next keymap distribution.
4197 \begin_layout Standard
4198 More keywords will be supported in keymap configuration file in future,
4202 \begin_layout Itemize
4203 \begin_inset Flex Code
4206 \begin_layout Plain Layout
4217 \begin_inset space \hfill{}
4221 \begin_inset Flex Code
4224 \begin_layout Plain Layout
4233 \begin_layout Itemize
4234 \begin_inset Flex Code
4237 \begin_layout Plain Layout
4248 \begin_inset space \hfill{}
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4261 an external keymap translation program
4264 \begin_layout Standard
4265 Also, it should look into
4266 \begin_inset Flex Code
4269 \begin_layout Plain Layout
4275 file for defaults, too (for example, a
4276 \begin_inset Flex Code
4279 \begin_layout Plain Layout
4287 option to include default keyboard).
4295 \begin_layout Section
4296 International Keymap Stuff
4297 \begin_inset CommandInset label
4299 name "sec:International-Keymap-Stuff"
4306 \begin_layout Standard
4307 \begin_inset Note Note
4310 \begin_layout Plain Layout
4311 In doing the revisions on this document in March 2008, I did not look over
4312 this stuff, as I do not understand it.
4313 It would be good if someone else could do so.
4322 \begin_layout Standard
4323 The next two sections describe the
4324 \begin_inset Flex Code
4327 \begin_layout Plain Layout
4336 \begin_inset Flex Code
4339 \begin_layout Plain Layout
4347 file syntax in detail.
4348 These sections should help you design your own key map if the ones provided
4349 do not meet your needs.
4352 \begin_layout Subsection
4356 \begin_layout Standard
4360 \begin_inset Flex Code
4363 \begin_layout Plain Layout
4369 file maps keystrokes to characters or strings.
4370 As the name suggests, it sets a keyboard mapping.
4372 \begin_inset Flex Code
4375 \begin_layout Plain Layout
4386 \begin_inset Flex Code
4389 \begin_layout Plain Layout
4404 \begin_inset Flex Code
4407 \begin_layout Plain Layout
4420 \begin_inset Flex Code
4423 \begin_layout Plain Layout
4432 \begin_inset Flex Code
4435 \begin_layout Plain Layout
4443 are described in this section.
4446 \begin_layout Labeling
4447 \labelwidthstring 00.00.0000
4448 \begin_inset Flex Code
4451 \begin_layout Plain Layout
4459 Map a character to a string
4462 \begin_layout LyX-Code
4477 \begin_layout Standard
4510 the double-quote (")
4527 must be escaped with a preceding backslash (
4538 \begin_layout Standard
4540 \begin_inset Flex Noun
4543 \begin_layout Plain Layout
4551 statement to cause the symbol
4552 \begin_inset Flex Noun
4555 \begin_layout Plain Layout
4563 to be output for the keystroke
4564 \begin_inset Flex Noun
4567 \begin_layout Plain Layout
4578 \begin_layout LyX-Code
4584 \begin_layout Labeling
4585 \labelwidthstring 00.00.0000
4586 \begin_inset Flex Code
4589 \begin_layout Plain Layout
4597 Specify an accent character
4600 \begin_layout LyX-Code
4609 \begin_layout Standard
4610 This will make the cha
4648 This is the dead key
4652 \begin_layout Plain Layout
4659 refers to a key that does not produce a character by itself, but when followed
4660 with another key, produces the desired accent character.
4661 For example, a German characte
4663 r with an umlaut like
4673 can be produced in this manner.
4682 \begin_layout Standard
4695 and then another key not in
4712 followed by the other, not allowed key, as output.
4716 \begin_inset Flex Noun
4719 \begin_layout Plain Layout
4727 cancels a dead key, so if
4738 \begin_inset Flex Noun
4741 \begin_layout Plain Layout
4750 , the cursor will not go one position backwards but will instead cancel
4766 might have had on the next keystroke.
4770 \begin_layout Standard
4771 The following example specifies that the character ' is to be an acute accent,
4772 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4775 \begin_layout LyX-Code
4778 kmod ' acute aeiouAEIOU
4781 \begin_layout Labeling
4782 \labelwidthstring 00.00.0000
4783 \begin_inset Flex Code
4786 \begin_layout Plain Layout
4792 Specify an exception to the accent character
4795 \begin_layout LyX-Code
4804 \begin_layout Standard
4805 This defines an exce
4846 have been assigned a keystroke with a previous
4849 \begin_inset Flex Code
4852 \begin_layout Plain Layout
4876 must not belong in the
4923 If such a declaration does not exist in
4931 \begin_inset Flex Code
4934 \begin_layout Plain Layout
4968 \begin_inset Flex Code
4971 \begin_layout Plain Layout
4985 \begin_layout Standard
4986 The following command produces causes äi to be produced when you enter acute-i
4990 \begin_layout LyX-Code
5004 \begin_layout Labeling
5005 \labelwidthstring 00.00.0000
5006 \begin_inset Flex Code
5009 \begin_layout Plain Layout
5015 Combine two accent characters
5018 \begin_layout LyX-Code
5024 accent1 accent2 allowed
5027 \begin_layout Standard
5028 This one is getting pretty esoteric.
5029 It allows you to combine the effect
5085 \begin_inset Flex Code
5088 \begin_layout Plain Layout
5116 \begin_layout Standard
5117 Consider this example from the
5118 \begin_inset Flex Code
5121 \begin_layout Plain Layout
5132 \begin_layout LyX-Code
5135 kmod ; acute aeioyvhAEIOYVH
5139 kcomb acute umlaut iyIY
5142 \begin_layout Standard
5143 This allows you to press
5144 \begin_inset Flex Noun
5147 \begin_layout Plain Layout
5155 and get the effect of
5156 \begin_inset Flex Code
5159 \begin_layout Plain Layout
5178 in this case cancels the last dead key, so if you press
5179 \begin_inset Flex Noun
5182 \begin_layout Plain Layout
5191 \begin_inset Flex Code
5194 \begin_layout Plain Layout
5207 \begin_layout Subsection
5211 \begin_layout Standard
5213 \begin_inset Flex Code
5216 \begin_layout Plain Layout
5224 mapping is performed, a
5225 \begin_inset Flex Code
5228 \begin_layout Plain Layout
5238 file maps the strings that the symbols generate to characters in the current
5240 The \SpecialChar LyX
5241 distribution currently includes at least the
5242 \begin_inset Flex Code
5245 \begin_layout Plain Layout
5254 \begin_inset Flex Code
5257 \begin_layout Plain Layout
5268 \begin_layout Standard
5270 \begin_inset Flex Code
5273 \begin_layout Plain Layout
5281 file is a sequence of declarations of the form
5284 \begin_layout LyX-Code
5297 \begin_layout Standard
5298 For example, in order to map
5299 \begin_inset Flex Noun
5302 \begin_layout Plain Layout
5312 to the corresponding character in the iso-8859-1 set (233), the following
5316 \begin_layout LyX-Code
5324 \begin_layout Standard
5326 \begin_inset Flex Code
5329 \begin_layout Plain Layout
5338 \begin_inset Flex Code
5341 \begin_layout Plain Layout
5359 the same character can apply to more than one string.
5361 \begin_inset Flex Code
5364 \begin_layout Plain Layout
5375 \begin_layout LyX-Code
5387 \begin_inset Newline newline
5403 \begin_layout Standard
5405 cannot find a mapping for the string produced by the keystroke or a
5406 deadkey sequence, it will check if it looks like an accented char and try
5407 to draw an accent over the character on screen.
5410 \begin_layout Subsection
5414 \begin_layout Standard
5415 There is a second way to add support for international characters through
5416 so-called dead-keys.
5417 A dead-key works in combination with a letter to produce an accented character.
5418 Here, we'll explain how to create a really simple dead-key to illustrate
5422 \begin_layout Standard
5423 Suppose you happen to need the circumflex character,
5424 \begin_inset Quotes eld
5428 \begin_inset Quotes erd
5433 \begin_inset Flex Noun
5436 \begin_layout Plain Layout
5443 \begin_inset space ~
5447 \begin_inset Flex Noun
5450 \begin_layout Plain Layout
5456 ] to the \SpecialChar LyX
5458 \begin_inset Flex Code
5461 \begin_layout Plain Layout
5468 \begin_inset Flex Code
5471 \begin_layout Plain Layout
5478 Now, whenever you type the
5479 \begin_inset Flex Noun
5482 \begin_layout Plain Layout
5488 -key followed by a letter, that letter will have a circumflex accent on
5490 For example, the sequence
5491 \begin_inset Quotes eld
5495 \begin_inset Flex Noun
5498 \begin_layout Plain Layout
5505 \begin_inset Quotes erd
5508 produces the letter:
5509 \begin_inset Quotes eld
5513 \begin_inset Quotes erd
5517 If you tried to type
5518 \begin_inset Quotes eld
5522 \begin_inset Flex Noun
5525 \begin_layout Plain Layout
5532 \begin_inset Quotes erd
5535 , however, \SpecialChar LyX
5536 will complain with a beep, since a
5537 \begin_inset Quotes eld
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5551 \begin_inset Quotes erd
5554 never takes a circumflex accent.
5556 \begin_inset Flex Noun
5559 \begin_layout Plain Layout
5565 after a dead-key produces the bare-accent.
5566 Please note this last point! If you bind a key to a dead-key, you'll need
5567 to rebind the character on that key to yet another key.
5569 \begin_inset Flex Noun
5572 \begin_layout Plain Layout
5578 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5581 \begin_layout Standard
5582 One common way to bind dead-keys is to use
5583 \begin_inset Flex Noun
5586 \begin_layout Plain Layout
5593 \begin_inset Flex Noun
5596 \begin_layout Plain Layout
5603 \begin_inset Flex Noun
5606 \begin_layout Plain Layout
5612 in combination with an accent, like
5613 \begin_inset Quotes eld
5617 \begin_inset Flex Noun
5620 \begin_layout Plain Layout
5627 \begin_inset Quotes erd
5631 \begin_inset Quotes eld
5635 \begin_inset Flex Noun
5638 \begin_layout Plain Layout
5645 \begin_inset Quotes erd
5649 \begin_inset Quotes eld
5653 \begin_inset Flex Noun
5656 \begin_layout Plain Layout
5663 \begin_inset Quotes erd
5667 Another way involves using
5668 \begin_inset Flex Code
5671 \begin_layout Plain Layout
5678 \begin_inset Flex Code
5681 \begin_layout Plain Layout
5687 to set up the special
5688 \begin_inset Flex Code
5691 \begin_layout Plain Layout
5699 \begin_inset Flex Code
5702 \begin_layout Plain Layout
5708 acts in some ways just like
5709 \begin_inset Flex Noun
5712 \begin_layout Plain Layout
5718 and permits you to bind keys to accented characters.
5719 You can also turn keys into dead-keys by binding them to something like
5721 \begin_inset Flex Code
5724 \begin_layout Plain Layout
5730 and then binding this symbolic key to the corresponding \SpecialChar LyX
5735 \begin_layout Plain Layout
5740 : This is exactly what I do in my
5741 \begin_inset Flex Code
5744 \begin_layout Plain Layout
5751 \begin_inset Flex Code
5754 \begin_layout Plain Layout
5762 \begin_inset Flex Noun
5765 \begin_layout Plain Layout
5767 \begin_inset space ~
5776 \begin_inset Flex Code
5779 \begin_layout Plain Layout
5785 and a bunch of these
5786 \begin_inset Quotes eld
5790 \begin_inset Flex Code
5793 \begin_layout Plain Layout
5800 \begin_inset Quotes erd
5803 symbolic keys bound such things as
5804 \begin_inset Flex Noun
5807 \begin_layout Plain Layout
5809 \begin_inset space ~
5818 \begin_inset Flex Noun
5821 \begin_layout Plain Layout
5823 \begin_inset space ~
5832 This is how I produce my accented characters.
5837 You can make just about anything into the
5838 \begin_inset Flex Code
5841 \begin_layout Plain Layout
5848 \begin_inset Flex Noun
5851 \begin_layout Plain Layout
5857 keys, a spare function key, etc.
5858 As for the \SpecialChar LyX
5859 commands that produce accents, check the entry for
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5874 You'll find the complete list there.
5877 \begin_layout Subsection
5878 Saving your Language Configuration
5881 \begin_layout Standard
5882 You can edit your preferences so that your desired language environment
5883 is automatically configured when \SpecialChar LyX
5885 \begin_inset Flex Noun
5888 \begin_layout Plain Layout
5889 Edit\SpecialChar menuseparator
5898 \begin_layout Chapter
5899 Installing New Document Classes, Layouts, and Templates
5900 \begin_inset CommandInset label
5902 name "cha:Installing-New-Document"
5907 \begin_inset Argument 1
5910 \begin_layout Plain Layout
5911 Installing New Document Classes
5919 \begin_layout Standard
5920 In this chapter, we describe the procedures for creating and installing
5921 new \SpecialChar LyX
5922 layout and template files, as well as offer a refresher on correctly
5923 installing new \SpecialChar LaTeX
5928 \begin_layout Standard
5929 First, let us a say a few words about how one ought to think about the relation
5930 between \SpecialChar LyX
5931 and \SpecialChar LaTeX
5933 The thing to understand is that, in a certain sense, \SpecialChar LyX
5934 doesn't know anything
5935 about \SpecialChar LaTeX
5937 Indeed, from \SpecialChar LyX
5938 's point of view, \SpecialChar LaTeX
5939 is just one of several
5940 \begin_inset Quotes eld
5944 \begin_inset Quotes erd
5947 in which it is capable of producing output.
5948 Other such formats are DocBook, plaintext, and XHTML.
5950 is, of course, a particularly important format, but very little of the
5951 information \SpecialChar LyX
5952 has about \SpecialChar LaTeX
5953 is actually contained in the program itself.
5957 \begin_layout Plain Layout
5958 Some commands are sufficiently complex that they are
5959 \begin_inset Quotes eld
5963 \begin_inset Quotes erd
5966 into \SpecialChar LyX
5968 But the developers generally regard this as a Bad Thing.
5973 Rather, that information, even for the standard classes like
5974 \begin_inset Flex Code
5977 \begin_layout Plain Layout
5983 , is contained in `layout files'.
5984 Similarly, \SpecialChar LyX
5985 itself does not know much about DocBook or XHTML.
5986 What it knows is contained in layout files.
5989 \begin_layout Standard
5990 You can think of the layout file for a given document class as a translation
5991 manual between \SpecialChar LyX
5992 constructs—paragraphs with their corresponding styles,
5993 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5996 Almost everything \SpecialChar LyX
5998 \begin_inset Flex Code
6001 \begin_layout Plain Layout
6007 , for example, is contained in the file
6008 \begin_inset Flex Code
6011 \begin_layout Plain Layout
6017 and in various other files it includes.
6018 For this reason, anyone intending to write layout files should plan to
6019 study the existing files.
6020 A good place to start is with
6021 \begin_inset Flex Code
6024 \begin_layout Plain Layout
6030 , which is included in
6031 \begin_inset Flex Code
6034 \begin_layout Plain Layout
6041 \begin_inset Flex Code
6044 \begin_layout Plain Layout
6050 , and many of the other layout files for document classes.
6051 This file is where sections and the like are defined:
6052 \begin_inset Flex Code
6055 \begin_layout Plain Layout
6061 tells \SpecialChar LyX
6062 how paragraphs that are marked with the Section, Subsection, etc,
6063 styles can be translated into corresponding \SpecialChar LaTeX
6064 , DocBook, and XHTML commands
6067 \begin_inset Flex Code
6070 \begin_layout Plain Layout
6076 file basically just includes several of these
6077 \begin_inset Flex Code
6080 \begin_layout Plain Layout
6089 \begin_layout Standard
6090 Defining the \SpecialChar LyX
6092 correspondence is not the only thing layout files do, though.
6093 Their other job is to define how the \SpecialChar LyX
6094 constructs themselves will appear
6096 The fact that layout files have these two jobs is often a source of confusion,
6097 because they are completely separate.
6098 Telling \SpecialChar LyX
6099 how to translate a certain paragraph style into \SpecialChar LaTeX
6102 how to display it; conversely, telling \SpecialChar LyX
6103 how to display a certain paragraph
6104 style does not tell \SpecialChar LyX
6105 how to translate it into \SpecialChar LaTeX
6106 (let alone tell \SpecialChar LaTeX
6109 So, in general, when you define a new \SpecialChar LyX
6110 construct, you must always do two
6111 quite separate things: (i)
6112 \begin_inset space ~
6115 tell \SpecialChar LyX
6116 how to translate it into \SpecialChar LaTeX
6118 \begin_inset space ~
6121 tell \SpecialChar LyX
6125 \begin_layout Standard
6126 Much the same is true, of course, as regards \SpecialChar LyX
6127 's other backend formats, though
6128 XHTML is in some ways different, because in that case \SpecialChar LyX
6133 able, to some extent, to use information about how it should display a
6134 paragraph on the screen to output information (in the form of CSS) about
6135 how the paragraph should be displayed in a browser.
6136 Even in this case, however, the distinction between what \SpecialChar LyX
6138 and how things are rendered externally remains in force, and the two can
6139 be controlled separately.
6141 \begin_inset CommandInset ref
6143 reference "sec:Tags-for-XHTML"
6150 \begin_layout Section
6151 Installing new \SpecialChar LaTeX
6155 \begin_layout Standard
6156 Some installations may not include a \SpecialChar LaTeX
6157 package or class file that you would
6158 like to use within \SpecialChar LyX
6160 For example, you might need Foil\SpecialChar TeX
6161 , a package for preparing slides for overhead
6163 Modern \SpecialChar LaTeX
6164 distributions like \SpecialChar TeX
6165 Live (2008 or newer) or MiK\SpecialChar TeX
6166 provide a user interface
6167 for installing such packages.
6168 For example, with MiK\SpecialChar TeX
6169 , you start the program
6170 \begin_inset Quotes eld
6174 \begin_inset space ~
6178 \begin_inset Quotes erd
6181 to get a list of available packages.
6182 To install one of them, right click on it or use the corresponding toolbar
6186 \begin_layout Standard
6187 If your \SpecialChar LaTeX
6188 distribution does not provide such a `package manager', or if the
6189 package is not available from your distribution, then follow these steps
6190 to install it manually:
6193 \begin_layout Enumerate
6194 Get the package from
6195 \begin_inset CommandInset href
6198 target "http://www.ctan.org/"
6206 \begin_layout Enumerate
6207 If the package contains a file with the ending
6208 \begin_inset Quotes eld
6212 \begin_inset Flex Code
6215 \begin_layout Plain Layout
6222 \begin_inset Quotes erd
6225 (is the case for Foil\SpecialChar TeX
6226 ) then open a console, change to the folder of this
6227 file and execute the command
6228 \begin_inset Flex Code
6231 \begin_layout Plain Layout
6238 You have now unpacked the package and have all files to install it.
6239 Most \SpecialChar LaTeX
6240 -packages are not packed and you can skip this step.
6243 \begin_layout Enumerate
6244 Now you need to decide if the package should be available for all users
6249 \begin_layout Enumerate
6250 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6251 for all users on your system, then install it in your `local' \SpecialChar TeX
6253 install it in your own `user' \SpecialChar TeX
6255 Where these trees should be created, if they do not already exist, depends
6257 To find this out, look in the file
6258 \begin_inset Flex Code
6261 \begin_layout Plain Layout
6271 \begin_layout Plain Layout
6272 This is usually in the directory
6273 \begin_inset Flex Code
6276 \begin_layout Plain Layout
6282 , though you can execute the command
6283 \begin_inset Flex Code
6286 \begin_layout Plain Layout
6297 The location of the `local' \SpecialChar TeX
6298 tree is defined by the
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6308 variable; this is usually somewhere like
6309 \begin_inset Flex Code
6312 \begin_layout Plain Layout
6313 /usr/local/share/texmf
6318 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6321 The location of the `user' \SpecialChar TeX
6323 \begin_inset Flex Code
6326 \begin_layout Plain Layout
6333 \begin_inset Flex Code
6336 \begin_layout Plain Layout
6343 \begin_inset Flex Code
6346 \begin_layout Plain Layout
6355 (If these variables are not predefined, you have to define them.) You'll
6356 probably need root permissions to create or modify the `local' tree, but
6357 not for your `user' tree.
6358 \begin_inset Newline newline
6361 In general, it is recommended to install in the user tree because your user
6362 will not be modified or even overwritten when you upgrade your system.
6363 It will typically also be backed up together with everything else when
6364 you backup your home directory (which, of course, you do on a regular basis).
6367 \begin_layout Enumerate
6368 On Windows, if you want the new package to be available for all users on
6369 your system, change to the folder where \SpecialChar LaTeX
6370 is installed and then change to
6372 \begin_inset Flex Code
6375 \begin_layout Plain Layout
6386 (For MiK\SpecialChar TeX
6387 , this would be by default the folder
6388 \begin_inset Flex Code
6391 \begin_layout Plain Layout
6409 \begin_layout Plain Layout
6410 Note that this will be the correct path only on English installations.
6411 On a German one, it would be
6412 \begin_inset Flex Code
6415 \begin_layout Plain Layout
6429 , and similarly for other languages.
6434 Create there a new folder
6435 \begin_inset Flex Code
6438 \begin_layout Plain Layout
6444 and copy all files of the package into it.
6446 \begin_inset Newline newline
6449 If the package should only available for you or you don't have admin permissions
6450 , do the same, but in the local \SpecialChar LaTeX
6453 \begin_inset space \thinspace{}
6456 g., for MiK\SpecialChar TeX
6458 \begin_inset space ~
6461 2.8 under Windows XP, this would be the folder:
6462 \begin_inset Newline newline
6468 \begin_inset Flex Code
6471 \begin_layout Plain Layout
6474 Documents and Settings
6486 \begin_inset Newline newline
6492 \begin_inset Phantom HPhantom
6495 \begin_layout Plain Layout
6506 \begin_inset Flex Code
6509 \begin_layout Plain Layout
6522 \begin_inset Newline newline
6525 On Vista, it would be:
6526 \begin_inset Newline newline
6530 \begin_inset Flex Code
6533 \begin_layout Plain Layout
6559 \begin_layout Enumerate
6560 Now one only need to tell \SpecialChar LaTeX
6561 that there are new files.
6562 This depends on the used \SpecialChar LaTeX
6567 \begin_layout Enumerate
6568 For \SpecialChar TeX
6569 Live execute the command
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6580 If you installed the package for all users, then you will probably need
6581 to have root permissions for that.
6584 \begin_layout Enumerate
6585 For MiK\SpecialChar TeX
6586 , if you have installed the package for all users, start the program
6588 \begin_inset Quotes eld
6592 \begin_inset space ~
6596 \begin_inset Quotes erd
6599 and press the button marked
6600 \begin_inset Quotes eld
6604 \begin_inset Quotes erd
6608 Otherwise start the program
6609 \begin_inset Quotes eld
6613 \begin_inset Quotes erd
6620 \begin_layout Enumerate
6621 Finally, you need to tell \SpecialChar LyX
6622 that there are new packages available.
6623 So, in \SpecialChar LyX
6625 \begin_inset Flex Noun
6628 \begin_layout Plain Layout
6631 \SpecialChar menuseparator
6637 and then restart \SpecialChar LyX
6641 \begin_layout Standard
6642 Now the package is installed.
6643 In our example, the document class
6644 \begin_inset Flex Code
6647 \begin_layout Plain Layout
6653 will now be available under
6654 \begin_inset Flex Noun
6657 \begin_layout Plain Layout
6658 Document\SpecialChar menuseparator
6659 Settings\SpecialChar menuseparator
6666 \begin_inset Quotes eld
6670 \begin_inset Quotes erd
6677 \begin_layout Standard
6678 If you would like to use a \SpecialChar LaTeX
6679 document class that is not even listed in the
6681 \begin_inset Flex Noun
6684 \begin_layout Plain Layout
6685 Document\SpecialChar menuseparator
6686 Settings\SpecialChar menuseparator
6692 , then you need to create a `layout' file for it.
6693 That is the topic of the next section.
6696 \begin_layout Section
6697 Types of layout files
6700 \begin_layout Standard
6701 This section describes the various sorts of \SpecialChar LyX
6702 files that contain layout informati
6704 These files describe various paragraph and character styles, determining
6705 how \SpecialChar LyX
6706 should display them and how they should be translated into \SpecialChar LaTeX
6708 XHTML, or whatever output format is being used.
6712 \begin_layout Standard
6713 We shall try to provide a thorough description of the process of writing
6715 However, there are so many different types of documents supported even
6716 by just \SpecialChar LaTeX
6717 that we can't hope to cover every different possibility or problem
6718 you might encounter.
6719 The \SpecialChar LyX
6720 users' list is frequented by people with lots of experience with layout
6721 design who are willing to share what they've learned, so please feel free
6722 to ask questions there.
6725 \begin_layout Standard
6726 As you prepare to write a new layout, it is extremely helpful to look at
6727 the layouts distributed with \SpecialChar LyX
6729 If you write a \SpecialChar LyX
6730 layout for a \SpecialChar LaTeX
6731 document class that might also be used by
6732 others, or write a module that might be useful to others, then you should
6733 consider posting your layout to the
6734 \begin_inset CommandInset href
6736 name "layout section on the LyX wiki"
6737 target "https://wiki.lyx.org/Layouts/Layouts"
6742 or even to the \SpecialChar LyX
6743 developers' list, so that it might be included in \SpecialChar LyX
6748 \begin_layout Plain Layout
6749 Note that \SpecialChar LyX
6750 is licensed under the General Public License, so any material
6751 that is contributed to \SpecialChar LyX
6752 must be similarly licensed.
6760 \begin_layout Subsection
6762 \begin_inset CommandInset label
6764 name "subsec:Layout-modules"
6771 \begin_layout Standard
6772 We have spoken to this point about `layout files'.
6773 But there are different sorts of files that contain layout information.
6774 Layout files, strictly so called, have the
6775 \begin_inset Flex Code
6778 \begin_layout Plain Layout
6784 extension and provide \SpecialChar LyX
6785 with information about document classes.
6786 Since \SpecialChar LyX
6787 1.6 layout information can also be contained in layout
6792 \begin_inset Flex Code
6795 \begin_layout Plain Layout
6802 Modules are to \SpecialChar LaTeX
6803 packages much as layouts are to \SpecialChar LaTeX
6804 classes, and some modules—such
6806 \begin_inset Flex Code
6809 \begin_layout Plain Layout
6815 module—specifically provide support for one package.
6816 In a sense, layout modules are similar to included
6820 \begin_layout Plain Layout
6821 These can have any extension, but by convention have the
6822 \begin_inset Flex Code
6825 \begin_layout Plain Layout
6837 \begin_inset Flex Code
6840 \begin_layout Plain Layout
6846 —in that modules are not specific to a given document class but may be used
6847 with many different classes.
6848 The difference is that using an included file with
6849 \begin_inset Flex Code
6852 \begin_layout Plain Layout
6858 requires editing that file.
6859 Modules, by contrast, are selected in the
6860 \begin_inset Flex Noun
6863 \begin_layout Plain Layout
6864 Document\SpecialChar menuseparator
6873 \begin_layout Standard
6874 Building modules is the easiest way to get started with layout editing,
6875 since it can be as simple as adding a single new paragraph style or flex
6877 But modules may, in principle, contain anything a layout file can contain.
6880 \begin_layout Standard
6881 After creating a new module and copying it to the
6882 \begin_inset Flex Code
6885 \begin_layout Plain Layout
6891 folder, you will need to reconfigure and then restart \SpecialChar LyX
6894 However, changes you make to the module will be seen immediately, if you
6896 \begin_inset Flex Noun
6899 \begin_layout Plain Layout
6900 Document\SpecialChar menuseparator
6906 , highlight something, and then hit
6907 \begin_inset Quotes eld
6911 \begin_inset Quotes erd
6917 It is strongly recommended that you save your work before doing this
6922 it is strongly recommended that you not attempt to edit modules while simultaneo
6923 usly working on actual documents
6926 Though of course the developers strive to keep \SpecialChar LyX
6927 stable in such situations,
6928 syntax errors and the like in your module file could cause strange behavior.
6931 \begin_layout Subsubsection
6935 \begin_layout Standard
6936 Modules are to \SpecialChar LyX
6937 as packages are to \SpecialChar LaTeX
6939 Sometimes, however, you find yourself wanting a specific inset or character
6940 style just for one document and writing a module that will also be available
6941 to other documents makes little sense.
6942 What you need is \SpecialChar LyX
6944 \begin_inset Quotes eld
6948 \begin_inset Quotes erd
6954 \begin_layout Standard
6955 You will find it under
6957 Document\SpecialChar menuseparator
6958 Settings\SpecialChar menuseparator
6962 The large text box allows you to enter anything that you might enter in
6963 a layout file or module.
6964 You can think of a document's local layout, in fact, as a module that belongs
6966 So, in particular, you must enter a
6967 \begin_inset Flex Code
6970 \begin_layout Plain Layout
6977 Any format is acceptable, but one would normally use the format current
6979 (In \SpecialChar LyX
6986 , the current layout format is
6995 \begin_layout Standard
6996 When you have entered something in the
6997 \begin_inset Flex Code
7000 \begin_layout Plain Layout
7006 pane, \SpecialChar LyX
7008 \begin_inset Quotes eld
7012 \begin_inset Quotes erd
7015 button at the bottom.
7016 Clicking this button will cause \SpecialChar LyX
7017 to determine whether what you have entered
7018 is valid layout information for the chosen format.
7020 will report the result but, unfortunately, will not tell you what errors
7021 there might have been.
7022 These will be written to the terminal, however, if \SpecialChar LyX
7023 is started from a terminal.
7024 You will not be permitted to save your local layout until you have entered
7028 \begin_layout Standard
7029 The warnings at the end of the previous section apply here, too.
7030 Do not play with local layout while you are actually working, especially
7031 if you have not saved your document.
7032 That said, using local layout with a test document can be a very convenient
7033 way to try out layout ideas, or even to start developing a module.
7036 \begin_layout Subsection
7038 \begin_inset Flex Noun
7041 \begin_layout Plain Layout
7050 \begin_layout Standard
7051 There are two situations you are likely to encounter when wanting to support
7052 a new \SpecialChar LaTeX
7053 document class, involving style (
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 ) files and \SpecialChar LaTeX2e
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7075 Supporting a style file is usually fairly easy.
7076 Supporting a new class file is a bit harder.
7077 We'll discuss the former in this section and the latter in the next.
7078 Similar remarks apply, of course, if you want to support a new DocBook
7082 \begin_layout Standard
7083 The easier case is the one in which your new document class is provided
7084 as a style file that is to be used in conjunction with an already supported
7086 For the sake of the example, we'll assume that the style file is called
7088 \begin_inset Flex Noun
7091 \begin_layout Plain Layout
7097 and that it is meant to be used with
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7107 , which is a standard class.
7111 \begin_layout Standard
7112 Start by copying the existing class's layout file into your local directory:
7116 \begin_layout Plain Layout
7117 Of course, which directory is your local directory will vary by platform,
7118 and \SpecialChar LyX
7119 allows you to specify your local directory on startup, too, using
7121 \begin_inset Flex Code
7124 \begin_layout Plain Layout
7138 \begin_layout LyX-Code
7139 cp report.layout ~/.lyx/layouts/myclass.layout
7142 \begin_layout Standard
7144 \begin_inset Flex Code
7147 \begin_layout Plain Layout
7153 and change the line:
7156 \begin_layout LyX-Code
7159 DeclareLaTeXClass{Report (Standard Class)}
7162 \begin_layout Standard
7166 \begin_layout LyX-Code
7169 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7172 \begin_layout Standard
7176 \begin_layout LyX-Code
7178 \begin_inset Newline newline
7184 \begin_inset Newline newline
7190 \begin_layout Standard
7191 near the top of the file.
7194 \begin_layout Standard
7195 Start \SpecialChar LyX
7197 \begin_inset Flex Noun
7200 \begin_layout Plain Layout
7201 Tools\SpecialChar menuseparator
7208 Then restart \SpecialChar LyX
7209 and try creating a new document.
7211 \begin_inset Flex Noun
7214 \begin_layout Plain Layout
7220 " as a document class option in the
7221 \begin_inset Flex Noun
7224 \begin_layout Plain Layout
7225 Document\SpecialChar menuseparator
7232 It is likely that some of the sectioning commands and such in your new
7233 class will work differently from how they worked in the base class—
7234 \begin_inset Flex Code
7237 \begin_layout Plain Layout
7243 in this example—so you can fiddle around with the settings for the different
7244 sections if you wish.
7245 The layout information for sections is contained in
7246 \begin_inset Flex Code
7249 \begin_layout Plain Layout
7255 , but you do not need to copy and change this file.
7256 Instead, you can simply add your changes to your layout file, after the
7258 \begin_inset Flex Code
7261 \begin_layout Plain Layout
7267 , which itself includes
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7278 For example, you might add these lines:
7281 \begin_layout LyX-Code
7285 \begin_layout LyX-Code
7289 \begin_layout LyX-Code
7293 \begin_layout LyX-Code
7297 \begin_layout LyX-Code
7301 \begin_layout Standard
7302 to change the font for chapter headings to sans-serif.
7303 This will override (or, in this case, add to) the existing declaration
7304 for the Chapter style.
7308 \begin_layout Standard
7309 Your new package may also provide commands or environments not present in
7311 In this case, you will want to add these to the layout file.
7313 \begin_inset CommandInset ref
7315 reference "sec:TextClass"
7319 for information on how to do so.
7322 \begin_layout Standard
7324 \begin_inset Flex Noun
7327 \begin_layout Plain Layout
7333 can be used with several different document classes, and even if it cannot,
7334 you might find it easiest just to write a module that you can load with
7336 The simplest possible such module would be:
7339 \begin_layout LyX-Code
7342 DeclareLyXModule{My Class}
7345 \begin_layout LyX-Code
7349 \begin_layout LyX-Code
7350 #Support for myclass.sty.
7353 \begin_layout LyX-Code
7355 \begin_inset Newline newline
7361 \begin_layout LyX-Code
7369 \begin_inset Newline newline
7375 \begin_layout LyX-Code
7377 \begin_inset Newline newline
7383 \begin_inset Newline newline
7389 \begin_layout Standard
7390 A more complex module might modify the behavior of some existing constructs
7391 or define some new ones.
7393 \begin_inset CommandInset ref
7395 reference "sec:TextClass"
7402 \begin_layout Subsection
7404 \begin_inset Flex Noun
7407 \begin_layout Plain Layout
7416 \begin_layout Standard
7417 There are two possibilities here.
7418 One is that the class file is itself based upon an existing document class.
7419 For example, many thesis classes are based upon
7420 \begin_inset Flex Noun
7423 \begin_layout Plain Layout
7430 To see whether yours is, look for a line like
7433 \begin_layout LyX-Code
7439 \begin_layout Standard
7441 If so, then you may proceed largely as in the previous section, though
7443 \begin_inset Flex Code
7446 \begin_layout Plain Layout
7447 Declare\SpecialChar LaTeX
7453 line will be different.
7454 If your new class is
7455 \begin_inset Flex Code
7458 \begin_layout Plain Layout
7464 and it is based upon
7465 \begin_inset Flex Code
7468 \begin_layout Plain Layout
7474 , then the line should read:
7478 \begin_layout Plain Layout
7479 And it will be easiest if you save the file to
7480 \begin_inset Flex Code
7483 \begin_layout Plain Layout
7490 assumes that the document class has the same name as the layout file.
7499 \begin_layout LyX-Code
7502 DeclareLaTeXClass[thesis,book]{thesis}
7505 \begin_layout Standard
7506 If, on the other hand, the new class is not based upon an existing class,
7507 you will probably have to
7508 \begin_inset Quotes eld
7512 \begin_inset Quotes erd
7516 We strongly suggest copying an existing layout file which uses a similar
7518 class and then modifying it, if you can do so.
7519 At least use an existing file as a starting point so you can find out what
7520 items you need to worry about.
7521 Again, the specifics are covered below.
7524 \begin_layout Subsection
7526 \begin_inset CommandInset label
7528 name "subsec:Creating-Templates"
7535 \begin_layout Standard
7536 Once you have written a layout file for a new document class, you might
7537 want to consider writing a
7542 A template acts as a kind of tutorial for your layout, showing how it might
7543 be used, though containing dummy content.
7544 You can of course look at the various templates included with \SpecialChar LyX
7548 \begin_layout Standard
7549 Templates are created just like usual documents: using \SpecialChar LyX
7551 The only difference is that usual documents contain all possible settings,
7552 including the font scheme and the paper size.
7553 Usually a user doesn't want a template to overwrite his preferred settings
7554 for such parameters.
7555 For that reason, the designer of a template should remove the corresponding
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7569 \begin_inset Flex Code
7572 \begin_layout Plain Layout
7580 from the template \SpecialChar LyX
7582 This can be done with any simple text-editor, for example
7583 \begin_inset Flex Code
7586 \begin_layout Plain Layout
7593 \begin_inset Flex Code
7596 \begin_layout Plain Layout
7605 \begin_layout Standard
7606 Put the edited template files you create in
7607 \begin_inset Flex Code
7610 \begin_layout Plain Layout
7616 , copy the ones you use from the global template directory in
7617 \begin_inset Flex Code
7620 \begin_layout Plain Layout
7626 to the same place, and redefine the template path in the
7627 \begin_inset Flex Noun
7630 \begin_layout Plain Layout
7631 Tools\SpecialChar menuseparator
7632 Preferences\SpecialChar menuseparator
7641 \begin_layout Standard
7642 Note, by the way, that there is a template which has a particular meaning:
7643 \begin_inset Newline linebreak
7647 \begin_inset Flex Code
7650 \begin_layout Plain Layout
7657 This template is loaded every time you create a new document with
7658 \begin_inset Flex Noun
7661 \begin_layout Plain Layout
7662 File\SpecialChar menuseparator
7668 in order to provide useful defaults.
7669 To create this template from inside \SpecialChar LyX
7670 , all you have to do is to open a document
7671 with the correct settings, and use the
7672 \begin_inset Flex Noun
7675 \begin_layout Plain Layout
7676 Save as Document Defaults
7684 \begin_layout Subsection
7685 Upgrading old layout files
7688 \begin_layout Standard
7689 The format of layout files changes with each \SpecialChar LyX
7690 release, so old layout files
7691 need to be converted to the new format.
7693 reads a layout file in an older format, it automatically calls the
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7704 to convert it to a temporary file in current format.
7705 The original file is left untouched.
7706 If you use the layout file often, then, you may want to convert it permanently,
7707 so that \SpecialChar LyX
7708 does not have to do so itself every time.
7709 To do this, you can call the converter manually:
7712 \begin_layout Enumerate
7714 \begin_inset Flex Code
7717 \begin_layout Plain Layout
7724 \begin_inset Flex Code
7727 \begin_layout Plain Layout
7736 \begin_layout Enumerate
7738 \begin_inset Newline newline
7742 \begin_inset Flex Code
7745 \begin_layout Plain Layout
7746 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7752 \begin_inset Newline newline
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7765 is the name of your \SpecialChar LyX
7769 \begin_layout Standard
7770 Note that manual conversion does not affect included files, so these will
7771 have to be converted separately.
7774 \begin_layout Subsection
7775 \begin_inset CommandInset label
7777 name "subsec:Cite-Engine-Files"
7784 \begin_layout Standard
7785 A specific form of layout files are the so-called
7786 \begin_inset Flex Code
7789 \begin_layout Plain Layout
7795 files that are located in the
7796 \begin_inset Flex Code
7799 \begin_layout Plain Layout
7806 Their purpose is to define the specifics of \SpecialChar LaTeX
7807 packages aimed at bibliography
7820 , but also the way how normal Bib\SpecialChar TeX
7821 citations (without additional packages)
7822 are handled in \SpecialChar LyX
7823 is defined in such a file.
7827 \begin_layout Standard
7828 More specifically, it is defined which packages \SpecialChar LyX
7829 needs to load, which citation
7830 commands are available, how these are to be displayed in \SpecialChar LyX
7832 the dialogs, the context menus) as well as in the XHTML and plain text
7834 Furthermore, the files specify available style variants (author-year, numerical
7835 , etc.) and their specifics.
7836 The cite engine files are also used to generate the options that are available
7839 Document\SpecialChar menuseparator
7840 Settings\SpecialChar menuseparator
7841 Bibliography\SpecialChar menuseparator
7847 \begin_layout Standard
7848 Even though a cite engine file is essentially a normal layout file that
7849 could theoretically include any layout information, it usually primarily
7850 includes some specific parameters such as
7851 \begin_inset Flex Code
7854 \begin_layout Plain Layout
7861 \begin_inset Flex Code
7864 \begin_layout Plain Layout
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7891 The syntax of the latter two is described in
7892 \begin_inset CommandInset ref
7894 reference "subsec:Citation-engine-description"
7902 \begin_inset CommandInset ref
7904 reference "subsec:Citation-format-description"
7908 , as well as in the files themselves.
7911 \begin_layout Section
7912 \begin_inset CommandInset label
7914 name "sec:TextClass"
7918 The layout file format
7921 \begin_layout Standard
7922 The following sections describe how layout files are structured and written.
7923 Our advice is to go slowly, save and test often.
7924 It is really not that hard, except that the multitude of options can become
7925 overwhelming, especially if you try to check out too many at once.
7926 It becomes easier if you use existing layouts of \SpecialChar LyX
7927 as examples/reference
7928 or if you modify an existing layout to your needs.
7931 \begin_layout Standard
7932 Note that all the tags used in layout files are case-insensitive.
7934 \begin_inset Flex Code
7937 \begin_layout Plain Layout
7944 \begin_inset Flex Code
7947 \begin_layout Plain Layout
7954 \begin_inset Flex Code
7957 \begin_layout Plain Layout
7963 are really the same tag.
7964 The possible arguments are printed in brackets after the tag's name.
7965 The default argument is typeset
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7978 If the argument has a data type like
7979 \begin_inset Quotes eld
7983 \begin_inset Quotes erd
7987 \begin_inset Quotes eld
7991 \begin_inset Quotes erd
7994 , the default is shown like this:
7995 \begin_inset Flex Code
7998 \begin_layout Plain Layout
8009 \begin_layout Subsection
8010 The document class declaration and classification
8013 \begin_layout Standard
8014 Lines in a layout file which begin with
8015 \begin_inset Flex Code
8018 \begin_layout Plain Layout
8025 There is one exception to this rule.
8027 \begin_inset Flex Code
8030 \begin_layout Plain Layout
8036 files should begin with lines like:
8039 \begin_layout LyX-Code
8042 #% Do not delete the line below; configure depends on this
8045 \begin_layout LyX-Code
8050 DeclareLaTeXClass{Article (Standard Class)}
8053 \begin_layout LyX-Code
8058 DeclareCategory{Articles}
8061 \begin_layout Standard
8062 The second and third lines are used when you (re)configure \SpecialChar LyX
8064 The layout file is read by the \SpecialChar LaTeX
8066 \begin_inset Flex Code
8069 \begin_layout Plain Layout
8075 , in a special mode where
8076 \begin_inset Flex Code
8079 \begin_layout Plain Layout
8086 The first line is just a \SpecialChar LaTeX
8087 comment, the second one contains the mandatory
8088 declaration of the text class and the third line contains the optional
8089 classification of the class.
8090 If these lines appear in a file named
8091 \begin_inset Flex Code
8094 \begin_layout Plain Layout
8100 , then they define a text class of name
8101 \begin_inset Flex Code
8104 \begin_layout Plain Layout
8110 (the name of the layout file) which uses the \SpecialChar LaTeX
8112 \begin_inset Flex Code
8115 \begin_layout Plain Layout
8121 (the default is to use the same name as the layout).
8123 \begin_inset Quotes eld
8126 Article (Standard Class)
8127 \begin_inset Quotes erd
8130 that appears above is used as a description of the text class in the
8131 \begin_inset Flex Noun
8134 \begin_layout Plain Layout
8135 Document\SpecialChar menuseparator
8143 \begin_inset Quotes eld
8147 \begin_inset Quotes erd
8150 in the example) is also used in the
8151 \begin_inset Flex Noun
8154 \begin_layout Plain Layout
8155 Document\SpecialChar menuseparator
8161 dialog: the text classes are grouped by these categories (which are usually
8162 genres, so typical categories are
8163 \begin_inset Quotes eld
8167 \begin_inset Quotes erd
8171 \begin_inset Quotes eld
8175 \begin_inset Quotes erd
8179 \begin_inset Quotes eld
8183 \begin_inset Quotes erd
8187 \begin_inset Quotes eld
8191 \begin_inset Quotes erd
8195 \begin_inset Quotes eld
8199 \begin_inset Quotes erd
8203 \begin_inset Quotes eld
8207 \begin_inset Quotes erd
8211 If no category has been declared, the class will be put in the
8212 \begin_inset Quotes eld
8216 \begin_inset Quotes erd
8222 \begin_layout Standard
8223 Let's assume that you wrote your own text class that uses the
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8233 document class, but where you changed the appearance of the section headings.
8234 If you put it in a file
8235 \begin_inset Flex Code
8238 \begin_layout Plain Layout
8244 , the header of this file should be:
8247 \begin_layout LyX-Code
8250 #% Do not delete the line below; configure depends on this
8253 \begin_layout LyX-Code
8258 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8261 \begin_layout LyX-Code
8266 DeclareCategory{Articles}
8269 \begin_layout Standard
8270 This declares a text class
8271 \begin_inset Flex Code
8274 \begin_layout Plain Layout
8280 , associated with the \SpecialChar LaTeX
8282 \begin_inset Flex Code
8285 \begin_layout Plain Layout
8292 \begin_inset Quotes eld
8295 Article (with My Own Headings)
8296 \begin_inset Quotes erd
8300 If your text class depends on several packages, you can declare it as:
8303 \begin_layout LyX-Code
8306 #% Do not delete the line below; configure depends on this
8309 \begin_layout LyX-Code
8314 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8317 \begin_layout LyX-Code
8322 DeclareCategory{Articles}
8325 \begin_layout Standard
8326 This indicates that your text class uses the
8327 \begin_inset Flex Code
8330 \begin_layout Plain Layout
8337 Finally, it is also possible to declare classes for DocBook code.
8338 Typical declarations will look like:
8341 \begin_layout LyX-Code
8344 #% Do not delete the line below; configure depends on this
8347 \begin_layout LyX-Code
8352 DeclareDocBookClass[article]{SGML (DocBook Article)}
8355 \begin_layout LyX-Code
8360 DeclareCategory{Articles (DocBook)}
8363 \begin_layout Standard
8364 Note that these declarations can also be given an optional parameter declaring
8365 the name of the document class (but not a list).
8368 \begin_layout Standard
8369 So, to be as explicit as possible, the form of the layout declaration is:
8372 \begin_layout LyX-Code
8377 DeclareLaTeXClass[class,package.sty]{layout description}
8380 \begin_layout LyX-Code
8385 DeclareCategory{category}
8388 \begin_layout Standard
8389 The class need only be specified if the name of the \SpecialChar LaTeX
8391 name of the layout file are different or if there are packages to load.
8392 If the name of the class file is not specified, then \SpecialChar LyX
8394 that it is the same as the name of the layout file.
8397 \begin_layout Standard
8398 When the text class has been modified to your taste, all you have to do
8399 is to copy it either to
8400 \begin_inset Flex Code
8403 \begin_layout Plain Layout
8410 \begin_inset Flex Code
8413 \begin_layout Plain Layout
8420 \begin_inset Flex Noun
8423 \begin_layout Plain Layout
8424 Tools\SpecialChar menuseparator
8430 , exit \SpecialChar LyX
8432 Then your new text class should be available along with the others.
8435 \begin_layout Standard
8436 Once the layout file is installed, you can edit it and see your changes
8437 without having to reconfigure or to restart \SpecialChar LyX
8442 \begin_layout Plain Layout
8443 In versions of \SpecialChar LyX
8444 prior to 1.6, this was not true.
8445 As a result, editing layout files was very time consuming, since you had
8446 constantly to restart \SpecialChar LyX
8452 You can force a reload of the current layout by using the \SpecialChar LyX
8454 \begin_inset Flex Noun
8457 \begin_layout Plain Layout
8464 There is no default binding for this function—though, of course, you can
8465 bind it to a key yourself.
8466 But you will normally use this function simply by entering it in the mini-buffe
8471 \begin_layout Standard
8477 \begin_inset Flex Noun
8480 \begin_layout Plain Layout
8486 is very much an `advanced feature'.
8491 recommended that you save your work before using this function.
8496 recommended that you not attempt to edit layout information while simultaneousl
8497 y working on a document that you care about.
8498 Use a test document.
8499 Syntax errors and the like in your layout file could cause peculiar behavior.
8500 In particular, such errors could cause \SpecialChar LyX
8501 to regard the current layout as
8502 invalid and to attempt to switch to some other layout.
8506 \begin_layout Plain Layout
8507 Really bad syntax errors may even caused \SpecialChar LyX
8509 This is because certain sorts of errors may make \SpecialChar LyX
8520 The \SpecialChar LyX
8521 team strives to keep \SpecialChar LyX
8522 stable in such situations, but safe is better
8527 \begin_layout Plain Layout
8528 While we're giving advice: make regular backups.
8529 And be nice to your mother.
8537 \begin_layout Subsection
8538 The Module declaration
8541 \begin_layout Standard
8542 A module must begin with a line like the following:
8545 \begin_layout LyX-Code
8548 DeclareLyXModule[endnotes.sty]{Endnotes}
8551 \begin_layout Standard
8552 The mandatory argument, in curly brackets, is the name of the module, as
8554 \begin_inset Flex Noun
8557 \begin_layout Plain Layout
8558 Document\SpecialChar menuseparator
8559 Settings\SpecialChar menuseparator
8566 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8568 on which the module depends.
8569 It is also possible to use the form
8570 \begin_inset Flex Noun
8573 \begin_layout Plain Layout
8579 as an optional argument, which declares that the module can only be used
8580 when there exists a conversion chain between the formats `
8581 \begin_inset Flex Code
8584 \begin_layout Plain Layout
8591 \begin_inset Flex Code
8594 \begin_layout Plain Layout
8603 \begin_layout Standard
8604 The module declaration should then be followed by lines like the following:
8608 \begin_layout Plain Layout
8609 Preferably in English if the module should be published with \SpecialChar LyX
8611 This description will appear in the list of messages to be translated and
8612 will be thus translated with the next interface update.
8620 \begin_layout LyX-Code
8624 \begin_layout LyX-Code
8625 #Adds an endnote command, in addition to footnotes.
8629 \begin_layout LyX-Code
8630 #You will need to add
8632 theendnotes in TeX code where you
8635 \begin_layout LyX-Code
8636 #want the endnotes to appear.
8640 \begin_layout LyX-Code
8644 \begin_layout LyX-Code
8645 #Requires: somemodule | othermodule
8648 \begin_layout LyX-Code
8649 #Excludes: badmodule
8652 \begin_layout Standard
8653 The description is used in
8654 \begin_inset Flex Noun
8657 \begin_layout Plain Layout
8658 Document\SpecialChar menuseparator
8659 Settings\SpecialChar menuseparator
8665 to provide the user with information about what the module does.
8667 \begin_inset Flex Code
8670 \begin_layout Plain Layout
8676 line is used to identify other modules with which this one must be used;
8678 \begin_inset Flex Code
8681 \begin_layout Plain Layout
8687 line is used to identify modules with which this one may not be used.
8688 Both are optional, and, as shown, multiple modules should be separated
8689 with the pipe symbol: |.
8690 Note that the required modules are treated disjunctively:
8694 of the required modules must be used.
8699 excluded module may be used.
8700 Note that modules are identified here by their filenames without the
8701 \begin_inset Flex Code
8704 \begin_layout Plain Layout
8712 \begin_inset Flex Code
8715 \begin_layout Plain Layout
8722 \begin_inset Flex Code
8725 \begin_layout Plain Layout
8734 \begin_layout Subsection
8735 The CiteEngine file declaration
8738 \begin_layout Standard
8739 A cite engine file must begin with a line like the following:
8742 \begin_layout LyX-Code
8745 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8748 \begin_layout Standard
8749 The mandatory argument, in curly brackets, is the name of the cite style,
8750 as it should appear in
8751 \begin_inset Flex Noun
8754 \begin_layout Plain Layout
8755 Document\SpecialChar menuseparator
8756 Settings\SpecialChar menuseparator
8763 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8765 on which the cite engine depends.
8768 \begin_layout Standard
8769 The cite engine declaration should then be followed by lines like the following:
8773 \begin_layout Plain Layout
8774 Preferably in English if the module should be published with \SpecialChar LyX
8776 This description will appear in the list of messages to be translated and
8777 will be thus translated with the next interface update.
8785 \begin_layout LyX-Code
8789 \begin_layout LyX-Code
8790 # Biblatex supports many author-year and numerical styles.
8793 \begin_layout LyX-Code
8794 # It is mainly aimed at the Humanities.
8798 \begin_layout LyX-Code
8799 # customizable, fully localized and provides many features
8802 \begin_layout LyX-Code
8803 # that are not possible with BibTeX.
8804 The use of 'biber' as
8807 \begin_layout LyX-Code
8808 # bibliography processor is advised.
8811 \begin_layout LyX-Code
8815 \begin_layout Standard
8816 The description is used in
8817 \begin_inset Flex Noun
8820 \begin_layout Plain Layout
8821 Document\SpecialChar menuseparator
8822 Settings\SpecialChar menuseparator
8828 to provide the user with information about the cite engine.
8831 \begin_layout Subsection
8835 \begin_layout Standard
8836 The first non-comment line of any layout file, included file, or module
8841 contain the file format number:
8844 \begin_layout Description
8845 \begin_inset Flex Code
8848 \begin_layout Plain Layout
8855 \begin_inset Flex Code
8858 \begin_layout Plain Layout
8864 ] The format number of the layout file.
8867 \begin_layout Standard
8868 This tag was introduced with \SpecialChar LyX
8870 \begin_inset space ~
8874 Layout files from older \SpecialChar LyX
8875 versions do not have an explicit file format and
8876 are considered to have
8877 \begin_inset Flex Code
8880 \begin_layout Plain Layout
8882 \begin_inset space ~
8891 The format for the present version of \SpecialChar LyX
8893 But each version of \SpecialChar LyX
8894 is capable of reading earlier versions' layout files,
8895 just as they are capable of reading files produced by earlier versions
8898 There is, however, no provision for converting to earlier formats.
8901 \begin_layout Subsection
8902 \begin_inset CommandInset label
8904 name "subsec:General-text-class"
8908 General text class parameters
8911 \begin_layout Standard
8912 These are general parameters that govern the behavior of an entire document
8918 mean that they must appear in
8919 \begin_inset Flex Code
8922 \begin_layout Plain Layout
8928 files rather than in modules.
8929 A module can contain any layout tag.)
8932 \begin_layout Description
8934 \change_inserted -712698321 1526899478
8935 \begin_inset Flex Code
8938 \begin_layout Plain Layout
8940 \change_inserted -712698321 1526898610
8941 AddToCiteEngine <engine>
8946 Extends the possibilities for displaying citation references.
8948 \begin_inset CommandInset ref
8950 reference "subsec:Citation-engine-description"
8959 \begin_inset Flex Code
8962 \begin_layout Plain Layout
8964 \change_inserted -712698321 1526898823
8975 \begin_layout Description
8976 \begin_inset Flex Code
8979 \begin_layout Plain Layout
8985 Adds information that will be output in the
8986 \begin_inset Flex Code
8989 \begin_layout Plain Layout
8995 block when the document is output to XHTML.
8996 Typically, this would be used to output CSS style information, but it can
8997 be used for anything that can appear in
8998 \begin_inset Flex Code
9001 \begin_layout Plain Layout
9009 \begin_inset Quotes eld
9013 \begin_inset Flex Code
9016 \begin_layout Plain Layout
9023 \begin_inset Quotes erd
9029 \begin_layout Description
9030 \begin_inset Flex Code
9033 \begin_layout Plain Layout
9039 Adds information to the document preamble.
9041 \begin_inset Newline newline
9045 \begin_inset Quotes eld
9049 \begin_inset Flex Code
9052 \begin_layout Plain Layout
9059 \begin_inset Quotes erd
9065 \begin_layout Description
9066 \begin_inset Flex Code
9069 \begin_layout Plain Layout
9075 Defines the possibilities for displaying citation references.
9077 \begin_inset CommandInset ref
9079 reference "subsec:Citation-engine-description"
9088 \begin_inset Quotes eld
9092 \begin_inset Flex Code
9095 \begin_layout Plain Layout
9102 \begin_inset Quotes erd
9106 Primarily used in cite engine files (see
9107 \begin_inset CommandInset ref
9109 reference "subsec:Cite-Engine-Files"
9118 \change_inserted -712698321 1526898530
9119 Note that if you specify this in a layout file or module, any cite engine
9120 definition will be overridden.
9122 \begin_inset Flex Code
9125 \begin_layout Plain Layout
9127 \change_inserted -712698321 1526898530
9140 \begin_layout Description
9141 \begin_inset Flex Code
9144 \begin_layout Plain Layout
9150 Defines formats for use in the display of bibliographic information.
9152 \begin_inset CommandInset ref
9154 reference "subsec:Citation-format-description"
9160 \begin_inset Quotes eld
9164 \begin_inset Flex Code
9167 \begin_layout Plain Layout
9174 \begin_inset Quotes erd
9178 Primarily used in cite engine files (see
9179 \begin_inset CommandInset ref
9181 reference "subsec:Cite-Engine-Files"
9190 \change_inserted -712698321 1526898585
9191 A cite format defined in a layout or module will override the cite engine
9197 \begin_layout Description
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9208 \begin_inset Flex Code
9211 \begin_layout Plain Layout
9220 \begin_inset Flex Code
9223 \begin_layout Plain Layout
9229 ] Determines whether
9233 or Bib\SpecialChar TeX
9234 is used to generate a Bibliography.
9235 Primarily used in cite engine files (see
9236 \begin_inset CommandInset ref
9238 reference "subsec:Cite-Engine-Files"
9248 \begin_layout Description
9249 \begin_inset Flex Code
9252 \begin_layout Plain Layout
9258 Describes various global options supported by the document class.
9260 \begin_inset CommandInset ref
9262 reference "subsec:ClassOptions"
9268 \begin_inset Quotes eld
9272 \begin_inset Flex Code
9275 \begin_layout Plain Layout
9282 \begin_inset Quotes erd
9288 \begin_layout Description
9289 \begin_inset Flex Code
9292 \begin_layout Plain Layout
9299 \begin_inset Flex Code
9302 \begin_layout Plain Layout
9311 \begin_inset space \thinspace{}
9315 \begin_inset Flex Code
9318 \begin_layout Plain Layout
9324 ] Whether the class should
9328 to having one or two columns.
9329 Can be changed in the
9330 \begin_inset Flex Noun
9333 \begin_layout Plain Layout
9334 Document\SpecialChar menuseparator
9343 \begin_layout Description
9344 \begin_inset Flex Code
9347 \begin_layout Plain Layout
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 ] This sequence defines the properties for a counter.
9364 If the counter does not yet exist, it is created; if it does exist, it
9367 \begin_inset Quotes eld
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9381 \begin_inset Quotes erd
9385 \begin_inset Newline newline
9389 \begin_inset CommandInset ref
9391 reference "subsec:Counters"
9395 for details on counters.
9398 \begin_layout Description
9399 \begin_inset Flex Code
9402 \begin_layout Plain Layout
9408 Sets the default font used to display the document.
9410 \begin_inset CommandInset ref
9412 reference "subsec:Font-description"
9416 for how to declare fonts.
9418 \begin_inset Quotes eld
9422 \begin_inset Flex Code
9425 \begin_layout Plain Layout
9432 \begin_inset Quotes erd
9438 \begin_layout Description
9439 \begin_inset Flex Code
9442 \begin_layout Plain Layout
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9458 ] Specifies a module to be included by default with this document class.
9459 The module is specified as filename without the
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9470 The user can still remove the module, but it will be active at the outset.
9471 (This applies only when new files are created, or when this class is chosen
9472 for an existing document.)
9475 \begin_layout Description
9476 \begin_inset Flex Code
9479 \begin_layout Plain Layout
9486 \begin_inset Flex Code
9489 \begin_layout Plain Layout
9495 ] This is the style that will be assigned to new paragraphs, usually
9496 \begin_inset Flex Noun
9499 \begin_layout Plain Layout
9506 This will default to the first defined style if not given, but you are
9507 encouraged to use this directive.
9510 \begin_layout Description
9511 \begin_inset Flex Code
9514 \begin_layout Plain Layout
9521 \begin_inset Flex Code
9524 \begin_layout Plain Layout
9530 ] This tag indicates that the module (which is specified by filename without
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9541 extension) cannot be used with this document class.
9542 This might be used in a journal-specific layout file to prevent, say, the
9544 \begin_inset Flex Code
9547 \begin_layout Plain Layout
9553 module that numbers theorems by section.
9558 be used in a module.
9559 Modules have their own way of excluding other modules (see
9560 \begin_inset CommandInset ref
9562 reference "subsec:Layout-modules"
9569 \begin_layout Description
9570 \begin_inset Flex Code
9573 \begin_layout Plain Layout
9579 Defines a new float.
9581 \begin_inset CommandInset ref
9583 reference "subsec:Floats"
9589 \begin_inset Quotes eld
9593 \begin_inset Flex Code
9596 \begin_layout Plain Layout
9603 \begin_inset Quotes erd
9609 \begin_layout Description
9610 \begin_inset Flex Code
9613 \begin_layout Plain Layout
9619 Sets the information that will be output in the
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9629 block when this document class is output to XHTML.
9630 Note that this will completely override any prior
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9641 \begin_inset Flex Code
9644 \begin_layout Plain Layout
9652 \begin_inset Newline newline
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9665 if you just want to add material to the preamble.) Must end with
9666 \begin_inset Quotes eld
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9680 \begin_inset Quotes erd
9686 \begin_layout Description
9687 \begin_inset Flex Code
9690 \begin_layout Plain Layout
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9706 ] The style to use for the table of contents, bibliography, and so forth,
9707 when the document is output to HTML.
9708 For articles, this should normally be
9709 \begin_inset Flex Code
9712 \begin_layout Plain Layout
9719 \begin_inset Flex Code
9722 \begin_layout Plain Layout
9729 If it is not given, then \SpecialChar LyX
9730 will attempt to figure out which layout to use.
9733 \begin_layout Description
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9744 \begin_inset Flex Code
9747 \begin_layout Plain Layout
9753 ] Modifies the properties of the given counter.
9754 If the counter does not exist, the statement is ignored.
9756 \begin_inset Quotes eld
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9770 \begin_inset Quotes erd
9774 \begin_inset Newline newline
9778 \begin_inset CommandInset ref
9780 reference "subsec:Counters"
9784 for details on counters.
9787 \begin_layout Description
9788 \begin_inset Flex Code
9791 \begin_layout Plain Layout
9798 \begin_inset Flex Code
9801 \begin_layout Plain Layout
9807 ] This allows you to include another layout definition file within yours
9808 to avoid duplicating commands.
9809 Common examples are the standard layout files, for example,
9810 \begin_inset Flex Code
9813 \begin_layout Plain Layout
9819 , which contains most of the basic layouts.
9822 \begin_layout Description
9823 \begin_inset Flex Code
9826 \begin_layout Plain Layout
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9842 ] This section (re-)defines the layout of an inset.
9843 It can be applied to an existing inset or to a new, user-defined inset,
9844 e.g., a new character style.
9846 \begin_inset Quotes eld
9850 \begin_inset Flex Code
9853 \begin_layout Plain Layout
9860 \begin_inset Quotes erd
9864 \begin_inset Newline newline
9868 \begin_inset CommandInset ref
9870 reference "subsec:Flex-insets-and"
9874 for more information.
9878 \begin_layout Description
9879 \begin_inset Flex Code
9882 \begin_layout Plain Layout
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9898 ] A string that indicates the width of the left margin on the screen, for
9900 \begin_inset Quotes eld
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9914 \begin_inset Quotes erd
9918 (Note that this is not a `length', like
9919 \begin_inset Quotes eld
9923 \begin_inset Quotes erd
9929 \begin_layout Description
9930 \begin_inset Flex Code
9933 \begin_layout Plain Layout
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9949 ] An integer that determines the maximal number of names displayed in an
9950 author-year citation before the citation switches to
9951 \begin_inset Quotes eld
9955 \begin_inset Quotes erd
9959 Primarily used in cite engine files (see
9960 \begin_inset CommandInset ref
9962 reference "subsec:Cite-Engine-Files"
9972 \begin_layout Description
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9983 \begin_inset Flex Code
9986 \begin_layout Plain Layout
9992 ] Modifies the properties of the given paragraph style.
9993 If the style does not exist, this section is ignored.
9995 \begin_inset Quotes eld
9999 \begin_inset Flex Code
10002 \begin_layout Plain Layout
10009 \begin_inset Quotes erd
10015 \begin_layout Description
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10026 \begin_inset Flex Code
10029 \begin_layout Plain Layout
10035 ] Deletes an existing counter, usually one defined in an included file.
10038 \begin_layout Description
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10058 ] Deletes an existing float.
10059 This is particularly useful when you want to suppress a float that has
10060 been defined in an input file.
10063 \begin_layout Description
10064 \begin_inset Flex Code
10067 \begin_layout Plain Layout
10074 \begin_inset Flex Code
10077 \begin_layout Plain Layout
10083 ] Deletes an existing style.
10086 \begin_layout Description
10087 \begin_inset Flex Code
10090 \begin_layout Plain Layout
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10116 ] Define a new table of contents with type
10117 \begin_inset Flex Code
10120 \begin_layout Plain Layout
10127 \begin_inset Flex Code
10130 \begin_layout Plain Layout
10137 See also the AddToToc commands.
10140 \begin_layout Description
10141 \begin_inset Flex Code
10144 \begin_layout Plain Layout
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10160 ] The file format (as defined in the \SpecialChar LyX
10161 preferences) produced by this document
10163 It is mainly useful when
10164 \begin_inset Flex Code
10167 \begin_layout Plain Layout
10174 \begin_inset Flex Code
10177 \begin_layout Plain Layout
10183 and one wants to define a new type of literate document.
10184 The format is reset to
10185 \begin_inset Quotes eld
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10199 \begin_inset Quotes erd
10203 \begin_inset Quotes eld
10207 \begin_inset Flex Code
10210 \begin_layout Plain Layout
10217 \begin_inset Quotes erd
10220 when the corresponding
10221 \begin_inset Flex Code
10224 \begin_layout Plain Layout
10230 parameter is encountered.
10233 \begin_layout Description
10234 \begin_inset Flex Code
10237 \begin_layout Plain Layout
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10258 \begin_inset Flex Code
10261 \begin_layout Plain Layout
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10277 ] Specifies what sort of output documents using this class will produce.
10280 \begin_layout Description
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10301 \begin_inset Flex Code
10304 \begin_layout Plain Layout
10310 ] Specifies options, given in the second string, for the package named by
10313 \begin_inset Quotes eld
10317 \begin_inset Flex Code
10320 \begin_layout Plain Layout
10321 PackageOptions natbib square
10327 \begin_inset Quotes erd
10331 \begin_inset Flex Code
10334 \begin_layout Plain Layout
10340 to be loaded with the
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10351 (For \SpecialChar TeX
10352 perts, this causes \SpecialChar LyX
10354 \begin_inset Flex Code
10357 \begin_layout Plain Layout
10360 PassOptionsToPackage{natbib}{square}
10366 \begin_inset Flex Code
10369 \begin_layout Plain Layout
10378 \begin_layout Description
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10420 ] The default pagestyle.
10421 Can be changed in the
10422 \begin_inset Flex Noun
10425 \begin_layout Plain Layout
10426 Document\SpecialChar menuseparator
10435 \begin_layout Description
10436 \begin_inset Flex Code
10439 \begin_layout Plain Layout
10445 Sets the preamble for the \SpecialChar LaTeX
10447 Note that this will completely override any prior
10448 \begin_inset Flex Code
10451 \begin_layout Plain Layout
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10469 \begin_inset Flex Code
10472 \begin_layout Plain Layout
10478 if you just want to add material to the preamble.) Must end with
10479 \begin_inset Quotes eld
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10493 \begin_inset Quotes erd
10499 \begin_layout Description
10500 \begin_inset Flex Code
10503 \begin_layout Plain Layout
10510 \begin_inset Flex Code
10513 \begin_layout Plain Layout
10520 \begin_inset Flex Code
10523 \begin_layout Plain Layout
10532 \begin_inset space \thinspace{}
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10545 ] Whether the class already provides the feature
10546 \begin_inset Flex Code
10549 \begin_layout Plain Layout
10556 A feature is in general the name of a package (e.
10557 \begin_inset space \thinspace{}
10561 \begin_inset space \space{}
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10575 \begin_inset Flex Code
10578 \begin_layout Plain Layout
10585 \begin_inset space \thinspace{}
10589 \begin_inset space \space{}
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10614 \begin_inset CommandInset ref
10616 reference "chap:List-of-functions"
10620 for the list of features.
10623 \begin_layout Description
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10634 \begin_inset Flex Code
10637 \begin_layout Plain Layout
10643 ] Indicates that this layout provides the functionality of the module mentioned,
10644 which should be specified by the filename without the
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10655 This will typically be used if the layout includes the module directly,
10656 rather than using the
10657 \begin_inset Flex Code
10660 \begin_layout Plain Layout
10666 tag to indicate that it ought to be used.
10667 It could also be used in a module that provided an alternate implementation
10668 of the same functionality.
10671 \begin_layout Description
10672 \begin_inset Flex Code
10675 \begin_layout Plain Layout
10682 \begin_inset Flex Code
10685 \begin_layout Plain Layout
10691 ] Creates a new paragraph style if it does not already exist.
10692 If the style does exist, this section is ignored.
10694 \begin_inset Quotes eld
10698 \begin_inset Flex Code
10701 \begin_layout Plain Layout
10708 \begin_inset Quotes erd
10714 \begin_layout Description
10715 \begin_inset Flex Code
10718 \begin_layout Plain Layout
10725 \begin_inset Flex Code
10728 \begin_layout Plain Layout
10734 ] Whether the class requires the feature
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 Multiple features must be separated by commas.
10746 Note that you can only request supported features.
10748 \begin_inset CommandInset ref
10750 reference "chap:List-of-functions"
10754 for the list of features.).
10755 If you require a package with specific options, you can additionally use
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10769 \begin_layout Description
10770 \begin_inset Flex Code
10773 \begin_layout Plain Layout
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10789 ] A string that indicates the width of the right margin on the screen, for
10791 \begin_inset Quotes eld
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10805 \begin_inset Quotes erd
10811 \begin_layout Description
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10822 \begin_inset Flex Code
10825 \begin_layout Plain Layout
10831 ] Sets which divisions get numbered.
10833 \begin_inset Newline newline
10837 \begin_inset Flex Code
10840 \begin_layout Plain Layout
10846 counter in \SpecialChar LaTeX
10850 \begin_layout Description
10851 \begin_inset Flex Code
10854 \begin_layout Plain Layout
10861 \begin_inset Flex Code
10864 \begin_layout Plain Layout
10873 \begin_inset space \thinspace{}
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10886 ] Whether the class-default should be printing on one or both sides of the
10888 Can be changed in the
10889 \begin_inset Flex Noun
10892 \begin_layout Plain Layout
10893 Document\SpecialChar menuseparator
10902 \begin_layout Description
10903 \begin_inset Flex Code
10906 \begin_layout Plain Layout
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10922 ] This sequence defines a paragraph style.
10923 If the style does not yet exist, it is created; if it does exist, its parameter
10926 \begin_inset Quotes eld
10930 \begin_inset Flex Code
10933 \begin_layout Plain Layout
10940 \begin_inset Quotes erd
10944 \begin_inset Newline newline
10948 \begin_inset CommandInset ref
10950 reference "subsec:Paragraph-Styles"
10954 for details on paragraph styles.
10955 \change_inserted -712698321 1553617804
10959 \begin_layout Description
10961 \change_inserted -712698321 1553617862
10962 \begin_inset Flex Code
10965 \begin_layout Plain Layout
10967 \change_inserted -712698321 1553617809
10974 \begin_inset Flex Code
10977 \begin_layout Plain Layout
10979 \change_inserted -712698321 1553617805
10985 ] defines the default table style that is used when inserting a table.
10986 The following styles are available:
10990 \begin_layout Itemize
10992 \change_inserted -712698321 1553617929
10993 \begin_inset Flex Code
10996 \begin_layout Plain Layout
10998 \change_inserted -712698321 1553617920
11007 \begin_inset Quotes eld
11011 \begin_inset Quotes erd
11014 ) style with horizontal lines only and a bold top and bottom line.
11017 \begin_layout Itemize
11019 \change_inserted -712698321 1553618031
11020 \begin_inset Flex Code
11023 \begin_layout Plain Layout
11025 \change_inserted -712698321 1553618006
11031 : Simple table lines.
11034 \begin_layout Itemize
11036 \change_inserted -712698321 1553618309
11037 \begin_inset Flex Code
11040 \begin_layout Plain Layout
11042 \change_inserted -712698321 1553618031
11049 \begin_inset Flex Code
11052 \begin_layout Plain Layout
11054 \change_inserted -712698321 1553618043
11060 , but with the header column offset with a second horizontal line.
11061 This is also the default style of \SpecialChar LyX
11065 \begin_layout Itemize
11067 \change_inserted -712698321 1553618280
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11073 \change_inserted -712698321 1553618261
11079 : Table without lines.
11085 \begin_layout Description
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11096 \begin_inset Flex Code
11099 \begin_layout Plain Layout
11105 ] The name of the command or environment to be used with
11106 \begin_inset Flex Code
11109 \begin_layout Plain Layout
11118 \begin_layout Description
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11141 \begin_inset Flex Code
11144 \begin_layout Plain Layout
11150 ] Indicates what kind of markup is used to define the title of a document.
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11161 means that the macro with name
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11171 will be inserted after the last layout which has
11172 \begin_inset Quotes eld
11176 \begin_inset Flex Code
11179 \begin_layout Plain Layout
11181 \begin_inset space ~
11190 \begin_inset Quotes erd
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11204 corresponds to the case where all layouts which have
11205 \begin_inset Quotes eld
11209 \begin_inset Flex Code
11212 \begin_layout Plain Layout
11214 \begin_inset space ~
11223 \begin_inset Quotes erd
11226 should be enclosed into the
11227 \begin_inset Flex Code
11230 \begin_layout Plain Layout
11239 \begin_layout Description
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11259 ] Sets which divisions are included in the table of contents.
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11270 counter in \SpecialChar LaTeX
11274 \begin_layout Subsection
11275 \begin_inset Flex Code
11278 \begin_layout Plain Layout
11285 \begin_inset CommandInset label
11287 name "subsec:ClassOptions"
11294 \begin_layout Standard
11296 \begin_inset Flex Code
11299 \begin_layout Plain Layout
11305 section can contain the following entries:
11308 \begin_layout Description
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11328 ] The list of available font sizes for the document's main font, separated
11330 \begin_inset Quotes eld
11334 \begin_inset Flex Code
11337 \begin_layout Plain Layout
11344 \begin_inset Quotes erd
11350 \begin_layout Description
11351 \begin_inset Flex Code
11354 \begin_layout Plain Layout
11360 Used to set the DTD line with XML-based output classes.
11362 \begin_inset space \thinspace{}
11366 \begin_inset Quotes eld
11369 -//OASIS//DTD DocBook V4.2//EN
11370 \begin_inset Quotes erd
11376 \begin_layout Description
11377 \begin_inset Flex Code
11380 \begin_layout Plain Layout
11387 \begin_inset Flex Code
11390 \begin_layout Plain Layout
11391 string="empty|plain|headings|fancy"
11396 ] The list of available page sty\SpecialChar softhyphen
11398 \begin_inset Quotes eld
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11412 \begin_inset Quotes erd
11418 \begin_layout Description
11419 \begin_inset Flex Code
11422 \begin_layout Plain Layout
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11438 ] Some document class options, separated by a comma, that will be added
11439 to the optional part of the
11440 \begin_inset Flex Code
11443 \begin_layout Plain Layout
11454 \begin_layout Standard
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11465 section must end with
11466 \begin_inset Quotes eld
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11480 \begin_inset Quotes erd
11486 \begin_layout Subsection
11488 \begin_inset CommandInset label
11490 name "subsec:Paragraph-Styles"
11497 \begin_layout Standard
11498 A paragraph style description looks like this:
11502 \begin_layout Plain Layout
11503 Note that this will either define a new style or modify an existing one.
11511 \begin_layout LyX-Code
11518 \begin_layout LyX-Code
11522 \begin_layout LyX-Code
11526 \begin_layout Standard
11527 where the following commands are allowed:
11530 \begin_layout Description
11531 \begin_inset Flex Code
11534 \begin_layout Plain Layout
11541 \begin_inset Flex Code
11544 \begin_layout Plain Layout
11550 =""] This paragraph will appear in the table of contents of the given type.
11551 An empty string disables.
11552 See also the OutlinerName and the IsTocCaption commands.
11556 \begin_layout Description
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11567 \begin_inset Flex Code
11570 \begin_layout Plain Layout
11575 , left, right, center
11580 ] Paragraph alignment.
11583 \begin_layout Description
11584 \begin_inset Flex Code
11587 \begin_layout Plain Layout
11594 \begin_inset Flex Code
11597 \begin_layout Plain Layout
11602 , left, right, center
11607 ] A comma separated list of permitted alignments.
11608 (Some \SpecialChar LaTeX
11609 styles prohibit certain alignments, since those wouldn't make sense.
11610 For example a right-aligned or centered enumeration isn't possible.)
11613 \begin_layout Description
11614 \begin_inset Flex Code
11617 \begin_layout Plain Layout
11624 \begin_inset Flex Code
11627 \begin_layout Plain Layout
11633 ] Defines argument number <int> of a command\SpecialChar breakableslash
11634 environment associated with
11636 This is useful for things like section headings, and only makes sense with
11639 Every (optional or required) argument of a command or environment – except
11640 for the required argument that is associated with the content of the paragraph
11641 itself – has a separate definition, where the number specifies the order
11643 The definition must end with
11644 \begin_inset Flex Code
11647 \begin_layout Plain Layout
11654 So a command with two optional arguments has:
11658 \begin_layout Quote
11664 \begin_layout Quote
11670 \begin_layout Quote
11676 \begin_layout Quote
11682 \begin_layout Quote
11688 \begin_layout Quote
11694 \begin_layout Standard
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11705 definition, the following specifications are possible:
11708 \begin_layout Itemize
11709 \begin_inset Flex Code
11712 \begin_layout Plain Layout
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11728 The string that will appear both in the menu (to insert this argument)
11729 and on the argument inset button (unless you also specify a separate
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11740 For the menu, you can define an accelerator by appending the respective
11741 character to the string, divided by
11742 \begin_inset Quotes eld
11746 \begin_inset Quotes erd
11750 \begin_inset space \thinspace{}
11754 \begin_inset space \space{}
11758 \begin_inset Quotes eld
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11772 \begin_inset Quotes erd
11778 \begin_layout Itemize
11779 \begin_inset Flex Code
11782 \begin_layout Plain Layout
11789 \begin_inset Flex Code
11792 \begin_layout Plain Layout
11798 A separate string for the menu.
11799 You can define an accelerator by appending the respective character to
11800 the string, divided by
11801 \begin_inset Quotes eld
11805 \begin_inset Quotes erd
11809 \begin_inset space \thinspace{}
11813 \begin_inset space \space{}
11817 \begin_inset Quotes eld
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11831 \begin_inset Quotes erd
11835 This specification is optional.
11836 If it is not given the
11837 \begin_inset Flex Code
11840 \begin_layout Plain Layout
11846 will be used instead for the menu.
11849 \begin_layout Itemize
11850 \begin_inset Flex Code
11853 \begin_layout Plain Layout
11860 \begin_inset Flex Code
11863 \begin_layout Plain Layout
11869 A longer explanatory text that appears in the tooltip when hovering over
11870 the argument inset.
11873 \begin_layout Itemize
11874 \begin_inset Flex Code
11877 \begin_layout Plain Layout
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11896 \begin_inset space \thinspace{}
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11909 ] Declare if this is a mandatory (1) or an optional (0) argument.
11910 Mandatory arguments will be output empty if not given, while optional arguments
11911 will not be output at all.
11912 By default, mandatory arguments are delimited by
11913 \begin_inset Flex Code
11916 \begin_layout Plain Layout
11922 , while optional arguments are delimited by
11923 \begin_inset Flex Code
11926 \begin_layout Plain Layout
11935 \begin_layout Itemize
11936 \begin_inset Flex Code
11939 \begin_layout Plain Layout
11946 \begin_inset Flex Code
11949 \begin_layout Plain Layout
11955 defines another argument (by its number) which this argument requires to
11956 be output if it is itself output.
11958 \begin_inset space \thinspace{}
11961 g., in \SpecialChar LaTeX
11962 commands, optional arguments often require previous optional arguments
11963 to be output (at least empty), as in
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11970 command[][argument]{text}
11976 This can be achieved by the statement
11977 \begin_inset Flex Code
11980 \begin_layout Plain Layout
11987 \begin_inset Flex Code
11990 \begin_layout Plain Layout
11999 \begin_layout Itemize
12000 \begin_inset Flex Code
12003 \begin_layout Plain Layout
12010 \begin_inset Flex Code
12013 \begin_layout Plain Layout
12019 defines a custom left delimiter (instead of
12020 \begin_inset Flex Code
12023 \begin_layout Plain Layout
12030 \begin_inset Flex Code
12033 \begin_layout Plain Layout
12040 A line break in the output can be indicated by
12041 \begin_inset Flex Code
12044 \begin_layout Plain Layout
12053 \begin_layout Itemize
12054 \begin_inset Flex Code
12057 \begin_layout Plain Layout
12064 \begin_inset Flex Code
12067 \begin_layout Plain Layout
12073 defines a custom right delimiter (instead of
12074 \begin_inset Flex Code
12077 \begin_layout Plain Layout
12084 \begin_inset Flex Code
12087 \begin_layout Plain Layout
12094 A line break in the output can be indicated by
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12107 \begin_layout Itemize
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12127 defines an argument that is inserted if and only if no user-specified arguments
12129 \begin_inset space \thinspace{}
12133 \begin_inset space \space{}
12136 if no argument inset has been inserted (note that also an empty argument
12137 inset omits the DefaultArg).
12138 Multiple arguments need to be separated by comma.
12141 \begin_layout Itemize
12142 \begin_inset Flex Code
12145 \begin_layout Plain Layout
12152 \begin_inset Flex Code
12155 \begin_layout Plain Layout
12161 defines an argument that is inserted in any case (alone or in addition
12162 to user-specified arguments).
12163 Multiple arguments need to be separated by comma.
12166 \begin_layout Itemize
12167 \begin_inset Flex Code
12170 \begin_layout Plain Layout
12176 The font used for the argument content, see
12177 \begin_inset CommandInset ref
12179 reference "subsec:Font-description"
12186 \begin_layout Itemize
12187 \begin_inset Flex Code
12190 \begin_layout Plain Layout
12196 The font used for the label; see
12197 \begin_inset CommandInset ref
12199 reference "subsec:Font-description"
12206 \begin_layout Itemize
12207 \begin_inset Flex Code
12210 \begin_layout Plain Layout
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12225 , Minimalistic, Conglomerate
12230 ] describes the rendering style used for the inset's frame and buttons.
12233 \begin_layout Itemize
12234 \begin_inset Flex Code
12237 \begin_layout Plain Layout
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12263 , this argument is automatically inserted when the respective style is selected.
12264 Currently, only one argument per style\SpecialChar breakableslash
12265 layout can be automatically inserted.
12268 \begin_layout Itemize
12269 \begin_inset Flex Code
12272 \begin_layout Plain Layout
12279 \begin_inset Flex Code
12282 \begin_layout Plain Layout
12289 \begin_inset Flex Code
12292 \begin_layout Plain Layout
12298 , this argument will be inserted with a copy of the co-text (either selected
12299 text or the whole paragraph) as content.
12302 \begin_layout Itemize
12303 \begin_inset Flex Code
12306 \begin_layout Plain Layout
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12326 ] Whether the contents of this argument should be output in raw form, meaning
12327 without special translations that \SpecialChar LaTeX
12330 \begin_inset Flex Code
12333 \begin_layout Plain Layout
12339 status is inherited by the inset or paragraph layout the argument belongs
12340 to, true and false change the status for the given argument only.
12343 \begin_layout Itemize
12344 \begin_inset Flex Code
12347 \begin_layout Plain Layout
12354 \begin_inset Flex Code
12357 \begin_layout Plain Layout
12358 string of characters
12367 Defines individual characters
12368 \begin_inset Newline linebreak
12371 that should be output in raw form, meaning without special translations
12372 that \SpecialChar LaTeX
12374 Note that, contrary to PassThru, this needs to be explicitly defined for
12376 That is, arguments do not inherit PassThruChars from their parent inset
12380 \begin_layout Itemize
12381 \begin_inset Flex Code
12384 \begin_layout Plain Layout
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12403 \begin_inset space \thinspace{}
12407 \begin_inset Flex Code
12410 \begin_layout Plain Layout
12416 ] If this is set to 1, the argument will output its content in the corresponding
12417 item in the table of contents.
12421 \begin_layout Standard
12422 By default, the text entered in the \SpecialChar LyX
12423 workarea in the respective layout is
12424 the last (mandatory) argument of a command if the
12425 \begin_inset Flex Code
12428 \begin_layout Plain Layout
12435 \begin_inset Flex Code
12438 \begin_layout Plain Layout
12445 However, arguments with the prefix
12446 \begin_inset Flex Code
12449 \begin_layout Plain Layout
12455 are output after this workarea argument.
12456 Note that post-argument numbering restarts at 1, so the first argument
12457 following the workarea argument is
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12468 Post-arguments are ignored in any other
12469 \begin_inset Flex Code
12472 \begin_layout Plain Layout
12479 \begin_inset Flex Code
12482 \begin_layout Plain Layout
12491 \begin_layout Standard
12493 \begin_inset Flex Code
12496 \begin_layout Plain Layout
12505 \begin_inset Flex Code
12508 \begin_layout Plain Layout
12517 \begin_inset Flex Code
12520 \begin_layout Plain Layout
12526 followed by the number (e.
12527 \begin_inset space \thinspace{}
12531 \begin_inset space \space{}
12535 \begin_inset Flex Code
12538 \begin_layout Plain Layout
12545 \change_inserted -712698321 1534487781
12549 \begin_layout Standard
12551 \change_inserted -712698321 1534488561
12552 Finally, there is a special argument type with the prefix
12553 \begin_inset Flex Code
12556 \begin_layout Plain Layout
12558 \change_inserted -712698321 1534487844
12567 It is not really an argument, but uses the argument interface (thus, the
12568 prefix is also followed by a number, e.
12569 \begin_inset space \thinspace{}
12574 \begin_inset Flex Code
12577 \begin_layout Plain Layout
12579 \change_inserted -712698321 1534488412
12580 Argument listpreamble:1
12586 As the name implies, it is targeted at lists such as
12603 Its content will be output at the list start, before the first
12604 \begin_inset Flex Code
12607 \begin_layout Plain Layout
12609 \change_inserted -712698321 1534488058
12619 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12621 This way, users can insert redefinitions (of lengths etc.) to individual
12623 By default, these arguments do not have a delimiter.
12629 \begin_layout Description
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12639 Includes a comma-separated list of layouts that should be nested in and
12640 after the current layout.
12641 Only makes sense for nestable layouts (such as environments).
12643 \begin_inset Quotes eld
12647 \begin_inset Flex Code
12650 \begin_layout Plain Layout
12657 \begin_inset Quotes erd
12662 \begin_inset Flex Code
12665 \begin_layout Plain Layout
12674 \begin_layout Description
12675 \begin_inset Flex Code
12678 \begin_layout Plain Layout
12684 Note that this will completely override any prior
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12694 declaration for this style.
12696 \begin_inset Quotes eld
12700 \begin_inset Flex Code
12703 \begin_layout Plain Layout
12710 \begin_inset Quotes erd
12715 \begin_inset CommandInset ref
12717 reference "subsec:I18n"
12721 for details on its use.
12724 \begin_layout Description
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12748 \begin_layout Plain Layout
12749 Note that a `float' here is a real number, such as: 1.5.
12754 The vertical space with which the last of a chain of paragraphs with this
12755 style is separated from the following paragraph.
12756 If the next paragraph has another style, the separations are not simply
12757 added, but the maximum is taken.
12760 \begin_layout Description
12761 \begin_inset Flex Code
12764 \begin_layout Plain Layout
12771 \begin_inset Flex Code
12774 \begin_layout Plain Layout
12780 ] The category for this style.
12781 This is used to group related styles in the style combobox on the toolbar.
12782 Any string can be used, but you may want to use existing categories with
12787 \begin_layout Description
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12797 Depth of XML command.
12798 Used only with XML-type formats.
12801 \begin_layout Description
12802 \begin_inset Flex Code
12805 \begin_layout Plain Layout
12812 \begin_inset Flex Code
12815 \begin_layout Plain Layout
12821 ] Copies all the features of an existing style into the current one.
12825 \begin_layout Description
12826 \begin_inset Flex Code
12829 \begin_layout Plain Layout
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12845 ] The name of a style whose preamble should be output
12850 This allows to ensure some ordering of the preamble snippets when macros
12851 definitions depend on one another.
12855 \begin_layout Plain Layout
12856 Note that, besides that functionality, there is no way to ensure any ordering
12858 The ordering that you see in a given version of \SpecialChar LyX
12859 may change without warning
12868 \begin_layout Description
12869 \begin_inset Flex Code
12872 \begin_layout Plain Layout
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12887 , Box, Filled_Box, Static
12892 ] The type of label that stands at the end of the paragraph (or sequence
12894 \begin_inset Flex Code
12897 \begin_layout Plain Layout
12904 \begin_inset Newline newline
12908 \begin_inset Flex Code
12911 \begin_layout Plain Layout
12918 \begin_inset Flex Code
12921 \begin_layout Plain Layout
12928 \begin_inset Flex Code
12931 \begin_layout Plain Layout
12939 \begin_inset Flex Code
12942 \begin_layout Plain Layout
12949 \begin_inset Quotes eld
12953 \begin_inset Quotes erd
12957 \begin_inset Flex Code
12960 \begin_layout Plain Layout
12967 \begin_inset space \space{}
12971 \begin_inset Flex Code
12974 \begin_layout Plain Layout
12980 ) is a white (resp.
12981 \begin_inset space ~
12984 black) square suitable for end of proof markers,
12985 \begin_inset Flex Code
12988 \begin_layout Plain Layout
12994 is an explicit text string.
12997 \begin_layout Description
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13017 ] The string used for a label with a
13018 \begin_inset Flex Code
13021 \begin_layout Plain Layout
13028 \begin_inset Newline newline
13032 \begin_inset Flex Code
13035 \begin_layout Plain Layout
13045 \begin_layout Description
13046 \begin_inset Flex Code
13049 \begin_layout Plain Layout
13055 The font used for both the text body
13061 \begin_inset CommandInset ref
13063 reference "subsec:Font-description"
13068 Note that defining this font automatically defines the
13069 \begin_inset Flex Code
13072 \begin_layout Plain Layout
13079 So you should define this one first if you also want to define
13080 \begin_inset Flex Code
13083 \begin_layout Plain Layout
13092 \begin_layout Description
13093 \begin_inset Flex Code
13096 \begin_layout Plain Layout
13103 \begin_inset Flex Code
13106 \begin_layout Plain Layout
13112 ] Used for backporting new styles to stable \SpecialChar LyX
13114 The first stable version that supports this tag is \SpecialChar LyX
13116 The argument is a number which may either be 0, -1 or any value greater
13119 \begin_inset Flex Code
13122 \begin_layout Plain Layout
13128 flag of a style is greater than zero, it will always be written to the
13130 If a .lyx file is read, the style definitions from the document header are
13131 added to the document class.
13132 Therefore even older \SpecialChar LyX
13133 versions can handle the style.
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13144 is a version number: if the style is read, and the version number is less
13145 than the version number of the already existing style in the document class,
13146 the new style is ignored.
13147 If the version number is greater, the new style replaces the existing style.
13148 A value of -1 means an infinite version number, i.
13149 \begin_inset space \thinspace{}
13153 \begin_inset space \space{}
13156 the style is always used.
13159 \begin_layout Description
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13170 \begin_inset Flex Code
13173 \begin_layout Plain Layout
13182 \begin_inset space \thinspace{}
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13195 ] Usually \SpecialChar LyX
13196 does not allow you to insert more than one space between words,
13197 since a space is considered as the separation between two words, not a
13198 character or symbol of its own.
13199 This is a very fine thing but sometimes annoying, for example, when typing
13200 program code or plain \SpecialChar LaTeX
13203 \begin_inset Flex Code
13206 \begin_layout Plain Layout
13214 \change_deleted -495245474 1550490105
13218 will create protected blanks for the additional blanks when in
13219 \change_inserted -495245474 1550490096
13221 \begin_inset Flex Code
13224 \begin_layout Plain Layout
13226 \change_inserted -495245474 1550490089
13233 \change_deleted -495245474 1550490116
13234 another mode than \SpecialChar LaTeX
13237 \change_inserted -495245474 1550247760
13239 \begin_inset Flex Code
13242 \begin_layout Plain Layout
13244 \change_inserted -495245474 1550247736
13251 \begin_inset Flex Code
13254 \begin_layout Plain Layout
13256 \change_inserted -495245474 1550247755
13267 \begin_layout Description
13268 \begin_inset Flex Code
13271 \begin_layout Plain Layout
13277 These tags are used with XHTML output.
13279 \begin_inset CommandInset ref
13281 reference "subsec:Paragraph-Style-XHTML"
13288 \begin_layout Description
13289 \begin_inset Flex Code
13292 \begin_layout Plain Layout
13298 [FIXME] (Used only with XML-type formats.)
13301 \begin_layout Description
13302 \begin_inset Flex Code
13305 \begin_layout Plain Layout
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13324 \begin_inset space \thinspace{}
13328 \begin_inset Flex Code
13331 \begin_layout Plain Layout
13338 \begin_inset Flex Code
13341 \begin_layout Plain Layout
13347 , marks the style as to be included in the document preamble and not in
13349 This is useful for document classes that want such information as the title
13350 and author to appear in the preamble.
13351 Note that this works only for styles for which the
13352 \begin_inset Flex Code
13355 \begin_layout Plain Layout
13362 \begin_inset Flex Code
13365 \begin_layout Plain Layout
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13384 \begin_layout Description
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13395 \begin_inset Flex Code
13398 \begin_layout Plain Layout
13407 \begin_inset space \thinspace{}
13411 \begin_inset Flex Code
13414 \begin_layout Plain Layout
13421 \begin_inset Flex Code
13424 \begin_layout Plain Layout
13430 , marks the style as being part of a title block (see also the
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13453 \begin_layout Description
13454 \begin_inset Flex Code
13457 \begin_layout Plain Layout
13463 Includes a comma-separated list of layouts after which this one should
13465 Only makes sense with regard to nestable layouts (such as environments).
13467 \begin_inset Quotes eld
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13481 \begin_inset Quotes erd
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13498 \begin_layout Description
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13521 \begin_inset space \thinspace{}
13525 \begin_inset Flex Code
13528 \begin_layout Plain Layout
13534 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13535 of its contents in its item in the table of contents.
13536 Otherwise, only the label, if it exists, appears.
13539 \begin_layout Description
13540 \begin_inset Flex Code
13543 \begin_layout Plain Layout
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13559 ] The \SpecialChar LaTeX
13560 command sequence declaring an item in a list.
13561 The command is to be defined without the preceding backslash (the default
13563 \begin_inset Quotes eld
13567 \begin_inset Quotes erd
13571 \begin_inset Flex Code
13574 \begin_layout Plain Layout
13582 in the \SpecialChar LaTeX
13586 \begin_layout Description
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13597 \begin_inset Flex Code
13600 \begin_layout Plain Layout
13606 ] This provides extra space between paragraphs that have the same style.
13607 If you put other styles into an environment, each is separated with the
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13619 But the whole items of the environment are additionally separated with
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 Note that this is a
13636 \begin_layout Description
13637 \begin_inset Flex Code
13640 \begin_layout Plain Layout
13646 [FIXME] (Used only with XML-type formats.)
13649 \begin_layout Description
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13660 \begin_inset Flex Code
13663 \begin_layout Plain Layout
13672 \begin_inset space \thinspace{}
13676 \begin_inset Flex Code
13679 \begin_layout Plain Layout
13685 ] Usually \SpecialChar LyX
13686 does not allow you to leave a paragraph empty, since it would
13687 lead to empty \SpecialChar LaTeX
13689 There are some cases where this could be desirable however: in a letter
13690 template, the required fields can be provided as empty fields, so that
13691 people do not forget them; in some special classes, a style can be used
13692 as some kind of break, which does not contain actual text.
13695 \begin_layout Description
13696 \begin_inset Flex Code
13699 \begin_layout Plain Layout
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13715 ] The vertical space between the label and the text body.
13716 Only used for labels that are above the text body (
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13727 \begin_inset Newline newline
13731 \begin_inset Flex Code
13734 \begin_layout Plain Layout
13735 Centered_Top_Environment
13743 \begin_layout Description
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13754 \begin_inset Flex Code
13757 \begin_layout Plain Layout
13763 ] The name of the counter for automatic numbering.
13764 In order to have the counter appear with your label, you will need to reference
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13778 This will work with
13779 \begin_inset Flex Code
13782 \begin_layout Plain Layout
13789 \begin_inset Flex Code
13792 \begin_layout Plain Layout
13799 \begin_inset Flex Code
13802 \begin_layout Plain Layout
13809 \begin_inset Flex Code
13812 \begin_layout Plain Layout
13819 \begin_inset Newline newline
13827 \begin_inset Flex Code
13830 \begin_layout Plain Layout
13837 \begin_inset Flex Code
13840 \begin_layout Plain Layout
13846 , though this case is a bit complicated.
13847 Suppose you declare
13848 \begin_inset Quotes eld
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13856 LabelCounter myenum
13862 \begin_inset Quotes erd
13866 Then the actual counters used are
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13897 \begin_inset Flex Code
13900 \begin_layout Plain Layout
13906 , much as in \SpecialChar LaTeX
13908 These counters must all be declared separately.
13909 \begin_inset Newline newline
13913 \begin_inset CommandInset ref
13915 reference "subsec:Counters"
13919 for details on counters.
13922 \begin_layout Description
13923 \begin_inset Flex Code
13926 \begin_layout Plain Layout
13932 The font used for the label.
13934 \begin_inset CommandInset ref
13936 reference "subsec:Font-description"
13943 \begin_layout Description
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13963 ] Text that indicates how far a label should be indented.
13966 \begin_layout Description
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13977 \begin_inset Flex Code
13980 \begin_layout Plain Layout
13986 ] Text that indicates the amount of horizontal space between the label and
13988 Only used for labels that are not above the text body.
13991 \begin_layout Description
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14002 \begin_inset Flex Code
14005 \begin_layout Plain Layout
14011 ] The string used for the label.
14013 \begin_inset Flex Code
14016 \begin_layout Plain Layout
14022 is set, this string can be contain the special formatting commands described
14024 \begin_inset CommandInset ref
14026 reference "subsec:Counters"
14033 \begin_layout Description
14034 \begin_inset Flex Code
14037 \begin_layout Plain Layout
14038 LabelStringAppendix
14044 \begin_inset Flex Code
14047 \begin_layout Plain Layout
14053 ] This is used inside the appendix instead of
14054 \begin_inset Newline newline
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14069 \begin_inset Flex Code
14072 \begin_layout Plain Layout
14079 \begin_inset Newline newline
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14087 LabelStringAppendix
14095 \begin_layout Description
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14105 [FIXME] (Used only with XML-type formats.)
14108 \begin_layout Description
14109 \begin_inset Flex Code
14112 \begin_layout Plain Layout
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14127 , Manual, Static, Above,
14128 \begin_inset Newline newline
14131 Centered, Sensitive, Enumerate,
14132 \begin_inset Newline newline
14135 Itemize, Bibliography
14144 \begin_layout Description
14145 \begin_inset Flex Code
14148 \begin_layout Plain Layout
14154 means the label is the very first word (up to the first real blank).
14155 Use protected spaces if you want more than one word as the label.
14159 \begin_layout Description
14160 \begin_inset Flex Code
14163 \begin_layout Plain Layout
14169 means the label is simply what is declared as
14170 \begin_inset Flex Code
14173 \begin_layout Plain Layout
14180 This will be displayed
14181 \begin_inset Quotes eld
14185 \begin_inset Quotes erd
14188 , at the beginning of the paragraph.
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14209 , then it will be displayed only in the first paragraph of any sequence
14210 of paragraphs with the same
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14223 \begin_layout Description
14224 \begin_inset Flex Code
14227 \begin_layout Plain Layout
14234 \begin_inset space ~
14238 \begin_inset space ~
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14251 are special cases of
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 The label will be printed above the paragraph either at the beginning of
14263 the line or centered.
14266 \begin_layout Description
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14276 is a special case for the caption-labels
14277 \begin_inset Quotes eld
14281 \begin_inset Quotes erd
14285 \begin_inset Quotes eld
14289 \begin_inset Quotes erd
14293 \begin_inset Newline newline
14297 \begin_inset Flex Code
14300 \begin_layout Plain Layout
14306 means the (hardcoded) label string depends on the kind of float: It is
14307 hardcoded to be `FloatType N', where N is the value of the counter associated
14309 For the case that a caption is inserted outside of a float the
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14320 \begin_inset Quotes eld
14324 \begin_inset Quotes erd
14330 \begin_layout Description
14331 \begin_inset Flex Code
14334 \begin_layout Plain Layout
14340 produces the usual sort of enumeration labels.
14341 The number type needs to be set in the
14346 \begin_inset CommandInset ref
14348 reference "subsec:Counters"
14355 \begin_layout Description
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14365 produces various bullets at the different levels.
14366 The bullet types displayed can be set via
14367 \begin_inset Flex Noun
14370 \begin_layout Plain Layout
14371 Document\SpecialChar menuseparator
14372 Settings\SpecialChar menuseparator
14381 \begin_layout Description
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14391 should be used only with
14392 \begin_inset Flex Code
14395 \begin_layout Plain Layout
14396 LatexType BibEnvironment
14405 \begin_layout Description
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14415 Note that this will completely override any prior
14416 \begin_inset Flex Code
14419 \begin_layout Plain Layout
14425 declaration for this style.
14427 \begin_inset Quotes eld
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14441 \begin_inset Quotes erd
14446 \begin_inset CommandInset ref
14448 reference "subsec:I18n"
14452 for details on its use.
14455 \begin_layout Description
14456 \begin_inset Flex Code
14459 \begin_layout Plain Layout
14466 \begin_inset Flex Code
14469 \begin_layout Plain Layout
14475 ] The name of the corresponding \SpecialChar LaTeX
14477 Either the environment or command name.
14480 \begin_layout Description
14481 \begin_inset Flex Code
14484 \begin_layout Plain Layout
14491 \begin_inset Flex Code
14494 \begin_layout Plain Layout
14500 ] An optional parameter for the corresponding
14501 \begin_inset Flex Code
14504 \begin_layout Plain Layout
14511 This parameter cannot be changed from within \SpecialChar LyX
14513 \begin_inset Flex Code
14516 \begin_layout Plain Layout
14522 for customizable parameters).
14523 This will be output as is after all \SpecialChar LaTeX
14525 \begin_inset Flex Code
14528 \begin_layout Plain Layout
14537 \begin_layout Description
14538 \begin_inset Flex Code
14541 \begin_layout Plain Layout
14548 \begin_inset Flex Code
14551 \begin_layout Plain Layout
14556 , Command, Environment, Item_Environment,
14557 \begin_inset Newline newline
14560 List_Environment, Bib_Environment
14565 ] How the style should be translated into \SpecialChar LaTeX
14570 \begin_layout Plain Layout
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14580 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14581 Visit the SGML class files for specific examples.
14590 \begin_layout Description
14591 \begin_inset Flex Code
14594 \begin_layout Plain Layout
14600 means nothing special.
14603 \begin_layout Description
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14624 {\SpecialChar ldots
14633 \begin_layout Description
14634 \begin_inset Flex Code
14637 \begin_layout Plain Layout
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14654 }\SpecialChar ldots
14670 \begin_layout Description
14671 \begin_inset Flex Code
14674 \begin_layout Plain Layout
14681 \begin_inset Flex Code
14684 \begin_layout Plain Layout
14691 \begin_inset Flex Code
14694 \begin_layout Plain Layout
14702 is generated for each paragraph of this environment.
14706 \begin_layout Description
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14727 \begin_inset Newline newline
14731 \begin_inset Flex Code
14734 \begin_layout Plain Layout
14740 is passed as an argument to the environment.
14741 \begin_inset Newline newline
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14754 can be defined in the
14755 \begin_inset Flex Noun
14758 \begin_layout Plain Layout
14759 Edit\SpecialChar menuseparator
14761 \begin_inset space ~
14772 \begin_layout Description
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14792 but adds the necessary mandatory argument (the longest label) to the begin
14793 statement of the bibliography environment:
14794 \begin_inset Newline newline
14798 \begin_inset Flex Code
14801 \begin_layout Plain Layout
14804 begin{thebibliography}{99}
14810 It is therefore only useful for bibliography environments.
14811 The default longest label
14812 \begin_inset Quotes eld
14816 \begin_inset Quotes erd
14819 can be changed by the user in the paragraph settings of a bibliography
14823 \begin_layout Standard
14824 Putting the last few things together, the \SpecialChar LaTeX
14825 output will be either:
14828 \begin_layout LyX-Code
14831 LatexName[LatexParam]{\SpecialChar ldots
14835 \begin_layout Standard
14839 \begin_layout LyX-Code
14842 begin{LatexName}[LatexParam] \SpecialChar ldots
14848 \begin_layout Standard
14849 depending upon the \SpecialChar LaTeX
14854 \begin_layout Description
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14874 ] A string that is put at the beginning of the style content.
14875 A line break in the output can be indicated by
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14888 \begin_layout Description
14889 \begin_inset Flex Code
14892 \begin_layout Plain Layout
14899 \begin_inset Flex Code
14902 \begin_layout Plain Layout
14908 ] If you put styles into environments, the different
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14918 are not simply added, but added with a factor
14919 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14923 Note that this parameter is also used when
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14934 \begin_inset Flex Code
14937 \begin_layout Plain Layout
14944 \begin_inset Flex Code
14947 \begin_layout Plain Layout
14954 Then it is added to the manual or dynamic margin.
14955 \begin_inset Newline newline
14959 \begin_inset Quotes eld
14963 \begin_inset Flex Code
14966 \begin_layout Plain Layout
14973 \begin_inset Quotes erd
14976 means that the paragraph is indented with the width of
14977 \begin_inset Quotes eld
14981 \begin_inset Flex Code
14984 \begin_layout Plain Layout
14991 \begin_inset Quotes erd
14994 in the normal font.
14995 You can get a negative width by prefixing the string with
14996 \begin_inset Quotes eld
15000 \begin_inset Flex Code
15003 \begin_layout Plain Layout
15010 \begin_inset Quotes erd
15014 This way was chosen so that the look is the same with each used screen
15018 \begin_layout Description
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15037 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15043 \begin_inset Newline newline
15046 The kind of margin that the style has on the left side.
15050 \begin_layout Description
15051 \begin_inset Flex Code
15054 \begin_layout Plain Layout
15060 just means a fixed margin.
15063 \begin_layout Description
15064 \begin_inset Flex Code
15067 \begin_layout Plain Layout
15073 means that the left margin depends on the string entered in the
15074 \begin_inset Flex Noun
15077 \begin_layout Plain Layout
15078 Edit\SpecialChar menuseparator
15080 \begin_inset space ~
15089 This is used to typeset nice lists without tabulators.
15092 \begin_layout Description
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15102 means that the margin depends on the size of the label.
15103 This is used for automatic enumerated headlines.
15104 It is obvious that the headline
15105 \begin_inset Quotes eld
15108 5.4.3.2.1 Very long headline
15109 \begin_inset Quotes erd
15112 must have a wider left margin (as wide as
15113 \begin_inset Quotes eld
15117 \begin_inset Quotes erd
15120 plus the space) than
15121 \begin_inset Quotes eld
15124 3.2 Very long headline
15125 \begin_inset Quotes erd
15129 \begin_inset Quotes eld
15133 \begin_inset Quotes erd
15136 are not able to do this.
15139 \begin_layout Description
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15149 is similar, but only the very first row of the paragraph is dynamic, while
15150 the others are static; this is used, for example, for descriptions.
15153 \begin_layout Description
15154 \begin_inset Flex Code
15157 \begin_layout Plain Layout
15163 means the margin is chosen in a way that the longest row of this paragraph
15164 fits to the right margin.
15165 This is used to typeset an address on the right edge of the page.
15169 \begin_layout Description
15170 \begin_inset Flex Code
15173 \begin_layout Plain Layout
15180 \begin_inset Flex Code
15183 \begin_layout Plain Layout
15192 \begin_inset space \thinspace{}
15196 \begin_inset Flex Code
15199 \begin_layout Plain Layout
15205 ] Whether fragile commands in this style should be
15206 \begin_inset Flex Code
15209 \begin_layout Plain Layout
15222 whether this command should itself be protected.)
15223 \change_inserted -712698321 1523696949
15227 \begin_layout Description
15229 \change_inserted -712698321 1552395557
15230 \begin_inset Flex Code
15233 \begin_layout Plain Layout
15235 \change_inserted -712698321 1523696950
15242 \begin_inset Flex Code
15245 \begin_layout Plain Layout
15247 \change_inserted -712698321 1523696950
15256 \begin_inset space \thinspace{}
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15265 \change_inserted -712698321 1523696950
15271 ] This causes macros that contain this layout to be protected with
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15277 \change_inserted -712698321 1523696950
15290 ) if necessary and thus allows (some) verbatim stuff in macros.
15293 \begin_layout Description
15295 \change_inserted -712698321 1552395844
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15301 \change_inserted -712698321 1552395561
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15313 \change_inserted -712698321 1552395557
15322 \begin_inset space \thinspace{}
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15331 \change_inserted -712698321 1552395557
15337 ] Whether specific commands in this style (such as
15338 \begin_inset Flex Code
15341 \begin_layout Plain Layout
15343 \change_inserted -712698321 1552395655
15354 \begin_inset Flex Code
15357 \begin_layout Plain Layout
15359 \change_inserted -712698321 1552395661
15369 ) should be protected in an
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15375 \change_inserted -712698321 1552395631
15386 This is particularly needed for styles that draw on
15394 commands which parse their content in complex ways.
15399 \begin_layout Description
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15420 \begin_inset space \thinspace{}
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15435 ] Whether newlines are translated into \SpecialChar LaTeX
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15451 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15453 inside \SpecialChar LyX
15457 \begin_layout Description
15458 \begin_inset Flex Code
15461 \begin_layout Plain Layout
15468 \begin_inset Flex Code
15471 \begin_layout Plain Layout
15480 \begin_inset space \thinspace{}
15484 \begin_inset Flex Code
15487 \begin_layout Plain Layout
15493 ] If set to true, and if
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15513 ) paragraphs are being indented, then the indentation of such a paragraph
15514 following one of this type will be suppressed.
15515 (So this will not affect the display of non-default paragraphs.)
15518 \begin_layout Description
15519 \begin_inset Flex Code
15522 \begin_layout Plain Layout
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15538 ] Name of a style that has replaced this style.
15539 This is used to rename a style, while keeping backward compatibility.
15542 \begin_layout Description
15543 \begin_inset Flex Code
15546 \begin_layout Plain Layout
15553 \begin_inset Flex Code
15556 \begin_layout Plain Layout
15563 \begin_inset space \thinspace{}
15567 \begin_inset Flex Code
15570 \begin_layout Plain Layout
15576 ] Determines whether consecutive paragraphs of the same type are treated
15577 as belonging together.
15578 This has the effect that the
15579 \begin_inset Flex Code
15582 \begin_layout Plain Layout
15588 is only printed once before such a group.
15589 By default, this is true for
15590 \begin_inset Flex Code
15593 \begin_layout Plain Layout
15600 \begin_inset Flex Code
15603 \begin_layout Plain Layout
15610 \begin_inset Flex Code
15613 \begin_layout Plain Layout
15619 and false for all other types.
15622 \begin_layout Description
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15633 \begin_inset Flex Code
15636 \begin_layout Plain Layout
15645 \begin_inset space \thinspace{}
15649 \begin_inset Flex Code
15652 \begin_layout Plain Layout
15658 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15660 but only by a line break; together with
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15670 , this allows to emulate a plain text editor (like the ERT inset).
15673 \begin_layout Description
15674 \begin_inset Flex Code
15677 \begin_layout Plain Layout
15684 \begin_inset Flex Code
15687 \begin_layout Plain Layout
15693 ] The indent of the very first line of a paragraph.
15695 \begin_inset Newline newline
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15708 will be fixed for a certain style.
15709 The exception is the default style, since the indentation for these paragraphs
15710 can be prohibited with
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15731 style paragraphs inside environments use the
15732 \begin_inset Flex Code
15735 \begin_layout Plain Layout
15741 of the environment, not their native one.
15743 \begin_inset Flex Code
15746 \begin_layout Plain Layout
15752 paragraphs inside an enumeration are not indented.
15755 \begin_layout Description
15756 \begin_inset Flex Code
15759 \begin_layout Plain Layout
15766 \begin_inset Flex Code
15769 \begin_layout Plain Layout
15775 ] The vertical space between two paragraphs of this style.
15778 \begin_layout Description
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15789 \begin_inset Flex Code
15792 \begin_layout Plain Layout
15799 allows the user to choose either
15800 \begin_inset Quotes eld
15804 \begin_inset Quotes erd
15808 \begin_inset Quotes eld
15812 \begin_inset Quotes erd
15815 to separate paragraphs.
15817 \begin_inset Quotes eld
15821 \begin_inset Quotes erd
15825 \begin_inset Flex Code
15828 \begin_layout Plain Layout
15836 \begin_inset Quotes eld
15840 \begin_inset Quotes erd
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15853 is ignored and all paragraphs are separated by the
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15864 The vertical space is calculated with
15865 \begin_inset Flex Code
15868 \begin_layout Plain Layout
15870 \begin_inset space ~
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 is the height of a row with the normal font.
15889 This way, the look stays the same with different screen fonts.
15892 \begin_layout Description
15893 \begin_inset Flex Code
15896 \begin_layout Plain Layout
15903 \begin_inset Flex Code
15906 \begin_layout Plain Layout
15915 \begin_inset space \thinspace{}
15919 \begin_inset Flex Code
15922 \begin_layout Plain Layout
15928 ] Whether the contents of this paragraph should be output in raw form, meaning
15929 without special translations that \SpecialChar LaTeX
15933 \begin_layout Description
15934 \begin_inset Flex Code
15937 \begin_layout Plain Layout
15944 \begin_inset Flex Code
15947 \begin_layout Plain Layout
15957 Defines individual characters that should be output in raw form, meaning
15958 without special translations that \SpecialChar LaTeX
15962 \begin_layout Description
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15972 Information to be included in the \SpecialChar LaTeX
15973 preamble when this style is used.
15974 Used to define macros, load packages, etc., required by this particular
15977 \begin_inset Quotes eld
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15991 \begin_inset Quotes erd
15997 \begin_layout Description
15998 \begin_inset Flex Code
16001 \begin_layout Plain Layout
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16017 ] The prefix to use when creating labels referring to paragraphs of this
16019 This allows the use of formatted references.
16022 \begin_layout Description
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16033 \begin_inset Flex Code
16036 \begin_layout Plain Layout
16042 ] Whether the style requires the feature
16043 \begin_inset Flex Code
16046 \begin_layout Plain Layout
16053 \begin_inset CommandInset ref
16055 reference "chap:List-of-functions"
16059 for the list of features).
16060 If you require a package with specific options, you can additionally use
16062 \begin_inset Flex Code
16065 \begin_layout Plain Layout
16071 as a general text class parameter (see
16072 \begin_inset CommandInset ref
16074 reference "subsec:General-text-class"
16081 \begin_layout Description
16082 \begin_inset Flex Code
16085 \begin_layout Plain Layout
16092 \begin_inset Flex Code
16095 \begin_layout Plain Layout
16104 \begin_inset Flex Code
16107 \begin_layout Plain Layout
16113 ] Resets the \SpecialChar LaTeX
16114 arguments of this style (as defined via the
16115 \begin_inset Flex Code
16118 \begin_layout Plain Layout
16125 This is useful if you have copied a style via
16126 \begin_inset Flex Code
16129 \begin_layout Plain Layout
16135 , but you do not want to inherit its (required and optional) arguments.
16138 \begin_layout Description
16139 \begin_inset Flex Code
16142 \begin_layout Plain Layout
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16161 \begin_inset Flex Code
16164 \begin_layout Plain Layout
16170 ] Resumes a counter that is usually reset at each new sequence of layouts.
16171 This is currently only useful when
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16182 \begin_inset Flex Code
16185 \begin_layout Plain Layout
16194 \begin_layout Description
16195 \begin_inset Flex Code
16198 \begin_layout Plain Layout
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16214 ] A string that is put at the end of the layout content.
16215 A line break in the output can be indicated by
16216 \begin_inset Flex Code
16219 \begin_layout Plain Layout
16228 \begin_layout Description
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16239 \begin_inset Flex Code
16242 \begin_layout Plain Layout
16249 \begin_inset Flex Code
16252 \begin_layout Plain Layout
16261 \begin_layout Description
16262 \begin_inset Flex Code
16265 \begin_layout Plain Layout
16272 \begin_inset Flex Code
16275 \begin_layout Plain Layout
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16309 \begin_inset space ~
16317 ] This defines what the default spacing should be in the style.
16319 \begin_inset Flex Code
16322 \begin_layout Plain Layout
16329 \begin_inset Flex Code
16332 \begin_layout Plain Layout
16339 \begin_inset Flex Code
16342 \begin_layout Plain Layout
16348 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16349 If you specify the argument
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16359 , then you must also provide a value argument which will be the actual multiplie
16361 Note that, contrary to other parameters,
16362 \begin_inset Flex Code
16365 \begin_layout Plain Layout
16371 implies the generation of specific \SpecialChar LaTeX
16372 code, using the \SpecialChar LaTeX
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16388 \begin_layout Description
16389 \begin_inset Flex Code
16392 \begin_layout Plain Layout
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16409 \begin_inset space \thinspace{}
16413 \begin_inset Flex Code
16416 \begin_layout Plain Layout
16424 ] Allow spell-checking paragraphs of this style.
16428 \begin_layout Description
16429 \begin_inset Flex Code
16432 \begin_layout Plain Layout
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16460 ] Steps the master counter of a given counter at the beginning of a new
16461 sequence of layouts.
16462 This is currently only useful when
16463 \begin_inset Flex Code
16466 \begin_layout Plain Layout
16473 \begin_inset Flex Code
16476 \begin_layout Plain Layout
16485 \begin_layout Description
16486 \begin_inset Flex Code
16489 \begin_layout Plain Layout
16495 The font used for the text body .
16497 \begin_inset CommandInset ref
16499 reference "subsec:Font-description"
16506 \begin_layout Description
16507 \begin_inset Flex Code
16510 \begin_layout Plain Layout
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16532 The level of the style in the table of contents.
16533 This is used for automatic numbering of section headings.
16536 \begin_layout Description
16537 \begin_inset Flex Code
16540 \begin_layout Plain Layout
16549 \begin_inset Flex Code
16552 \begin_layout Plain Layout
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16573 \begin_inset Flex Code
16576 \begin_layout Plain Layout
16582 ] This tag determines whether the first line indentation of this paragraph
16583 can be toggled via the Paragraph settings dialog.
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16600 is set, indentation can be toggled if the document settings use
16601 \begin_inset Quotes eld
16605 \begin_inset Quotes erd
16608 paragraph style, with
16609 \begin_inset Flex Code
16612 \begin_layout Plain Layout
16618 , indentation can always be toggled, notwithstanding the document settings,
16620 \begin_inset Flex Code
16623 \begin_layout Plain Layout
16629 , indentation can never be toggled.
16632 \begin_layout Description
16633 \begin_inset Flex Code
16636 \begin_layout Plain Layout
16643 \begin_inset Flex Code
16646 \begin_layout Plain Layout
16652 ] The vertical space with which the very first of a chain of paragraphs
16653 with this style is separated from the previous paragraph.
16654 If the previous paragraph has another style, the separations are not simply
16655 added, but the maximum is taken.
16658 \begin_layout Subsection
16659 \begin_inset CommandInset label
16665 Internationalization of Paragraph Styles
16668 \begin_layout Standard
16670 has long supported internationalization of layout information, but, until
16671 version 2.0, this applied only to the user interface and not to, say, PDF
16673 Thus, French authors were forced to resort to ugly hacks if they wanted
16678 1' instead of `Theorem 1'.
16679 Thanks to Georg Baum, that is no longer the case.
16682 \begin_layout Standard
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16693 defines text that is to appear in the typeset document, it may use
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16713 to support non-English and even multi-language documents correctly.
16714 The following excerpt (from the
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16724 file) shows how this works:
16727 \begin_layout LyX-Code
16732 \begin_layout LyX-Code
16735 theoremstyle{remark}
16738 \begin_layout LyX-Code
16741 newtheorem{claim}[thm]{
16748 \begin_layout LyX-Code
16752 \begin_layout LyX-Code
16756 \begin_layout LyX-Code
16761 claimname}{_(Claim)}
16764 \begin_layout LyX-Code
16768 \begin_layout LyX-Code
16772 \begin_layout LyX-Code
16781 claimname}{_(Claim)}}
16784 \begin_layout LyX-Code
16789 \begin_layout Standard
16790 In principle, any legal \SpecialChar LaTeX
16792 \begin_inset Flex Code
16795 \begin_layout Plain Layout
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16811 tags, but in practice they will typically look as they do here.
16812 The key to correct translation of the typeset text is the definition of
16813 the \SpecialChar LaTeX
16815 \begin_inset Flex Code
16818 \begin_layout Plain Layout
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16842 \begin_layout Standard
16844 \begin_inset Flex Code
16847 \begin_layout Plain Layout
16853 tag provides for internationalization based upon the overall language of
16855 The contents of the tag will be included in the preamble, just as with
16857 \begin_inset Flex Code
16860 \begin_layout Plain Layout
16867 What makes it special is the use of the
16868 \begin_inset Quotes eld
16872 \begin_inset Quotes erd
16876 \begin_inset Flex Code
16879 \begin_layout Plain Layout
16885 , which will be replaced, when \SpecialChar LyX
16886 produces \SpecialChar LaTeX
16887 output, with the translation of
16888 its argument into the document language.
16891 \begin_layout Standard
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16902 tag is more complex, since it is meant to provide support for multi-language
16903 documents and so offers an interface to the
16904 \begin_inset Flex Code
16907 \begin_layout Plain Layout
16914 Its contents will be added to the preamble once for each language that
16915 appears in the document.
16916 In this case, the argument to
16917 \begin_inset Flex Code
16920 \begin_layout Plain Layout
16926 will be replaced with its translation into the language in question; the
16928 \begin_inset Flex Code
16931 \begin_layout Plain Layout
16937 is replaced by the language name (as used by the babel package).
16940 \begin_layout Standard
16941 A German document that also included a French section would thus have the
16942 following in the preamble:
16945 \begin_layout LyX-Code
16954 claimname}{Affirmation}}
16955 \begin_inset Newline newline
16966 claimname}{Behauptung}}
16967 \begin_inset Newline newline
16974 claimname}{Behauptung}
16977 \begin_layout Standard
16980 \begin_inset Flex Code
16983 \begin_layout Plain Layout
16989 will then conspire to produce the correct text in the output.
16992 \begin_layout Standard
16993 One important point to note here is that the translations are provided by
16995 itself, through the file
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 This means, in effect, that
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17026 are really only of use in layout files that are provided with \SpecialChar LyX
17028 entered in user-created layout files will not be seen by \SpecialChar LyX
17029 's internationalizatio
17030 n routines unless the
17031 \begin_inset Flex Code
17034 \begin_layout Plain Layout
17040 file is modified accordingly.
17041 That said, however, any layout created with the intention that it will
17042 be included with \SpecialChar LyX
17043 should use these tags where appropriate.
17044 Please note that the paragraph style translations provided by \SpecialChar LyX
17046 change with a minor update (e.
17047 \begin_inset space \thinspace{}
17051 \begin_inset space \space{}
17054 from version 2.1.x to 2.1.y).
17055 It is however quite likely that a major update (e.
17056 \begin_inset space \thinspace{}
17060 \begin_inset space \space{}
17063 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17066 \begin_layout Subsection
17068 \begin_inset CommandInset label
17070 name "subsec:Floats"
17077 \begin_layout Standard
17078 It is necessary to define the floats (
17079 \begin_inset Flex Noun
17082 \begin_layout Plain Layout
17089 \begin_inset Flex Noun
17092 \begin_layout Plain Layout
17098 , \SpecialChar ldots
17099 ) in the text class itself.
17100 Standard floats are included in the file
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17110 , so you may have to do no more than add
17113 \begin_layout LyX-Code
17114 Input stdfloats.inc
17117 \begin_layout Standard
17118 to your layout file.
17119 If you want to implement a text class that proposes some other float types
17120 (like the AGU class bundled with \SpecialChar LyX
17121 ), the information below will hopefully
17125 \begin_layout Description
17126 \begin_inset Flex Code
17129 \begin_layout Plain Layout
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17145 =!htbpH] Allowed placement options for this float type.
17146 The value is a string of placement characters.
17147 Possible characters include:
17152 \begin_inset Quotes eld
17156 \begin_inset Quotes erd
17164 \begin_inset Quotes eld
17168 \begin_inset Quotes erd
17176 \begin_inset Quotes eld
17180 \begin_inset Quotes erd
17188 \begin_inset Quotes eld
17192 \begin_inset Quotes erd
17200 \begin_inset Quotes eld
17204 \begin_inset Quotes erd
17212 \begin_inset Quotes eld
17216 \begin_inset Quotes erd
17220 The order of the characters in the string does not matter.
17221 If no placement options are allowed, use the string
17228 \begin_layout Description
17229 \begin_inset Flex Code
17232 \begin_layout Plain Layout
17239 \begin_inset Flex Code
17242 \begin_layout Plain Layout
17251 \begin_inset space \thinspace{}
17257 \begin_inset Flex Code
17260 \begin_layout Plain Layout
17270 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17286 if the float does not support this feature.
17289 \begin_layout Description
17290 \begin_inset Flex Code
17293 \begin_layout Plain Layout
17300 \begin_inset Flex Code
17303 \begin_layout Plain Layout
17312 \begin_inset space \thinspace{}
17318 \begin_inset Flex Code
17321 \begin_layout Plain Layout
17331 ] Defines whether the float has a starred variant that spans columns in
17332 a two column paragraph.
17334 \begin_inset Flex Code
17337 \begin_layout Plain Layout
17343 if the float does not support this feature.
17346 \begin_layout Description
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17367 \begin_inset Quotes erd
17371 \begin_inset Quotes erd
17374 ] The file name extension of an auxiliary file for the list of figures (or
17377 writes the captions to this file.
17380 \begin_layout Description
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17401 \begin_inset Quotes erd
17405 \begin_inset Quotes erd
17408 ] The string that will be used in the menus and also for the caption.
17409 This is translated to the current language if babel is used.
17412 \begin_layout Description
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17422 These tags control the XHTML output.
17424 \begin_inset CommandInset ref
17426 reference "sec:Tags-for-XHTML"
17433 \begin_layout Description
17434 \begin_inset Flex Code
17437 \begin_layout Plain Layout
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17458 \begin_inset space \thinspace{}
17462 \begin_inset Flex Code
17465 \begin_layout Plain Layout
17471 ] Indicates whether the float is already defined in the document class or
17472 if instead the \SpecialChar LaTeX
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17483 needs to be loaded to define it on-the-fly.
17485 \begin_inset Flex Code
17488 \begin_layout Plain Layout
17495 \begin_inset Flex Code
17498 \begin_layout Plain Layout
17505 It should be set to
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17515 if the float is already defined by the \SpecialChar LaTeX
17519 \begin_layout Description
17520 \begin_inset Flex Code
17523 \begin_layout Plain Layout
17530 \begin_inset Flex Code
17533 \begin_layout Plain Layout
17540 \begin_inset Quotes erd
17544 \begin_inset Quotes erd
17547 ] The command used to generate a list of floats of this type; the leading
17556 \begin_inset Flex Code
17559 \begin_layout Plain Layout
17565 is false, since there is no standard way to generate this command.
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17576 is true, since in that case there is a standard way to define the command.
17579 \begin_layout Description
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Quotes erd
17604 \begin_inset Quotes erd
17607 ] A title for a list of floats of this kind (list of figures, tables, or
17609 It is used for the screen label within \SpecialChar LyX
17610 , it is used by \SpecialChar LaTeX
17612 it is used as the title in the XHTML output.
17613 It will be translated to the document language.
17616 \begin_layout Description
17617 \begin_inset Flex Code
17620 \begin_layout Plain Layout
17627 \begin_inset Flex Code
17630 \begin_layout Plain Layout
17637 \begin_inset Quotes erd
17641 \begin_inset Quotes erd
17644 ] This (optional) argument determines whether floats of this class will
17645 be numbered within some sectional unit of the document.
17647 \begin_inset Flex Code
17650 \begin_layout Plain Layout
17657 \begin_inset Quotes eld
17661 \begin_inset Flex Code
17664 \begin_layout Plain Layout
17671 \begin_inset Quotes erd
17674 , the floats will be numbered within chapters.
17678 \begin_layout Description
17679 \begin_inset Flex Code
17682 \begin_layout Plain Layout
17689 \begin_inset Flex Code
17692 \begin_layout Plain Layout
17699 \begin_inset Quotes erd
17703 \begin_inset Quotes erd
17706 ] The default placement for the given class of floats.
17707 The string should be as in standard \SpecialChar LaTeX
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17739 \begin_inset Flex Code
17742 \begin_layout Plain Layout
17748 for top, bottom, page, and here, respectively.
17752 \begin_layout Plain Layout
17753 Note that the order of these letters in the string is irrelevant, like in
17760 On top of that there is a new type,
17761 \begin_inset Flex Code
17764 \begin_layout Plain Layout
17770 , which does not really correspond to a float, since it means: put it
17771 \begin_inset Quotes eld
17775 \begin_inset Quotes erd
17779 Note however that the
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17789 specifier is special and, because of implementation details, cannot be
17790 used in non-built in float types.
17791 If you do not understand what this means, just use
17792 \begin_inset Quotes eld
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17806 \begin_inset Quotes erd
17812 \begin_layout Description
17813 \begin_inset Flex Code
17816 \begin_layout Plain Layout
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17832 ] The prefix to use when creating labels referring to floats of this type.
17833 This allows the use of formatted references.
17834 Note that you can remove any
17835 \begin_inset Flex Code
17838 \begin_layout Plain Layout
17844 set by a copied style by using the special value
17845 \begin_inset Quotes eld
17849 \begin_inset Quotes erd
17852 , which must be all caps.
17855 \begin_layout Description
17856 \begin_inset Flex Code
17859 \begin_layout Plain Layout
17866 \begin_inset Flex Code
17869 \begin_layout Plain Layout
17876 \begin_inset Quotes erd
17880 \begin_inset Quotes erd
17883 ] The style used when defining the float using
17884 \begin_inset Flex Code
17887 \begin_layout Plain Layout
17898 \begin_layout Description
17899 \begin_inset Flex Code
17902 \begin_layout Plain Layout
17909 \begin_inset Flex Code
17912 \begin_layout Plain Layout
17919 \begin_inset Quotes erd
17923 \begin_inset Quotes erd
17927 \begin_inset Quotes eld
17931 \begin_inset Quotes erd
17934 of the new class of floats, like program or algorithm.
17935 After the appropriate
17936 \begin_inset Flex Code
17939 \begin_layout Plain Layout
17948 \begin_inset Flex Code
17951 \begin_layout Plain Layout
17960 \begin_inset Flex Code
17963 \begin_layout Plain Layout
17974 \begin_layout Description
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17995 \begin_inset space \thinspace{}
17999 \begin_inset Flex Code
18002 \begin_layout Plain Layout
18010 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18012 \begin_inset Flex Code
18015 \begin_layout Plain Layout
18021 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18025 \begin_layout Standard
18026 Note that defining a float with type
18027 \begin_inset Flex Code
18030 \begin_layout Plain Layout
18038 automatically defines the corresponding counter with name
18039 \begin_inset Flex Code
18042 \begin_layout Plain Layout
18053 \begin_layout Subsection
18054 Flex insets and InsetLayout
18055 \begin_inset CommandInset label
18057 name "subsec:Flex-insets-and"
18064 \begin_layout Standard
18065 Flex insets come in three different kinds:
18068 \begin_layout Itemize
18070 \begin_inset Flex Code
18073 \begin_layout Plain Layout
18079 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18081 \begin_inset Flex Code
18084 \begin_layout Plain Layout
18093 \begin_inset Flex Code
18096 \begin_layout Plain Layout
18107 \begin_layout Itemize
18109 \begin_inset Flex Code
18112 \begin_layout Plain Layout
18118 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18120 footnote, and the like.
18121 An obvious example is an endnote inset, which is defined in the
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18134 \begin_layout Itemize
18136 \begin_inset Flex Code
18139 \begin_layout Plain Layout
18145 ): For use with DocBook classes.
18148 \begin_layout Standard
18149 Flex insets are defined using the
18150 \begin_inset Flex Code
18153 \begin_layout Plain Layout
18159 tag, which shall be explained in a moment.
18162 \begin_layout Standard
18164 \begin_inset Flex Code
18167 \begin_layout Plain Layout
18173 tag also serves another function: It can be used to customize the general
18174 layout of many different types of insets.
18176 \begin_inset Flex Code
18179 \begin_layout Plain Layout
18185 can be used to customize the layout parameters for footnotes, marginal
18186 notes, note insets, \SpecialChar TeX
18187 code (ERT) insets, branches, listings, indexes, boxes,
18188 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18191 \begin_layout Standard
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18202 definition must begin with a line of the form:
18205 \begin_layout LyX-Code
18209 \begin_layout Standard
18211 \begin_inset Flex Code
18214 \begin_layout Plain Layout
18220 indicates the inset whose layout is being defined, and here there are four
18224 \begin_layout Enumerate
18225 The layout for a pre-existing inset is being modified.
18226 In this case, can be
18227 \begin_inset Flex Code
18230 \begin_layout Plain Layout
18236 any one of the following:
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18257 \begin_inset Flex Code
18260 \begin_layout Plain Layout
18267 \begin_inset Flex Code
18270 \begin_layout Plain Layout
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18287 \begin_inset Flex Code
18290 \begin_layout Plain Layout
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18337 \begin_inset Flex Code
18340 \begin_layout Plain Layout
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18367 \begin_inset Flex Code
18370 \begin_layout Plain Layout
18377 \begin_inset Flex Code
18380 \begin_layout Plain Layout
18387 \begin_inset Flex Code
18390 \begin_layout Plain Layout
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18427 \begin_inset Flex Code
18430 \begin_layout Plain Layout
18439 \begin_layout Enumerate
18440 The layout for a Flex inset is being defined.
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18451 must be of the form
18452 \begin_inset Quotes eld
18456 \begin_inset Flex Code
18459 \begin_layout Plain Layout
18466 \begin_inset Quotes erd
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18479 may be be any valid identifier not used by a pre-existing Flex inset.
18480 The identifier may include spaces, but in that case the whole thing must
18481 be wrapped in quotes.
18482 Note that the definition of a flex inset
18487 \begin_inset Flex Code
18490 \begin_layout Plain Layout
18496 entry, declaring which type of inset it defines.
18499 \begin_layout Enumerate
18500 The layout for user specific branch is being defined.
18502 \begin_inset Flex Code
18505 \begin_layout Plain Layout
18511 must be of the form
18512 \begin_inset Quotes eld
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18526 \begin_inset Quotes erd
18530 \begin_inset Flex Code
18533 \begin_layout Plain Layout
18539 may be be any valid identifier of branch defined in user's document.
18540 The identifier may include spaces, but in that case the whole thing must
18541 be wrapped in quotes.
18542 The main purpose of this feature is to allow \SpecialChar LaTeX
18543 wrapping around specific
18544 branches as user needs.
18547 \begin_layout Enumerate
18548 The layout of a user (or class) specific caption is being defined.
18550 \begin_inset Flex Code
18553 \begin_layout Plain Layout
18559 must be of the form
18560 \begin_inset Quotes eld
18564 \begin_inset Flex Code
18567 \begin_layout Plain Layout
18574 \begin_inset Quotes erd
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18587 specifies the name of the caption as it appears in the menu.
18588 Have a look at the standard caption (
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18598 ), the specific captions of the KOMA-Script classes (
18599 \begin_inset Flex Code
18602 \begin_layout Plain Layout
18609 \begin_inset Flex Code
18612 \begin_layout Plain Layout
18621 \begin_inset space ~
18625 \begin_inset Newline linebreak
18631 \begin_inset Flex Code
18634 \begin_layout Plain Layout
18640 ) for applications.
18643 \begin_layout Standard
18645 \begin_inset Flex Code
18648 \begin_layout Plain Layout
18654 definition can contain the following entries:
18657 \begin_layout Description
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18668 \begin_inset Flex Code
18671 \begin_layout Plain Layout
18677 =""] This inset will appear in the table of contents of the given type.
18678 An empty string disables.
18679 See also the OutlinerName and the IsTocCaption commands.
18680 This is only implemented for Flex insets.
18684 \begin_layout Description
18685 \begin_inset Flex Code
18688 \begin_layout Plain Layout
18695 \begin_inset Flex Code
18698 \begin_layout Plain Layout
18704 ] Defines argument number of a command\SpecialChar breakableslash
18705 environment associated with the current
18707 The definition must end with
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18719 \begin_inset CommandInset ref
18721 reference "subsec:Paragraph-Styles"
18728 \begin_layout Description
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18738 Preamble for changing language commands; see
18739 \begin_inset CommandInset ref
18741 reference "subsec:I18n"
18748 \begin_layout Description
18749 \begin_inset Flex Code
18752 \begin_layout Plain Layout
18759 \begin_inset Flex Code
18762 \begin_layout Plain Layout
18768 ] The color for the inset's background.
18770 \begin_inset CommandInset ref
18772 reference "chap:Names-of-colors"
18776 for a list of the available color names.
18779 \begin_layout Description
18780 \begin_inset Flex Code
18783 \begin_layout Plain Layout
18790 \begin_inset Flex Code
18793 \begin_layout Plain Layout
18802 \begin_inset space \thinspace{}
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18815 ] Whether to use the content of the inset as the label, when the inset is
18820 \begin_layout Description
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18840 ] As with paragraph styles, see
18841 \begin_inset CommandInset ref
18843 reference "subsec:Paragraph-Styles"
18848 Note that you need to specify the complete type, e.
18849 \begin_inset space \thinspace{}
18853 \begin_inset space ~
18857 \begin_inset Flex Code
18860 \begin_layout Plain Layout
18861 CopyStyle Flex:<name>
18869 \begin_layout Description
18870 \begin_inset Flex Code
18873 \begin_layout Plain Layout
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18892 \begin_inset space \thinspace{}
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18905 ] Indicates whether the user may employ the Paragraph Settings dialog to
18906 customize the paragraph.
18909 \begin_layout Description
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18920 \begin_inset Flex Code
18923 \begin_layout Plain Layout
18930 \begin_inset Flex Code
18933 \begin_layout Plain Layout
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18949 , describing the rendering style used for the inset's frame and buttons.
18950 Footnotes generally use
18951 \begin_inset Flex Code
18954 \begin_layout Plain Layout
18960 , ERT insets generally
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18970 , and character styles
18971 \begin_inset Flex Code
18974 \begin_layout Plain Layout
18983 \begin_layout Description
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19006 \begin_inset space \thinspace{}
19012 \begin_inset Flex Code
19015 \begin_layout Plain Layout
19024 \begin_inset Flex Code
19027 \begin_layout Plain Layout
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19044 Indicates whether the environment will stand on its own in the output or
19045 will appear inline with the surrounding text.
19046 If set to false, it is supposed that the \SpecialChar LaTeX
19047 environment ignores white space
19048 (including one newline character) after the
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19065 \begin_inset Flex Code
19068 \begin_layout Plain Layout
19082 \change_inserted 731793113 1538674858
19086 \begin_layout Description
19088 \change_inserted 731793113 1538674891
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19094 \change_inserted 731793113 1538674863
19106 ,1] Allow the contents of the inset to be edited externally (using whatever
19107 editor is defined for the document's output format).
19112 \begin_layout Description
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19122 Required at the end of the
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19135 \begin_layout Description
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19145 The font used for both the text body
19151 \begin_inset CommandInset ref
19153 reference "subsec:Font-description"
19158 Note that defining this font automatically defines the
19159 \begin_inset Flex Code
19162 \begin_layout Plain Layout
19168 to the same value, so define this first and define
19169 \begin_inset Flex Code
19172 \begin_layout Plain Layout
19178 later if you want them to be different.
19181 \begin_layout Description
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19186 FixedWidthPreambleEncoding
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19204 \begin_inset space \thinspace{}
19208 \begin_inset Flex Code
19211 \begin_layout Plain Layout
19217 ] Force a fixed width encoding for the translated contents of
19218 \begin_inset Flex Code
19221 \begin_layout Plain Layout
19228 \begin_inset Flex Code
19231 \begin_layout Plain Layout
19237 code generated by this layout.
19238 This is needed for special \SpecialChar LaTeX
19243 that do not work with variable width encodings such as
19248 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19249 backends such as Xe\SpecialChar TeX
19251 Lua\SpecialChar TeX
19255 \begin_layout Description
19256 \begin_inset Flex Code
19259 \begin_layout Plain Layout
19260 ForceLocalFontSwitch
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19278 \begin_inset space \thinspace{}
19282 \begin_inset Flex Code
19285 \begin_layout Plain Layout
19291 ] When using babel, always use a local font switch (
19292 \begin_inset Flex Code
19295 \begin_layout Plain Layout
19303 ), never a global one (such as
19304 \begin_inset Flex Code
19307 \begin_layout Plain Layout
19318 \begin_layout Description
19319 \begin_inset Flex Code
19322 \begin_layout Plain Layout
19329 \begin_inset Flex Code
19332 \begin_layout Plain Layout
19341 \begin_inset space \thinspace{}
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19355 \begin_inset Quotes eld
19359 \begin_inset Quotes erd
19362 language, leading to Left-to-Right (Latin) output, e.
19363 \begin_inset space \thinspace{}
19367 \begin_inset space \space{}
19370 in \SpecialChar TeX
19375 \begin_layout Description
19376 \begin_inset Flex Code
19379 \begin_layout Plain Layout
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19398 \begin_inset space \thinspace{}
19402 \begin_inset Flex Code
19405 \begin_layout Plain Layout
19411 ] Force a a line break in the \SpecialChar LaTeX
19412 output before the inset starts and after
19414 This assures the inset itself is output on its own lines, for parsing purposes.
19417 \begin_layout Description
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19440 \begin_inset space \thinspace{}
19444 \begin_inset Flex Code
19447 \begin_layout Plain Layout
19453 ] Indicates whether the
19454 \begin_inset Flex Code
19457 \begin_layout Plain Layout
19463 should be used or, instead, the user can change the paragraph style used
19468 \begin_layout Description
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19491 \begin_inset space \thinspace{}
19495 \begin_inset Flex Code
19498 \begin_layout Plain Layout
19504 ] As with paragraph styles, see
19505 \begin_inset CommandInset ref
19507 reference "subsec:Paragraph-Styles"
19514 \begin_layout Description
19515 \begin_inset Flex Code
19518 \begin_layout Plain Layout
19524 These tags control the XHTML output.
19526 \begin_inset CommandInset ref
19528 reference "sec:Tags-for-XHTML"
19535 \begin_layout Description
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19558 \begin_inset space \thinspace{}
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19571 ] Whether to include the contents of this inset in the strings generated
19572 for the `Outline' pane for all table of contents, regardless of the AddToToc
19574 One would not, for example, want the content of a footnote in a section
19575 header to be included in the TOC displayed in the outline, but one would
19576 normally want the content of a character style displayed.
19577 Default is false: not to include.
19580 \begin_layout Description
19581 \begin_inset Flex Code
19584 \begin_layout Plain Layout
19591 \begin_inset Flex Code
19594 \begin_layout Plain Layout
19603 \begin_inset space \thinspace{}
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19616 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19617 of its contents in its item in the table of contents.
19618 Otherwise, only the label appears.
19621 \begin_layout Description
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19646 \begin_inset space \thinspace{}
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19659 ] As with paragraph styles, see
19660 \begin_inset CommandInset ref
19662 reference "subsec:Paragraph-Styles"
19669 \begin_layout Description
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19679 The font used for the label.
19681 \begin_inset CommandInset ref
19683 reference "subsec:Font-description"
19688 Note that this definition can never appear before
19689 \begin_inset Flex Code
19692 \begin_layout Plain Layout
19698 , lest it be ineffective.
19701 \begin_layout Description
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19712 \begin_inset Flex Code
19715 \begin_layout Plain Layout
19722 \begin_inset Quotes erd
19726 \begin_inset Quotes erd
19729 ] What will be displayed on the button or elsewhere as the inset label.
19731 \begin_inset Flex Code
19734 \begin_layout Plain Layout
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19751 ) modify this label on the fly.
19754 \begin_layout Description
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19764 Language dependent preamble; see
19765 \begin_inset CommandInset ref
19767 reference "subsec:I18n"
19774 \begin_layout Description
19775 \begin_inset Flex Code
19778 \begin_layout Plain Layout
19785 \begin_inset Flex Code
19788 \begin_layout Plain Layout
19794 ] The name of the corresponding \SpecialChar LaTeX
19796 Either the environment or command name.
19799 \begin_layout Description
19800 \begin_inset Flex Code
19803 \begin_layout Plain Layout
19810 \begin_inset Flex Code
19813 \begin_layout Plain Layout
19819 ] The optional parameter for the corresponding
19820 \begin_inset Flex Code
19823 \begin_layout Plain Layout
19829 stuff, including possible bracket pairs like
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19840 This parameter cannot be changed from within \SpecialChar LyX
19842 \begin_inset Flex Code
19845 \begin_layout Plain Layout
19851 for customizable parameters).
19852 It will be output as is after all \SpecialChar LaTeX
19854 \begin_inset Flex Code
19857 \begin_layout Plain Layout
19866 \begin_layout Description
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19881 Command, Environment, None
19886 ] How the style should be translated into \SpecialChar LaTeX
19891 \begin_layout Plain Layout
19892 \begin_inset Flex Code
19895 \begin_layout Plain Layout
19901 is perhaps a bit misleading, since these rules apply to SGML classes too.
19902 Visit the SGML class files for specific examples.
19911 \begin_layout Description
19912 \begin_inset Flex Code
19915 \begin_layout Plain Layout
19921 means nothing special
19924 \begin_layout Description
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19935 \begin_inset Flex Code
19938 \begin_layout Plain Layout
19945 {\SpecialChar ldots
19954 \begin_layout Description
19955 \begin_inset Flex Code
19958 \begin_layout Plain Layout
19965 \begin_inset Flex Code
19968 \begin_layout Plain Layout
19975 }\SpecialChar ldots
19990 \begin_layout Standard
19991 Putting the last few things together, the \SpecialChar LaTeX
19992 output will be either:
19995 \begin_layout LyX-Code
19998 LatexName[LatexParam]{\SpecialChar ldots
20002 \begin_layout Standard
20006 \begin_layout LyX-Code
20009 begin{LatexName}[LatexParam] \SpecialChar ldots
20015 \begin_layout Standard
20016 depending upon the \SpecialChar LaTeX
20021 \begin_layout Description
20022 \begin_inset Flex Code
20025 \begin_layout Plain Layout
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 ] A string that is put at the beginning of the layout content.
20042 A line break in the output can be indicated by
20043 \begin_inset Flex Code
20046 \begin_layout Plain Layout
20055 \begin_layout Description
20056 \begin_inset Flex Code
20059 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20105 (indicating a dummy definition ending definitions of charstyles, etc).
20106 This entry is required in and is only meaningful for Flex insets.
20107 Among other things, it determines on which menu this inset will appear.
20109 \begin_inset Flex Code
20112 \begin_layout Plain Layout
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20128 will automatically set
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20139 \begin_inset Flex Code
20142 \begin_layout Plain Layout
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20159 can be set to true, or
20160 \begin_inset Flex Code
20163 \begin_layout Plain Layout
20170 \begin_inset Flex Code
20173 \begin_layout Plain Layout
20179 insets by setting it
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20196 \begin_layout Description
20197 \begin_inset Flex Code
20200 \begin_layout Plain Layout
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20219 \begin_inset space \thinspace{}
20223 \begin_inset Flex Code
20226 \begin_layout Plain Layout
20232 ] Whether multiple paragraphs are permitted in this inset.
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20243 to the same value and
20244 \begin_inset Flex Code
20247 \begin_layout Plain Layout
20253 to the opposite value.
20254 These can be reset to other values, if they are used
20259 \begin_inset Flex Code
20262 \begin_layout Plain Layout
20272 \begin_layout Description
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20283 \begin_inset Flex Code
20286 \begin_layout Plain Layout
20295 \begin_inset space \thinspace{}
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20308 ] Whether fragile commands in this inset should be
20309 \begin_inset Flex Code
20312 \begin_layout Plain Layout
20325 whether the command should itself be protected.) Default is false.
20326 \change_inserted -712698321 1523633958
20330 \begin_layout Description
20332 \change_inserted -712698321 1552395786
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20338 \change_inserted -712698321 1523633961
20345 \begin_inset Flex Code
20348 \begin_layout Plain Layout
20350 \change_inserted -712698321 1523633958
20359 \begin_inset space \thinspace{}
20363 \begin_inset Flex Code
20366 \begin_layout Plain Layout
20368 \change_inserted -712698321 1523633958
20374 ] This causes macros that contain this inset to be protected with
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20380 \change_inserted -712698321 1523634038
20395 ) if necessary and thus allows (some) verbatim stuff in macros.
20399 \begin_layout Description
20401 \change_inserted -712698321 1552395824
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20407 \change_inserted -712698321 1552395787
20414 \begin_inset Flex Code
20417 \begin_layout Plain Layout
20419 \change_inserted -712698321 1552395787
20428 \begin_inset space \thinspace{}
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20437 \change_inserted -712698321 1552395787
20443 ] Whether specific commands in this inset (such as
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20449 \change_inserted -712698321 1552395787
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20463 \change_inserted -712698321 1552395787
20471 ) should be protected in an
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20477 \change_inserted -712698321 1552395787
20486 This is particularly needed for insets that draw on
20494 commands which parse their content in complex ways.
20500 \begin_layout Description
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20520 ] Deletes an existing
20521 \begin_inset Flex Code
20524 \begin_layout Plain Layout
20533 \begin_layout Description
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20563 that has replaced this
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20574 This is used to rename an
20575 \begin_inset Flex Code
20578 \begin_layout Plain Layout
20584 , while keeping backward compatibility.
20587 \begin_layout Description
20588 \begin_inset Flex Code
20591 \begin_layout Plain Layout
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20610 \begin_inset space \thinspace{}
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20623 ] As with paragraph styles, see
20624 \begin_inset CommandInset ref
20626 reference "subsec:Paragraph-Styles"
20634 \begin_layout Description
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20645 \begin_inset Flex Code
20648 \begin_layout Plain Layout
20657 \begin_inset space \thinspace{}
20661 \begin_inset Flex Code
20664 \begin_layout Plain Layout
20670 ] As with paragraph styles, see
20671 \begin_inset CommandInset ref
20673 reference "subsec:Paragraph-Styles"
20681 \begin_layout Description
20682 \begin_inset Flex Code
20685 \begin_layout Plain Layout
20691 As with paragraph styles, see
20692 \begin_inset CommandInset ref
20694 reference "subsec:Paragraph-Styles"
20701 \begin_layout Description
20702 \begin_inset Flex Code
20705 \begin_layout Plain Layout
20712 \begin_inset Flex Code
20715 \begin_layout Plain Layout
20721 ] The prefix to use when creating labels referring to insets of this type.
20722 This allows the use of formatted references.
20725 \begin_layout Description
20726 \begin_inset Flex Code
20729 \begin_layout Plain Layout
20736 \begin_inset Flex Code
20739 \begin_layout Plain Layout
20745 ] As with paragraph styles, see
20746 \begin_inset CommandInset ref
20748 reference "subsec:Paragraph-Styles"
20755 \begin_layout Description
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20766 \begin_inset Flex Code
20769 \begin_layout Plain Layout
20778 \begin_inset space \thinspace{}
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20791 ] Resets the \SpecialChar LaTeX
20792 arguments of this layout (as defined via the
20793 \begin_inset Flex Code
20796 \begin_layout Plain Layout
20803 This is useful if you have copied a style via
20804 \begin_inset Flex Code
20807 \begin_layout Plain Layout
20813 , but you do not want to inherit its (required and optional) arguments.
20816 \begin_layout Description
20817 \begin_inset Flex Code
20820 \begin_layout Plain Layout
20827 \begin_inset Flex Code
20830 \begin_layout Plain Layout
20837 \begin_inset space \thinspace{}
20841 \begin_inset Flex Code
20844 \begin_layout Plain Layout
20852 ] Whether this inset should use the font of its surrounding environment
20854 Default is false: use the font of the surrounding environment.
20857 \begin_layout Description
20858 \begin_inset Flex Code
20861 \begin_layout Plain Layout
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20877 ] A string that is put at the end of the layout content.
20878 A line break in the output can be indicated by
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20891 \begin_layout Description
20892 \begin_inset Flex Code
20895 \begin_layout Plain Layout
20902 \begin_inset Flex Code
20905 \begin_layout Plain Layout
20912 \begin_inset space \thinspace{}
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20927 ] Allow spell-checking the contents of this inset.
20931 \begin_layout Subsection
20933 \begin_inset CommandInset label
20935 name "subsec:Counters"
20942 \begin_layout Standard
20943 It is necessary to define the counters (
20944 \begin_inset Flex Noun
20947 \begin_layout Plain Layout
20954 \begin_inset Flex Noun
20957 \begin_layout Plain Layout
20963 , \SpecialChar ldots
20964 ) in the text class itself.
20965 The standard counters are defined in the file
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20975 , so you may have to do no more than add
20978 \begin_layout LyX-Code
20979 Input stdcounters.inc
20982 \begin_layout Standard
20983 to your layout file to get them to work.
20984 But if you want to define custom counters, then you can do so.
20985 The counter declaration must begin with:
20988 \begin_layout LyX-Code
20989 Counter CounterName
20992 \begin_layout Standard
20994 \begin_inset Flex Code
20997 \begin_layout Plain Layout
21003 ' is replaced by the name of the counter.
21004 And it must end with
21005 \begin_inset Quotes eld
21009 \begin_inset Flex Code
21012 \begin_layout Plain Layout
21019 \begin_inset Quotes erd
21023 The following parameters can also be used:
21026 \begin_layout Description
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21046 ] Sets the initial value for the counter, to which it will be reset whenever
21048 Normally, one will want the default, 1.
21051 \begin_layout Description
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21062 \begin_inset Flex Code
21065 \begin_layout Plain Layout
21072 \begin_inset Quotes erd
21076 \begin_inset Quotes erd
21079 ] When defined, this string defines how the counter is displayed.
21080 Setting this value sets
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21085 LabelStringAppendix
21091 The following special constructs can be used in the string:
21095 \begin_layout Itemize
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21107 will be replaced by the expansion of the
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21122 LabelStringAppendix
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21141 \begin_layout Itemize
21142 counter values can be expressed using \SpecialChar LaTeX
21144 \begin_inset Newline newline
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21168 \begin_inset Flex Code
21171 \begin_layout Plain Layout
21183 \begin_layout Plain Layout
21193 Actually, the situation is a bit more complicated: any
21212 other than those described below will produce arabic numerals.
21213 It would not be surprising to see this change in the future.
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21228 : 1, 2, 3,\SpecialChar ldots
21230 \begin_inset Flex Code
21233 \begin_layout Plain Layout
21239 for lower-case letters: a, b, c, \SpecialChar ldots
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21250 for upper-case letters: A, B, C, \SpecialChar ldots
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21261 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21272 for upper-case roman numerals: I, II, III\SpecialChar ldots
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21283 for hebrew numerals.
21287 \begin_layout Standard
21288 If LabelString is not defined, a default value is constructed as follows:
21289 if the counter has a master counter
21290 \begin_inset Flex Code
21293 \begin_layout Plain Layout
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21310 \begin_inset Newline newline
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21327 is used; otherwise the string
21328 \begin_inset Flex Code
21331 \begin_layout Plain Layout
21342 \begin_layout Description
21343 \begin_inset Flex Code
21346 \begin_layout Plain Layout
21347 LabelStringAppendix
21353 \begin_inset Flex Code
21356 \begin_layout Plain Layout
21363 \begin_inset Quotes erd
21367 \begin_inset Quotes erd
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21380 , but for use in the Appendix.
21383 \begin_layout Description
21384 \begin_inset Flex Code
21387 \begin_layout Plain Layout
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21404 \begin_inset Quotes erd
21408 \begin_inset Quotes erd
21411 ] A format for use with formatted references to this counter.
21412 For example, one might want to have references to section numbers appear
21414 \begin_inset Quotes eld
21418 \begin_inset Quotes erd
21422 The string should contain
21423 \begin_inset Quotes eld
21427 \begin_inset Quotes erd
21431 This will be replaced by the counter number itself.
21432 So, for sections, it would be: Section ##.
21435 \begin_layout Description
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21446 \begin_inset Flex Code
21449 \begin_layout Plain Layout
21456 \begin_inset Quotes erd
21460 \begin_inset Quotes erd
21463 ] If this is set to the name of another counter, the present counter will
21464 be reset every time the other one is increased.
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21488 \begin_layout Subsection
21490 \begin_inset CommandInset label
21492 name "subsec:Font-description"
21499 \begin_layout Standard
21500 A font description looks like this:
21503 \begin_layout LyX-Code
21520 \begin_layout LyX-Code
21524 \begin_layout LyX-Code
21528 \begin_layout Standard
21529 The following commands are available:
21532 \begin_layout Description
21533 \begin_inset Flex Code
21536 \begin_layout Plain Layout
21543 \begin_inset Flex Code
21546 \begin_layout Plain Layout
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21565 \begin_inset Flex Code
21568 \begin_layout Plain Layout
21575 \begin_inset Flex Code
21578 \begin_layout Plain Layout
21585 \begin_inset Flex Code
21588 \begin_layout Plain Layout
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21605 \begin_inset Flex Code
21608 \begin_layout Plain Layout
21615 \begin_inset Flex Code
21618 \begin_layout Plain Layout
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21635 \begin_inset Flex Code
21638 \begin_layout Plain Layout
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21665 \begin_inset Flex Code
21668 \begin_layout Plain Layout
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21715 \begin_inset Flex Code
21718 \begin_layout Plain Layout
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21747 \begin_layout Description
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21758 \begin_inset Flex Code
21761 \begin_layout Plain Layout
21770 \begin_inset Flex Code
21773 \begin_layout Plain Layout
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21792 \begin_layout Description
21793 \begin_inset Flex Code
21796 \begin_layout Plain Layout
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21812 ] Valid arguments are:
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21833 \begin_inset Flex Code
21836 \begin_layout Plain Layout
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21893 \begin_inset Flex Code
21896 \begin_layout Plain Layout
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21933 Each of these turns on or off the corresponding attribute.
21935 \begin_inset Flex Code
21938 \begin_layout Plain Layout
21944 turns on emphasis, and
21945 \begin_inset Flex Code
21948 \begin_layout Plain Layout
21956 \begin_inset Newline newline
21959 If the latter seems puzzling, remember that the font settings for the present
21960 context are generally inherited from the surrounding context.
21962 \begin_inset Flex Code
21965 \begin_layout Plain Layout
21971 would turn off the emphasis that was anyway in effect, say, in a theorem
21975 \begin_layout Description
21976 \begin_inset Flex Code
21979 \begin_layout Plain Layout
21986 \begin_inset Flex Code
21989 \begin_layout Plain Layout
21998 \begin_inset Flex Code
22001 \begin_layout Plain Layout
22010 \begin_layout Description
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22033 \begin_inset Flex Code
22036 \begin_layout Plain Layout
22043 \begin_inset Flex Code
22046 \begin_layout Plain Layout
22053 \begin_inset Flex Code
22056 \begin_layout Plain Layout
22065 \begin_layout Description
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22160 \begin_layout Subsection
22161 \begin_inset CommandInset label
22163 name "subsec:Citation-engine-description"
22167 Cite engine description
22170 \begin_layout Standard
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22181 blocks, as used mainly in cite engine files (see
22182 \begin_inset CommandInset ref
22184 reference "subsec:Cite-Engine-Files"
22191 ), define the citation commands provided by a specific
22192 \begin_inset Quotes eld
22196 \begin_inset Quotes erd
22200 A cite engine, in \SpecialChar LyX
22201 terms, is way specific way to format citations, using
22202 numbers, author names and/or years.
22203 Currently, \SpecialChar LyX
22204 supports three such engine types, namely:
22207 \begin_layout Enumerate
22208 \begin_inset Flex Code
22211 \begin_layout Plain Layout
22217 : the default Bib\SpecialChar TeX
22218 way to format citations, a simple numeric style (e.
22219 \begin_inset space \thinspace{}
22223 \begin_inset Quotes eld
22227 \begin_inset Quotes erd
22233 \begin_layout Enumerate
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22243 : Harvard-styled citations using author names and publication year (e.
22244 \begin_inset space \thinspace{}
22248 \begin_inset Quotes eld
22251 Smith and Miller (2017b)
22252 \begin_inset Quotes erd
22258 \begin_layout Enumerate
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22268 : extended numerical citations that also allow for author or title next
22270 \begin_inset space \thinspace{}
22274 \begin_inset Quotes eld
22277 Smith and Miller [1]
22278 \begin_inset Quotes erd
22284 \begin_layout Standard
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22294 blocks look like this:
22297 \begin_layout LyX-Code
22301 \begin_layout LyX-Code
22305 \begin_layout LyX-Code
22309 \begin_layout LyX-Code
22310 citeyearpar[][]=parencite*
22313 \begin_layout LyX-Code
22317 \begin_layout LyX-Code
22321 \begin_layout Standard
22323 \begin_inset Flex Code
22326 \begin_layout Plain Layout
22332 denotes the engine.
22333 The individual lines respectively define a cite command or cite command
22334 paradigm supported by this engine.
22335 The line can be as simple as a cite command that is used both to name the
22336 respective \SpecialChar LyX
22337 command and the \SpecialChar LaTeX
22338 output or more complex in order to differentiate
22340 The full syntax is:
22343 \begin_layout LyX-Code
22344 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22347 \begin_layout Itemize
22348 \begin_inset Flex Code
22351 \begin_layout Plain Layout
22357 : The name as used in the
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22371 \begin_layout Standard
22372 For portability reasons, we try to use the same name for same-formatted
22373 commands in different cite packages (thus many names stem from natbib,
22374 and thus we need to differentiate a
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22384 sometimes, if the \SpecialChar LaTeX
22385 command names differ).
22389 \begin_layout Itemize
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22399 : a (comma-separated) list of commands that fall back to the given
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22409 in the current engine.
22410 This eases the switch of citation packages and engines.
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22431 in layout definitions.
22434 \begin_layout Itemize
22435 \begin_inset Flex Code
22438 \begin_layout Plain Layout
22444 : The actual \SpecialChar LaTeX
22445 command that is output.
22449 \begin_layout Standard
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22490 will be output to \SpecialChar LaTeX
22494 \begin_layout Standard
22498 \begin_layout Itemize
22499 Capitalization indicates that the command also has a capitalized form (
22500 \begin_inset Flex Code
22503 \begin_layout Plain Layout
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22525 These usually enforce up-casing of name prefixes (
22530 \begin_inset Formula $\Rightarrow$
22540 \begin_layout Itemize
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22551 indicate the number of optional arguments (there can be 0–2).
22554 \begin_layout Itemize
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22565 indicates there is a starred version of the command (
22566 \begin_inset Flex Code
22569 \begin_layout Plain Layout
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22595 \begin_layout Standard
22596 By default, the starred version means: Output all authors even if it should
22598 \begin_inset Quotes eld
22602 \begin_inset Quotes erd
22606 \begin_inset Flex Code
22609 \begin_layout Plain Layout
22618 \begin_layout Standard
22619 If the star has a different meaning for a given command, it can be specified
22621 \begin_inset Flex Code
22624 \begin_layout Plain Layout
22625 <!_stardesc!_stardesctooltip>
22631 Maximal two translatable macro keywords, marked by the prefix
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22642 The first points to the string that replaces the
22643 \begin_inset Quotes eld
22647 \begin_inset Quotes erd
22650 checkbox label in the citation dialog, the second one to an optional tool
22651 tip for this checkbox.
22655 \begin_layout Standard
22656 Note that these two macros have to be defined in a
22657 \begin_inset Flex Code
22660 \begin_layout Plain Layout
22666 (see next section), dropping the
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22676 from the prefix, like this:
22679 \begin_layout LyX-Code
22680 _stardesc Sta&rred command label
22683 \begin_layout LyX-Code
22684 _stardesctooltip Tooltip for the starred command checkbox.
22688 \begin_layout Itemize
22690 \begin_inset Flex Code
22693 \begin_layout Plain Layout
22699 indicates that this command features
22700 \begin_inset Quotes eld
22703 qualified citation lists
22704 \begin_inset Quotes erd
22712 -specific feature for multi-reference citations where an individual pre-
22713 and postnote can be given to each reference in the list.
22714 Please refer to the
22718 manual for details.
22719 \change_inserted -712698321 1526898670
22723 \begin_layout Standard
22725 \change_inserted -712698321 1526899524
22726 If you want to add a cite command to a cite engine (e.
22727 \begin_inset space \thinspace{}
22730 g., add a specific command provided by a class), you can use
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22736 \change_inserted -712698321 1526898768
22737 AddToCiteEngine <engine type> \SpecialChar ldots
22746 Note that only cite commands that do not exist yet are added.
22751 \begin_layout Subsection
22752 \begin_inset CommandInset label
22754 name "subsec:Citation-format-description"
22758 Cite format description
22761 \begin_layout Standard
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22772 blocks are used to describe how bibliographic information should be displayed,
22773 both within \SpecialChar LyX
22774 itself (in the citation dialog and in tooltips, for example)
22775 and in XHTML output.
22776 Such a block might look like this:
22779 \begin_layout LyX-Code
22783 \begin_layout LyX-Code
22787 \begin_layout LyX-Code
22791 \begin_layout LyX-Code
22795 \begin_layout Standard
22799 \begin_layout LyX-Code
22803 \begin_layout LyX-Code
22807 \begin_layout LyX-Code
22811 \begin_layout LyX-Code
22815 \begin_layout Standard
22816 In the first case, the individual lines define how the bibliographic information
22817 associated with an article or book, respectively, is to be displayed, and
22818 such a definition can be given for any
22819 \begin_inset Quotes els
22823 \begin_inset Quotes ers
22826 that might be present in a Bib\SpecialChar TeX
22829 defines a default format in the source code that will be used if no specific
22830 definition has been given.
22832 predefines several formats in the file
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22842 , which is included in most of \SpecialChar LyX
22843 's document classes.
22846 \begin_layout Standard
22847 In the second case, the lines define how a specific citation command (in
22849 \begin_inset Flex Code
22852 \begin_layout Plain Layout
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22872 ) is to be displayed on the citation inset label, in the citation dialog,
22873 menu or XHTML output.
22875 defines such formats for the citation style variants it supports via
22877 Document\SpecialChar menuseparator
22878 Setting\SpecialChar menuseparator
22879 Bibliography\SpecialChar ldots
22883 \begin_inset Flex Code
22886 \begin_layout Plain Layout
22892 files that are shipped with \SpecialChar LyX
22894 \begin_inset CommandInset ref
22896 reference "subsec:Cite-Engine-Files"
22906 \begin_layout Standard
22907 The definitions use a simple language that allows Bib\SpecialChar TeX
22908 keys to be replaced
22910 Keys should be enclosed in
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22921 \begin_inset Flex Code
22924 \begin_layout Plain Layout
22931 So a simple definition might look like this:
22934 \begin_layout LyX-Code
22936 \begin_inset Quotes eld
22940 \begin_inset Quotes erd
22946 \begin_layout Standard
22947 This would print the author, followed by a comma, followed by the title,
22948 in quotes, followed by a period.
22951 \begin_layout Standard
22952 Of course, sometimes you may want to print a key only if it exists.
22953 This can be done by using a conditional construction, such as:
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22959 \begin_inset space ~
22969 \begin_inset Flex Code
22972 \begin_layout Plain Layout
22978 key exists, then print
22979 \begin_inset Quotes eld
22983 \begin_inset space ~
22987 \begin_inset Quotes erd
22990 followed by the volume key.
22991 It is also possible to have an else clause in the conditional, such as:
22992 \begin_inset Newline newline
22996 \begin_inset Flex Code
22999 \begin_layout Plain Layout
23000 {%author%[[%author%]][[%editor%, ed.]]}
23006 \begin_inset Newline newline
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23019 key is printed if it exists; otherwise, the editor key is printed, followed
23021 \begin_inset Quotes eld
23025 \begin_inset space ~
23029 \begin_inset Quotes erd
23032 Note that the key is again enclosed in
23033 \begin_inset Flex Code
23036 \begin_layout Plain Layout
23042 signs; the entire conditional is enclosed in braces; and the if and else
23043 clauses are enclosed in double brackets,
23044 \begin_inset Quotes eld
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 \begin_inset Quotes eld
23062 \begin_inset Quotes eld
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23076 \begin_inset Quotes erd
23080 There must be no space between any of these.
23083 \begin_layout Standard
23084 Next to the entry keys, there are some special keys that can be used for
23085 these conditionals:
23088 \begin_layout Itemize
23089 \begin_inset Flex Code
23092 \begin_layout Plain Layout
23093 {%dialog%[[true]][[false]]}
23099 \begin_inset Quotes eld
23103 \begin_inset Quotes erd
23106 part for dialogs and menus, the
23107 \begin_inset Quotes eld
23111 \begin_inset Quotes erd
23114 part for other contexts (workarea, export)
23117 \begin_layout Itemize
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23122 {%export%[[true]][[false]]}
23128 \begin_inset Quotes eld
23132 \begin_inset Quotes erd
23135 part for export and menus, the
23136 \begin_inset Quotes eld
23140 \begin_inset Quotes erd
23143 part for other contexts (workarea, dialog)
23146 \begin_layout Itemize
23147 \begin_inset Flex Code
23150 \begin_layout Plain Layout
23157 \begin_inset Quotes eld
23161 \begin_inset Quotes erd
23164 part if another item follows (e.
23165 \begin_inset space \thinspace{}
23168 g., in a citation with multiple keys)
23171 \begin_layout Itemize
23172 \begin_inset Flex Code
23175 \begin_layout Plain Layout
23176 {%second%[[true]][[false]]}
23182 \begin_inset Quotes eld
23186 \begin_inset Quotes erd
23189 if this is the second of multiple items, else the
23190 \begin_inset Quotes eld
23194 \begin_inset Quotes erd
23200 \begin_layout Itemize
23201 \begin_inset Flex Code
23204 \begin_layout Plain Layout
23205 {%ifstar%[[true]][[false]]}
23211 \begin_inset Quotes eld
23215 \begin_inset Quotes erd
23218 part for starred citation commands (such as
23219 \begin_inset Flex Code
23222 \begin_layout Plain Layout
23230 ), the false part for unstarred
23233 \begin_layout Itemize
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23238 {%ifentrytype:<type>%[[true]][[false]]}
23244 \begin_inset Quotes eld
23248 \begin_inset Quotes erd
23251 if the current entry type matches
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23261 , else the false part (e.g., in a citation definition:
23262 \begin_inset Flex Code
23265 \begin_layout Plain Layout
23266 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23274 \begin_layout Itemize
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23279 {%ifmultiple:<authortype>%[[true]][[false]]}
23285 \begin_inset Quotes eld
23289 \begin_inset Quotes erd
23292 if the current author type (author, editor etc.) has multiple authors, else
23293 the false part (e.g., in a bibliography definition:
23294 \begin_inset Flex Code
23297 \begin_layout Plain Layout
23298 {%ifmultiple:editor%[[eds.]][[ed.]]}
23306 \begin_layout Itemize
23307 \begin_inset Flex Code
23310 \begin_layout Plain Layout
23311 {%ifqualified%[[true]][[false]]}
23317 \begin_inset Quotes eld
23321 \begin_inset Quotes erd
23324 part if the current citation is a qualified citation list (a specific
23328 format for multi-reference citations), the false part if this is not the
23332 \begin_layout Standard
23334 \begin_inset Flex Code
23337 \begin_layout Plain Layout
23343 prints the author key as it is recorded in the bibliography file.
23344 This might not be what you want, since it will result in a string such
23346 \begin_inset Quotes eld
23349 Miller, Peter and Smith, Mary and White, Jane
23350 \begin_inset Quotes erd
23354 \begin_inset Quotes eld
23358 \begin_inset Quotes erd
23361 is used by Bib\SpecialChar TeX
23362 to delimit authors).
23364 therefore provides some methods to get properly formatted name lists (which
23365 will also get translated).
23366 The following keys are provided:
23369 \begin_layout Enumerate
23370 For name lists with pre- and surname, suitable for the main authors/editors
23371 of a bibliography item.
23373 \begin_inset Flex Code
23376 \begin_layout Plain Layout
23382 part denotes the kind of list that is requested (e.g.
23384 \begin_inset Flex Code
23387 \begin_layout Plain Layout
23397 \begin_layout Itemize
23398 \begin_inset Flex Code
23401 \begin_layout Plain Layout
23402 %abbrvnames:<nametype>%
23407 : Provides a name list which is abbreviated (with
23408 \begin_inset Quotes eld
23412 \begin_inset Quotes erd
23416 \begin_inset Flex Code
23419 \begin_layout Plain Layout
23428 \begin_layout Itemize
23429 \begin_inset Flex Code
23432 \begin_layout Plain Layout
23433 %fullnames:<nametype>%
23438 : Provides a full name list (never abbreviated with
23439 \begin_inset Quotes eld
23443 \begin_inset Quotes erd
23449 \begin_layout Itemize
23450 \begin_inset Flex Code
23453 \begin_layout Plain Layout
23454 %forceabbrvnames:<nametype>%
23459 : Provides a name list which is always abbreviated (with
23460 \begin_inset Quotes eld
23464 \begin_inset Quotes erd
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23481 \begin_layout Enumerate
23482 Alternative name lists with pre- and surname, if the order of pre- and surname
23483 inside the bibliography item differs (as in:
23484 \begin_inset Quotes eld
23487 Miller, John: Some text, in: Mary Smith, ed.: A volume
23488 \begin_inset Quotes erd
23495 \begin_layout Itemize
23496 \begin_inset Flex Code
23499 \begin_layout Plain Layout
23500 %abbrvbynames:<nametype>%
23505 : Provides a name list which is abbreviated (with
23506 \begin_inset Quotes eld
23510 \begin_inset Quotes erd
23514 \begin_inset Flex Code
23517 \begin_layout Plain Layout
23526 \begin_layout Itemize
23527 \begin_inset Flex Code
23530 \begin_layout Plain Layout
23531 %fullbynames:<nametype>%
23536 : Provides a full name list (never abbreviated with
23537 \begin_inset Quotes eld
23541 \begin_inset Quotes erd
23547 \begin_layout Itemize
23548 \begin_inset Flex Code
23551 \begin_layout Plain Layout
23552 %forceabbrvbynames:<nametype>%
23557 : Provides a name list which is always abbreviated (with
23558 \begin_inset Quotes eld
23562 \begin_inset Quotes erd
23566 \begin_inset Flex Code
23569 \begin_layout Plain Layout
23579 \begin_layout Enumerate
23580 And finally name lists which consist of family names only, as used in author-yea
23582 These do not take a
23583 \begin_inset Flex Code
23586 \begin_layout Plain Layout
23592 part, but always return either an author list or, if this does not exist,
23593 an editor list (as common in author-year labels):
23597 \begin_layout Itemize
23598 \begin_inset Flex Code
23601 \begin_layout Plain Layout
23607 : Provides a name list which is abbreviated (with
23608 \begin_inset Quotes eld
23612 \begin_inset Quotes erd
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23628 \begin_layout Itemize
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23638 : Provides a full name list (never abbreviated with
23639 \begin_inset Quotes eld
23643 \begin_inset Quotes erd
23649 \begin_layout Itemize
23650 \begin_inset Flex Code
23653 \begin_layout Plain Layout
23654 %forceabbrvciteauthor%
23659 : Provides a name list which is always abbreviated (with
23660 \begin_inset Quotes eld
23664 \begin_inset Quotes erd
23668 \begin_inset Flex Code
23671 \begin_layout Plain Layout
23681 \begin_layout Standard
23682 The order of pre- and surname in the former two lists can be adjusted by
23686 \begin_layout Itemize
23687 \begin_inset Flex Code
23690 \begin_layout Plain Layout
23691 !firstnameform %surname%, %prename%
23696 (first author in lists of type 1)
23699 \begin_layout Itemize
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23704 !othernameform %surname%, %prename%
23709 (other authors in lists of type 1)
23712 \begin_layout Itemize
23713 \begin_inset Flex Code
23716 \begin_layout Plain Layout
23717 !firstbynameform %prename% %surname%
23722 (first author in lists of type 2)
23725 \begin_layout Itemize
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23730 !otherbynameform %prename% %surname%
23735 (other authors in lists of type 2)
23738 \begin_layout Standard
23739 This allows you to configure namings like
23740 \begin_inset Quotes eld
23743 Miller, Peter and Mary Smith: \SpecialChar ldots
23744 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23746 \begin_inset Quotes erd
23752 \begin_layout Standard
23753 There is one other piece of syntax available in definitions, which looks
23755 \begin_inset Flex Code
23758 \begin_layout Plain Layout
23765 This defines a piece of formatting information that is to be used when
23767 \begin_inset Quotes eld
23771 \begin_inset Quotes erd
23775 Obviously, we do not want to output HTML tags when writing plain text,
23776 so they should be wrapped in
23777 \begin_inset Quotes eld
23781 \begin_inset Quotes erd
23785 \begin_inset Quotes eld
23789 \begin_inset Quotes erd
23795 \begin_layout Standard
23796 Two special sorts of definitions are also possible in a
23797 \begin_inset Flex Code
23800 \begin_layout Plain Layout
23807 An example of the first would be:
23810 \begin_layout LyX-Code
23812 \begin_inset Quotes eld
23816 \begin_inset Quotes erd
23822 \begin_layout Standard
23823 This is an abbreviation, or macro, and it can be used by treating it as
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23846 exactly as it would treat its definition.
23847 So, let us issue the obvious
23855 \begin_layout LyX-Code
23859 \begin_layout Standard
23860 or anything like it.
23862 shouldn't go into an infinite loop, but it may go into a long one before
23866 \begin_layout Standard
23867 The second sort of special definition might look like this:
23870 \begin_layout LyX-Code
23874 \begin_layout Standard
23875 This defines a translatable piece of text, which allows relevant parts of
23876 the bibliography or citation to be translated.
23877 It can be included in a definition by treating it as a key:
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23888 Note that there are two different translation paths: All definitions starting
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23899 , such as in the example above, will be translated to the currently active
23900 buffer language (so the translation will match the generated document).
23901 All definitions starting with underscore only will be translated to the
23903 This is the proper translation for strings that only occur in the dialogs
23904 or on buttons, such as this one:
23907 \begin_layout LyX-Code
23908 _addtobib Add to bibliography only.
23911 \begin_layout Standard
23912 Several of these translatable strings are predefined in
23913 \begin_inset Flex Code
23916 \begin_layout Plain Layout
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23933 Note that these are not macros, in the sense just defined.
23934 They will not be expanded.
23937 \begin_layout Standard
23938 So here then is an example that uses several of these features:
23939 \begin_inset VSpace defskip
23945 \begin_layout Standard
23949 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23952 \begin_layout Standard
23953 \begin_inset VSpace defskip
23956 This defines a macro that prints the author, followed by a comma, if the
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23967 key is defined, or else prints the name of the editor, followed by the
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23978 or its translation (it is by default
23979 \begin_inset Quotes eld
23983 \begin_inset Quotes erd
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23997 Note that this is in fact defined in
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24007 , so you can use it in your own definitions, or re-definitions, if you load
24011 \begin_layout Section
24012 \begin_inset CommandInset label
24014 name "sec:Tags-for-XHTML"
24018 Tags for XHTML output
24021 \begin_layout Standard
24022 As with \SpecialChar LaTeX
24023 or DocBook, the format of \SpecialChar LyX
24024 's XHTML output is also controlled by
24025 layout information.
24026 In general, \SpecialChar LyX
24027 provides sensible defaults and, as mentioned earlier, it will
24028 even construct default CSS style rules from the other layout tags.
24029 For example, \SpecialChar LyX
24030 will attempt to use the information provided in the
24031 \begin_inset Flex Code
24034 \begin_layout Plain Layout
24040 declaration for the Chapter style to write CSS that will appropriately
24041 format chapter headings.
24044 \begin_layout Standard
24045 In many cases, then, you may not have to do anything at all to get acceptable
24046 XHTML output for your own environments, custom insets, and so forth.
24047 But in some cases you will, and so \SpecialChar LyX
24048 provides a number of layout tags that
24049 can be used to customize the XHTML and CSS that are generated.
24052 \begin_layout Standard
24053 Note that there are two tags,
24054 \begin_inset Flex Code
24057 \begin_layout Plain Layout
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24073 that may appear outside style and inset declarations.
24075 \begin_inset CommandInset ref
24077 reference "subsec:General-text-class"
24081 for details on these.
24084 \begin_layout Subsection
24085 \begin_inset CommandInset label
24087 name "subsec:Paragraph-Style-XHTML"
24094 \begin_layout Standard
24095 The sort of XHTML \SpecialChar LyX
24096 outputs for a paragraph depends upon whether we are dealing
24097 with a normal paragraph, a command, or an environment, where this is itself
24098 determined by the contents of the corresponding
24099 \begin_inset Flex Code
24102 \begin_layout Plain Layout
24113 \begin_layout Standard
24114 For a command or normal paragraph, the output XHTML has the following form:
24117 \begin_layout LyX-Code
24121 \begin_inset Quotes erd
24125 \begin_inset Quotes erd
24131 \begin_layout LyX-Code
24135 \begin_inset Quotes erd
24139 \begin_inset Quotes erd
24145 \begin_layout LyX-Code
24148 Contents of the paragraph.
24151 \begin_layout LyX-Code
24157 \begin_layout Standard
24158 The label tags are of course omitted if the paragraph does not have a label.
24161 \begin_layout Standard
24162 For an environment that is not some sort of list, the XHTML takes this form:
24165 \begin_layout LyX-Code
24169 \begin_inset Quotes erd
24173 \begin_inset Quotes erd
24179 \begin_layout LyX-Code
24183 \begin_inset Quotes erd
24187 \begin_inset Quotes erd
24191 \begin_inset Quotes erd
24195 \begin_inset Quotes erd
24198 >Environment Label</labeltag>First paragraph.</itemtag>
24201 \begin_layout LyX-Code
24204 <itemtag>Second paragraph.</itemtag>
24207 \begin_layout LyX-Code
24213 \begin_layout Standard
24214 Note that the label is output only for the first paragraph, as it should
24215 be for a theorem, for example.
24219 \begin_layout Standard
24220 For a list, we have one of these forms:
24223 \begin_layout LyX-Code
24227 \begin_inset Quotes erd
24231 \begin_inset Quotes erd
24237 \begin_layout LyX-Code
24241 \begin_inset Quotes erd
24245 \begin_inset Quotes erd
24249 \begin_inset Quotes erd
24253 \begin_inset Quotes erd
24256 >List Label</labeltag>First item.</itemtag>
24259 \begin_layout LyX-Code
24263 \begin_inset Quotes erd
24267 \begin_inset Quotes erd
24271 \begin_inset Quotes erd
24275 \begin_inset Quotes erd
24278 >List Label</labeltag>Second item.</itemtag>
24281 \begin_layout LyX-Code
24287 \begin_layout LyX-Code
24291 \begin_layout LyX-Code
24295 \begin_inset Quotes erd
24299 \begin_inset Quotes erd
24305 \begin_layout LyX-Code
24309 \begin_inset Quotes erd
24313 \begin_inset Quotes erd
24316 >List Label</labeltag><itemtag attr=
24317 \begin_inset Quotes erd
24321 \begin_inset Quotes erd
24324 >First item.</itemtag>
24327 \begin_layout LyX-Code
24331 \begin_inset Quotes erd
24335 \begin_inset Quotes erd
24338 >List Label</labeltag><itemtag attr=
24339 \begin_inset Quotes erd
24343 \begin_inset Quotes erd
24346 >Second item.</itemtag>
24349 \begin_layout LyX-Code
24355 \begin_layout Standard
24356 Note the different orders of
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24377 Which order we get depends upon the setting of
24378 \begin_inset Flex Code
24381 \begin_layout Plain Layout
24388 \begin_inset Flex Code
24391 \begin_layout Plain Layout
24397 is false (the default), you get the first of these, with the label within
24398 the item; if true, you get the second, with the label outside the item.
24401 \begin_layout Standard
24402 The specific tags and attributes output for each paragraph type can be controlle
24403 d by means of the layout tags we are about to describe.
24404 As mentioned earlier, however, \SpecialChar LyX
24405 uses sensible defaults for many of these,
24406 so you often may not need to do very much to get good XHTML output.
24407 Think of the available tags as there so you can tweak things to your liking.
24410 \begin_layout Description
24411 \begin_inset Flex Code
24414 \begin_layout Plain Layout
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24430 ] Specifies attribute information to be output with the main tag.
24432 \begin_inset Quotes eld
24436 \begin_inset Flex Code
24439 \begin_layout Plain Layout
24446 \begin_inset Quotes erd
24450 By default, \SpecialChar LyX
24452 \begin_inset Quotes eld
24456 \begin_inset Flex Code
24459 \begin_layout Plain Layout
24466 \begin_inset Quotes erd
24470 \begin_inset Flex Code
24473 \begin_layout Plain Layout
24479 is the \SpecialChar LyX
24480 name of the layout, made lowercase, for example: chapter.
24485 contain any style information.
24487 \begin_inset Flex Code
24490 \begin_layout Plain Layout
24499 \begin_layout Description
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24510 \begin_inset Flex Code
24513 \begin_layout Plain Layout
24523 ] Whether to output the default CSS information \SpecialChar LyX
24524 generates for this layout,
24525 even if additional information is explicitly provided via
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24537 \begin_inset Flex Code
24540 \begin_layout Plain Layout
24546 allows you to alter or augment the generated CSS, rather than to override
24549 \begin_inset Flex Code
24552 \begin_layout Plain Layout
24561 \begin_layout Description
24562 \begin_inset Flex Code
24565 \begin_layout Plain Layout
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24581 ] The tag to be used for individual paragraphs of environments, replacing
24583 \begin_inset Flex Code
24586 \begin_layout Plain Layout
24592 in the examples above.
24594 \begin_inset Flex Code
24597 \begin_layout Plain Layout
24606 \begin_layout Description
24607 \begin_inset Flex Code
24610 \begin_layout Plain Layout
24617 \begin_inset Flex Code
24620 \begin_layout Plain Layout
24626 ] Attributes for the item tag.
24628 \begin_inset Newline newline
24632 \begin_inset Quotes eld
24636 \begin_inset Flex Code
24639 \begin_layout Plain Layout
24640 class=`layoutname_item'
24646 \begin_inset Quotes erd
24654 contain any style information.
24656 \begin_inset Flex Code
24659 \begin_layout Plain Layout
24668 \begin_layout Description
24669 \begin_inset Flex Code
24672 \begin_layout Plain Layout
24679 \begin_inset Flex Code
24682 \begin_layout Plain Layout
24688 ] The tag to be used for paragraph and item labels, replacing
24689 \begin_inset Flex Code
24692 \begin_layout Plain Layout
24698 in the examples above.
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24710 \begin_inset Flex Code
24713 \begin_layout Plain Layout
24720 \begin_inset Flex Code
24723 \begin_layout Plain Layout
24730 \begin_inset Flex Code
24733 \begin_layout Plain Layout
24734 Centered_Top_Environment
24739 , in which case it defaults to
24740 \begin_inset Flex Code
24743 \begin_layout Plain Layout
24752 \begin_layout Description
24753 \begin_inset Flex Code
24756 \begin_layout Plain Layout
24763 \begin_inset Flex Code
24766 \begin_layout Plain Layout
24772 ] Attributes for the label tag.
24774 \begin_inset Newline newline
24778 \begin_inset Quotes eld
24782 \begin_inset Flex Code
24785 \begin_layout Plain Layout
24786 class=`layoutname_label'
24792 \begin_inset Quotes erd
24800 contain any style information.
24802 \begin_inset Flex Code
24805 \begin_layout Plain Layout
24814 \begin_layout Description
24815 \begin_inset Flex Code
24818 \begin_layout Plain Layout
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24838 ] Meaningful only for list-like environments, this tag controls whether
24839 the label tag is output before or inside the item tag.
24840 This is used, for example, in the description environment, where we want
24842 \begin_inset Flex Code
24845 \begin_layout Plain Layout
24846 <dt>\SpecialChar ldots
24847 </dt><dd>\SpecialChar ldots
24855 \begin_inset Flex Code
24858 \begin_layout Plain Layout
24864 : The label tag is output inside the item tag.
24867 \begin_layout Description
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24877 Information to be output in the
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24887 section when this style is used.
24888 This might, for example, be used to include a
24889 \begin_inset Flex Code
24892 \begin_layout Plain Layout
24899 \begin_inset Flex Code
24902 \begin_layout Plain Layout
24911 \begin_layout Description
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24921 CSS style information to be included when this style is used.
24922 Note that this will automatically be wrapped in a layout-generated
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24932 block, so only the CSS itself need be included.
24934 \begin_inset Flex Code
24937 \begin_layout Plain Layout
24946 \begin_layout Description
24947 \begin_inset Flex Code
24950 \begin_layout Plain Layout
24957 \begin_inset Flex Code
24960 \begin_layout Plain Layout
24966 ] The tag to be used for the main label, replacing
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24976 in the examples above.
24978 \begin_inset Flex Code
24981 \begin_layout Plain Layout
24990 \begin_layout Description
24991 \begin_inset Flex Code
24994 \begin_layout Plain Layout
25001 \begin_inset Flex Code
25004 \begin_layout Plain Layout
25014 ] Marks this style as the one to be used to generate the
25015 \begin_inset Flex Code
25018 \begin_layout Plain Layout
25024 tag for the XHTML file.
25025 By default, it is false.
25027 \begin_inset Flex Code
25030 \begin_layout Plain Layout
25036 file sets it to true for the
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25050 \begin_layout Subsection
25054 \begin_layout Standard
25055 The XHTML output of insets can also be controlled by information in layout
25060 \begin_layout Plain Layout
25061 At present, this is true only for
25062 \begin_inset Quotes eld
25066 \begin_inset Quotes erd
25069 insets (insets you can type into) and is not true for
25070 \begin_inset Quotes eld
25074 \begin_inset Quotes erd
25077 insets (insets that are associated with dialog boxes).
25082 Here, too, \SpecialChar LyX
25083 tries to provide sensible defaults, and it constructs default
25085 But everything can be customized.
25088 \begin_layout Standard
25089 The XHTML \SpecialChar LyX
25090 outputs for an inset has the following form:
25093 \begin_layout LyX-Code
25095 \begin_inset Quotes erd
25099 \begin_inset Quotes erd
25105 \begin_layout LyX-Code
25106 <labeltag>Label</labeltag>
25109 \begin_layout LyX-Code
25111 \begin_inset Quotes erd
25115 \begin_inset Quotes erd
25118 >Contents of the inset.</innertag>
25121 \begin_layout LyX-Code
25125 \begin_layout Standard
25126 If the inset permits multiple paragraphs—that is, if
25127 \begin_inset Flex Code
25130 \begin_layout Plain Layout
25136 is true—then the contents of the inset will itself be output as paragraphs
25137 formatted according to the styles used for those paragraphs (standard,
25138 quote, and the like).
25139 The label tag is of course omitted if the paragraph does not have a label
25140 and, at present, is always
25141 \begin_inset Flex Code
25144 \begin_layout Plain Layout
25151 The inner tag is optional and, by default, does not appear.
25154 \begin_layout Standard
25155 The specific tags and attributes output for each inset can be controlled
25156 by means of the following layout tags.
25159 \begin_layout Description
25160 \begin_inset Flex Code
25163 \begin_layout Plain Layout
25170 \begin_inset Flex Code
25173 \begin_layout Plain Layout
25179 ] Specifies attribute information to be output with the main tag.
25181 \begin_inset Quotes eld
25185 \begin_inset Flex Code
25188 \begin_layout Plain Layout
25189 class=`myinset' onclick=`\SpecialChar ldots
25196 \begin_inset Quotes erd
25200 By default, \SpecialChar LyX
25202 \begin_inset Quotes eld
25206 \begin_inset Flex Code
25209 \begin_layout Plain Layout
25216 \begin_inset Quotes erd
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25229 is the \SpecialChar LyX
25230 name of the inset, made lowercase and with non-alphanumeric characters
25231 converted to underscores, for example: footnote.
25234 \begin_layout Description
25235 \begin_inset Flex Code
25238 \begin_layout Plain Layout
25245 \begin_inset Flex Code
25248 \begin_layout Plain Layout
25258 ] Whether to output the default CSS information \SpecialChar LyX
25259 generates for this layout,
25260 even if additional information is explicitly provided via
25261 \begin_inset Flex Code
25264 \begin_layout Plain Layout
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25281 allows you to alter or augment the generated CSS, rather than to override
25286 \begin_layout Description
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25297 \begin_inset Flex Code
25300 \begin_layout Plain Layout
25306 ] Attributes for the inner tag.
25308 \begin_inset Newline newline
25312 \begin_inset Quotes eld
25316 \begin_inset Flex Code
25319 \begin_layout Plain Layout
25320 class=`insetname_inner'
25326 \begin_inset Quotes erd
25332 \begin_layout Description
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25343 \begin_inset Flex Code
25346 \begin_layout Plain Layout
25352 ] The inner tag, replacing
25353 \begin_inset Flex Code
25356 \begin_layout Plain Layout
25362 in the examples above.
25363 By default, there is none.
25366 \begin_layout Description
25367 \begin_inset Flex Code
25370 \begin_layout Plain Layout
25377 \begin_inset Flex Code
25380 \begin_layout Plain Layout
25388 ] Whether this inset represents a standalone block of text (such as a footnote)
25389 or instead represents material that is included in the surrounding text
25390 (such as a branch).
25394 \begin_layout Description
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25414 ] A label for this inset, possibly including a reference to a counter.
25415 For example, for footnote, it might be:
25416 \begin_inset Flex Code
25419 \begin_layout Plain Layout
25428 This is optional, and there is no default.
25431 \begin_layout Description
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25441 Information to be output in the
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25451 section when this style is used.
25452 This might, for example, be used to include a
25453 \begin_inset Flex Code
25456 \begin_layout Plain Layout
25463 \begin_inset Flex Code
25466 \begin_layout Plain Layout
25475 \begin_layout Description
25476 \begin_inset Flex Code
25479 \begin_layout Plain Layout
25485 CSS style information to be included when this style is used.
25486 Note that this will automatically be wrapped in a layout-generated
25487 \begin_inset Flex Code
25490 \begin_layout Plain Layout
25496 block, so only the CSS itself need be included.
25499 \begin_layout Description
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25510 \begin_inset Flex Code
25513 \begin_layout Plain Layout
25519 ] The tag to be used for the main label, replacing
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25529 in the examples above.
25530 The default depends upon the setting of
25531 \begin_inset Flex Code
25534 \begin_layout Plain Layout
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25550 is true, the default is
25551 \begin_inset Flex Code
25554 \begin_layout Plain Layout
25560 ; if it is false, the default is
25561 \begin_inset Flex Code
25564 \begin_layout Plain Layout
25573 \begin_layout Subsection
25577 \begin_layout Standard
25578 The XHTML output for floats too can be controlled by layout information.
25579 The output has the following form:
25582 \begin_layout LyX-Code
25584 \begin_inset Quotes erd
25588 \begin_inset Quotes erd
25594 \begin_layout LyX-Code
25595 Contents of the float.
25598 \begin_layout LyX-Code
25602 \begin_layout Standard
25603 The caption, if there is one, is a separate inset and will be output as
25605 Its appearance can be controlled via the InsetLayout for caption insets.
25609 \begin_layout Description
25610 \begin_inset Flex Code
25613 \begin_layout Plain Layout
25620 \begin_inset Flex Code
25623 \begin_layout Plain Layout
25629 ] Specifies attribute information to be output with the main tag.
25631 \begin_inset Quotes eld
25635 \begin_inset Flex Code
25638 \begin_layout Plain Layout
25639 class=`myfloat' onclick=`\SpecialChar ldots
25646 \begin_inset Quotes erd
25650 By default, \SpecialChar LyX
25652 \begin_inset Quotes eld
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25660 class=`float float-floattype'
25666 \begin_inset Quotes erd
25670 \begin_inset Flex Code
25673 \begin_layout Plain Layout
25679 is \SpecialChar LyX
25680 's name for this type of float, as determined by the float declaration
25682 \begin_inset CommandInset ref
25684 reference "subsec:Floats"
25688 ), though made lowercase and with non-alphanumeric characters converted
25689 to underscores, for example: float-table.
25692 \begin_layout Description
25693 \begin_inset Flex Code
25696 \begin_layout Plain Layout
25702 CSS style information to be included when this float is used.
25703 Note that this will automatically be wrapped in a layout-generated
25704 \begin_inset Flex Code
25707 \begin_layout Plain Layout
25713 block, so only the CSS itself need be included.
25716 \begin_layout Description
25717 \begin_inset Flex Code
25720 \begin_layout Plain Layout
25727 \begin_inset Flex Code
25730 \begin_layout Plain Layout
25736 ] The tag to be used for this float, replacing
25737 \begin_inset Quotes eld
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25751 \begin_inset Quotes erd
25754 in the example above.
25756 \begin_inset Flex Code
25759 \begin_layout Plain Layout
25765 and will rarely need changing.
25768 \begin_layout Subsection
25769 Bibliography formatting
25772 \begin_layout Standard
25773 The bibliography can be formatted using
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25785 \begin_inset CommandInset ref
25787 reference "subsec:Citation-format-description"
25794 \begin_layout Subsection
25799 \begin_layout Standard
25800 We have several times mentioned that \SpecialChar LyX
25801 will generate default CSS style rules
25802 for both insets and paragraph styles, based upon the other layout information
25804 In this section, we shall say a word about which layout information \SpecialChar LyX
25809 \begin_layout Standard
25810 At present, \SpecialChar LyX
25811 auto-generates CSS only for font information, making use of
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25833 \begin_inset Flex Code
25836 \begin_layout Plain Layout
25843 \begin_inset Flex Code
25846 \begin_layout Plain Layout
25853 \begin_inset Flex Code
25856 \begin_layout Plain Layout
25863 \begin_inset CommandInset ref
25865 reference "subsec:Font-description"
25870 The translation is mostly straightforward and obvious.
25872 \begin_inset Quotes eld
25876 \begin_inset Flex Code
25879 \begin_layout Plain Layout
25886 \begin_inset Quotes erd
25890 \begin_inset Quotes eld
25894 \begin_inset Flex Code
25897 \begin_layout Plain Layout
25898 font-family: sans-serif;
25904 \begin_inset Quotes erd
25908 The correspondence of \SpecialChar LyX
25909 sizes and CSS sizes is a little less obvious but
25910 nonetheless intuitive.
25912 \begin_inset Flex Code
25915 \begin_layout Plain Layout
25922 \begin_inset Flex URL
25925 \begin_layout Plain Layout
25935 \begin_layout Chapter
25936 Including External Material
25937 \begin_inset CommandInset label
25939 name "chap:Including-External-Material"
25946 \begin_layout Standard
25947 \begin_inset Box Shadowbox
25957 height_special "totalheight"
25962 backgroundcolor "none"
25965 \begin_layout Plain Layout
25966 WARNING: This portion of the documentation has not been updated for some
25968 We certainly hope that it is still accurate, but there are no guarantees.
25976 \begin_layout Standard
25977 The use of material from sources external to \SpecialChar LyX
25978 is covered in detail in the
25984 This part of the manual covers what needs to happen behind the scenes for
25985 new sorts of material to be included.
25988 \begin_layout Section
25992 \begin_layout Standard
25993 The external material feature is based on the concept of a
25998 A template is a specification of how \SpecialChar LyX
25999 should interface with a certain kind
26001 As bundled, \SpecialChar LyX
26002 comes with predefined templates for Xfig figures, various
26003 raster format images, chess diagrams, and LilyPond music notation.
26004 You can check the actual list by using the menu
26005 \begin_inset Flex Noun
26008 \begin_layout Plain Layout
26009 Insert\SpecialChar menuseparator
26010 File\SpecialChar menuseparator
26017 Furthermore, it is possible to roll your own template to support a specific
26019 Later we'll describe in more detail what is involved, and hopefully you
26020 will submit all the templates you create so we can include them in a later
26025 \begin_layout Standard
26026 Another basic idea of the external material feature is to distinguish between
26027 the original file that serves as a base for final material and the produced
26028 file that is included in your exported or printed document.
26029 For example, consider the case of a figure produced with
26030 \begin_inset Flex Code
26033 \begin_layout Plain Layout
26040 The Xfig application itself works on an original file with the
26041 \begin_inset Flex Code
26044 \begin_layout Plain Layout
26051 Within Xfig, you create and change your figure, and when you are done,
26053 \begin_inset Flex Code
26056 \begin_layout Plain Layout
26063 When you want to include the figure in your document, you invoke
26064 \begin_inset Flex Code
26067 \begin_layout Plain Layout
26073 in order to create a PostScript file that can readily be included in your
26077 \begin_inset Flex Code
26080 \begin_layout Plain Layout
26086 file is the original file, and the PostScript file is the produced file.
26089 \begin_layout Standard
26090 This distinction is important in order to allow updating of the material
26091 while you are in the process of writing the document.
26092 Furthermore, it provides us with the flexibility that is needed to support
26093 multiple export formats.
26094 For instance, in the case of a plain text file, it is not exactly an award-winn
26095 ing idea to include the figure as raw PostScript.
26096 Instead, you would either prefer to just include a reference to the figure
26097 or try to invoke some graphics to ASCII converter to make the final result
26098 look similar to the real graphics.
26099 The external material management allows you to do this, because it is parametri
26100 zed on the different export formats that \SpecialChar LyX
26104 \begin_layout Standard
26105 Besides supporting the production of different products according to the
26106 exported format, it supports tight integration with editing and viewing
26108 In the case of an Xfig figure, you are able to invoke Xfig on the original
26109 file with a single click from within the external material dialog in \SpecialChar LyX
26111 and also preview the produced PostScript file with Ghostview with another
26113 No more fiddling around with the command line and/or file browsers to locate
26114 and manipulate the original or produced files.
26115 In this way, you are finally able to take full advantage of the many different
26116 applications that are relevant to use when you write your documents, and
26117 ultimately be more productive.
26120 \begin_layout Section
26121 The external template configuration files
26124 \begin_layout Standard
26125 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26127 However, be aware that doing this in an careless manner most probably
26131 introduce an easily exploitable security hole.
26132 So before you do this, please read the discussion about security in
26133 \begin_inset CommandInset ref
26135 reference "sec:Security-discussion"
26142 \begin_layout Standard
26143 Having said that, we encourage you to submit any interesting templates that
26148 \begin_layout Standard
26149 The external templates are defined in the
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26159 files that are stored in the
26160 \begin_inset Flex Code
26163 \begin_layout Plain Layout
26164 LyXDir/lib/xtemplates/
26170 Each template is defined in a file of its own.
26171 You can place your own templates in
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26176 UserDir/xtemplates/
26181 or copy existing templates to that directory in order to modify them.
26184 \begin_layout Standard
26185 A typical template looks like this:
26188 \begin_layout LyX-Code
26192 \begin_layout LyX-Code
26193 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26196 \begin_layout LyX-Code
26200 \begin_layout LyX-Code
26204 \begin_layout LyX-Code
26208 \begin_layout LyX-Code
26212 \begin_layout LyX-Code
26216 \begin_layout LyX-Code
26217 AutomaticProduction true
26220 \begin_layout LyX-Code
26224 \begin_layout LyX-Code
26228 \begin_layout LyX-Code
26232 \begin_layout LyX-Code
26233 TransformCommand Rotate RotationLatexCommand
26236 \begin_layout LyX-Code
26237 TransformCommand Resize ResizeLatexCommand
26240 \begin_layout LyX-Code
26241 Product "$$RotateFront$$ResizeFront
26244 \begin_layout LyX-Code
26249 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26252 \begin_layout LyX-Code
26253 $$ResizeBack$$RotateBack"
26256 \begin_layout LyX-Code
26260 \begin_layout LyX-Code
26261 UpdateResult "$$AbsPath$$Basename.pstex_t"
26264 \begin_layout LyX-Code
26265 Requirement "graphicx"
26268 \begin_layout LyX-Code
26269 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26272 \begin_layout LyX-Code
26273 ReferencedFile latex "$$AbsPath$$Basename.eps"
26276 \begin_layout LyX-Code
26277 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26280 \begin_layout LyX-Code
26284 \begin_layout LyX-Code
26288 \begin_layout LyX-Code
26289 TransformCommand Rotate RotationLatexCommand
26292 \begin_layout LyX-Code
26293 TransformCommand Resize ResizeLatexCommand
26296 \begin_layout LyX-Code
26297 Product "$$RotateFront$$ResizeFront
26300 \begin_layout LyX-Code
26305 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26308 \begin_layout LyX-Code
26309 $$ResizeBack$$RotateBack"
26312 \begin_layout LyX-Code
26313 UpdateFormat pdftex
26316 \begin_layout LyX-Code
26317 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26320 \begin_layout LyX-Code
26321 Requirement "graphicx"
26324 \begin_layout LyX-Code
26325 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26328 \begin_layout LyX-Code
26329 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26332 \begin_layout LyX-Code
26336 \begin_layout LyX-Code
26340 \begin_layout LyX-Code
26341 Product "[XFig: $$FName]"
26344 \begin_layout LyX-Code
26348 \begin_layout LyX-Code
26352 \begin_layout LyX-Code
26353 Product "<graphic fileref=
26355 "$$AbsOrRelPathMaster$$Basename.eps
26360 \begin_layout LyX-Code
26364 \begin_layout LyX-Code
26368 \begin_layout LyX-Code
26369 UpdateResult "$$AbsPath$$Basename.eps"
26372 \begin_layout LyX-Code
26373 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26376 \begin_layout LyX-Code
26377 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26380 \begin_layout LyX-Code
26384 \begin_layout LyX-Code
26388 \begin_layout Standard
26389 As you can see, the template is enclosed in
26390 \begin_inset Flex Code
26393 \begin_layout Plain Layout
26401 \begin_inset Flex Code
26404 \begin_layout Plain Layout
26411 It contains a header specifying some general settings and, for each supported
26412 primary document file format, a section
26413 \begin_inset Flex Code
26416 \begin_layout Plain Layout
26424 \begin_inset Flex Code
26427 \begin_layout Plain Layout
26436 \begin_layout Subsection
26437 The template header
26440 \begin_layout Description
26441 \begin_inset Flex Code
26444 \begin_layout Plain Layout
26445 AutomaticProduction
26446 \begin_inset space ~
26454 Whether the file represented by the template must be generated by \SpecialChar LyX
26456 This command must occur exactly once.
26459 \begin_layout Description
26460 \begin_inset Flex Code
26463 \begin_layout Plain Layout
26465 \begin_inset space ~
26473 A glob pattern that is used in the file dialog to filter out the desired
26475 If there is more than one possible file extension (e.
26476 \begin_inset space \thinspace{}
26480 \begin_inset space \space{}
26484 \begin_inset Flex Code
26487 \begin_layout Plain Layout
26494 \begin_inset Flex Code
26497 \begin_layout Plain Layout
26503 ), use something like
26504 \begin_inset Flex Code
26507 \begin_layout Plain Layout
26514 This command must occur exactly once.
26517 \begin_layout Description
26518 \begin_inset Flex Code
26521 \begin_layout Plain Layout
26523 \begin_inset space ~
26531 The text that is displayed on the button.
26532 This command must occur exactly once.
26535 \begin_layout Description
26536 \begin_inset Flex Code
26539 \begin_layout Plain Layout
26541 \begin_inset space ~
26545 \begin_inset space ~
26553 The help text that is used in the External dialog.
26554 Provide enough information to explain to the user just what the template
26555 can provide him with.
26556 This command must occur exactly once.
26559 \begin_layout Description
26560 \begin_inset Flex Code
26563 \begin_layout Plain Layout
26565 \begin_inset space ~
26573 The file format of the original file.
26574 This must be the name of a format that is known to \SpecialChar LyX
26576 \begin_inset CommandInset ref
26578 reference "sec:Formats"
26584 \begin_inset Quotes eld
26588 \begin_inset Flex Code
26591 \begin_layout Plain Layout
26598 \begin_inset Quotes erd
26601 if the template can handle original files of more than one format.
26603 will attempt to interrogate the file itself in order to deduce its format
26605 This command must occur exactly once.
26608 \begin_layout Description
26609 \begin_inset Flex Code
26612 \begin_layout Plain Layout
26614 \begin_inset space ~
26622 A unique name for the template.
26623 It must not contain substitution macros (see below).
26626 \begin_layout Description
26627 \begin_inset Flex Code
26630 \begin_layout Plain Layout
26632 \begin_inset space ~
26635 Rotate|Resize|Clip|Extra
26640 This command specifies which transformations are supported by this template.
26641 It may occur zero or more times.
26642 This command enables the corresponding tabs in the external dialog.
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26653 command must have either a corresponding
26654 \begin_inset Flex Code
26657 \begin_layout Plain Layout
26664 \begin_inset Flex Code
26667 \begin_layout Plain Layout
26674 \begin_inset Flex Code
26677 \begin_layout Plain Layout
26684 Otherwise the transformation will not be supported by that format.
26687 \begin_layout Subsection
26691 \begin_layout Description
26692 \begin_inset Flex Code
26695 \begin_layout Plain Layout
26697 \begin_inset space ~
26700 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26705 The primary document file format that this format definition is for.
26706 Not every template has a sensible representation in all document file formats.
26707 Please define nevertheless a
26708 \begin_inset Flex Code
26711 \begin_layout Plain Layout
26717 section for all templates.
26718 Use a dummy text when no representation is available.
26719 Then you can at least see a reference to the external material in the exported
26723 \begin_layout Description
26724 \begin_inset Flex Code
26727 \begin_layout Plain Layout
26729 \begin_inset space ~
26733 \begin_inset space ~
26741 This command defines an additional macro
26742 \begin_inset Flex Code
26745 \begin_layout Plain Layout
26751 for substitution in
26752 \begin_inset Flex Code
26755 \begin_layout Plain Layout
26763 \begin_inset Flex Code
26766 \begin_layout Plain Layout
26772 itself may contain substitution macros.
26773 The advantage over using
26774 \begin_inset Flex Code
26777 \begin_layout Plain Layout
26784 \begin_inset Flex Code
26787 \begin_layout Plain Layout
26793 is that the substituted value of
26794 \begin_inset Flex Code
26797 \begin_layout Plain Layout
26803 is sanitized so that it is a valid optional argument in the document format.
26804 This command may occur zero or more times.
26807 \begin_layout Description
26808 \begin_inset Flex Code
26811 \begin_layout Plain Layout
26813 \begin_inset space ~
26821 The text that is inserted in the exported document.
26822 This is actually the most important command and can be quite complex.
26823 This command must occur exactly once.
26826 \begin_layout Description
26827 \begin_inset Flex Code
26830 \begin_layout Plain Layout
26832 \begin_inset space ~
26840 This command specifies a preamble snippet that will be included in the
26843 It has to be defined using
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26865 This command may occur zero or more times.
26868 \begin_layout Description
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26874 \begin_inset space ~
26878 \begin_inset space ~
26886 This command denotes files that are created by the conversion process and
26887 are needed for a particular export format.
26888 If the filename is relative, it is interpreted relative to the master document.
26889 This command may be given zero or more times.
26892 \begin_layout Description
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26898 \begin_inset space ~
26906 The name of a required \SpecialChar LaTeX
26908 The package is included via
26909 \begin_inset Flex Code
26912 \begin_layout Plain Layout
26920 in the \SpecialChar LaTeX
26922 This command may occur zero or more times.
26925 \begin_layout Description
26926 \begin_inset Flex Code
26929 \begin_layout Plain Layout
26931 \begin_inset space ~
26935 \begin_inset space ~
26938 RotationLatexCommand
26943 This command specifies that the built in \SpecialChar LaTeX
26944 command should be used for rotation.
26945 This command may occur once or not at all.
26948 \begin_layout Description
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26954 \begin_inset space ~
26958 \begin_inset space ~
26966 This command specifies that the built in \SpecialChar LaTeX
26967 command should be used for resizing.
26968 This command may occur once or not at all.
26971 \begin_layout Description
26972 \begin_inset Flex Code
26975 \begin_layout Plain Layout
26977 \begin_inset space ~
26981 \begin_inset space ~
26984 RotationLatexOption
26989 This command specifies that rotation is done via an optional argument.
26990 This command may occur once or not at all.
26993 \begin_layout Description
26994 \begin_inset Flex Code
26997 \begin_layout Plain Layout
26999 \begin_inset space ~
27003 \begin_inset space ~
27011 This command specifies that resizing is done via an optional argument.
27012 This command may occur once or not at all.
27015 \begin_layout Description
27016 \begin_inset Flex Code
27019 \begin_layout Plain Layout
27021 \begin_inset space ~
27025 \begin_inset space ~
27033 This command specifies that clipping is done via an optional argument.
27034 This command may occur once or not at all.
27037 \begin_layout Description
27038 \begin_inset Flex Code
27041 \begin_layout Plain Layout
27043 \begin_inset space ~
27047 \begin_inset space ~
27055 This command specifies that an extra optional argument is used.
27056 This command may occur once or not at all.
27059 \begin_layout Description
27060 \begin_inset Flex Code
27063 \begin_layout Plain Layout
27065 \begin_inset space ~
27073 The file format of the converted file.
27074 This must be the name of a format that is known to \SpecialChar LyX
27076 \begin_inset Flex Noun
27079 \begin_layout Plain Layout
27080 Tools\SpecialChar menuseparator
27081 Preferences\SpecialChar menuseparator
27082 File Handling\SpecialChar menuseparator
27089 This command must occur exactly once.
27090 If the resulting file format is PDF, you need to specify the format
27091 \begin_inset Flex Code
27094 \begin_layout Plain Layout
27101 This is the PDF format used for including graphics.
27102 The other defined PDF formats are for document export.
27105 \begin_layout Description
27106 \begin_inset Flex Code
27109 \begin_layout Plain Layout
27111 \begin_inset space ~
27119 The file name of the converted file.
27120 The file name must be absolute.
27121 This command must occur exactly once.
27124 \begin_layout Subsection
27125 Preamble definitions
27128 \begin_layout Standard
27129 The external template configuration file may contain additional preamble
27130 definitions enclosed by
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27142 \begin_inset Flex Code
27145 \begin_layout Plain Layout
27152 They can be used by the templates in the
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27165 \begin_layout Section
27166 The substitution mechanism
27169 \begin_layout Standard
27170 When the external material facility invokes an external program, it is done
27171 on the basis of a command defined in the template configuration file.
27172 These commands can contain various macros that are expanded before execution.
27173 Execution always take place in the directory of the containing document.
27176 \begin_layout Standard
27177 Also, whenever external material is to be displayed, the name will be produced
27178 by the substitution mechanism, and most other commands in the template
27179 definition support substitution as well.
27182 \begin_layout Standard
27183 The available macros are the following:
27186 \begin_layout Description
27187 \begin_inset Flex Code
27190 \begin_layout Plain Layout
27191 $$AbsOrRelPathMaster
27196 The file path, absolute or relative to the master \SpecialChar LyX
27200 \begin_layout Description
27201 \begin_inset Flex Code
27204 \begin_layout Plain Layout
27205 $$AbsOrRelPathParent
27210 The file path, absolute or relative to the \SpecialChar LyX
27214 \begin_layout Description
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27224 The absolute file path.
27227 \begin_layout Description
27228 \begin_inset Flex Code
27231 \begin_layout Plain Layout
27237 The filename without path and without the extension.
27240 \begin_layout Description
27241 \begin_inset Flex Code
27244 \begin_layout Plain Layout
27246 \begin_inset Quotes eld
27250 \begin_inset Quotes erd
27258 This macro will expand to the contents of the file with the name
27259 \begin_inset Flex Code
27262 \begin_layout Plain Layout
27271 \begin_layout Description
27272 \begin_inset Flex Code
27275 \begin_layout Plain Layout
27281 The file extension (including the dot).
27284 \begin_layout Description
27285 \begin_inset Flex Code
27288 \begin_layout Plain Layout
27294 This will be the string
27295 \begin_inset Quotes eld
27299 \begin_inset Quotes erd
27302 if the file is in JPEG format, otherwise it will be the string
27303 \begin_inset Quotes eld
27307 \begin_inset Quotes erd
27311 This is useful to avoid uneeded conversions for output formats that support
27312 both PNG and JPEG fomats.
27313 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27318 \begin_layout Description
27319 \begin_inset Flex Code
27322 \begin_layout Plain Layout
27328 The filename of the file specified in the external material dialog.
27329 This is either an absolute name, or it is relative to the \SpecialChar LyX
27333 \begin_layout Description
27334 \begin_inset Flex Code
27337 \begin_layout Plain Layout
27344 \begin_inset Flex Code
27347 \begin_layout Plain Layout
27353 (absolute name or relative to the \SpecialChar LyX
27357 \begin_layout Description
27358 \begin_inset Flex Code
27361 \begin_layout Plain Layout
27367 The file path, relative to the master \SpecialChar LyX
27371 \begin_layout Description
27372 \begin_inset Flex Code
27375 \begin_layout Plain Layout
27381 The file path, relative to the \SpecialChar LyX
27385 \begin_layout Description
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27395 This macro will expand to the absolute path of the system directory.
27396 This is typically used to point to the various helper scripts that are
27397 bundled with \SpecialChar LyX
27401 \begin_layout Description
27402 \begin_inset Flex Code
27405 \begin_layout Plain Layout
27411 A name and full path to a temporary file which will be automatically deleted
27412 whenever the containing document is closed, or the external material insertion
27416 \begin_layout Standard
27417 All path macros contain a trailing directory separator, so you can construct
27419 \begin_inset space \thinspace{}
27423 \begin_inset space \space{}
27426 the absolute filename with
27427 \begin_inset Flex Code
27430 \begin_layout Plain Layout
27431 $$AbsPath$$Basename$$Extension
27439 \begin_layout Standard
27440 The macros above are substituted in all commands unless otherwise noted.
27442 \begin_inset Flex Code
27445 \begin_layout Plain Layout
27451 supports additionally the following substitutions if they are enabled by
27453 \begin_inset Flex Code
27456 \begin_layout Plain Layout
27463 \begin_inset Flex Code
27466 \begin_layout Plain Layout
27475 \begin_layout Description
27476 \begin_inset Flex Code
27479 \begin_layout Plain Layout
27485 The front part of the resize command.
27488 \begin_layout Description
27489 \begin_inset Flex Code
27492 \begin_layout Plain Layout
27498 The back part of the resize command.
27501 \begin_layout Description
27502 \begin_inset Flex Code
27505 \begin_layout Plain Layout
27511 The front part of the rotation command.
27514 \begin_layout Description
27515 \begin_inset Flex Code
27518 \begin_layout Plain Layout
27524 The back part of the rotation command.
27527 \begin_layout Standard
27528 The value string of the
27529 \begin_inset Flex Code
27532 \begin_layout Plain Layout
27538 command supports additionally the following substitutions if they are enabled
27540 \begin_inset Flex Code
27543 \begin_layout Plain Layout
27550 \begin_inset Flex Code
27553 \begin_layout Plain Layout
27562 \begin_layout Description
27563 \begin_inset Flex Code
27566 \begin_layout Plain Layout
27575 \begin_layout Description
27576 \begin_inset Flex Code
27579 \begin_layout Plain Layout
27588 \begin_layout Description
27589 \begin_inset Flex Code
27592 \begin_layout Plain Layout
27601 \begin_layout Description
27602 \begin_inset Flex Code
27605 \begin_layout Plain Layout
27611 The rotation option.
27614 \begin_layout Standard
27615 You may ask why there are so many path macros.
27616 There are mainly two reasons:
27619 \begin_layout Enumerate
27620 Relative and absolute file names should remain relative or absolute, respectivel
27622 Users may have reasons to prefer either form.
27623 Relative names are useful for portable documents that should work on different
27624 machines, for example.
27625 Absolute names may be required by some programs.
27628 \begin_layout Enumerate
27630 treats relative file names differently than \SpecialChar LyX
27631 and other programs in nested
27633 For \SpecialChar LyX
27634 , a relative file name is always relative to the document that contains
27636 For \SpecialChar LaTeX
27637 , it is always relative to the master document.
27638 These two definitions are identical if you have only one document, but
27639 differ if you have a master document that includes part documents.
27640 That means that relative filenames must be transformed when presented to
27643 Fortunately \SpecialChar LyX
27644 does this automatically for you if you choose the right macros.
27647 \begin_layout Standard
27648 So which path macro should be used in new template definitions? The rule
27652 \begin_layout Itemize
27654 \begin_inset Flex Code
27657 \begin_layout Plain Layout
27663 if an absolute path is required.
27666 \begin_layout Itemize
27668 \begin_inset Flex Code
27671 \begin_layout Plain Layout
27672 $$AbsOrRelPathMaster
27677 if the substituted string is some kind of \SpecialChar LaTeX
27681 \begin_layout Itemize
27683 \begin_inset Flex Code
27686 \begin_layout Plain Layout
27687 $$AbsOrRelPathParent
27692 in order to preserve the user's choice.
27695 \begin_layout Standard
27696 There are special cases where this rule does not work and e.
27697 \begin_inset space \thinspace{}
27701 \begin_inset space \space{}
27704 relative names are needed, but normally it will work just fine.
27705 One example for such a case is the command
27706 \begin_inset Flex Code
27709 \begin_layout Plain Layout
27710 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27715 in the XFig template above: We can't use the absolute name because the
27717 \begin_inset Flex Code
27720 \begin_layout Plain Layout
27726 files needs the relative name in order to rewrite the file content.
27729 \begin_layout Section
27730 Security discussion
27731 \begin_inset CommandInset label
27733 name "sec:Security-discussion"
27740 \begin_layout Standard
27741 The external material feature interfaces with a lot of external programs
27742 and does so automatically, so we have to consider the security implications
27744 In particular, since you have the option of including your own filenames
27745 and/or parameter strings and those are expanded into a command, it seems
27746 that it would be possible to create a malicious document which executes
27747 arbitrary commands when a user views or prints the document.
27748 This is something we definitely want to avoid.
27751 \begin_layout Standard
27752 However, since the external program commands are specified in the template
27753 configuration file only, there are no security issues if \SpecialChar LyX
27754 is properly configure
27755 d with safe templates only.
27756 This is so because the external programs are invoked with the
27757 \begin_inset Flex Code
27760 \begin_layout Plain Layout
27766 -system call rather than the
27767 \begin_inset Flex Code
27770 \begin_layout Plain Layout
27776 system-call, so it's not possible to execute arbitrary commands from the
27777 filename or parameter section via the shell.
27780 \begin_layout Standard
27781 This also implies that you are restricted in what command strings you can
27782 use in the external material templates.
27783 In particular, pipes and redirection are not readily available.
27784 This has to be so if \SpecialChar LyX
27785 should remain safe.
27786 If you want to use some of the shell features, you should write a safe
27787 script to do this in a controlled manner, and then invoke the script from
27788 the command string.
27792 \begin_layout Standard
27793 It is possible to design a template that interacts directly with the shell,
27794 but since this would allow a malicious user to execute arbitrary commands
27795 by writing clever filenames and/or parameters, we generally recommend that
27796 you only use safe scripts that work with the
27797 \begin_inset Flex Code
27800 \begin_layout Plain Layout
27806 system call in a controlled manner.
27807 Of course, for use in a controlled environment, it can be tempting to just
27808 fall back to use ordinary shell scripts.
27809 If you do so, be aware that you
27813 provide an easily exploitable security hole in your system.
27814 Of course it stands to reason that such unsafe templates will never be
27815 included in the standard \SpecialChar LyX
27816 distribution, although we do encourage people
27817 to submit new templates in the open source tradition.
27818 But \SpecialChar LyX
27819 as shipped from the official distribution channels will never have
27823 \begin_layout Standard
27824 Including external material provides a lot of power, and you have to be
27825 careful not to introduce security hazards with this power.
27826 A subtle error in a single line in an innocent looking script can open
27827 the door to huge security problems.
27828 So if you do not fully understand the issues, we recommend that you consult
27829 a knowledgeable security professional or the \SpecialChar LyX
27830 development team if you have
27831 any questions about whether a given template is safe or not.
27832 And do this before you use it in an uncontrolled environment.
27835 \begin_layout Chapter
27837 List of supported \SpecialChar LyX
27838 functions to be used in layouts
27839 \begin_inset CommandInset label
27841 name "chap:List-of-functions"
27848 \begin_layout Standard
27850 \begin_inset Tabular
27851 <lyxtabular version="3" rows="11" columns="8">
27852 <features tabularvalignment="middle">
27853 <column alignment="left" valignment="top">
27854 <column alignment="left" valignment="top">
27855 <column alignment="left" valignment="top">
27856 <column alignment="left" valignment="top">
27857 <column alignment="left" valignment="top">
27858 <column alignment="left" valignment="top">
27859 <column alignment="left" valignment="top">
27860 <column alignment="left" valignment="top">
27862 <cell alignment="left" valignment="top" usebox="none">
27865 \begin_layout Plain Layout
27871 <cell alignment="left" valignment="top" usebox="none">
27874 \begin_layout Plain Layout
27880 <cell alignment="left" valignment="top" usebox="none">
27883 \begin_layout Plain Layout
27889 <cell alignment="left" valignment="top" usebox="none">
27892 \begin_layout Plain Layout
27898 <cell alignment="center" valignment="top" usebox="none">
27901 \begin_layout Plain Layout
27907 <cell alignment="center" valignment="top" usebox="none">
27910 \begin_layout Plain Layout
27916 <cell alignment="center" valignment="top" usebox="none">
27919 \begin_layout Plain Layout
27925 <cell alignment="center" valignment="top" usebox="none">
27928 \begin_layout Plain Layout
27936 <cell alignment="left" valignment="top" usebox="none">
27939 \begin_layout Plain Layout
27945 <cell alignment="left" valignment="top" usebox="none">
27948 \begin_layout Plain Layout
27954 <cell alignment="left" valignment="top" usebox="none">
27957 \begin_layout Plain Layout
27963 <cell alignment="left" valignment="top" usebox="none">
27966 \begin_layout Plain Layout
27972 <cell alignment="center" valignment="top" usebox="none">
27975 \begin_layout Plain Layout
27981 <cell alignment="center" valignment="top" usebox="none">
27984 \begin_layout Plain Layout
27990 <cell alignment="center" valignment="top" usebox="none">
27993 \begin_layout Plain Layout
27999 <cell alignment="center" valignment="top" usebox="none">
28002 \begin_layout Plain Layout
28010 <cell alignment="left" valignment="top" usebox="none">
28013 \begin_layout Plain Layout
28019 <cell alignment="left" valignment="top" usebox="none">
28022 \begin_layout Plain Layout
28028 <cell alignment="left" valignment="top" usebox="none">
28031 \begin_layout Plain Layout
28037 <cell alignment="left" valignment="top" usebox="none">
28040 \begin_layout Plain Layout
28046 <cell alignment="center" valignment="top" usebox="none">
28049 \begin_layout Plain Layout
28055 <cell alignment="center" valignment="top" usebox="none">
28058 \begin_layout Plain Layout
28064 <cell alignment="center" valignment="top" usebox="none">
28067 \begin_layout Plain Layout
28073 <cell alignment="center" valignment="top" usebox="none">
28076 \begin_layout Plain Layout
28084 <cell alignment="left" valignment="top" usebox="none">
28087 \begin_layout Plain Layout
28093 <cell alignment="left" valignment="top" usebox="none">
28096 \begin_layout Plain Layout
28102 <cell alignment="left" valignment="top" usebox="none">
28105 \begin_layout Plain Layout
28111 <cell alignment="left" valignment="top" usebox="none">
28114 \begin_layout Plain Layout
28120 <cell alignment="center" valignment="top" usebox="none">
28123 \begin_layout Plain Layout
28129 <cell alignment="center" valignment="top" usebox="none">
28132 \begin_layout Plain Layout
28138 <cell alignment="center" valignment="top" usebox="none">
28141 \begin_layout Plain Layout
28147 <cell alignment="center" valignment="top" usebox="none">
28150 \begin_layout Plain Layout
28158 <cell alignment="left" valignment="top" usebox="none">
28161 \begin_layout Plain Layout
28167 <cell alignment="left" valignment="top" usebox="none">
28170 \begin_layout Plain Layout
28176 <cell alignment="left" valignment="top" usebox="none">
28179 \begin_layout Plain Layout
28185 <cell alignment="left" valignment="top" usebox="none">
28188 \begin_layout Plain Layout
28194 <cell alignment="center" valignment="top" usebox="none">
28197 \begin_layout Plain Layout
28203 <cell alignment="center" valignment="top" usebox="none">
28206 \begin_layout Plain Layout
28212 <cell alignment="center" valignment="top" usebox="none">
28215 \begin_layout Plain Layout
28221 <cell alignment="center" valignment="top" usebox="none">
28224 \begin_layout Plain Layout
28232 <cell alignment="left" valignment="top" usebox="none">
28235 \begin_layout Plain Layout
28241 <cell alignment="left" valignment="top" usebox="none">
28244 \begin_layout Plain Layout
28250 <cell alignment="left" valignment="top" usebox="none">
28253 \begin_layout Plain Layout
28259 <cell alignment="left" valignment="top" usebox="none">
28262 \begin_layout Plain Layout
28268 <cell alignment="center" valignment="top" usebox="none">
28271 \begin_layout Plain Layout
28277 <cell alignment="center" valignment="top" usebox="none">
28280 \begin_layout Plain Layout
28286 <cell alignment="center" valignment="top" usebox="none">
28289 \begin_layout Plain Layout
28295 <cell alignment="center" valignment="top" usebox="none">
28298 \begin_layout Plain Layout
28306 <cell alignment="left" valignment="top" usebox="none">
28309 \begin_layout Plain Layout
28315 <cell alignment="left" valignment="top" usebox="none">
28318 \begin_layout Plain Layout
28324 <cell alignment="left" valignment="top" usebox="none">
28327 \begin_layout Plain Layout
28333 <cell alignment="left" valignment="top" usebox="none">
28336 \begin_layout Plain Layout
28342 <cell alignment="center" valignment="top" usebox="none">
28345 \begin_layout Plain Layout
28351 <cell alignment="center" valignment="top" usebox="none">
28354 \begin_layout Plain Layout
28360 <cell alignment="center" valignment="top" usebox="none">
28363 \begin_layout Plain Layout
28369 <cell alignment="center" valignment="top" usebox="none">
28372 \begin_layout Plain Layout
28380 <cell alignment="left" valignment="top" usebox="none">
28383 \begin_layout Plain Layout
28389 <cell alignment="left" valignment="top" usebox="none">
28392 \begin_layout Plain Layout
28398 <cell alignment="left" valignment="top" usebox="none">
28401 \begin_layout Plain Layout
28407 <cell alignment="left" valignment="top" usebox="none">
28410 \begin_layout Plain Layout
28416 <cell alignment="center" valignment="top" usebox="none">
28419 \begin_layout Plain Layout
28425 <cell alignment="center" valignment="top" usebox="none">
28428 \begin_layout Plain Layout
28434 <cell alignment="center" valignment="top" usebox="none">
28437 \begin_layout Plain Layout
28443 <cell alignment="center" valignment="top" usebox="none">
28446 \begin_layout Plain Layout
28454 <cell alignment="left" valignment="top" usebox="none">
28457 \begin_layout Plain Layout
28463 <cell alignment="left" valignment="top" usebox="none">
28466 \begin_layout Plain Layout
28472 <cell alignment="left" valignment="top" usebox="none">
28475 \begin_layout Plain Layout
28481 <cell alignment="left" valignment="top" usebox="none">
28484 \begin_layout Plain Layout
28490 <cell alignment="center" valignment="top" usebox="none">
28493 \begin_layout Plain Layout
28499 <cell alignment="center" valignment="top" usebox="none">
28502 \begin_layout Plain Layout
28508 <cell alignment="center" valignment="top" usebox="none">
28511 \begin_layout Plain Layout
28517 <cell alignment="center" valignment="top" usebox="none">
28520 \begin_layout Plain Layout
28528 <cell alignment="left" valignment="top" usebox="none">
28531 \begin_layout Plain Layout
28537 <cell alignment="left" valignment="top" usebox="none">
28540 \begin_layout Plain Layout
28546 <cell alignment="left" valignment="top" usebox="none">
28549 \begin_layout Plain Layout
28555 <cell alignment="left" valignment="top" usebox="none">
28558 \begin_layout Plain Layout
28564 <cell alignment="center" valignment="top" usebox="none">
28567 \begin_layout Plain Layout
28573 <cell alignment="center" valignment="top" usebox="none">
28576 \begin_layout Plain Layout
28582 <cell alignment="center" valignment="top" usebox="none">
28585 \begin_layout Plain Layout
28591 <cell alignment="center" valignment="top" usebox="none">
28594 \begin_layout Plain Layout
28602 <cell alignment="center" valignment="top" usebox="none">
28605 \begin_layout Plain Layout
28611 <cell alignment="center" valignment="top" usebox="none">
28614 \begin_layout Plain Layout
28620 <cell alignment="center" valignment="top" usebox="none">
28623 \begin_layout Plain Layout
28629 <cell alignment="center" valignment="top" usebox="none">
28632 \begin_layout Plain Layout
28638 <cell alignment="center" valignment="top" usebox="none">
28641 \begin_layout Plain Layout
28647 <cell alignment="center" valignment="top" usebox="none">
28650 \begin_layout Plain Layout
28656 <cell alignment="center" valignment="top" usebox="none">
28659 \begin_layout Plain Layout
28665 <cell alignment="center" valignment="top" usebox="none">
28668 \begin_layout Plain Layout
28682 \begin_layout Chapter
28683 Names of available colors to be used in layouts
28684 \begin_inset CommandInset label
28686 name "chap:Names-of-colors"
28693 \begin_layout Standard
28694 The colors listed below are the standard colors and those that you can adjust
28695 in the \SpecialChar LyX
28699 \begin_layout Section
28703 \begin_layout Standard
28704 The following are no real colors, but rather act on color definitions:
28707 \begin_layout Description
28708 ignore The color is ignored
28711 \begin_layout Description
28712 inherit The color is inherited
28715 \begin_layout Description
28728 No particular color – clear or default
28731 \begin_layout Section
28735 \begin_layout Standard
28736 These are fixed colors that cannot me customized:
28739 \begin_layout Description
28743 \begin_layout Description
28747 \begin_layout Description
28751 \begin_layout Description
28755 \begin_layout Description
28759 \begin_layout Description
28763 \begin_layout Description
28767 \begin_layout Description
28771 \begin_layout Description
28775 \begin_layout Description
28779 \begin_layout Description
28783 \begin_layout Description
28787 \begin_layout Description
28791 \begin_layout Description
28795 \begin_layout Description
28799 \begin_layout Description
28803 \begin_layout Description
28807 \begin_layout Description
28811 \begin_layout Description
28815 \begin_layout Section
28819 \begin_layout Standard
28820 These are the colors allocated to specific elements in
28823 arg "dialog-show prefs"
28829 \begin_layout Description
28830 added_space Added space color
28833 \begin_layout Description
28834 addedtext Added text color
28837 \begin_layout Description
28838 appendix Appendix marker color
28841 \begin_layout Description
28842 background Background color
28845 \begin_layout Description
28846 bottomarea Bottom area color
28849 \begin_layout Description
28850 branchlabel Label color for branches
28853 \begin_layout Description
28854 buttonbg Color used for button background
28857 \begin_layout Description
28858 buttonframe Color for inset button frames
28861 \begin_layout Description
28862 buttonhoverbg Color used for button background under focus
28865 \begin_layout Description
28866 changebar Changebar color
28869 \begin_layout Description
28870 changedtextauthor1 Changed text color author 1
28873 \begin_layout Description
28874 changedtextauthor2 Changed text color author 2
28877 \begin_layout Description
28878 changedtextauthor3 Changed text color author 3
28881 \begin_layout Description
28882 changedtextauthor4 Changed text color author 4
28885 \begin_layout Description
28886 changedtextauthor5 Changed text color author 5
28889 \begin_layout Description
28890 collapsible Collapsible insets text color
28893 \begin_layout Description
28894 collapsibleframe Collapsible insets framecolor
28897 \begin_layout Description
28898 command Text color for command insets
28901 \begin_layout Description
28902 commandbg Background color for command insets
28905 \begin_layout Description
28906 commandframe Frame color for command insets
28909 \begin_layout Description
28910 comment Label color for comments
28913 \begin_layout Description
28914 commentbg Background color of comments
28917 \begin_layout Description
28918 cursor Cursor color
28921 \begin_layout Description
28922 deletedtext Deleted text color
28925 \begin_layout Description
28926 deletedtextmodifier Deleted text modifying color
28929 \begin_layout Description
28930 depthbar Color for the depth bars in the margin
28933 \begin_layout Description
28934 eolmarker End of line marker color
28937 \begin_layout Description
28938 error Color of the \SpecialChar LaTeX
28942 \begin_layout Description
28943 footlabel Label color for footnotes
28946 \begin_layout Description
28947 foreground Foreground color
28950 \begin_layout Description
28951 graphicsbg Graphics inset background color
28954 \begin_layout Description
28955 greyedoutbg Background color of greyedout inset
28958 \begin_layout Description
28959 greyedoutlabel Label color for greyedout insets
28962 \begin_layout Description
28963 greyedouttext Color for greyedout inset text
28966 \begin_layout Description
28967 indexlabel Label color for index insets
28970 \begin_layout Description
28971 inlinecompletion Inline completion color
28974 \begin_layout Description
28975 insetbg Inset marker background color
28978 \begin_layout Description
28979 insetframe Inset marker frame color
28982 \begin_layout Description
28983 language Color for marking foreign language words
28986 \begin_layout Description
28987 latex Text color in \SpecialChar LaTeX
28991 \begin_layout Description
28992 listingsbg Background color of listings inset
28995 \begin_layout Description
28996 marginlabel Label color for margin notes
28999 \begin_layout Description
29000 math Math inset text color
29003 \begin_layout Description
29004 mathbg Math inset background color
29007 \begin_layout Description
29008 mathcorners Math inset frame color not under focus
29011 \begin_layout Description
29012 mathframe Math inset frame color under focus
29015 \begin_layout Description
29016 mathline Math line color
29019 \begin_layout Description
29020 mathmacrobg Macro math inset background color
29023 \begin_layout Description
29024 mathmacroblend Macro math blended color
29027 \begin_layout Description
29028 mathmacroframe Macro math frame color
29031 \begin_layout Description
29032 mathmacrohoverbg Macro math inset background color hovered
29035 \begin_layout Description
29036 mathmacrolabel Macro math label color
29039 \begin_layout Description
29040 mathmacronewarg Macro template color for new parameters
29043 \begin_layout Description
29044 mathmacrooldarg Macro template color for old parameters
29047 \begin_layout Description
29048 newpage New page color
29051 \begin_layout Description
29052 nonunique_inlinecompletion Inline completion color for the non-unique part
29055 \begin_layout Description
29056 note Label color for notes
29059 \begin_layout Description
29060 notebg Background color of notes
29063 \begin_layout Description
29064 pagebreak Page break/line break color
29067 \begin_layout Description
29068 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29071 \begin_layout Description
29072 phantomtext Text color for phantom insets
29075 \begin_layout Description
29076 preview The color used for previews
29079 \begin_layout Description
29080 previewframe Preview frame color
29083 \begin_layout Description
29084 regexpframe Color for regexp frame
29087 \begin_layout Description
29088 scroll Color that indicates when a row can be scrolled
29091 \begin_layout Description
29092 selection Background color of selected text
29095 \begin_layout Description
29096 selectiontext Foreground color of selected text
29099 \begin_layout Description
29100 shadedbg Background color of shaded box
29103 \begin_layout Description
29104 special Special chars text color
29107 \begin_layout Description
29108 tabularline Table line color
29111 \begin_layout Description
29112 tabularonoffline Table line color
29115 \begin_layout Description
29116 urllabel Label color for URL insets
29119 \begin_layout Description
29120 urltext Color for URL inset text