1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 1
86 \use_package amssymb 1
89 \use_package mathdots 1
90 \use_package mathtools 1
92 \use_package stackrel 1
93 \use_package stmaryrd 1
94 \use_package undertilde 1
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes false
128 \output_changes false
137 Customizing \SpecialChar LyX
138 : Features for the Advanced User
142 by the \SpecialChar LyX
147 \begin_layout Plain Layout
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
152 \begin_inset CommandInset href
154 target "lyx-docs@lists.lyx.org"
162 \begin_inset Quotes eld
166 \begin_inset Quotes erd
169 in the subject header, and please cc the current maintainer of this file,
170 Richard Heck <rgheck@comcast.net>.
176 \begin_inset Newline newline
180 \begin_inset Newline newline
186 \begin_layout Standard
187 \begin_inset CommandInset toc
188 LatexCommand tableofcontents
195 \begin_layout Standard
196 \begin_inset Note Note
199 \begin_layout Plain Layout
200 Please use change tracking when modifying this document.
201 This makes it easier for our translators to recognize things that have
202 been changed, and it helps the maintainer keep up-to-date with what's been
211 \begin_layout Chapter
215 \begin_layout Standard
216 This manual covers the customization features present in \SpecialChar LyX
218 In it, we discuss issues like keyboard shortcuts, screen previewing options,
219 printer options, sending commands to \SpecialChar LyX
220 via the \SpecialChar LyX
221 Server, internationalization,
222 installing new \SpecialChar LaTeX
223 classes and \SpecialChar LyX
225 We can't possibly hope to touch on everything you can change—our developers
226 add new features faster than we can document them—but we will explain the
227 most common customizations and hopefully point you in the right direction
228 for some of the more obscure ones.
231 \begin_layout Standard
232 \begin_inset Branch OutDated
236 \begin_layout Standard
237 Information from previous versions of this document that now seems to be
238 outdated is contained in the OutDated branch of this document.
239 By default, this information will not appear in the \SpecialChar LaTeX
248 \begin_layout Chapter
253 \begin_layout Standard
254 This chapter aims to help you to find your way through the \SpecialChar LyX
257 Before continuing to read this chapter, you should find out where your
259 library and user directories are by using
260 \begin_inset Flex Noun
263 \begin_layout Plain Layout
264 Help\SpecialChar menuseparator
275 The library directory is the place where \SpecialChar LyX
276 places its system-wide configuration
277 files; the user directory is where you can place your modified versions.
278 We will call the former
279 \begin_inset Flex Code
282 \begin_layout Plain Layout
289 \begin_inset Flex Noun
292 \begin_layout Plain Layout
298 in the remainder of this document.
302 \begin_layout Section
304 \begin_inset Flex Code
307 \begin_layout Plain Layout
316 \begin_layout Standard
317 \begin_inset Flex Code
320 \begin_layout Plain Layout
326 and its sub-directories contain a number of files and that can be used
327 to customize \SpecialChar LyX
329 You can change many of these files from within \SpecialChar LyX
331 \begin_inset Flex Noun
334 \begin_layout Plain Layout
335 Tools\SpecialChar menuseparator
342 Most customization that you will want to do in \SpecialChar LyX
343 is possible through this
345 However, many other inner aspects of \SpecialChar LyX
346 can be customized by modifying the
348 \begin_inset Flex Code
351 \begin_layout Plain Layout
358 These files fall in different categories, described in the following subsection
362 \begin_layout Subsection
363 Automatically generated files
366 \begin_layout Standard
367 The files, which are to be found in
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
377 , are generated when you configure \SpecialChar LyX
379 They contain various default values that are guessed by inspection.
380 In general, it is not a good idea to modify them, since they might be overwritt
384 \begin_layout Labeling
385 \labelwidthstring 00.00.0000
386 \begin_inset Flex Code
389 \begin_layout Plain Layout
395 contains defaults for various commands.
398 \begin_layout Labeling
399 \labelwidthstring 00.00.0000
400 \begin_inset Flex Code
403 \begin_layout Plain Layout
409 contains the list of packages that have been recognized by \SpecialChar LyX
411 It is currently unused by the \SpecialChar LyX
412 program itself, but the information extracted,
413 and more, is made available with
414 \begin_inset Flex Noun
417 \begin_layout Plain Layout
418 Help\SpecialChar menuseparator
432 \begin_layout Labeling
433 \labelwidthstring 00.00.0000
434 \begin_inset Flex Code
437 \begin_layout Plain Layout
443 the list of text classes that have been found in your
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
453 directories, along with the associated \SpecialChar LaTeX
454 document class and their description.
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 the list of layout modules found in your
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
481 \begin_layout Labeling
482 \labelwidthstring 00.00.0000
483 \begin_inset Flex Code
486 \begin_layout Plain Layout
492 lists of various sorts of \SpecialChar LaTeX
493 -related files found on your system
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
502 doc/\SpecialChar LaTeX
508 is automatically generated during configuration from the file
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
520 It contains information on your \SpecialChar LaTeX
524 \begin_layout Subsection
528 \begin_layout Standard
529 These directories are duplicated between
530 \begin_inset Flex Code
533 \begin_layout Plain Layout
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 If a particular files exists in both places, the one in
551 \begin_inset Flex Code
554 \begin_layout Plain Layout
563 \begin_layout Labeling
564 \labelwidthstring 00.00.0000
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 this directory contains files with the extension
575 \begin_inset Flex Code
578 \begin_layout Plain Layout
584 that define the keybindings used in \SpecialChar LyX
586 If there exists an internationalized version of the bind file named
587 \begin_inset Flex Code
590 \begin_layout Plain Layout
596 , that will be used first.
599 \begin_layout Labeling
600 \labelwidthstring 00.00.0000
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
610 contains files with the extension
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
620 which define the diverse citation possibilities (natbib, biblatex etc.).
622 \begin_inset CommandInset ref
624 reference "subsec:Cite-Engine-Files"
634 \begin_layout Labeling
635 \labelwidthstring 00.00.0000
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
645 contains graphics files that can be included in documents.
649 \begin_layout Labeling
650 \labelwidthstring 00.00.0000
651 \begin_inset Flex Code
654 \begin_layout Plain Layout
660 contains \SpecialChar LyX
661 documentation files (including the one you are currently reading).
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
673 deserves special attention, as noted above.
674 The internationalized help docs are in subdirectories
675 \begin_inset Flex Code
678 \begin_layout Plain Layout
685 \begin_inset Quotes eld
689 \begin_inset Quotes erd
692 is the ISO language code.
694 \begin_inset CommandInset ref
696 reference "cha:Internationalizing-LyX"
703 \begin_layout Labeling
704 \labelwidthstring 00.00.0000
705 \begin_inset Flex Code
708 \begin_layout Plain Layout
714 contains example files that explain how to use some features.
715 In the file browser, press the
716 \begin_inset Flex Noun
719 \begin_layout Plain Layout
728 \begin_layout Labeling
729 \labelwidthstring 00.00.0000
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
739 contains image files that are used by the
740 \begin_inset Flex Noun
743 \begin_layout Plain Layout
750 In addition, it also contains the individual icons used in the toolbar
751 and the banners that can be shown when \SpecialChar LyX
755 \begin_layout Labeling
756 \labelwidthstring 00.00.0000
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
766 contains keyboard keymapping files.
768 \begin_inset CommandInset ref
770 reference "sec:International-Keymap-Stuff"
777 \begin_layout Labeling
778 \labelwidthstring 00.00.0000
779 \begin_inset Flex Code
782 \begin_layout Plain Layout
788 contains the text class and module files described in
789 \begin_inset CommandInset ref
791 reference "cha:Installing-New-Document"
798 \begin_layout Labeling
799 \labelwidthstring 00.00.0000
800 \begin_inset Flex Code
803 \begin_layout Plain Layout
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
819 Python scripts used to convert between \SpecialChar LyX
821 These can be run from the command line if, say, you want to batch-convert
825 \begin_layout Labeling
826 \labelwidthstring 00.00.0000
827 \begin_inset Flex Code
830 \begin_layout Plain Layout
836 contains some files that demonstrate the capabilities of the
837 \begin_inset Flex Noun
840 \begin_layout Plain Layout
851 Also contains some scripts used by \SpecialChar LyX
855 \begin_layout Labeling
856 \labelwidthstring 00.00.0000
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
866 contains the standard \SpecialChar LyX
867 template files described in
868 \begin_inset CommandInset ref
870 reference "subsec:Creating-Templates"
877 \begin_layout Labeling
878 \labelwidthstring 00.00.0000
879 \begin_inset Flex Code
882 \begin_layout Plain Layout
888 contains files with the extension
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
898 that define the user interface to \SpecialChar LyX
900 That is, the files define which items appear in which menus and the items
901 appearing on the toolbar.
904 \begin_layout Labeling
905 \labelwidthstring 00.00.0000
906 \begin_inset Flex Code
909 \begin_layout Plain Layout
915 contains files with the extension
916 \begin_inset Flex Code
919 \begin_layout Plain Layout
925 which define the templates for the insertion of external material to a
928 \begin_inset CommandInset ref
930 reference "chap:Including-External-Material"
937 \begin_layout Subsection
938 Files you don't want to modify
941 \begin_layout Standard
942 These files are used internally by \SpecialChar LyX
943 and you generally do not need to modify
944 them unless you are a developer.
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
958 this file contains the list of \SpecialChar LyX
960 The contents are displayed with the menu entry
961 \begin_inset Flex Noun
964 \begin_layout Plain Layout
965 Help\SpecialChar menuseparator
978 \begin_layout Labeling
979 \labelwidthstring 00.00.0000
980 \begin_inset Flex Code
983 \begin_layout Plain Layout
989 this is a \SpecialChar LaTeX
990 script used during the configuration process.
994 \begin_layout Labeling
995 \labelwidthstring 00.00.0000
996 \begin_inset Flex Code
999 \begin_layout Plain Layout
1005 this is a Python script that is used to re-configure \SpecialChar LyX
1007 It creates configuration files in the directory it was run from.
1010 \begin_layout Subsection
1011 Other files needing a line or two
1014 \begin_layout Labeling
1015 \labelwidthstring 00.00.0000
1016 \begin_inset Flex Code
1019 \begin_layout Plain Layout
1025 this contains tables describing how different character encodings can be
1029 \begin_layout Labeling
1030 \labelwidthstring 00.00.0000
1031 \begin_inset Flex Code
1034 \begin_layout Plain Layout
1040 this file contains a list of all the languages currently supported by \SpecialChar LyX
1044 \begin_layout Labeling
1045 \labelwidthstring 00.00.0000
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1055 contains information about the supported fonts.
1058 \begin_layout Labeling
1059 \labelwidthstring 00.00.0000
1060 \begin_inset Flex Code
1063 \begin_layout Plain Layout
1069 this file contains translations for internationalized paragraph styles
1071 \begin_inset CommandInset ref
1073 reference "subsec:I18n"
1080 \begin_layout Labeling
1081 \labelwidthstring 00.00.0000
1082 \begin_inset Flex Code
1085 \begin_layout Plain Layout
1091 this file contains information about Unicode-encoded glyphs and the way
1092 they are supported by \SpecialChar LyX
1093 via \SpecialChar LaTeX
1097 \begin_layout Section
1098 Your local configuration directory
1101 \begin_layout Standard
1102 Even if you are using \SpecialChar LyX
1103 as an unprivileged user, you might want to change
1105 configuration for your own use.
1107 \begin_inset Flex Code
1110 \begin_layout Plain Layout
1116 directory contains all your personal configuration files.
1117 This is the directory described as
1118 \begin_inset Quotes eld
1122 \begin_inset Quotes erd
1126 \begin_inset Flex Noun
1129 \begin_layout Plain Layout
1130 Help\SpecialChar menuseparator
1132 \begin_inset space ~
1141 This directory is used as a mirror of
1142 \begin_inset Flex Code
1145 \begin_layout Plain Layout
1151 , which means that every file in
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1161 is a replacement for the corresponding file in
1162 \begin_inset Flex Code
1165 \begin_layout Plain Layout
1172 Any configuration file described in the above sections can be placed either
1173 in the system-wide directory, in which case it will affect all users, or
1174 in your local directory for your own use.
1177 \begin_layout Standard
1178 To make things clearer, let's provide a few examples:
1181 \begin_layout Itemize
1182 The preferences set in the
1183 \begin_inset Flex Noun
1186 \begin_layout Plain Layout
1187 Tools\SpecialChar menuseparator
1193 dialog are saved to a file
1194 \begin_inset Flex Code
1197 \begin_layout Plain Layout
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1216 \begin_layout Itemize
1217 When you reconfigure using
1218 \begin_inset Flex Noun
1221 \begin_layout Plain Layout
1222 Tools\SpecialChar menuseparator
1230 \begin_inset Flex Code
1233 \begin_layout Plain Layout
1239 script, and the resulting files are written in your local configuration
1241 This means that any additional text class file that you might have added
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1252 will be added to the list of classes in the
1253 \begin_inset Flex Noun
1256 \begin_layout Plain Layout
1257 Document\SpecialChar menuseparator
1266 \begin_layout Itemize
1267 If you get some updated documentation from \SpecialChar LyX
1268 ftp site and cannot install
1269 it because you do not have sysadmin rights on your system, you can just
1271 \begin_inset Flex Code
1274 \begin_layout Plain Layout
1280 and the items in the
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1290 menu will open them!
1293 \begin_layout Section
1294 Running \SpecialChar LyX
1295 with multiple configurations
1298 \begin_layout Standard
1299 The configuration freedom of the local configuration directory may not suffice
1300 if you want to have more than one configuration at your disposal.
1301 For example, you may want to be use different key bindings or printer settings
1303 You can achieve this by having several such directories.
1304 You then specify which directory to use at run-time.
1307 \begin_layout Standard
1308 Invoking \SpecialChar LyX
1309 with the command line switch
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1323 instructs the program to read the configuration from that directory, and
1324 not from the default directory.
1325 (You can determine the default directory by running \SpecialChar LyX
1327 \begin_inset Flex Code
1330 \begin_layout Plain Layout
1336 switch.) If the specified directory does not exist, \SpecialChar LyX
1338 for you, just like it does for the default directory on the first time
1339 you run the program.
1340 You can modify the configuration options in this additional user directory
1341 exactly as you would for the default directory.
1342 These directories are completely independent (but read on).
1343 Note that setting the environment variable
1344 \begin_inset Flex Code
1347 \begin_layout Plain Layout
1353 to some value has exactly the same effect.
1356 \begin_layout Standard
1357 Having several configurations also requires more maintenance: if you want
1358 to add a new layout to
1359 \begin_inset Flex Code
1362 \begin_layout Plain Layout
1368 which you want available from all your configurations, you must add it
1369 to each directory separately.
1370 You can avoid this with the following trick: after \SpecialChar LyX
1371 creates the additional
1372 directory, most of the subdirectories (see above) are empty.
1373 If you want the new configuration to mirror an existing one, replace the
1374 empty subdirectory with a symbolic link to the matching subdirectory in
1375 the existing configuration.
1377 \begin_inset Flex Code
1380 \begin_layout Plain Layout
1386 subdirectory, however, since it contains a file written by the configuration
1387 script (also accessible through
1388 \begin_inset Flex Noun
1391 \begin_layout Plain Layout
1392 Tools\SpecialChar menuseparator
1398 ) which is configuration-specific.
1401 \begin_layout Chapter
1402 The Preferences dialog
1405 \begin_layout Standard
1406 All options of the preferences dialog are described in the Appendix
1408 The Preferences Dialog
1415 For some options you might find here more details.
1418 \begin_layout Section
1420 \begin_inset CommandInset label
1429 \begin_layout Standard
1430 The first step is to define your file formats if they are not already defined.
1432 \begin_inset Flex Noun
1435 \begin_layout Plain Layout
1436 Tools\SpecialChar menuseparator
1444 \begin_inset Flex Noun
1447 \begin_layout Plain Layout
1448 File Handling\SpecialChar menuseparator
1455 \begin_inset Flex Noun
1458 \begin_layout Plain Layout
1464 button to define your new format.
1466 \begin_inset Flex Noun
1469 \begin_layout Plain Layout
1475 field contains the name used to identify the format in the GUI.
1477 \begin_inset Flex Noun
1480 \begin_layout Plain Layout
1486 is used to identify the format internally.
1487 You will also need to enter a file extension.
1488 These are all required.
1490 \begin_inset Flex Noun
1493 \begin_layout Plain Layout
1499 field is used to provide a keyboard shortcut on the menus.
1500 (For example, pressing
1501 \begin_inset Flex Noun
1504 \begin_layout Plain Layout
1511 \begin_inset Flex Noun
1514 \begin_layout Plain Layout
1515 Document\SpecialChar menuseparator
1516 View (Other Formats)\SpecialChar menuseparator
1525 \begin_layout Standard
1527 \begin_inset Flex Noun
1530 \begin_layout Plain Layout
1537 \begin_inset Flex Noun
1540 \begin_layout Plain Layout
1547 For example, you might want to use
1548 \begin_inset Flex Noun
1551 \begin_layout Plain Layout
1557 to view PostScript files.
1558 You can enter the command needed to start the program in the corresponding
1560 In defining this command, you can use the four variables listed in the
1562 The viewer is launched when you view an image in \SpecialChar LyX
1564 \begin_inset Flex Noun
1567 \begin_layout Plain Layout
1568 Document\SpecialChar menuseparator
1575 The editor is for example launched when you right-click on an image and
1577 \begin_inset Flex Noun
1580 \begin_layout Plain Layout
1586 in the appearing context menu.
1589 \begin_layout Standard
1591 \begin_inset Flex Noun
1594 \begin_layout Plain Layout
1600 type of a format is optional, but if it is specified, it must be unique
1602 It is used to detect files of this format from the file contents.
1603 For some important file formats there is no MIME type officially registered
1605 \begin_inset CommandInset href
1608 target "http://www.iana.org/assignments/media-types/"
1614 Therefore \SpecialChar LyX
1615 uses the extended list of MIME types as specified by
1616 \begin_inset CommandInset href
1618 name "freedesktop.org"
1619 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1627 \begin_layout Standard
1629 \begin_inset Flex Noun
1632 \begin_layout Plain Layout
1638 option tells \SpecialChar LyX
1639 that a format is suitable for document export.
1640 If this is set and if a suitable conversion route exists (see
1641 \begin_inset CommandInset ref
1643 reference "sec:Converters"
1647 ), the format will appear in the
1648 \begin_inset Flex Noun
1651 \begin_layout Plain Layout
1652 File\SpecialChar menuseparator
1659 The format will also appear in the
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1664 Document\SpecialChar menuseparator
1670 menu if a viewer is specified for the format.
1671 Pure image formats, such as
1672 \begin_inset Flex Code
1675 \begin_layout Plain Layout
1681 , should not use this option.
1682 Formats that can both represent vector graphics and documents like
1683 \begin_inset Flex Code
1686 \begin_layout Plain Layout
1695 \begin_layout Standard
1697 \begin_inset Flex Noun
1700 \begin_layout Plain Layout
1701 Vector graphics format
1706 tells \SpecialChar LyX
1707 that a format can contain vector graphics.
1708 This information is used to determine the target format of included graphics
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1720 Included graphics may need to be converted to either
1721 \begin_inset Flex Noun
1724 \begin_layout Plain Layout
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1751 \begin_inset Flex Noun
1754 \begin_layout Plain Layout
1760 cannot handle other image formats.
1761 If an included graphic is not already in
1762 \begin_inset Flex Noun
1765 \begin_layout Plain Layout
1772 \begin_inset Flex Noun
1775 \begin_layout Plain Layout
1782 \begin_inset Flex Noun
1785 \begin_layout Plain Layout
1791 format, it is converted to
1792 \begin_inset Flex Noun
1795 \begin_layout Plain Layout
1801 if the vector format option is set, and otherwise to
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1814 \begin_layout Section
1818 \begin_layout Standard
1819 Since all conversions from one format to another take place in \SpecialChar LyX
1821 directory, it is sometimes necessary to modify a file before copying it
1822 to the temporary directory in order that the conversion may be performed.
1826 \begin_layout Plain Layout
1827 For example, the file may refer to other files—images, for example—using
1828 relative file names, and these may become invalid when the file is copied
1829 to the temporary directory.
1834 This is done by a Copier: It copies a file to (or from) the temporary directory
1835 and may modify it in the process.
1838 \begin_layout Standard
1839 The definitions of the copiers may use eight variables:
1842 \begin_layout Labeling
1843 \labelwidthstring 00.00.0000
1844 \begin_inset Flex Code
1847 \begin_layout Plain Layout
1853 The \SpecialChar LyX
1854 system directory (e.
1855 \begin_inset space \thinspace{}
1859 \begin_inset space \space{}
1863 \begin_inset Flex Noun
1866 \begin_layout Plain Layout
1875 \begin_layout Labeling
1876 \labelwidthstring 00.00.0000
1877 \begin_inset Flex Code
1880 \begin_layout Plain Layout
1889 \begin_layout Labeling
1890 \labelwidthstring 00.00.0000
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1903 \begin_layout Labeling
1904 \labelwidthstring 00.00.0000
1905 \begin_inset Flex Code
1908 \begin_layout Plain Layout
1914 The base name (without filename extension) in the \SpecialChar LyX
1918 \begin_layout Labeling
1919 \labelwidthstring 00.00.0000
1920 \begin_inset Flex Code
1923 \begin_layout Plain Layout
1929 The full directory path of the \SpecialChar LyX
1933 \begin_layout Labeling
1934 \labelwidthstring 00.00.0000
1935 \begin_inset Flex Code
1938 \begin_layout Plain Layout
1944 The full pathname to the original \SpecialChar LyX
1945 file being processed
1948 \begin_layout Labeling
1949 \labelwidthstring 00.00.0000
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1959 The filename (without any directory path) of the \SpecialChar LyX
1963 \begin_layout Labeling
1964 \labelwidthstring 00.00.0000
1965 \begin_inset Flex Code
1968 \begin_layout Plain Layout
1974 The `\SpecialChar LaTeX
1978 \begin_layout Standard
1979 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1987 It is relevant only when exporting files suitable for such inclusion.
1990 \begin_layout Standard
1991 Copiers can be used to do almost anything with output files.
1992 For example, suppose you want generated pdf files to be copied to a special
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
2004 Then you could write a shell script such as this one:
2007 \begin_layout Standard
2008 \begin_inset listings
2012 \begin_layout Plain Layout
2017 \begin_layout Plain Layout
2022 \begin_layout Plain Layout
2024 TOFILE=`basename $2`
2027 \begin_layout Plain Layout
2029 cp $FROMFILE /home/you/pdf/$TOFILE
2034 Save it in your local \SpecialChar LyX
2036 \begin_inset Flex Code
2039 \begin_layout Plain Layout
2040 /home/you/.lyx/scripts/pdfcopier.sh
2045 —and make it executable, if you need to do so on your platform.
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2051 Tools\SpecialChar menuseparator
2057 dialog, select under
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 File Handling\SpecialChar menuseparator
2069 \begin_inset Flex Noun
2072 \begin_layout Plain Layout
2078 format—or one of the other pdf formats—and enter
2079 \begin_inset Flex Code
2082 \begin_layout Plain Layout
2083 pdfcopier.sh $$i $$o
2089 \begin_inset Flex Noun
2092 \begin_layout Plain Layout
2102 \begin_layout Standard
2103 Copiers are used by \SpecialChar LyX
2104 in various of its own conversions.
2105 For example, if appropriate programs are found, \SpecialChar LyX
2106 will automatically install
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2118 \begin_inset Flex Noun
2121 \begin_layout Plain Layout
2123 \begin_inset space ~
2132 When these formats are exported, the copier sees that not just the main
2133 HTML file but various associated files (style files, images, etc.) are also
2135 All these files are written to a subdirectory of the directory in which
2136 the original \SpecialChar LyX
2141 \begin_layout Plain Layout
2142 This copier can be customized.
2144 \begin_inset Quotes eld
2148 \begin_inset Quotes erd
2151 argument takes a comma-separated list of extensions to be copied; if it
2152 is omitted, all files will be copied.
2154 \begin_inset Quotes eld
2158 \begin_inset Quotes erd
2161 argument determines the extension added to the generated directory.
2163 \begin_inset Quotes eld
2167 \begin_inset Flex Noun
2170 \begin_layout Plain Layout
2177 \begin_inset Quotes erd
2180 , so HTML generated from
2181 \begin_inset Flex Noun
2184 \begin_layout Plain Layout
2185 /path/to/filename.lyx
2191 \begin_inset Flex Noun
2194 \begin_layout Plain Layout
2195 /path/to/filename.html.LyXconv
2209 \begin_layout Section
2211 \begin_inset CommandInset label
2213 name "sec:Converters"
2220 \begin_layout Standard
2221 You can define your own Converters to convert files between different formats.
2223 \begin_inset Flex Noun
2226 \begin_layout Plain Layout
2227 Tools\SpecialChar menuseparator
2228 Preferences\SpecialChar menuseparator
2229 File Handling\SpecialChar menuseparator
2238 \begin_layout Standard
2239 To define a new converter, select the
2240 \begin_inset Flex Noun
2243 \begin_layout Plain Layout
2245 \begin_inset space ~
2254 \begin_inset Flex Noun
2257 \begin_layout Plain Layout
2259 \begin_inset space ~
2267 from the drop-down lists, enter the command needed for the conversion,
2269 \begin_inset Flex Noun
2272 \begin_layout Plain Layout
2279 Several variables can be used in the definition of converters:
2282 \begin_layout Labeling
2283 \labelwidthstring 00.00.0000
2284 \begin_inset Flex Code
2287 \begin_layout Plain Layout
2293 The \SpecialChar LyX
2297 \begin_layout Labeling
2298 \labelwidthstring 00.00.0000
2299 \begin_inset Flex Code
2302 \begin_layout Plain Layout
2311 \begin_layout Labeling
2312 \labelwidthstring 00.00.0000
2313 \begin_inset Flex Code
2316 \begin_layout Plain Layout
2325 \begin_layout Labeling
2326 \labelwidthstring 00.00.0000
2327 \begin_inset Flex Code
2330 \begin_layout Plain Layout
2336 The base filename of the input file (i.
2337 \begin_inset space \thinspace{}
2340 g., without the extension)
2343 \begin_layout Labeling
2344 \labelwidthstring 00.00.0000
2345 \begin_inset Flex Code
2348 \begin_layout Plain Layout
2354 The path to the input file
2357 \begin_layout Labeling
2358 \labelwidthstring 00.00.0000
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2368 The path to the original input file (this is different from $$p when a
2369 chain of converters is called)
2372 \begin_layout Labeling
2373 \labelwidthstring 00.00.0000
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2383 The iconv name for the encoding of the document.
2386 \begin_layout Standard
2388 \begin_inset Flex Noun
2391 \begin_layout Plain Layout
2393 \begin_inset space ~
2401 field you can enter the following flags, separated by commas:
2404 \begin_layout Labeling
2405 \labelwidthstring 00.00.0000
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2415 This converter runs some form of \SpecialChar LaTeX
2417 This will make \SpecialChar LyX
2418 's \SpecialChar LaTeX
2419 error logs available.
2422 \begin_layout Labeling
2423 \labelwidthstring 00.00.0000
2424 \begin_inset Flex Code
2427 \begin_layout Plain Layout
2433 Needs the \SpecialChar LaTeX
2435 \begin_inset Flex Noun
2438 \begin_layout Plain Layout
2444 file for the conversion.
2447 \begin_layout Labeling
2448 \labelwidthstring 00.00.0000
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2459 \begin_inset Quotes eld
2463 \begin_inset Quotes erd
2466 file from the backend, which in practice means a \SpecialChar LaTeX
2467 file like the one we
2468 would export, without
2469 \begin_inset Flex Code
2472 \begin_layout Plain Layout
2481 \begin_layout Labeling
2482 \labelwidthstring 00.00.0000
2483 \begin_inset Flex Code
2486 \begin_layout Plain Layout
2495 \begin_layout Standard
2496 The following three flags are not really flags at all because they take
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2503 \begin_inset space ~
2507 \begin_inset space ~
2518 \begin_layout Labeling
2519 \labelwidthstring 00.00.0000
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2529 If set, the converter's standard error will be redirected to a file
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2539 , and the script given as argument will be run as:
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2544 script < infile.out > infile.log
2550 The argument may contain
2551 \begin_inset Flex Code
2554 \begin_layout Plain Layout
2563 \begin_layout Labeling
2564 \labelwidthstring 00.00.0000
2565 \begin_inset Flex Code
2568 \begin_layout Plain Layout
2574 The name of the directory in which the converter will dump the generated
2577 will not create this directory, and it does not copy anything into it,
2578 though it will copy this directory to the destination.
2579 The argument may contain
2580 \begin_inset Flex Code
2583 \begin_layout Plain Layout
2589 , which will be replaced by the base name of the input and output files,
2590 respectively, when the directory is copied.
2591 \begin_inset Newline newline
2594 Note that resultdir and usetempdir make no sense together.
2595 The latter will be ignored if the former is given.
2598 \begin_layout Labeling
2599 \labelwidthstring 00.00.0000
2600 \begin_inset Flex Code
2603 \begin_layout Plain Layout
2609 Determines the output file name and may, contain
2610 \begin_inset Flex Code
2613 \begin_layout Plain Layout
2620 Sensible only with resultdir and optional even then; if not given, it defaults
2624 \begin_layout Standard
2625 None of these last three are presently used in any of the converters that
2626 are installed with \SpecialChar LyX
2631 \begin_layout Standard
2632 You do not have to define converters for all formats between which you want
2634 For example, you will note that there is no `\SpecialChar LyX
2635 to PostScript' converter,
2636 but \SpecialChar LyX
2637 will export PostScript.
2638 It does so by first creating a \SpecialChar LaTeX
2639 file (no converter needs to be defined
2640 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2642 and finally converting the resulting DVI file to PostScript.
2644 finds such `chains' of converters automatically, and it will always choose
2645 the shortest possible chain.
2646 You can, though, still define multiple conversion methods between file
2648 For example, the standard \SpecialChar LyX
2649 configuration provides five ways to convert
2654 \begin_layout Enumerate
2656 \begin_inset Flex Noun
2659 \begin_layout Plain Layout
2668 \begin_layout Enumerate
2669 via (DVI and) PostScript, using
2670 \begin_inset Flex Noun
2673 \begin_layout Plain Layout
2682 \begin_layout Enumerate
2684 \begin_inset Flex Noun
2687 \begin_layout Plain Layout
2696 \begin_layout Enumerate
2698 \begin_inset Flex Noun
2701 \begin_layout Plain Layout
2711 \begin_layout Enumerate
2713 \begin_inset Flex Noun
2716 \begin_layout Plain Layout
2726 \begin_layout Standard
2727 To define such alternate chains, you must define multiple target `file formats',
2729 \begin_inset CommandInset ref
2731 reference "sec:Formats"
2736 For example, in the standard configuration, the formats named
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2757 \begin_inset Flex Noun
2760 \begin_layout Plain Layout
2767 \begin_inset Flex Noun
2770 \begin_layout Plain Layout
2777 \begin_inset Flex Noun
2780 \begin_layout Plain Layout
2787 \begin_inset Flex Noun
2790 \begin_layout Plain Layout
2797 \begin_inset Flex Noun
2800 \begin_layout Plain Layout
2807 \begin_inset Flex Noun
2810 \begin_layout Plain Layout
2818 \begin_inset Flex Noun
2821 \begin_layout Plain Layout
2828 \begin_inset Flex Noun
2831 \begin_layout Plain Layout
2838 ) are defined, all of which share the extension
2839 \begin_inset Flex Noun
2842 \begin_layout Plain Layout
2848 , and which correspond to the conversion methods just mentioned.
2851 \begin_layout Chapter
2852 Internationalizing \SpecialChar LyX
2854 \begin_inset CommandInset label
2856 name "cha:Internationalizing-LyX"
2863 \begin_layout Standard
2865 supports using a translated interface.
2866 Last time we checked, \SpecialChar LyX
2867 provided text in thirty languages.
2868 The language of choice is called your
2873 (For further reading on locale settings, see also the documentation for
2874 locale that comes with your operating system.
2875 For Linux, the manual page for
2876 \begin_inset Flex Code
2879 \begin_layout Plain Layout
2885 could be a good place to start).
2888 \begin_layout Standard
2889 Notice that these translations will work, but do contain a few flaws.
2890 In particular, all dialogs have been designed with the English text in
2891 mind, which means that some of the translated text will be too large to
2892 fit within the space allocated.
2893 This is only a display problem and will not cause any harm.
2894 Also, you will find that some of the translations do not define shortcut
2895 keys for everything.
2896 Sometimes, there are simply not enough free letters to do it.
2897 Other times, the translator just hasn't got around to doing it yet.
2898 Our localization team, which you may wish to join,
2902 \begin_layout Plain Layout
2903 If you are a fluent speaker of a language other than English, joining these
2904 teams is a great way to give back to the \SpecialChar LyX
2910 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2914 \begin_layout Section
2915 Translating \SpecialChar LyX
2919 \begin_layout Subsection
2920 Translating the graphical user interface (text messages).
2923 \begin_layout Standard
2926 \begin_inset Flex Code
2929 \begin_layout Plain Layout
2935 library to handle the internationalization of the interface.
2936 To have \SpecialChar LyX
2937 speak your favorite language in all menus and dialogs, you need
2939 \begin_inset Flex Code
2942 \begin_layout Plain Layout
2948 -file for that language.
2949 When this is available, you'll have to generate a
2950 \begin_inset Flex Code
2953 \begin_layout Plain Layout
2959 -file from it and install the
2960 \begin_inset Flex Code
2963 \begin_layout Plain Layout
2970 The process of doing all of this is explained in the documentation for
2972 \begin_inset Flex Code
2975 \begin_layout Plain Layout
2982 It is possible to do this just for yourself, but if you're going to do
2983 it, you might as well share the results of your labors with the rest of
2984 the \SpecialChar LyX
2986 Send a message to the \SpecialChar LyX
2987 developers' list for more information about how
2991 \begin_layout Standard
2992 In short, this is what you should do (xx denotes the language code):
2995 \begin_layout Itemize
2996 Check out the \SpecialChar LyX
2999 \begin_inset CommandInset href
3001 name "information on the web"
3002 target "http://www.lyx.org/HowToUseGIT"
3010 \begin_layout Itemize
3012 \begin_inset Flex Code
3015 \begin_layout Plain Layout
3021 to the folder of the
3022 \begin_inset Flex Code
3025 \begin_layout Plain Layout
3033 \begin_inset Flex Code
3036 \begin_layout Plain Layout
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3053 doesn't exist anywhere, it can be remade with the console command
3054 \begin_inset Flex Code
3057 \begin_layout Plain Layout
3063 in that directory, or you can use an existing po-file for some other language
3067 \begin_layout Itemize
3069 \begin_inset Flex Code
3072 \begin_layout Plain Layout
3082 \begin_layout Plain Layout
3083 This is just a text file, so it can be edited in any text editor.
3084 But there are also specialized programs that support such editing, such
3089 (for all platforms) or
3098 contains a `mode' for editing
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3109 \begin_inset Flex URL
3112 \begin_layout Plain Layout
3114 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3126 For some menu- and widget-labels, there are also shortcut keys that should
3128 Those keys are marked after a `|', and should be translated according to
3129 the words and phrases of the language.
3130 You should also fill also out the information at the beginning of the new
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3141 -file with your email-address, etc., so people know where to reach you with
3142 suggestions and entertaining flames.
3145 \begin_layout Standard
3146 If you are just doing this on your own, then:
3149 \begin_layout Itemize
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3161 This can be done with
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3166 msgfmt -o xx.mo < xx.po
3174 \begin_layout Itemize
3176 \begin_inset Flex Code
3179 \begin_layout Plain Layout
3185 -file to your locale-tree, at the correct directory for application messages
3190 xx, and under the name
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3201 \begin_inset space \thinspace{}
3205 \begin_inset space \space{}
3209 \begin_inset Flex Code
3212 \begin_layout Plain Layout
3213 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3223 \begin_layout Standard
3224 As said, however, it would be best if the new
3225 \begin_inset Flex Code
3228 \begin_layout Plain Layout
3234 file could be added to the \SpecialChar LyX
3235 distribution, so others can use it.
3236 Adding it involves making additional changes to \SpecialChar LyX
3238 So send an email to the developers' mailing list if you're interested in
3242 \begin_layout Subsubsection
3246 \begin_layout Standard
3247 Sometimes it turns out that one English message needs to be translated into
3248 different messages in the target language.
3249 One example is the message
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3259 which has the German translation
3267 , depending upon exactly what the English
3268 \begin_inset Quotes eld
3272 \begin_inset Quotes erd
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3286 does not handle such ambiguous translations.
3287 Therefore you have to add some context information to the message: Instead
3289 \begin_inset Flex Code
3292 \begin_layout Plain Layout
3299 \begin_inset Flex Code
3302 \begin_layout Plain Layout
3303 To[[as in 'From format x to format y']]
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3313 To[[as in 'From page x to page y']].
3318 Now the two occurrences of
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3338 and can be translated correctly to
3349 \begin_layout Standard
3350 Of course the context information needs to be stripped off the original
3351 message when no translation is used.
3352 Therefore you have to put it in double square brackets at the end of the
3353 message (see the example above).
3354 The translation mechanism of \SpecialChar LyX
3355 ensures that everything in double square
3356 brackets at the end of messages is removed before displaying the message.
3359 \begin_layout Subsection
3360 Translating the documentation.
3363 \begin_layout Standard
3364 The online documentation (in the
3365 \begin_inset Flex Noun
3368 \begin_layout Plain Layout
3374 -menu) can (and should!) be translated.
3375 If there are translated versions of the documentation available
3379 \begin_layout Plain Layout
3380 As of March 2008, at least some of the documents have been translated into
3381 fourteen languages, with the Tutorial available in a few more.
3386 and the locale is set accordingly, these will be used automagically by
3390 looks for translated versions as
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3395 LyXDir/doc/xx/DocName.lyx
3401 \begin_inset Flex Code
3404 \begin_layout Plain Layout
3410 is the code for the language currently in use.
3411 If there are no translated documents, the default English versions will
3413 Note that the translated versions must have the same filenames (
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3423 above) as the original.
3424 If you feel up to translating the documentation (an excellent way to proof-read
3425 the original documentation by the way!), there are a few things you should
3429 \begin_layout Itemize
3430 Check out the documentation translation web page at
3431 \begin_inset CommandInset href
3433 name "http://www.lyx.org/Translation"
3434 target "http://www.lyx.org/Translation"
3440 That way, you can find out which (if any) documents have already been translate
3441 d into your language.
3442 You can also find out who (if anyone) is organizing the effort to translate
3443 the documentation into your language.
3444 If no one is organizing the effort, please let us know that you're interested.
3447 \begin_layout Standard
3448 Once you get to actually translating, here's a few hints for you that may
3452 \begin_layout Itemize
3453 Join the documentation team! There is information on how to do that in
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3464 \begin_inset Flex Noun
3467 \begin_layout Plain Layout
3468 Help\SpecialChar menuseparator
3474 ), which by the way is the first document you should translate.
3477 \begin_layout Itemize
3478 Learn the typographic conventions for the language you are translating to.
3479 Typography is an ancient art and over the centuries, a great variety of
3480 conventions have developed throughout different parts of the world.
3481 Also study the professional terminology amongst typographers in your country.
3482 Inventing your own terminology will only confuse the users.
3485 (Warning! Typography is addictive!)
3488 \begin_layout Itemize
3489 Make a copy of the document.
3490 This will be your working copy.
3491 You can use this as your personal translated help-file by placing it in
3493 \begin_inset Flex Code
3496 \begin_layout Plain Layout
3503 \begin_inset Note Greyedout
3506 \begin_layout Plain Layout
3511 For a complex document with external material (images, etc.), if you make
3513 \begin_inset space \thinspace{}
3517 \begin_inset space \space{}
3520 in a temp dir, beware that the links to external material may be broken
3521 when the document is moved to a different place.
3522 The best way is to retrieve the \SpecialChar LyX
3524 \begin_inset Flex URL
3527 \begin_layout Plain Layout
3529 http://www.lyx.org/HowToUseGIT
3534 ) and to edit the doc file in place.
3542 \begin_layout Itemize
3543 Sometimes the original document (from the \SpecialChar LyX
3544 team) will be updated.
3545 Use the source viewer at
3546 \begin_inset CommandInset href
3548 name "http://www.lyx.org/trac/timeline"
3549 target "http://www.lyx.org/trac/timeline"
3554 to see what has been changed.
3555 That way you can easily see which parts of the translated document need
3559 \begin_layout Standard
3560 If you ever find an error in the original document, fix it and notify the
3561 rest of the documentation team of the changes! (You didn't forget to join
3562 the documentation team, did you?)
3565 \begin_layout Standard
3566 \begin_inset Branch OutDated
3570 \begin_layout Section
3571 International Keyboard Support
3574 \begin_layout Standard
3577 [Editor's Note: The following section is by
3585 It needs to be fixed to conform to the new Documentation Style sheet and
3586 to make use of the new v1.0 features.
3587 The whole thing also needs to be merged with the section following it.-jw
3588 It may also be badly out of date.-rh (2008)]
3591 \begin_layout Subsection
3592 Defining Own Keymaps: Keymap File Format
3595 \begin_layout Standard
3596 Let's look at a keyboard definition file a little closer.
3597 It is a plain text file defining
3600 \begin_layout Itemize
3601 key-to-key or key-to-string translations
3604 \begin_layout Itemize
3608 \begin_layout Itemize
3609 dead keys exceptions
3612 \begin_layout Standard
3613 To define key-to-key or key-to-string translation, use this command:
3616 \begin_layout Quotation
3617 \begin_inset Flex Code
3620 \begin_layout Plain Layout
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3641 \begin_layout Standard
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3652 is the key to be translated and
3653 \begin_inset Flex Code
3656 \begin_layout Plain Layout
3662 is the string to be inserted into the document.
3663 To define dead keys, use:
3666 \begin_layout Quotation
3667 \begin_inset Flex Code
3670 \begin_layout Plain Layout
3679 \begin_inset Flex Code
3682 \begin_layout Plain Layout
3691 \begin_layout Standard
3693 \begin_inset Flex Code
3696 \begin_layout Plain Layout
3702 is a keyboard key and
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3713 The following dead keys are supported (shortcut name is in parentheses):
3716 \begin_layout Quotation
3720 \begin_inset space \hfill{}
3726 \begin_layout Quotation
3728 \begin_inset space \hfill{}
3734 \begin_layout Quotation
3736 \begin_inset space \hfill{}
3742 \begin_layout Quotation
3744 \begin_inset space \hfill{}
3750 \begin_layout Quotation
3752 \begin_inset space \hfill{}
3758 \begin_layout Quotation
3760 \begin_inset space \hfill{}
3767 \begin_layout Plain Layout
3779 \begin_layout Quotation
3781 \begin_inset space \hfill{}
3787 \begin_layout Quotation
3789 \begin_inset space \hfill{}
3796 \begin_layout Plain Layout
3808 \begin_layout Quotation
3810 \begin_inset space \hfill{}
3816 \begin_layout Quotation
3818 \begin_inset space \hfill{}
3824 \begin_layout Quotation
3826 \begin_inset space \hfill{}
3833 \begin_layout Plain Layout
3845 \begin_layout Quotation
3847 \begin_inset space \hfill{}
3854 \begin_layout Plain Layout
3866 \begin_layout Quotation
3868 \begin_inset space \hfill{}
3874 \begin_layout Quotation
3875 hungarian umlaut (hug)
3876 \begin_inset space \hfill{}
3882 \begin_layout Quotation
3884 \begin_inset space \hfill{}
3890 \begin_layout Quotation
3892 \begin_inset space \hfill{}
3899 \begin_layout Plain Layout
3911 \begin_layout Standard
3912 Since in many international keyboards there are exceptions to what some
3913 dead keys should do, you can define them using
3916 \begin_layout Quotation
3917 \begin_inset Flex Code
3920 \begin_layout Plain Layout
3928 deadkey key outstring
3931 \begin_layout Standard
3932 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3936 \begin_layout Quotation
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3953 \begin_layout Standard
3954 to make it work correctly.
3955 Also, you have to define as exceptions dead keys over i and j, to remove
3956 the dot from them before inserting an accent mark.
3957 I will change this when the time comes, but so far I haven't had time.
3960 \begin_layout Standard
3961 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3964 \begin_inset Flex Code
3967 \begin_layout Plain Layout
3973 have different meaning.
3975 \begin_inset Flex Code
3978 \begin_layout Plain Layout
3984 marks comments, quotes start and end \SpecialChar LaTeX
3986 To enter quote, you'll need to use
3987 \begin_inset Flex Code
3990 \begin_layout Plain Layout
3999 \begin_inset Flex Code
4002 \begin_layout Plain Layout
4009 \begin_inset Flex Code
4012 \begin_layout Plain Layout
4023 \begin_layout Standard
4024 If you make a keyboard description file that works for your language, please
4025 mail it to me, so I can include it in the next keymap distribution.
4028 \begin_layout Standard
4029 More keywords will be supported in keymap configuration file in future,
4033 \begin_layout Itemize
4034 \begin_inset Flex Code
4037 \begin_layout Plain Layout
4048 \begin_inset space \hfill{}
4052 \begin_inset Flex Code
4055 \begin_layout Plain Layout
4064 \begin_layout Itemize
4065 \begin_inset Flex Code
4068 \begin_layout Plain Layout
4079 \begin_inset space \hfill{}
4083 \begin_inset Flex Code
4086 \begin_layout Plain Layout
4092 an external keymap translation program
4095 \begin_layout Standard
4096 Also, it should look into
4097 \begin_inset Flex Code
4100 \begin_layout Plain Layout
4106 file for defaults, too (for example, a
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4118 option to include default keyboard).
4126 \begin_layout Section
4127 International Keymap Stuff
4128 \begin_inset CommandInset label
4130 name "sec:International-Keymap-Stuff"
4137 \begin_layout Standard
4138 \begin_inset Note Note
4141 \begin_layout Plain Layout
4142 In doing the revisions on this document in March 2008, I did not look over
4143 this stuff, as I do not understand it.
4144 It would be good if someone else could do so.
4153 \begin_layout Standard
4154 The next two sections describe the
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4178 file syntax in detail.
4179 These sections should help you design your own key map if the ones provided
4180 do not meet your needs.
4183 \begin_layout Subsection
4187 \begin_layout Standard
4191 \begin_inset Flex Code
4194 \begin_layout Plain Layout
4200 file maps keystrokes to characters or strings.
4201 As the name suggests, it sets a keyboard mapping.
4203 \begin_inset Flex Code
4206 \begin_layout Plain Layout
4217 \begin_inset Flex Code
4220 \begin_layout Plain Layout
4235 \begin_inset Flex Code
4238 \begin_layout Plain Layout
4251 \begin_inset Flex Code
4254 \begin_layout Plain Layout
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4274 are described in this section.
4277 \begin_layout Labeling
4278 \labelwidthstring 00.00.0000
4279 \begin_inset Flex Code
4282 \begin_layout Plain Layout
4290 Map a character to a string
4293 \begin_layout LyX-Code
4308 \begin_layout Standard
4341 the double-quote (")
4358 must be escaped with a preceding backslash (
4369 \begin_layout Standard
4371 \begin_inset Flex Noun
4374 \begin_layout Plain Layout
4382 statement to cause the symbol
4383 \begin_inset Flex Noun
4386 \begin_layout Plain Layout
4394 to be output for the keystroke
4395 \begin_inset Flex Noun
4398 \begin_layout Plain Layout
4409 \begin_layout LyX-Code
4415 \begin_layout Labeling
4416 \labelwidthstring 00.00.0000
4417 \begin_inset Flex Code
4420 \begin_layout Plain Layout
4428 Specify an accent character
4431 \begin_layout LyX-Code
4440 \begin_layout Standard
4441 This will make the cha
4479 This is the dead key
4483 \begin_layout Plain Layout
4490 refers to a key that does not produce a character by itself, but when followed
4491 with another key, produces the desired accent character.
4492 For example, a German characte
4494 r with an umlaut like
4504 can be produced in this manner.
4513 \begin_layout Standard
4526 and then another key not in
4543 followed by the other, not allowed key, as output.
4547 \begin_inset Flex Noun
4550 \begin_layout Plain Layout
4558 cancels a dead key, so if
4569 \begin_inset Flex Noun
4572 \begin_layout Plain Layout
4581 , the cursor will not go one position backwards but will instead cancel
4597 might have had on the next keystroke.
4601 \begin_layout Standard
4602 The following example specifies that the character ' is to be an acute accent,
4603 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4606 \begin_layout LyX-Code
4609 kmod ' acute aeiouAEIOU
4612 \begin_layout Labeling
4613 \labelwidthstring 00.00.0000
4614 \begin_inset Flex Code
4617 \begin_layout Plain Layout
4623 Specify an exception to the accent character
4626 \begin_layout LyX-Code
4635 \begin_layout Standard
4636 This defines an exce
4677 have been assigned a keystroke with a previous
4680 \begin_inset Flex Code
4683 \begin_layout Plain Layout
4707 must not belong in the
4754 If such a declaration does not exist in
4762 \begin_inset Flex Code
4765 \begin_layout Plain Layout
4799 \begin_inset Flex Code
4802 \begin_layout Plain Layout
4816 \begin_layout Standard
4817 The following command produces causes äi to be produced when you enter acute-i
4821 \begin_layout LyX-Code
4835 \begin_layout Labeling
4836 \labelwidthstring 00.00.0000
4837 \begin_inset Flex Code
4840 \begin_layout Plain Layout
4846 Combine two accent characters
4849 \begin_layout LyX-Code
4855 accent1 accent2 allowed
4858 \begin_layout Standard
4859 This one is getting pretty esoteric.
4860 It allows you to combine the effect
4916 \begin_inset Flex Code
4919 \begin_layout Plain Layout
4947 \begin_layout Standard
4948 Consider this example from the
4949 \begin_inset Flex Code
4952 \begin_layout Plain Layout
4963 \begin_layout LyX-Code
4966 kmod ; acute aeioyvhAEIOYVH
4970 kcomb acute umlaut iyIY
4973 \begin_layout Standard
4974 This allows you to press
4975 \begin_inset Flex Noun
4978 \begin_layout Plain Layout
4986 and get the effect of
4987 \begin_inset Flex Code
4990 \begin_layout Plain Layout
5009 in this case cancels the last dead key, so if you press
5010 \begin_inset Flex Noun
5013 \begin_layout Plain Layout
5022 \begin_inset Flex Code
5025 \begin_layout Plain Layout
5038 \begin_layout Subsection
5042 \begin_layout Standard
5044 \begin_inset Flex Code
5047 \begin_layout Plain Layout
5055 mapping is performed, a
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5069 file maps the strings that the symbols generate to characters in the current
5071 The \SpecialChar LyX
5072 distribution currently includes at least the
5073 \begin_inset Flex Code
5076 \begin_layout Plain Layout
5085 \begin_inset Flex Code
5088 \begin_layout Plain Layout
5099 \begin_layout Standard
5101 \begin_inset Flex Code
5104 \begin_layout Plain Layout
5112 file is a sequence of declarations of the form
5115 \begin_layout LyX-Code
5128 \begin_layout Standard
5129 For example, in order to map
5130 \begin_inset Flex Noun
5133 \begin_layout Plain Layout
5143 to the corresponding character in the iso-8859-1 set (233), the following
5147 \begin_layout LyX-Code
5155 \begin_layout Standard
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5169 \begin_inset Flex Code
5172 \begin_layout Plain Layout
5190 the same character can apply to more than one string.
5192 \begin_inset Flex Code
5195 \begin_layout Plain Layout
5206 \begin_layout LyX-Code
5218 \begin_inset Newline newline
5234 \begin_layout Standard
5236 cannot find a mapping for the string produced by the keystroke or a
5237 deadkey sequence, it will check if it looks like an accented char and try
5238 to draw an accent over the character on screen.
5241 \begin_layout Subsection
5245 \begin_layout Standard
5246 There is a second way to add support for international characters through
5247 so-called dead-keys.
5248 A dead-key works in combination with a letter to produce an accented character.
5249 Here, we'll explain how to create a really simple dead-key to illustrate
5253 \begin_layout Standard
5254 Suppose you happen to need the circumflex character,
5255 \begin_inset Quotes eld
5259 \begin_inset Quotes erd
5264 \begin_inset Flex Noun
5267 \begin_layout Plain Layout
5274 \begin_inset space ~
5278 \begin_inset Flex Noun
5281 \begin_layout Plain Layout
5287 ] to the \SpecialChar LyX
5289 \begin_inset Flex Code
5292 \begin_layout Plain Layout
5299 \begin_inset Flex Code
5302 \begin_layout Plain Layout
5309 Now, whenever you type the
5310 \begin_inset Flex Noun
5313 \begin_layout Plain Layout
5319 -key followed by a letter, that letter will have a circumflex accent on
5321 For example, the sequence
5322 \begin_inset Quotes eld
5326 \begin_inset Flex Noun
5329 \begin_layout Plain Layout
5336 \begin_inset Quotes erd
5339 produces the letter:
5340 \begin_inset Quotes eld
5344 \begin_inset Quotes erd
5348 If you tried to type
5349 \begin_inset Quotes eld
5353 \begin_inset Flex Noun
5356 \begin_layout Plain Layout
5363 \begin_inset Quotes erd
5366 , however, \SpecialChar LyX
5367 will complain with a beep, since a
5368 \begin_inset Quotes eld
5372 \begin_inset Flex Noun
5375 \begin_layout Plain Layout
5382 \begin_inset Quotes erd
5385 never takes a circumflex accent.
5387 \begin_inset Flex Noun
5390 \begin_layout Plain Layout
5396 after a dead-key produces the bare-accent.
5397 Please note this last point! If you bind a key to a dead-key, you'll need
5398 to rebind the character on that key to yet another key.
5400 \begin_inset Flex Noun
5403 \begin_layout Plain Layout
5409 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5412 \begin_layout Standard
5413 One common way to bind dead-keys is to use
5414 \begin_inset Flex Noun
5417 \begin_layout Plain Layout
5424 \begin_inset Flex Noun
5427 \begin_layout Plain Layout
5434 \begin_inset Flex Noun
5437 \begin_layout Plain Layout
5443 in combination with an accent, like
5444 \begin_inset Quotes eld
5448 \begin_inset Flex Noun
5451 \begin_layout Plain Layout
5458 \begin_inset Quotes erd
5462 \begin_inset Quotes eld
5466 \begin_inset Flex Noun
5469 \begin_layout Plain Layout
5476 \begin_inset Quotes erd
5480 \begin_inset Quotes eld
5484 \begin_inset Flex Noun
5487 \begin_layout Plain Layout
5494 \begin_inset Quotes erd
5498 Another way involves using
5499 \begin_inset Flex Code
5502 \begin_layout Plain Layout
5509 \begin_inset Flex Code
5512 \begin_layout Plain Layout
5518 to set up the special
5519 \begin_inset Flex Code
5522 \begin_layout Plain Layout
5530 \begin_inset Flex Code
5533 \begin_layout Plain Layout
5539 acts in some ways just like
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5549 and permits you to bind keys to accented characters.
5550 You can also turn keys into dead-keys by binding them to something like
5552 \begin_inset Flex Code
5555 \begin_layout Plain Layout
5561 and then binding this symbolic key to the corresponding \SpecialChar LyX
5566 \begin_layout Plain Layout
5571 : This is exactly what I do in my
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5582 \begin_inset Flex Code
5585 \begin_layout Plain Layout
5593 \begin_inset Flex Noun
5596 \begin_layout Plain Layout
5598 \begin_inset space ~
5607 \begin_inset Flex Code
5610 \begin_layout Plain Layout
5616 and a bunch of these
5617 \begin_inset Quotes eld
5621 \begin_inset Flex Code
5624 \begin_layout Plain Layout
5631 \begin_inset Quotes erd
5634 symbolic keys bound such things as
5635 \begin_inset Flex Noun
5638 \begin_layout Plain Layout
5640 \begin_inset space ~
5649 \begin_inset Flex Noun
5652 \begin_layout Plain Layout
5654 \begin_inset space ~
5663 This is how I produce my accented characters.
5668 You can make just about anything into the
5669 \begin_inset Flex Code
5672 \begin_layout Plain Layout
5679 \begin_inset Flex Noun
5682 \begin_layout Plain Layout
5688 keys, a spare function key, etc.
5689 As for the \SpecialChar LyX
5690 commands that produce accents, check the entry for
5691 \begin_inset Flex Code
5694 \begin_layout Plain Layout
5705 You'll find the complete list there.
5708 \begin_layout Subsection
5709 Saving your Language Configuration
5712 \begin_layout Standard
5713 You can edit your preferences so that your desired language environment
5714 is automatically configured when \SpecialChar LyX
5716 \begin_inset Flex Noun
5719 \begin_layout Plain Layout
5720 Edit\SpecialChar menuseparator
5729 \begin_layout Chapter
5730 Installing New Document Classes, Layouts, and Templates
5731 \begin_inset CommandInset label
5733 name "cha:Installing-New-Document"
5738 \begin_inset Argument 1
5741 \begin_layout Plain Layout
5742 Installing New Document Classes
5750 \begin_layout Standard
5751 In this chapter, we describe the procedures for creating and installing
5752 new \SpecialChar LyX
5753 layout and template files, as well as offer a refresher on correctly
5754 installing new \SpecialChar LaTeX
5759 \begin_layout Standard
5760 First, let us a say a few words about how one ought to think about the relation
5761 between \SpecialChar LyX
5762 and \SpecialChar LaTeX
5764 The thing to understand is that, in a certain sense, \SpecialChar LyX
5765 doesn't know anything
5766 about \SpecialChar LaTeX
5768 Indeed, from \SpecialChar LyX
5769 's point of view, \SpecialChar LaTeX
5770 is just one of several
5771 \begin_inset Quotes eld
5775 \begin_inset Quotes erd
5778 in which it is capable of producing output.
5779 Other such formats are DocBook, plaintext, and XHTML.
5781 is, of course, a particularly important format, but very little of the
5782 information \SpecialChar LyX
5783 has about \SpecialChar LaTeX
5784 is actually contained in the program itself.
5788 \begin_layout Plain Layout
5789 Some commands are sufficiently complex that they are
5790 \begin_inset Quotes eld
5794 \begin_inset Quotes erd
5797 into \SpecialChar LyX
5799 But the developers generally regard this as a Bad Thing.
5804 Rather, that information, even for the standard classes like
5805 \begin_inset Flex Code
5808 \begin_layout Plain Layout
5814 , is contained in `layout files'.
5815 Similarly, \SpecialChar LyX
5816 itself does not know much about DocBook or XHTML.
5817 What it knows is contained in layout files.
5820 \begin_layout Standard
5821 You can think of the layout file for a given document class as a translation
5822 manual between \SpecialChar LyX
5823 constructs—paragraphs with their corresponding styles,
5824 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5827 Almost everything \SpecialChar LyX
5829 \begin_inset Flex Code
5832 \begin_layout Plain Layout
5838 , for example, is contained in the file
5839 \begin_inset Flex Code
5842 \begin_layout Plain Layout
5848 and in various other files it includes.
5849 For this reason, anyone intending to write layout files should plan to
5850 study the existing files.
5851 A good place to start is with
5852 \begin_inset Flex Code
5855 \begin_layout Plain Layout
5861 , which is included in
5862 \begin_inset Flex Code
5865 \begin_layout Plain Layout
5872 \begin_inset Flex Code
5875 \begin_layout Plain Layout
5881 , and many of the other layout files for document classes.
5882 This file is where sections and the like are defined:
5883 \begin_inset Flex Code
5886 \begin_layout Plain Layout
5892 tells \SpecialChar LyX
5893 how paragraphs that are marked with the Section, Subsection, etc,
5894 styles can be translated into corresponding \SpecialChar LaTeX
5895 , DocBook, and XHTML commands
5898 \begin_inset Flex Code
5901 \begin_layout Plain Layout
5907 file basically just includes several of these
5908 \begin_inset Flex Code
5911 \begin_layout Plain Layout
5920 \begin_layout Standard
5921 Defining the \SpecialChar LyX
5923 correspondence is not the only thing layout files do, though.
5924 Their other job is to define how the \SpecialChar LyX
5925 constructs themselves will appear
5927 The fact that layout files have these two jobs is often a source of confusion,
5928 because they are completely separate.
5929 Telling \SpecialChar LyX
5930 how to translate a certain paragraph style into \SpecialChar LaTeX
5933 how to display it; conversely, telling \SpecialChar LyX
5934 how to display a certain paragraph
5935 style does not tell \SpecialChar LyX
5936 how to translate it into \SpecialChar LaTeX
5937 (let alone tell \SpecialChar LaTeX
5940 So, in general, when you define a new \SpecialChar LyX
5941 construct, you must always do two
5942 quite separate things: (i)
5943 \begin_inset space ~
5946 tell \SpecialChar LyX
5947 how to translate it into \SpecialChar LaTeX
5949 \begin_inset space ~
5952 tell \SpecialChar LyX
5956 \begin_layout Standard
5957 Much the same is true, of course, as regards \SpecialChar LyX
5958 's other backend formats, though
5959 XHTML is in some ways different, because in that case \SpecialChar LyX
5964 able, to some extent, to use information about how it should display a
5965 paragraph on the screen to output information (in the form of CSS) about
5966 how the paragraph should be displayed in a browser.
5967 Even in this case, however, the distinction between what \SpecialChar LyX
5969 and how things are rendered externally remains in force, and the two can
5970 be controlled separately.
5972 \begin_inset CommandInset ref
5974 reference "sec:Tags-for-XHTML"
5981 \begin_layout Section
5982 Installing new \SpecialChar LaTeX
5986 \begin_layout Standard
5987 Some installations may not include a \SpecialChar LaTeX
5988 package or class file that you would
5989 like to use within \SpecialChar LyX
5991 For example, you might need Foil\SpecialChar TeX
5992 , a package for preparing slides for overhead
5994 Modern \SpecialChar LaTeX
5995 distributions like \SpecialChar TeX
5996 Live (2008 or newer) or MiK\SpecialChar TeX
5997 provide a user interface
5998 for installing such packages.
5999 For example, with MiK\SpecialChar TeX
6000 , you start the program
6001 \begin_inset Quotes eld
6005 \begin_inset space ~
6009 \begin_inset Quotes erd
6012 to get a list of available packages.
6013 To install one of them, right click on it or use the corresponding toolbar
6017 \begin_layout Standard
6018 If your \SpecialChar LaTeX
6019 distribution does not provide such a `package manager', or if the
6020 package is not available from your distribution, then follow these steps
6021 to install it manually:
6024 \begin_layout Enumerate
6025 Get the package from
6026 \begin_inset CommandInset href
6029 target "http://www.ctan.org/"
6037 \begin_layout Enumerate
6038 If the package contains a file with the ending
6039 \begin_inset Quotes eld
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6053 \begin_inset Quotes erd
6056 (is the case for Foil\SpecialChar TeX
6057 ) then open a console, change to the folder of this
6058 file and execute the command
6059 \begin_inset Flex Code
6062 \begin_layout Plain Layout
6069 You have now unpacked the package and have all files to install it.
6070 Most \SpecialChar LaTeX
6071 -packages are not packed and you can skip this step.
6074 \begin_layout Enumerate
6075 Now you need to decide if the package should be available for all users
6080 \begin_layout Enumerate
6081 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6082 for all users on your system, then install it in your `local' \SpecialChar TeX
6084 install it in your own `user' \SpecialChar TeX
6086 Where these trees should be created, if they do not already exist, depends
6088 To find this out, look in the file
6089 \begin_inset Flex Code
6092 \begin_layout Plain Layout
6102 \begin_layout Plain Layout
6103 This is usually in the directory
6104 \begin_inset Flex Code
6107 \begin_layout Plain Layout
6113 , though you can execute the command
6114 \begin_inset Flex Code
6117 \begin_layout Plain Layout
6128 The location of the `local' \SpecialChar TeX
6129 tree is defined by the
6130 \begin_inset Flex Code
6133 \begin_layout Plain Layout
6139 variable; this is usually somewhere like
6140 \begin_inset Flex Code
6143 \begin_layout Plain Layout
6144 /usr/local/share/texmf
6149 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6152 The location of the `user' \SpecialChar TeX
6154 \begin_inset Flex Code
6157 \begin_layout Plain Layout
6164 \begin_inset Flex Code
6167 \begin_layout Plain Layout
6174 \begin_inset Flex Code
6177 \begin_layout Plain Layout
6186 (If these variables are not predefined, you have to define them.) You'll
6187 probably need root permissions to create or modify the `local' tree, but
6188 not for your `user' tree.
6189 \begin_inset Newline newline
6192 In general, it is recommended to install in the user tree because your user
6193 will not be modified or even overwritten when you upgrade your system.
6194 It will typically also be backed up together with everything else when
6195 you backup your home directory (which, of course, you do on a regular basis).
6198 \begin_layout Enumerate
6199 On Windows, if you want the new package to be available for all users on
6200 your system, change to the folder where \SpecialChar LaTeX
6201 is installed and then change to
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6217 (For MiK\SpecialChar TeX
6218 , this would be by default the folder
6219 \begin_inset Flex Code
6222 \begin_layout Plain Layout
6240 \begin_layout Plain Layout
6241 Note that this will be the correct path only on English installations.
6242 On a German one, it would be
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6260 , and similarly for other languages.
6265 Create there a new folder
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6275 and copy all files of the package into it.
6277 \begin_inset Newline newline
6280 If the package should only available for you or you don't have admin permissions
6281 , do the same, but in the local \SpecialChar LaTeX
6284 \begin_inset space \thinspace{}
6287 g., for MiK\SpecialChar TeX
6289 \begin_inset space ~
6292 2.8 under Windows XP, this would be the folder:
6293 \begin_inset Newline newline
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6305 Documents and Settings
6317 \begin_inset Newline newline
6323 \begin_inset Phantom HPhantom
6326 \begin_layout Plain Layout
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6353 \begin_inset Newline newline
6356 On Vista, it would be:
6357 \begin_inset Newline newline
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6390 \begin_layout Enumerate
6391 Now one only need to tell \SpecialChar LaTeX
6392 that there are new files.
6393 This depends on the used \SpecialChar LaTeX
6398 \begin_layout Enumerate
6399 For \SpecialChar TeX
6400 Live execute the command
6401 \begin_inset Flex Code
6404 \begin_layout Plain Layout
6411 If you installed the package for all users, then you will probably need
6412 to have root permissions for that.
6415 \begin_layout Enumerate
6416 For MiK\SpecialChar TeX
6417 , if you have installed the package for all users, start the program
6419 \begin_inset Quotes eld
6423 \begin_inset space ~
6427 \begin_inset Quotes erd
6430 and press the button marked
6431 \begin_inset Quotes eld
6435 \begin_inset Quotes erd
6439 Otherwise start the program
6440 \begin_inset Quotes eld
6444 \begin_inset Quotes erd
6451 \begin_layout Enumerate
6452 Finally, you need to tell \SpecialChar LyX
6453 that there are new packages available.
6454 So, in \SpecialChar LyX
6456 \begin_inset Flex Noun
6459 \begin_layout Plain Layout
6462 \SpecialChar menuseparator
6468 and then restart \SpecialChar LyX
6472 \begin_layout Standard
6473 Now the package is installed.
6474 In our example, the document class
6475 \begin_inset Flex Code
6478 \begin_layout Plain Layout
6484 will now be available under
6485 \begin_inset Flex Noun
6488 \begin_layout Plain Layout
6489 Document\SpecialChar menuseparator
6490 Settings\SpecialChar menuseparator
6497 \begin_inset Quotes eld
6501 \begin_inset Quotes erd
6508 \begin_layout Standard
6509 If you would like to use a \SpecialChar LaTeX
6510 document class that is not even listed in the
6512 \begin_inset Flex Noun
6515 \begin_layout Plain Layout
6516 Document\SpecialChar menuseparator
6517 Settings\SpecialChar menuseparator
6523 , then you need to create a `layout' file for it.
6524 That is the topic of the next section.
6527 \begin_layout Section
6528 Types of layout files
6531 \begin_layout Standard
6532 This section describes the various sorts of \SpecialChar LyX
6533 files that contain layout informati
6535 These files describe various paragraph and character styles, determining
6536 how \SpecialChar LyX
6537 should display them and how they should be translated into \SpecialChar LaTeX
6539 XHTML, or whatever output format is being used.
6543 \begin_layout Standard
6544 We shall try to provide a thorough description of the process of writing
6546 However, there are so many different types of documents supported even
6547 by just \SpecialChar LaTeX
6548 that we can't hope to cover every different possibility or problem
6549 you might encounter.
6550 The \SpecialChar LyX
6551 users' list is frequented by people with lots of experience with layout
6552 design who are willing to share what they've learned, so please feel free
6553 to ask questions there.
6556 \begin_layout Standard
6557 As you prepare to write a new layout, it is extremely helpful to look at
6558 the layouts distributed with \SpecialChar LyX
6560 If you write a \SpecialChar LyX
6561 layout for a \SpecialChar LaTeX
6562 document class that might also be used by
6563 others, or write a module that might be useful to others, then you should
6564 consider posting your layout to the
6565 \begin_inset CommandInset href
6567 name "layout section on the LyX wiki"
6568 target "http://wiki.lyx.org/Layouts/Layouts"
6573 or even to the \SpecialChar LyX
6574 developers' list, so that it might be included in \SpecialChar LyX
6579 \begin_layout Plain Layout
6580 Note that \SpecialChar LyX
6581 is licensed under the General Public License, so any material
6582 that is contributed to \SpecialChar LyX
6583 must be similarly licensed.
6591 \begin_layout Subsection
6593 \begin_inset CommandInset label
6595 name "subsec:Layout-modules"
6602 \begin_layout Standard
6603 We have spoken to this point about `layout files'.
6604 But there are different sorts of files that contain layout information.
6605 Layout files, strictly so called, have the
6606 \begin_inset Flex Code
6609 \begin_layout Plain Layout
6615 extension and provide \SpecialChar LyX
6616 with information about document classes.
6617 Since \SpecialChar LyX
6618 1.6 layout information can also be contained in layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6633 Modules are to \SpecialChar LaTeX
6634 packages much as layouts are to \SpecialChar LaTeX
6635 classes, and some modules—such
6637 \begin_inset Flex Code
6640 \begin_layout Plain Layout
6646 module—specifically provide support for one package.
6647 In a sense, layout modules are similar to included
6651 \begin_layout Plain Layout
6652 These can have any extension, but by convention have the
6653 \begin_inset Flex Code
6656 \begin_layout Plain Layout
6668 \begin_inset Flex Code
6671 \begin_layout Plain Layout
6677 —in that modules are not specific to a given document class but may be used
6678 with many different classes.
6679 The difference is that using an included file with
6680 \begin_inset Flex Code
6683 \begin_layout Plain Layout
6689 requires editing that file.
6690 Modules, by contrast, are selected in the
6691 \begin_inset Flex Noun
6694 \begin_layout Plain Layout
6695 Document\SpecialChar menuseparator
6704 \begin_layout Standard
6705 Building modules is the easiest way to get started with layout editing,
6706 since it can be as simple as adding a single new paragraph style or flex
6708 But modules may, in principle, contain anything a layout file can contain.
6711 \begin_layout Standard
6712 After creating a new module and copying it to the
6713 \begin_inset Flex Code
6716 \begin_layout Plain Layout
6722 folder, you will need to reconfigure and then restart \SpecialChar LyX
6725 However, changes you make to the module will be seen immediately, if you
6727 \begin_inset Flex Noun
6730 \begin_layout Plain Layout
6731 Document\SpecialChar menuseparator
6737 , highlight something, and then hit
6738 \begin_inset Quotes eld
6742 \begin_inset Quotes erd
6748 It is strongly recommended that you save your work before doing this
6753 it is strongly recommended that you not attempt to edit modules while simultaneo
6754 usly working on actual documents
6757 Though of course the developers strive to keep \SpecialChar LyX
6758 stable in such situations,
6759 syntax errors and the like in your module file could cause strange behavior.
6762 \begin_layout Subsubsection
6766 \begin_layout Standard
6767 Modules are to \SpecialChar LyX
6768 as packages are to \SpecialChar LaTeX
6770 Sometimes, however, you find yourself wanting a specific inset or character
6771 style just for one document and writing a module that will also be available
6772 to other documents makes little sense.
6773 What you need is \SpecialChar LyX
6775 \begin_inset Quotes eld
6779 \begin_inset Quotes erd
6785 \begin_layout Standard
6786 You will find it under
6788 Document\SpecialChar menuseparator
6789 Settings\SpecialChar menuseparator
6793 The large text box allows you to enter anything that you might enter in
6794 a layout file or module.
6795 You can think of a document's local layout, in fact, as a module that belongs
6797 So, in particular, you must enter a
6798 \begin_inset Flex Code
6801 \begin_layout Plain Layout
6808 Any format is acceptable, but one would normally use the format current
6810 (In \SpecialChar LyX
6811 2.3, the current layout format is 63.)
6814 \begin_layout Standard
6815 When you have entered something in the
6816 \begin_inset Flex Code
6819 \begin_layout Plain Layout
6825 pane, \SpecialChar LyX
6827 \begin_inset Quotes eld
6831 \begin_inset Quotes erd
6834 button at the bottom.
6835 Clicking this button will cause \SpecialChar LyX
6836 to determine whether what you have entered
6837 is valid layout information for the chosen format.
6839 will report the result but, unfortunately, will not tell you what errors
6840 there might have been.
6841 These will be written to the terminal, however, if \SpecialChar LyX
6842 is started from a terminal.
6843 You will not be permitted to save your local layout until you have entered
6847 \begin_layout Standard
6848 The warnings at the end of the previous section apply here, too.
6849 Do not play with local layout while you are actually working, especially
6850 if you have not saved your document.
6851 That said, using local layout with a test document can be a very convenient
6852 way to try out layout ideas, or even to start developing a module.
6855 \begin_layout Subsection
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6869 \begin_layout Standard
6870 There are two situations you are likely to encounter when wanting to support
6871 a new \SpecialChar LaTeX
6872 document class, involving style (
6873 \begin_inset Flex Code
6876 \begin_layout Plain Layout
6882 ) files and \SpecialChar LaTeX2e
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6894 Supporting a style file is usually fairly easy.
6895 Supporting a new class file is a bit harder.
6896 We'll discuss the former in this section and the latter in the next.
6897 Similar remarks apply, of course, if you want to support a new DocBook
6901 \begin_layout Standard
6902 The easier case is the one in which your new document class is provided
6903 as a style file that is to be used in conjunction with an already supported
6905 For the sake of the example, we'll assume that the style file is called
6907 \begin_inset Flex Noun
6910 \begin_layout Plain Layout
6916 and that it is meant to be used with
6917 \begin_inset Flex Noun
6920 \begin_layout Plain Layout
6926 , which is a standard class.
6930 \begin_layout Standard
6931 Start by copying the existing class's layout file into your local directory:
6935 \begin_layout Plain Layout
6936 Of course, which directory is your local directory will vary by platform,
6937 and \SpecialChar LyX
6938 allows you to specify your local directory on startup, too, using
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6957 \begin_layout LyX-Code
6958 cp report.layout ~/.lyx/layouts/myclass.layout
6961 \begin_layout Standard
6963 \begin_inset Flex Code
6966 \begin_layout Plain Layout
6972 and change the line:
6975 \begin_layout LyX-Code
6978 DeclareLaTeXClass{Report (Standard Class)}
6981 \begin_layout Standard
6985 \begin_layout LyX-Code
6988 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6991 \begin_layout Standard
6995 \begin_layout LyX-Code
6997 \begin_inset Newline newline
7003 \begin_inset Newline newline
7009 \begin_layout Standard
7010 near the top of the file.
7013 \begin_layout Standard
7014 Start \SpecialChar LyX
7016 \begin_inset Flex Noun
7019 \begin_layout Plain Layout
7020 Tools\SpecialChar menuseparator
7027 Then restart \SpecialChar LyX
7028 and try creating a new document.
7030 \begin_inset Flex Noun
7033 \begin_layout Plain Layout
7039 " as a document class option in the
7040 \begin_inset Flex Noun
7043 \begin_layout Plain Layout
7044 Document\SpecialChar menuseparator
7051 It is likely that some of the sectioning commands and such in your new
7052 class will work differently from how they worked in the base class—
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7062 in this example—so you can fiddle around with the settings for the different
7063 sections if you wish.
7064 The layout information for sections is contained in
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7074 , but you do not need to copy and change this file.
7075 Instead, you can simply add your changes to your layout file, after the
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7086 , which itself includes
7087 \begin_inset Flex Code
7090 \begin_layout Plain Layout
7097 For example, you might add these lines:
7100 \begin_layout LyX-Code
7104 \begin_layout LyX-Code
7108 \begin_layout LyX-Code
7112 \begin_layout LyX-Code
7116 \begin_layout LyX-Code
7120 \begin_layout Standard
7121 to change the font for chapter headings to sans-serif.
7122 This will override (or, in this case, add to) the existing declaration
7123 for the Chapter style.
7127 \begin_layout Standard
7128 Your new package may also provide commands or environments not present in
7130 In this case, you will want to add these to the layout file.
7132 \begin_inset CommandInset ref
7134 reference "sec:TextClass"
7138 for information on how to do so.
7141 \begin_layout Standard
7143 \begin_inset Flex Noun
7146 \begin_layout Plain Layout
7152 can be used with several different document classes, and even if it cannot,
7153 you might find it easiest just to write a module that you can load with
7155 The simplest possible such module would be:
7158 \begin_layout LyX-Code
7161 DeclareLyXModule{My Class}
7164 \begin_layout LyX-Code
7168 \begin_layout LyX-Code
7169 #Support for myclass.sty.
7172 \begin_layout LyX-Code
7174 \begin_inset Newline newline
7180 \begin_layout LyX-Code
7182 \begin_inset Newline newline
7188 \begin_layout LyX-Code
7190 \begin_inset Newline newline
7196 \begin_inset Newline newline
7202 \begin_layout Standard
7203 A more complex module might modify the behavior of some existing constructs
7204 or define some new ones.
7206 \begin_inset CommandInset ref
7208 reference "sec:TextClass"
7215 \begin_layout Subsection
7217 \begin_inset Flex Noun
7220 \begin_layout Plain Layout
7229 \begin_layout Standard
7230 There are two possibilities here.
7231 One is that the class file is itself based upon an existing document class.
7232 For example, many thesis classes are based upon
7233 \begin_inset Flex Noun
7236 \begin_layout Plain Layout
7243 To see whether yours is, look for a line like
7246 \begin_layout LyX-Code
7252 \begin_layout Standard
7254 If so, then you may proceed largely as in the previous section, though
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7260 Declare\SpecialChar LaTeX
7266 line will be different.
7267 If your new class is
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 and it is based upon
7278 \begin_inset Flex Code
7281 \begin_layout Plain Layout
7287 , then the line should read:
7291 \begin_layout Plain Layout
7292 And it will be easiest if you save the file to
7293 \begin_inset Flex Code
7296 \begin_layout Plain Layout
7303 assumes that the document class has the same name as the layout file.
7312 \begin_layout LyX-Code
7315 DeclareLaTeXClass[thesis,book]{thesis}
7318 \begin_layout Standard
7319 If, on the other hand, the new class is not based upon an existing class,
7320 you will probably have to
7321 \begin_inset Quotes eld
7325 \begin_inset Quotes erd
7329 We strongly suggest copying an existing layout file which uses a similar
7331 class and then modifying it, if you can do so.
7332 At least use an existing file as a starting point so you can find out what
7333 items you need to worry about.
7334 Again, the specifics are covered below.
7337 \begin_layout Subsection
7339 \begin_inset CommandInset label
7341 name "subsec:Creating-Templates"
7348 \begin_layout Standard
7349 Once you have written a layout file for a new document class, you might
7350 want to consider writing a
7355 A template acts as a kind of tutorial for your layout, showing how it might
7356 be used, though containing dummy content.
7357 You can of course look at the various templates included with \SpecialChar LyX
7361 \begin_layout Standard
7362 Templates are created just like usual documents: using \SpecialChar LyX
7364 The only difference is that usual documents contain all possible settings,
7365 including the font scheme and the paper size.
7366 Usually a user doesn't want a template to overwrite his preferred settings
7367 for such parameters.
7368 For that reason, the designer of a template should remove the corresponding
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7393 from the template \SpecialChar LyX
7395 This can be done with any simple text-editor, for example
7396 \begin_inset Flex Code
7399 \begin_layout Plain Layout
7406 \begin_inset Flex Code
7409 \begin_layout Plain Layout
7418 \begin_layout Standard
7419 Put the edited template files you create in
7420 \begin_inset Flex Code
7423 \begin_layout Plain Layout
7429 , copy the ones you use from the global template directory in
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 to the same place, and redefine the template path in the
7440 \begin_inset Flex Noun
7443 \begin_layout Plain Layout
7444 Tools\SpecialChar menuseparator
7445 Preferences\SpecialChar menuseparator
7454 \begin_layout Standard
7455 Note, by the way, that there is a template which has a particular meaning:
7456 \begin_inset Newline linebreak
7460 \begin_inset Flex Code
7463 \begin_layout Plain Layout
7470 This template is loaded every time you create a new document with
7471 \begin_inset Flex Noun
7474 \begin_layout Plain Layout
7475 File\SpecialChar menuseparator
7481 in order to provide useful defaults.
7482 To create this template from inside \SpecialChar LyX
7483 , all you have to do is to open a document
7484 with the correct settings, and use the
7485 \begin_inset Flex Noun
7488 \begin_layout Plain Layout
7489 Save as Document Defaults
7497 \begin_layout Subsection
7498 Upgrading old layout files
7501 \begin_layout Standard
7502 The format of layout files changes with each \SpecialChar LyX
7503 release, so old layout files
7504 need to be converted to the new format.
7506 reads a layout file in an older format, it automatically calls the
7508 \begin_inset Flex Code
7511 \begin_layout Plain Layout
7517 to convert it to a temporary file in current format.
7518 The original file is left untouched.
7519 If you use the layout file often, then, you may want to convert it permanently,
7520 so that \SpecialChar LyX
7521 does not have to do so itself every time.
7522 To do this, you can call the converter manually:
7525 \begin_layout Enumerate
7527 \begin_inset Flex Code
7530 \begin_layout Plain Layout
7537 \begin_inset Flex Code
7540 \begin_layout Plain Layout
7549 \begin_layout Enumerate
7551 \begin_inset Newline newline
7555 \begin_inset Flex Code
7558 \begin_layout Plain Layout
7559 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7565 \begin_inset Newline newline
7569 \begin_inset Flex Code
7572 \begin_layout Plain Layout
7578 is the name of your \SpecialChar LyX
7582 \begin_layout Standard
7583 Note that manual conversion does not affect included files, so these will
7584 have to be converted separately.
7587 \begin_layout Subsection
7588 \begin_inset CommandInset label
7590 name "subsec:Cite-Engine-Files"
7597 \begin_layout Standard
7598 A specific form of layout files are the so-called
7599 \begin_inset Flex Code
7602 \begin_layout Plain Layout
7608 files that are located in the
7609 \begin_inset Flex Code
7612 \begin_layout Plain Layout
7619 Their purpose is to define the specifics of \SpecialChar LaTeX
7620 packages aimed at bibliography
7633 , but also the way how normal Bib\SpecialChar TeX
7634 citations (without additional packages)
7635 are handled in \SpecialChar LyX
7636 is defined in such a file.
7640 \begin_layout Standard
7641 More specifically, it is defined which packages \SpecialChar LyX
7642 needs to load, which citation
7643 commands are available, how these are to be displayed in \SpecialChar LyX
7645 the dialogs, the context menus) as well as in the XHTML and plain text
7647 Furthermore, the files specify available style variants (author-year, numerical
7648 , etc.) and their specifics.
7649 The cite engine files are also used to generate the options that are available
7652 Document\SpecialChar menuseparator
7653 Settings\SpecialChar menuseparator
7654 Bibliography\SpecialChar menuseparator
7660 \begin_layout Standard
7661 Even though a cite engine file is essentially a normal layout file that
7662 could theoretically include any layout information, it usually primarily
7663 includes some specific parameters such as
7664 \begin_inset Flex Code
7667 \begin_layout Plain Layout
7674 \begin_inset Flex Code
7677 \begin_layout Plain Layout
7684 \begin_inset Flex Code
7687 \begin_layout Plain Layout
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7704 The syntax of the latter two is described in
7705 \begin_inset CommandInset ref
7707 reference "subsec:Citation-engine-description"
7715 \begin_inset CommandInset ref
7717 reference "subsec:Citation-format-description"
7721 , as well as in the files themselves.
7724 \begin_layout Section
7725 \begin_inset CommandInset label
7727 name "sec:TextClass"
7731 The layout file format
7734 \begin_layout Standard
7735 The following sections describe how layout files are structured and written.
7736 Our advice is to go slowly, save and test often.
7737 It is really not that hard, except that the multitude of options can become
7738 overwhelming, especially if you try to check out too many at once.
7739 It becomes easier if you use existing layouts of \SpecialChar LyX
7740 as examples/reference
7741 or if you modify an existing layout to your needs.
7744 \begin_layout Standard
7745 Note that all the tags used in layout files are case-insensitive.
7747 \begin_inset Flex Code
7750 \begin_layout Plain Layout
7757 \begin_inset Flex Code
7760 \begin_layout Plain Layout
7767 \begin_inset Flex Code
7770 \begin_layout Plain Layout
7776 are really the same tag.
7777 The possible arguments are printed in brackets after the tag's name.
7778 The default argument is typeset
7779 \begin_inset Flex Code
7782 \begin_layout Plain Layout
7791 If the argument has a data type like
7792 \begin_inset Quotes eld
7796 \begin_inset Quotes erd
7800 \begin_inset Quotes eld
7804 \begin_inset Quotes erd
7807 , the default is shown like this:
7808 \begin_inset Flex Code
7811 \begin_layout Plain Layout
7822 \begin_layout Subsection
7823 The document class declaration and classification
7826 \begin_layout Standard
7827 Lines in a layout file which begin with
7828 \begin_inset Flex Code
7831 \begin_layout Plain Layout
7838 There is one exception to this rule.
7840 \begin_inset Flex Code
7843 \begin_layout Plain Layout
7849 files should begin with lines like:
7852 \begin_layout LyX-Code
7855 #% Do not delete the line below; configure depends on this
7858 \begin_layout LyX-Code
7863 DeclareLaTeXClass{Article (Standard Class)}
7866 \begin_layout LyX-Code
7871 DeclareCategory{Articles}
7874 \begin_layout Standard
7875 The second and third lines are used when you (re)configure \SpecialChar LyX
7877 The layout file is read by the \SpecialChar LaTeX
7879 \begin_inset Flex Code
7882 \begin_layout Plain Layout
7888 , in a special mode where
7889 \begin_inset Flex Code
7892 \begin_layout Plain Layout
7899 The first line is just a \SpecialChar LaTeX
7900 comment, the second one contains the mandatory
7901 declaration of the text class and the third line contains the optional
7902 classification of the class.
7903 If these lines appear in a file named
7904 \begin_inset Flex Code
7907 \begin_layout Plain Layout
7913 , then they define a text class of name
7914 \begin_inset Flex Code
7917 \begin_layout Plain Layout
7923 (the name of the layout file) which uses the \SpecialChar LaTeX
7925 \begin_inset Flex Code
7928 \begin_layout Plain Layout
7934 (the default is to use the same name as the layout).
7936 \begin_inset Quotes eld
7939 Article (Standard Class)
7940 \begin_inset Quotes erd
7943 that appears above is used as a description of the text class in the
7944 \begin_inset Flex Noun
7947 \begin_layout Plain Layout
7948 Document\SpecialChar menuseparator
7956 \begin_inset Quotes eld
7960 \begin_inset Quotes erd
7963 in the example) is also used in the
7964 \begin_inset Flex Noun
7967 \begin_layout Plain Layout
7968 Document\SpecialChar menuseparator
7974 dialog: the text classes are grouped by these categories (which are usually
7975 genres, so typical categories are
7976 \begin_inset Quotes eld
7980 \begin_inset Quotes erd
7984 \begin_inset Quotes eld
7988 \begin_inset Quotes erd
7992 \begin_inset Quotes eld
7996 \begin_inset Quotes erd
8000 \begin_inset Quotes eld
8004 \begin_inset Quotes erd
8008 \begin_inset Quotes eld
8012 \begin_inset Quotes erd
8016 \begin_inset Quotes eld
8020 \begin_inset Quotes erd
8024 If no category has been declared, the class will be put in the
8025 \begin_inset Quotes eld
8029 \begin_inset Quotes erd
8035 \begin_layout Standard
8036 Let's assume that you wrote your own text class that uses the
8037 \begin_inset Flex Code
8040 \begin_layout Plain Layout
8046 document class, but where you changed the appearance of the section headings.
8047 If you put it in a file
8048 \begin_inset Flex Code
8051 \begin_layout Plain Layout
8057 , the header of this file should be:
8060 \begin_layout LyX-Code
8063 #% Do not delete the line below; configure depends on this
8066 \begin_layout LyX-Code
8071 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8074 \begin_layout LyX-Code
8079 DeclareCategory{Articles}
8082 \begin_layout Standard
8083 This declares a text class
8084 \begin_inset Flex Code
8087 \begin_layout Plain Layout
8093 , associated with the \SpecialChar LaTeX
8095 \begin_inset Flex Code
8098 \begin_layout Plain Layout
8105 \begin_inset Quotes eld
8108 Article (with My Own Headings)
8109 \begin_inset Quotes erd
8113 If your text class depends on several packages, you can declare it as:
8116 \begin_layout LyX-Code
8119 #% Do not delete the line below; configure depends on this
8122 \begin_layout LyX-Code
8127 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8130 \begin_layout LyX-Code
8135 DeclareCategory{Articles}
8138 \begin_layout Standard
8139 This indicates that your text class uses the
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8150 Finally, it is also possible to declare classes for DocBook code.
8151 Typical declarations will look like:
8154 \begin_layout LyX-Code
8157 #% Do not delete the line below; configure depends on this
8160 \begin_layout LyX-Code
8165 DeclareDocBookClass[article]{SGML (DocBook Article)}
8168 \begin_layout LyX-Code
8173 DeclareCategory{Articles (DocBook)}
8176 \begin_layout Standard
8177 Note that these declarations can also be given an optional parameter declaring
8178 the name of the document class (but not a list).
8181 \begin_layout Standard
8182 So, to be as explicit as possible, the form of the layout declaration is:
8185 \begin_layout LyX-Code
8190 DeclareLaTeXClass[class,package.sty]{layout description}
8193 \begin_layout LyX-Code
8198 DeclareCategory{category}
8201 \begin_layout Standard
8202 The class need only be specified if the name of the \SpecialChar LaTeX
8204 name of the layout file are different or if there are packages to load.
8205 If the name of the class file is not specified, then \SpecialChar LyX
8207 that it is the same as the name of the layout file.
8210 \begin_layout Standard
8211 When the text class has been modified to your taste, all you have to do
8212 is to copy it either to
8213 \begin_inset Flex Code
8216 \begin_layout Plain Layout
8223 \begin_inset Flex Code
8226 \begin_layout Plain Layout
8233 \begin_inset Flex Noun
8236 \begin_layout Plain Layout
8237 Tools\SpecialChar menuseparator
8243 , exit \SpecialChar LyX
8245 Then your new text class should be available along with the others.
8248 \begin_layout Standard
8249 Once the layout file is installed, you can edit it and see your changes
8250 without having to reconfigure or to restart \SpecialChar LyX
8255 \begin_layout Plain Layout
8256 In versions of \SpecialChar LyX
8257 prior to 1.6, this was not true.
8258 As a result, editing layout files was very time consuming, since you had
8259 constantly to restart \SpecialChar LyX
8265 You can force a reload of the current layout by using the \SpecialChar LyX
8267 \begin_inset Flex Noun
8270 \begin_layout Plain Layout
8277 There is no default binding for this function—though, of course, you can
8278 bind it to a key yourself.
8279 But you will normally use this function simply by entering it in the mini-buffe
8284 \begin_layout Standard
8290 \begin_inset Flex Noun
8293 \begin_layout Plain Layout
8299 is very much an `advanced feature'.
8304 recommended that you save your work before using this function.
8309 recommended that you not attempt to edit layout information while simultaneousl
8310 y working on a document that you care about.
8311 Use a test document.
8312 Syntax errors and the like in your layout file could cause peculiar behavior.
8313 In particular, such errors could cause \SpecialChar LyX
8314 to regard the current layout as
8315 invalid and to attempt to switch to some other layout.
8319 \begin_layout Plain Layout
8320 Really bad syntax errors may even caused \SpecialChar LyX
8322 This is because certain sorts of errors may make \SpecialChar LyX
8333 The \SpecialChar LyX
8334 team strives to keep \SpecialChar LyX
8335 stable in such situations, but safe is better
8340 \begin_layout Plain Layout
8341 While we're giving advice: make regular backups.
8342 And be nice to your mother.
8350 \begin_layout Subsection
8351 The Module declaration
8354 \begin_layout Standard
8355 A module must begin with a line like the following:
8358 \begin_layout LyX-Code
8361 DeclareLyXModule[endnotes.sty]{Endnotes}
8364 \begin_layout Standard
8365 The mandatory argument, in curly brackets, is the name of the module, as
8367 \begin_inset Flex Noun
8370 \begin_layout Plain Layout
8371 Document\SpecialChar menuseparator
8372 Settings\SpecialChar menuseparator
8379 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8381 on which the module depends.
8382 It is also possible to use the form
8383 \begin_inset Flex Noun
8386 \begin_layout Plain Layout
8392 as an optional argument, which declares that the module can only be used
8393 when there exists a conversion chain between the formats `
8394 \begin_inset Flex Code
8397 \begin_layout Plain Layout
8404 \begin_inset Flex Code
8407 \begin_layout Plain Layout
8416 \begin_layout Standard
8417 The module declaration should then be followed by lines like the following:
8421 \begin_layout Plain Layout
8422 Preferably in English if the module should be published with \SpecialChar LyX
8424 This description will appear in the list of messages to be translated and
8425 will be thus translated with the next interface update.
8433 \begin_layout LyX-Code
8437 \begin_layout LyX-Code
8438 #Adds an endnote command, in addition to footnotes.
8442 \begin_layout LyX-Code
8443 #You will need to add
8445 theendnotes in TeX code where you
8448 \begin_layout LyX-Code
8449 #want the endnotes to appear.
8453 \begin_layout LyX-Code
8457 \begin_layout LyX-Code
8458 #Requires: somemodule | othermodule
8461 \begin_layout LyX-Code
8462 #Excludes: badmodule
8465 \begin_layout Standard
8466 The description is used in
8467 \begin_inset Flex Noun
8470 \begin_layout Plain Layout
8471 Document\SpecialChar menuseparator
8472 Settings\SpecialChar menuseparator
8478 to provide the user with information about what the module does.
8480 \begin_inset Flex Code
8483 \begin_layout Plain Layout
8489 line is used to identify other modules with which this one must be used;
8491 \begin_inset Flex Code
8494 \begin_layout Plain Layout
8500 line is used to identify modules with which this one may not be used.
8501 Both are optional, and, as shown, multiple modules should be separated
8502 with the pipe symbol: |.
8503 Note that the required modules are treated disjunctively:
8507 of the required modules must be used.
8512 excluded module may be used.
8513 Note that modules are identified here by their filenames without the
8514 \begin_inset Flex Code
8517 \begin_layout Plain Layout
8525 \begin_inset Flex Code
8528 \begin_layout Plain Layout
8535 \begin_inset Flex Code
8538 \begin_layout Plain Layout
8547 \begin_layout Subsection
8548 The CiteEngine file declaration
8551 \begin_layout Standard
8552 A cite engine file must begin with a line like the following:
8555 \begin_layout LyX-Code
8558 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8561 \begin_layout Standard
8562 The mandatory argument, in curly brackets, is the name of the cite style,
8563 as it should appear in
8564 \begin_inset Flex Noun
8567 \begin_layout Plain Layout
8568 Document\SpecialChar menuseparator
8569 Settings\SpecialChar menuseparator
8576 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8578 on which the cite engine depends.
8581 \begin_layout Standard
8582 The cite engine declaration should then be followed by lines like the following:
8586 \begin_layout Plain Layout
8587 Preferably in English if the module should be published with \SpecialChar LyX
8589 This description will appear in the list of messages to be translated and
8590 will be thus translated with the next interface update.
8598 \begin_layout LyX-Code
8602 \begin_layout LyX-Code
8603 # Biblatex supports many author-year and numerical styles.
8606 \begin_layout LyX-Code
8607 # It is mainly aimed at the Humanities.
8611 \begin_layout LyX-Code
8612 # customizable, fully localized and provides many features
8615 \begin_layout LyX-Code
8616 # that are not possible with BibTeX.
8617 The use of 'biber' as
8620 \begin_layout LyX-Code
8621 # bibliography processor is advised.
8624 \begin_layout LyX-Code
8628 \begin_layout Standard
8629 The description is used in
8630 \begin_inset Flex Noun
8633 \begin_layout Plain Layout
8634 Document\SpecialChar menuseparator
8635 Settings\SpecialChar menuseparator
8641 to provide the user with information about the cite engine.
8644 \begin_layout Subsection
8648 \begin_layout Standard
8649 The first non-comment line of any layout file, included file, or module
8654 contain the file format number:
8657 \begin_layout Description
8658 \begin_inset Flex Code
8661 \begin_layout Plain Layout
8668 \begin_inset Flex Code
8671 \begin_layout Plain Layout
8677 ] The format number of the layout file.
8680 \begin_layout Standard
8681 This tag was introduced with \SpecialChar LyX
8683 \begin_inset space ~
8687 Layout files from older \SpecialChar LyX
8688 versions do not have an explicit file format and
8689 are considered to have
8690 \begin_inset Flex Code
8693 \begin_layout Plain Layout
8695 \begin_inset space ~
8704 The format for the present version of \SpecialChar LyX
8706 But each version of \SpecialChar LyX
8707 is capable of reading earlier versions' layout files,
8708 just as they are capable of reading files produced by earlier versions
8711 There is, however, no provision for converting to earlier formats.
8714 \begin_layout Subsection
8715 \begin_inset CommandInset label
8717 name "subsec:General-text-class"
8721 General text class parameters
8724 \begin_layout Standard
8725 These are general parameters that govern the behavior of an entire document
8731 mean that they must appear in
8732 \begin_inset Flex Code
8735 \begin_layout Plain Layout
8741 files rather than in modules.
8742 A module can contain any layout tag.)
8745 \begin_layout Description
8746 \begin_inset Flex Code
8749 \begin_layout Plain Layout
8755 Adds information that will be output in the
8756 \begin_inset Flex Code
8759 \begin_layout Plain Layout
8765 block when the document is output to XHTML.
8766 Typically, this would be used to output CSS style information, but it can
8767 be used for anything that can appear in
8768 \begin_inset Flex Code
8771 \begin_layout Plain Layout
8779 \begin_inset Quotes eld
8783 \begin_inset Flex Code
8786 \begin_layout Plain Layout
8793 \begin_inset Quotes erd
8799 \begin_layout Description
8800 \begin_inset Flex Code
8803 \begin_layout Plain Layout
8809 Adds information to the document preamble.
8811 \begin_inset Newline newline
8815 \begin_inset Quotes eld
8819 \begin_inset Flex Code
8822 \begin_layout Plain Layout
8829 \begin_inset Quotes erd
8835 \begin_layout Description
8836 \begin_inset Flex Code
8839 \begin_layout Plain Layout
8845 Defines the possibilities for displaying citation references.
8847 \begin_inset CommandInset ref
8849 reference "subsec:Citation-engine-description"
8858 \begin_inset Quotes eld
8862 \begin_inset Flex Code
8865 \begin_layout Plain Layout
8872 \begin_inset Quotes erd
8876 Primarily used in cite engine files (see
8877 \begin_inset CommandInset ref
8879 reference "subsec:Cite-Engine-Files"
8889 \begin_layout Description
8890 \begin_inset Flex Code
8893 \begin_layout Plain Layout
8899 Defines formats for use in the display of bibliographic information.
8901 \begin_inset CommandInset ref
8903 reference "subsec:Citation-format-description"
8909 \begin_inset Quotes eld
8913 \begin_inset Flex Code
8916 \begin_layout Plain Layout
8923 \begin_inset Quotes erd
8927 Primarily used in cite engine files (see
8928 \begin_inset CommandInset ref
8930 reference "subsec:Cite-Engine-Files"
8940 \begin_layout Description
8941 \begin_inset Flex Code
8944 \begin_layout Plain Layout
8951 \begin_inset Flex Code
8954 \begin_layout Plain Layout
8963 \begin_inset Flex Code
8966 \begin_layout Plain Layout
8972 ] Determines whether
8976 or Bib\SpecialChar TeX
8977 is used to generate a Bibliography.
8978 Primarily used in cite engine files (see
8979 \begin_inset CommandInset ref
8981 reference "subsec:Cite-Engine-Files"
8991 \begin_layout Description
8992 \begin_inset Flex Code
8995 \begin_layout Plain Layout
9001 Describes various global options supported by the document class.
9003 \begin_inset CommandInset ref
9005 reference "subsec:ClassOptions"
9011 \begin_inset Quotes eld
9015 \begin_inset Flex Code
9018 \begin_layout Plain Layout
9025 \begin_inset Quotes erd
9031 \begin_layout Description
9032 \begin_inset Flex Code
9035 \begin_layout Plain Layout
9042 \begin_inset Flex Code
9045 \begin_layout Plain Layout
9054 \begin_inset space \thinspace{}
9058 \begin_inset Flex Code
9061 \begin_layout Plain Layout
9067 ] Whether the class should
9071 to having one or two columns.
9072 Can be changed in the
9073 \begin_inset Flex Noun
9076 \begin_layout Plain Layout
9077 Document\SpecialChar menuseparator
9086 \begin_layout Description
9087 \begin_inset Flex Code
9090 \begin_layout Plain Layout
9097 \begin_inset Flex Code
9100 \begin_layout Plain Layout
9106 ] This sequence defines the properties for a counter.
9107 If the counter does not yet exist, it is created; if it does exist, it
9110 \begin_inset Quotes eld
9114 \begin_inset Flex Code
9117 \begin_layout Plain Layout
9124 \begin_inset Quotes erd
9128 \begin_inset Newline newline
9132 \begin_inset CommandInset ref
9134 reference "subsec:Counters"
9138 for details on counters.
9141 \begin_layout Description
9142 \begin_inset Flex Code
9145 \begin_layout Plain Layout
9151 Sets the default font used to display the document.
9153 \begin_inset CommandInset ref
9155 reference "subsec:Font-description"
9159 for how to declare fonts.
9161 \begin_inset Quotes eld
9165 \begin_inset Flex Code
9168 \begin_layout Plain Layout
9175 \begin_inset Quotes erd
9181 \begin_layout Description
9182 \begin_inset Flex Code
9185 \begin_layout Plain Layout
9192 \begin_inset Flex Code
9195 \begin_layout Plain Layout
9201 ] Specifies a module to be included by default with this document class.
9202 The module is specified as filename without the
9203 \begin_inset Flex Code
9206 \begin_layout Plain Layout
9213 The user can still remove the module, but it will be active at the outset.
9214 (This applies only when new files are created, or when this class is chosen
9215 for an existing document.)
9218 \begin_layout Description
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9229 \begin_inset Flex Code
9232 \begin_layout Plain Layout
9238 ] This is the style that will be assigned to new paragraphs, usually
9239 \begin_inset Flex Noun
9242 \begin_layout Plain Layout
9249 This will default to the first defined style if not given, but you are
9250 encouraged to use this directive.
9253 \begin_layout Description
9254 \begin_inset Flex Code
9257 \begin_layout Plain Layout
9264 \begin_inset Flex Code
9267 \begin_layout Plain Layout
9273 ] This tag indicates that the module (which is specified by filename without
9275 \begin_inset Flex Code
9278 \begin_layout Plain Layout
9284 extension) cannot be used with this document class.
9285 This might be used in a journal-specific layout file to prevent, say, the
9287 \begin_inset Flex Code
9290 \begin_layout Plain Layout
9296 module that numbers theorems by section.
9301 be used in a module.
9302 Modules have their own way of excluding other modules (see
9303 \begin_inset CommandInset ref
9305 reference "subsec:Layout-modules"
9312 \begin_layout Description
9313 \begin_inset Flex Code
9316 \begin_layout Plain Layout
9322 Defines a new float.
9324 \begin_inset CommandInset ref
9326 reference "subsec:Floats"
9332 \begin_inset Quotes eld
9336 \begin_inset Flex Code
9339 \begin_layout Plain Layout
9346 \begin_inset Quotes erd
9352 \begin_layout Description
9353 \begin_inset Flex Code
9356 \begin_layout Plain Layout
9362 Sets the information that will be output in the
9363 \begin_inset Flex Code
9366 \begin_layout Plain Layout
9372 block when this document class is output to XHTML.
9373 Note that this will completely override any prior
9374 \begin_inset Flex Code
9377 \begin_layout Plain Layout
9384 \begin_inset Flex Code
9387 \begin_layout Plain Layout
9395 \begin_inset Newline newline
9399 \begin_inset Flex Code
9402 \begin_layout Plain Layout
9408 if you just want to add material to the preamble.) Must end with
9409 \begin_inset Quotes eld
9413 \begin_inset Flex Code
9416 \begin_layout Plain Layout
9423 \begin_inset Quotes erd
9429 \begin_layout Description
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9440 \begin_inset Flex Code
9443 \begin_layout Plain Layout
9449 ] The style to use for the table of contents, bibliography, and so forth,
9450 when the document is output to HTML.
9451 For articles, this should normally be
9452 \begin_inset Flex Code
9455 \begin_layout Plain Layout
9462 \begin_inset Flex Code
9465 \begin_layout Plain Layout
9472 If it is not given, then \SpecialChar LyX
9473 will attempt to figure out which layout to use.
9476 \begin_layout Description
9477 \begin_inset Flex Code
9480 \begin_layout Plain Layout
9487 \begin_inset Flex Code
9490 \begin_layout Plain Layout
9496 ] Modifies the properties of the given counter.
9497 If the counter does not exist, the statement is ignored.
9499 \begin_inset Quotes eld
9503 \begin_inset Flex Code
9506 \begin_layout Plain Layout
9513 \begin_inset Quotes erd
9517 \begin_inset Newline newline
9521 \begin_inset CommandInset ref
9523 reference "subsec:Counters"
9527 for details on counters.
9530 \begin_layout Description
9531 \begin_inset Flex Code
9534 \begin_layout Plain Layout
9541 \begin_inset Flex Code
9544 \begin_layout Plain Layout
9550 ] This allows you to include another layout definition file within yours
9551 to avoid duplicating commands.
9552 Common examples are the standard layout files, for example,
9553 \begin_inset Flex Code
9556 \begin_layout Plain Layout
9562 , which contains most of the basic layouts.
9565 \begin_layout Description
9566 \begin_inset Flex Code
9569 \begin_layout Plain Layout
9576 \begin_inset Flex Code
9579 \begin_layout Plain Layout
9585 ] This section (re-)defines the layout of an inset.
9586 It can be applied to an existing inset or to a new, user-defined inset,
9587 e.g., a new character style.
9589 \begin_inset Quotes eld
9593 \begin_inset Flex Code
9596 \begin_layout Plain Layout
9603 \begin_inset Quotes erd
9607 \begin_inset Newline newline
9611 \begin_inset CommandInset ref
9613 reference "subsec:Flex-insets-and"
9617 for more information.
9621 \begin_layout Description
9622 \begin_inset Flex Code
9625 \begin_layout Plain Layout
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9641 ] A string that indicates the width of the left margin on the screen, for
9643 \begin_inset Quotes eld
9647 \begin_inset Flex Code
9650 \begin_layout Plain Layout
9657 \begin_inset Quotes erd
9661 (Note that this is not a `length', like
9662 \begin_inset Quotes eld
9666 \begin_inset Quotes erd
9672 \begin_layout Description
9673 \begin_inset Flex Code
9676 \begin_layout Plain Layout
9683 \begin_inset Flex Code
9686 \begin_layout Plain Layout
9692 ] An integer that determines the maximal number of names displayed in an
9693 author-year citation before the citation switches to
9694 \begin_inset Quotes eld
9698 \begin_inset Quotes erd
9702 Primarily used in cite engine files (see
9703 \begin_inset CommandInset ref
9705 reference "subsec:Cite-Engine-Files"
9715 \begin_layout Description
9716 \begin_inset Flex Code
9719 \begin_layout Plain Layout
9726 \begin_inset Flex Code
9729 \begin_layout Plain Layout
9735 ] Modifies the properties of the given paragraph style.
9736 If the style does not exist, this section is ignored.
9738 \begin_inset Quotes eld
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9752 \begin_inset Quotes erd
9758 \begin_layout Description
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Flex Code
9772 \begin_layout Plain Layout
9778 ] Deletes an existing counter, usually one defined in an included file.
9781 \begin_layout Description
9782 \begin_inset Flex Code
9785 \begin_layout Plain Layout
9792 \begin_inset Flex Code
9795 \begin_layout Plain Layout
9801 ] Deletes an existing float.
9802 This is particularly useful when you want to suppress a float that has
9803 been defined in an input file.
9806 \begin_layout Description
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9817 \begin_inset Flex Code
9820 \begin_layout Plain Layout
9826 ] Deletes an existing style.
9829 \begin_layout Description
9830 \begin_inset Flex Code
9833 \begin_layout Plain Layout
9840 \begin_inset Flex Code
9843 \begin_layout Plain Layout
9850 \begin_inset Flex Code
9853 \begin_layout Plain Layout
9859 ] Define a new table of contents with type
9860 \begin_inset Flex Code
9863 \begin_layout Plain Layout
9870 \begin_inset Flex Code
9873 \begin_layout Plain Layout
9880 See also the AddToToc commands.
9883 \begin_layout Description
9884 \begin_inset Flex Code
9887 \begin_layout Plain Layout
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9903 ] The file format (as defined in the \SpecialChar LyX
9904 preferences) produced by this document
9906 It is mainly useful when
9907 \begin_inset Flex Code
9910 \begin_layout Plain Layout
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9926 and one wants to define a new type of literate document.
9927 The format is reset to
9928 \begin_inset Quotes eld
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9942 \begin_inset Quotes erd
9946 \begin_inset Quotes eld
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9960 \begin_inset Quotes erd
9963 when the corresponding
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9973 parameter is encountered.
9976 \begin_layout Description
9977 \begin_inset Flex Code
9980 \begin_layout Plain Layout
9987 \begin_inset Flex Code
9990 \begin_layout Plain Layout
10001 \begin_inset Flex Code
10004 \begin_layout Plain Layout
10011 \begin_inset Flex Code
10014 \begin_layout Plain Layout
10020 ] Specifies what sort of output documents using this class will produce.
10023 \begin_layout Description
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10034 \begin_inset Flex Code
10037 \begin_layout Plain Layout
10044 \begin_inset Flex Code
10047 \begin_layout Plain Layout
10053 ] Specifies options, given in the second string, for the package named by
10056 \begin_inset Quotes eld
10060 \begin_inset Flex Code
10063 \begin_layout Plain Layout
10064 PackageOptions natbib square
10070 \begin_inset Quotes erd
10074 \begin_inset Flex Code
10077 \begin_layout Plain Layout
10083 to be loaded with the
10084 \begin_inset Flex Code
10087 \begin_layout Plain Layout
10094 (For \SpecialChar TeX
10095 perts, this causes \SpecialChar LyX
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10103 PassOptionsToPackage{natbib}{square}
10109 \begin_inset Flex Code
10112 \begin_layout Plain Layout
10121 \begin_layout Description
10122 \begin_inset Flex Code
10125 \begin_layout Plain Layout
10132 \begin_inset Flex Code
10135 \begin_layout Plain Layout
10144 \begin_inset Flex Code
10147 \begin_layout Plain Layout
10154 \begin_inset Flex Code
10157 \begin_layout Plain Layout
10163 ] The default pagestyle.
10164 Can be changed in the
10165 \begin_inset Flex Noun
10168 \begin_layout Plain Layout
10169 Document\SpecialChar menuseparator
10178 \begin_layout Description
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10188 Sets the preamble for the \SpecialChar LaTeX
10190 Note that this will completely override any prior
10191 \begin_inset Flex Code
10194 \begin_layout Plain Layout
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10221 if you just want to add material to the preamble.) Must end with
10222 \begin_inset Quotes eld
10226 \begin_inset Flex Code
10229 \begin_layout Plain Layout
10236 \begin_inset Quotes erd
10242 \begin_layout Description
10243 \begin_inset Flex Code
10246 \begin_layout Plain Layout
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10275 \begin_inset space \thinspace{}
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10288 ] Whether the class already provides the feature
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10299 A feature is in general the name of a package (e.
10300 \begin_inset space \thinspace{}
10304 \begin_inset space \space{}
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset space \thinspace{}
10332 \begin_inset space \space{}
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10357 \begin_inset CommandInset ref
10359 reference "chap:List-of-functions"
10363 for the list of features.
10366 \begin_layout Description
10367 \begin_inset Flex Code
10370 \begin_layout Plain Layout
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10386 ] Indicates that this layout provides the functionality of the module mentioned,
10387 which should be specified by the filename without the
10388 \begin_inset Flex Code
10391 \begin_layout Plain Layout
10398 This will typically be used if the layout includes the module directly,
10399 rather than using the
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10409 tag to indicate that it ought to be used.
10410 It could also be used in a module that provided an alternate implementation
10411 of the same functionality.
10414 \begin_layout Description
10415 \begin_inset Flex Code
10418 \begin_layout Plain Layout
10425 \begin_inset Flex Code
10428 \begin_layout Plain Layout
10434 ] Creates a new paragraph style if it does not already exist.
10435 If the style does exist, this section is ignored.
10437 \begin_inset Quotes eld
10441 \begin_inset Flex Code
10444 \begin_layout Plain Layout
10451 \begin_inset Quotes erd
10457 \begin_layout Description
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10477 ] Whether the class requires the feature
10478 \begin_inset Flex Code
10481 \begin_layout Plain Layout
10488 Multiple features must be separated by commas.
10489 Note that you can only request supported features.
10491 \begin_inset CommandInset ref
10493 reference "chap:List-of-functions"
10497 for the list of features.).
10498 If you require a package with specific options, you can additionally use
10500 \begin_inset Flex Code
10503 \begin_layout Plain Layout
10512 \begin_layout Description
10513 \begin_inset Flex Code
10516 \begin_layout Plain Layout
10523 \begin_inset Flex Code
10526 \begin_layout Plain Layout
10532 ] A string that indicates the width of the right margin on the screen, for
10534 \begin_inset Quotes eld
10538 \begin_inset Flex Code
10541 \begin_layout Plain Layout
10548 \begin_inset Quotes erd
10554 \begin_layout Description
10555 \begin_inset Flex Code
10558 \begin_layout Plain Layout
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10574 ] Sets which divisions get numbered.
10576 \begin_inset Newline newline
10580 \begin_inset Flex Code
10583 \begin_layout Plain Layout
10589 counter in \SpecialChar LaTeX
10593 \begin_layout Description
10594 \begin_inset Flex Code
10597 \begin_layout Plain Layout
10604 \begin_inset Flex Code
10607 \begin_layout Plain Layout
10616 \begin_inset space \thinspace{}
10620 \begin_inset Flex Code
10623 \begin_layout Plain Layout
10629 ] Whether the class-default should be printing on one or both sides of the
10631 Can be changed in the
10632 \begin_inset Flex Noun
10635 \begin_layout Plain Layout
10636 Document\SpecialChar menuseparator
10645 \begin_layout Description
10646 \begin_inset Flex Code
10649 \begin_layout Plain Layout
10656 \begin_inset Flex Code
10659 \begin_layout Plain Layout
10665 ] This sequence defines a paragraph style.
10666 If the style does not yet exist, it is created; if it does exist, its parameter
10669 \begin_inset Quotes eld
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10683 \begin_inset Quotes erd
10687 \begin_inset Newline newline
10691 \begin_inset CommandInset ref
10693 reference "subsec:Paragraph-Styles"
10697 for details on paragraph styles.
10700 \begin_layout Description
10701 \begin_inset Flex Code
10704 \begin_layout Plain Layout
10711 \begin_inset Flex Code
10714 \begin_layout Plain Layout
10720 ] The name of the command or environment to be used with
10721 \begin_inset Flex Code
10724 \begin_layout Plain Layout
10733 \begin_layout Description
10734 \begin_inset Flex Code
10737 \begin_layout Plain Layout
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10756 \begin_inset Flex Code
10759 \begin_layout Plain Layout
10765 ] Indicates what kind of markup is used to define the title of a document.
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10776 means that the macro with name
10777 \begin_inset Flex Code
10780 \begin_layout Plain Layout
10786 will be inserted after the last layout which has
10787 \begin_inset Quotes eld
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10796 \begin_inset space ~
10805 \begin_inset Quotes erd
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10819 corresponds to the case where all layouts which have
10820 \begin_inset Quotes eld
10824 \begin_inset Flex Code
10827 \begin_layout Plain Layout
10829 \begin_inset space ~
10838 \begin_inset Quotes erd
10841 should be enclosed into the
10842 \begin_inset Flex Code
10845 \begin_layout Plain Layout
10854 \begin_layout Description
10855 \begin_inset Flex Code
10858 \begin_layout Plain Layout
10865 \begin_inset Flex Code
10868 \begin_layout Plain Layout
10874 ] Sets which divisions are included in the table of contents.
10876 \begin_inset Flex Code
10879 \begin_layout Plain Layout
10885 counter in \SpecialChar LaTeX
10889 \begin_layout Subsection
10890 \begin_inset Flex Code
10893 \begin_layout Plain Layout
10900 \begin_inset CommandInset label
10902 name "subsec:ClassOptions"
10909 \begin_layout Standard
10911 \begin_inset Flex Code
10914 \begin_layout Plain Layout
10920 section can contain the following entries:
10923 \begin_layout Description
10924 \begin_inset Flex Code
10927 \begin_layout Plain Layout
10934 \begin_inset Flex Code
10937 \begin_layout Plain Layout
10943 ] The list of available font sizes for the document's main font, separated
10945 \begin_inset Quotes eld
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10959 \begin_inset Quotes erd
10965 \begin_layout Description
10966 \begin_inset Flex Code
10969 \begin_layout Plain Layout
10975 Used to set the DTD line with XML-based output classes.
10977 \begin_inset space \thinspace{}
10981 \begin_inset Quotes eld
10984 -//OASIS//DTD DocBook V4.2//EN
10985 \begin_inset Quotes erd
10991 \begin_layout Description
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
11002 \begin_inset Flex Code
11005 \begin_layout Plain Layout
11006 string="empty|plain|headings|fancy"
11011 ] The list of available page sty\SpecialChar softhyphen
11013 \begin_inset Quotes eld
11017 \begin_inset Flex Code
11020 \begin_layout Plain Layout
11027 \begin_inset Quotes erd
11033 \begin_layout Description
11034 \begin_inset Flex Code
11037 \begin_layout Plain Layout
11044 \begin_inset Flex Code
11047 \begin_layout Plain Layout
11053 ] Some document class options, separated by a comma, that will be added
11054 to the optional part of the
11055 \begin_inset Flex Code
11058 \begin_layout Plain Layout
11069 \begin_layout Standard
11071 \begin_inset Flex Code
11074 \begin_layout Plain Layout
11080 section must end with
11081 \begin_inset Quotes eld
11085 \begin_inset Flex Code
11088 \begin_layout Plain Layout
11095 \begin_inset Quotes erd
11101 \begin_layout Subsection
11103 \begin_inset CommandInset label
11105 name "subsec:Paragraph-Styles"
11112 \begin_layout Standard
11113 A paragraph style description looks like this:
11117 \begin_layout Plain Layout
11118 Note that this will either define a new style or modify an existing one.
11126 \begin_layout LyX-Code
11133 \begin_layout LyX-Code
11137 \begin_layout LyX-Code
11141 \begin_layout Standard
11142 where the following commands are allowed:
11145 \begin_layout Description
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11165 =""] This paragraph will appear in the table of contents of the given type.
11166 An empty string disables.
11167 See also the OutlinerName and the IsTocCaption commands.
11171 \begin_layout Description
11172 \begin_inset Flex Code
11175 \begin_layout Plain Layout
11182 \begin_inset Flex Code
11185 \begin_layout Plain Layout
11190 , left, right, center
11195 ] Paragraph alignment.
11198 \begin_layout Description
11199 \begin_inset Flex Code
11202 \begin_layout Plain Layout
11209 \begin_inset Flex Code
11212 \begin_layout Plain Layout
11217 , left, right, center
11222 ] A comma separated list of permitted alignments.
11223 (Some \SpecialChar LaTeX
11224 styles prohibit certain alignments, since those wouldn't make sense.
11225 For example a right-aligned or centered enumeration isn't possible.)
11228 \begin_layout Description
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11248 ] Defines argument number <int> of a command\SpecialChar breakableslash
11249 environment associated with
11251 This is useful for things like section headings, and only makes sense with
11254 Every (optional or required) argument of a command or environment – except
11255 for the required argument that is associated with the content of the paragraph
11256 itself – has a separate definition, where the number specifies the order
11258 The definition must end with
11259 \begin_inset Flex Code
11262 \begin_layout Plain Layout
11269 So a command with two optional arguments has:
11273 \begin_layout Quote
11279 \begin_layout Quote
11285 \begin_layout Quote
11291 \begin_layout Quote
11297 \begin_layout Quote
11303 \begin_layout Quote
11309 \begin_layout Standard
11311 \begin_inset Flex Code
11314 \begin_layout Plain Layout
11320 definition, the following specifications are possible:
11323 \begin_layout Itemize
11324 \begin_inset Flex Code
11327 \begin_layout Plain Layout
11334 \begin_inset Flex Code
11337 \begin_layout Plain Layout
11343 The string that will appear both in the menu (to insert this argument)
11344 and on the argument inset button (unless you also specify a separate
11345 \begin_inset Flex Code
11348 \begin_layout Plain Layout
11355 For the menu, you can define an accelerator by appending the respective
11356 character to the string, divided by
11357 \begin_inset Quotes eld
11361 \begin_inset Quotes erd
11365 \begin_inset space \thinspace{}
11369 \begin_inset space \space{}
11373 \begin_inset Quotes eld
11377 \begin_inset Flex Code
11380 \begin_layout Plain Layout
11387 \begin_inset Quotes erd
11393 \begin_layout Itemize
11394 \begin_inset Flex Code
11397 \begin_layout Plain Layout
11404 \begin_inset Flex Code
11407 \begin_layout Plain Layout
11413 A separate string for the menu.
11414 You can define an accelerator by appending the respective character to
11415 the string, divided by
11416 \begin_inset Quotes eld
11420 \begin_inset Quotes erd
11424 \begin_inset space \thinspace{}
11428 \begin_inset space \space{}
11432 \begin_inset Quotes eld
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11446 \begin_inset Quotes erd
11450 This specification is optional.
11451 If it is not given the
11452 \begin_inset Flex Code
11455 \begin_layout Plain Layout
11461 will be used instead for the menu.
11464 \begin_layout Itemize
11465 \begin_inset Flex Code
11468 \begin_layout Plain Layout
11475 \begin_inset Flex Code
11478 \begin_layout Plain Layout
11484 A longer explanatory text that appears in the tooltip when hovering over
11485 the argument inset.
11488 \begin_layout Itemize
11489 \begin_inset Flex Code
11492 \begin_layout Plain Layout
11499 \begin_inset Flex Code
11502 \begin_layout Plain Layout
11511 \begin_inset space \thinspace{}
11515 \begin_inset Flex Code
11518 \begin_layout Plain Layout
11524 ] Declare if this is a mandatory (1) or an optional (0) argument.
11525 Mandatory arguments will be output empty if not given, while optional arguments
11526 will not be output at all.
11527 By default, mandatory arguments are delimited by
11528 \begin_inset Flex Code
11531 \begin_layout Plain Layout
11537 , while optional arguments are delimited by
11538 \begin_inset Flex Code
11541 \begin_layout Plain Layout
11550 \begin_layout Itemize
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11570 defines another argument (by its number) which this argument requires to
11571 be output if it is itself output.
11573 \begin_inset space \thinspace{}
11576 g., in \SpecialChar LaTeX
11577 commands, optional arguments often require previous optional arguments
11578 to be output (at least empty), as in
11579 \begin_inset Flex Code
11582 \begin_layout Plain Layout
11585 command[][argument]{text}
11591 This can be achieved by the statement
11592 \begin_inset Flex Code
11595 \begin_layout Plain Layout
11602 \begin_inset Flex Code
11605 \begin_layout Plain Layout
11614 \begin_layout Itemize
11615 \begin_inset Flex Code
11618 \begin_layout Plain Layout
11625 \begin_inset Flex Code
11628 \begin_layout Plain Layout
11634 defines a custom left delimiter (instead of
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11645 \begin_inset Flex Code
11648 \begin_layout Plain Layout
11655 A line break in the output can be indicated by
11656 \begin_inset Flex Code
11659 \begin_layout Plain Layout
11668 \begin_layout Itemize
11669 \begin_inset Flex Code
11672 \begin_layout Plain Layout
11679 \begin_inset Flex Code
11682 \begin_layout Plain Layout
11688 defines a custom right delimiter (instead of
11689 \begin_inset Flex Code
11692 \begin_layout Plain Layout
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11709 A line break in the output can be indicated by
11710 \begin_inset Flex Code
11713 \begin_layout Plain Layout
11722 \begin_layout Itemize
11723 \begin_inset Flex Code
11726 \begin_layout Plain Layout
11733 \begin_inset Flex Code
11736 \begin_layout Plain Layout
11742 defines an argument that is inserted if and only if no user-specified arguments
11744 \begin_inset space \thinspace{}
11748 \begin_inset space \space{}
11751 if no argument inset has been inserted (note that also an empty argument
11752 inset omits the DefaultArg).
11753 Multiple arguments need to be separated by comma.
11756 \begin_layout Itemize
11757 \begin_inset Flex Code
11760 \begin_layout Plain Layout
11767 \begin_inset Flex Code
11770 \begin_layout Plain Layout
11776 defines an argument that is inserted in any case (alone or in addition
11777 to user-specified arguments).
11778 Multiple arguments need to be separated by comma.
11781 \begin_layout Itemize
11782 \begin_inset Flex Code
11785 \begin_layout Plain Layout
11791 The font used for the argument content, see
11792 \begin_inset CommandInset ref
11794 reference "subsec:Font-description"
11801 \begin_layout Itemize
11802 \begin_inset Flex Code
11805 \begin_layout Plain Layout
11811 The font used for the label; see
11812 \begin_inset CommandInset ref
11814 reference "subsec:Font-description"
11821 \begin_layout Itemize
11822 \begin_inset Flex Code
11825 \begin_layout Plain Layout
11832 \begin_inset Flex Code
11835 \begin_layout Plain Layout
11840 , Minimalistic, Conglomerate
11845 ] describes the rendering style used for the inset's frame and buttons.
11848 \begin_layout Itemize
11849 \begin_inset Flex Code
11852 \begin_layout Plain Layout
11859 \begin_inset Flex Code
11862 \begin_layout Plain Layout
11869 \begin_inset Flex Code
11872 \begin_layout Plain Layout
11878 , this argument is automatically inserted when the respective style is selected.
11879 Currently, only one argument per style\SpecialChar breakableslash
11880 layout can be automatically inserted.
11883 \begin_layout Itemize
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11913 , this argument will be inserted with a copy of the co-text (either selected
11914 text or the whole paragraph) as content.
11917 \begin_layout Itemize
11918 \begin_inset Flex Code
11921 \begin_layout Plain Layout
11928 \begin_inset Flex Code
11931 \begin_layout Plain Layout
11941 ] Whether the contents of this argument should be output in raw form, meaning
11942 without special translations that \SpecialChar LaTeX
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11954 status is inherited by the inset or paragraph layout the argument belongs
11955 to, true and false change the status for the given argument only.
11958 \begin_layout Itemize
11959 \begin_inset Flex Code
11962 \begin_layout Plain Layout
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11973 string of characters
11982 Defines individual characters
11983 \begin_inset Newline linebreak
11986 that should be output in raw form, meaning without special translations
11987 that \SpecialChar LaTeX
11989 Note that, contrary to PassThru, this needs to be explicitly defined for
11991 That is, arguments do not inherit PassThruChars from their parent inset
11995 \begin_layout Itemize
11996 \begin_inset Flex Code
11999 \begin_layout Plain Layout
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12018 \begin_inset space \thinspace{}
12022 \begin_inset Flex Code
12025 \begin_layout Plain Layout
12031 ] If this is set to 1, the argument will output its content in the corresponding
12032 item in the table of contents.
12036 \begin_layout Standard
12037 By default, the text entered in the \SpecialChar LyX
12038 workarea in the respective layout is
12039 the last (mandatory) argument of a command if the
12040 \begin_inset Flex Code
12043 \begin_layout Plain Layout
12050 \begin_inset Flex Code
12053 \begin_layout Plain Layout
12060 However, arguments with the prefix
12061 \begin_inset Flex Code
12064 \begin_layout Plain Layout
12070 are output after this workarea argument.
12071 Note that post-argument numbering restarts at 1, so the first argument
12072 following the workarea argument is
12073 \begin_inset Flex Code
12076 \begin_layout Plain Layout
12083 Post-arguments are ignored in any other
12084 \begin_inset Flex Code
12087 \begin_layout Plain Layout
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12106 \begin_layout Standard
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12120 \begin_inset Flex Code
12123 \begin_layout Plain Layout
12132 \begin_inset Flex Code
12135 \begin_layout Plain Layout
12141 followed by the number (e.
12142 \begin_inset space \thinspace{}
12146 \begin_inset space \space{}
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12163 \begin_layout Description
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12173 Note that this will completely override any prior
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12183 declaration for this style.
12185 \begin_inset Quotes eld
12189 \begin_inset Flex Code
12192 \begin_layout Plain Layout
12199 \begin_inset Quotes erd
12204 \begin_inset CommandInset ref
12206 reference "subsec:I18n"
12210 for details on its use.
12213 \begin_layout Description
12214 \begin_inset Flex Code
12217 \begin_layout Plain Layout
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12237 \begin_layout Plain Layout
12238 Note that a `float' here is a real number, such as: 1.5.
12243 The vertical space with which the last of a chain of paragraphs with this
12244 style is separated from the following paragraph.
12245 If the next paragraph has another style, the separations are not simply
12246 added, but the maximum is taken.
12249 \begin_layout Description
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12269 ] The category for this style.
12270 This is used to group related styles in the style combobox on the toolbar.
12271 Any string can be used, but you may want to use existing categories with
12276 \begin_layout Description
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12286 Depth of XML command.
12287 Used only with XML-type formats.
12290 \begin_layout Description
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12301 \begin_inset Flex Code
12304 \begin_layout Plain Layout
12310 ] Copies all the features of an existing style into the current one.
12314 \begin_layout Description
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12334 ] The name of a style whose preamble should be output
12339 This allows to ensure some ordering of the preamble snippets when macros
12340 definitions depend on one another.
12344 \begin_layout Plain Layout
12345 Note that, besides that functionality, there is no way to ensure any ordering
12347 The ordering that you see in a given version of \SpecialChar LyX
12348 may change without warning
12357 \begin_layout Description
12358 \begin_inset Flex Code
12361 \begin_layout Plain Layout
12368 \begin_inset Flex Code
12371 \begin_layout Plain Layout
12376 , Box, Filled_Box, Static
12381 ] The type of label that stands at the end of the paragraph (or sequence
12383 \begin_inset Flex Code
12386 \begin_layout Plain Layout
12393 \begin_inset Newline newline
12397 \begin_inset Flex Code
12400 \begin_layout Plain Layout
12407 \begin_inset Flex Code
12410 \begin_layout Plain Layout
12417 \begin_inset Flex Code
12420 \begin_layout Plain Layout
12428 \begin_inset Flex Code
12431 \begin_layout Plain Layout
12438 \begin_inset Quotes eld
12442 \begin_inset Quotes erd
12446 \begin_inset Flex Code
12449 \begin_layout Plain Layout
12456 \begin_inset space \space{}
12460 \begin_inset Flex Code
12463 \begin_layout Plain Layout
12469 ) is a white (resp.
12470 \begin_inset space ~
12473 black) square suitable for end of proof markers,
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12483 is an explicit text string.
12486 \begin_layout Description
12487 \begin_inset Flex Code
12490 \begin_layout Plain Layout
12497 \begin_inset Flex Code
12500 \begin_layout Plain Layout
12506 ] The string used for a label with a
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12517 \begin_inset Newline newline
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12534 \begin_layout Description
12535 \begin_inset Flex Code
12538 \begin_layout Plain Layout
12544 The font used for both the text body
12550 \begin_inset CommandInset ref
12552 reference "subsec:Font-description"
12557 Note that defining this font automatically defines the
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12568 So you should define this one first if you also want to define
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12581 \begin_layout Description
12582 \begin_inset Flex Code
12585 \begin_layout Plain Layout
12592 \begin_inset Flex Code
12595 \begin_layout Plain Layout
12601 ] Used for backporting new styles to stable \SpecialChar LyX
12603 The first stable version that supports this tag is \SpecialChar LyX
12605 The argument is a number which may either be 0, -1 or any value greater
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12617 flag of a style is greater than zero, it will always be written to the
12619 If a .lyx file is read, the style definitions from the document header are
12620 added to the document class.
12621 Therefore even older \SpecialChar LyX
12622 versions can handle the style.
12624 \begin_inset Flex Code
12627 \begin_layout Plain Layout
12633 is a version number: if the style is read, and the version number is less
12634 than the version number of the already existing style in the document class,
12635 the new style is ignored.
12636 If the version number is greater, the new style replaces the existing style.
12637 A value of -1 means an infinite version number, i.
12638 \begin_inset space \thinspace{}
12642 \begin_inset space \space{}
12645 the style is always used.
12648 \begin_layout Description
12649 \begin_inset Flex Code
12652 \begin_layout Plain Layout
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12671 \begin_inset space \thinspace{}
12675 \begin_inset Flex Code
12678 \begin_layout Plain Layout
12684 ] Usually \SpecialChar LyX
12685 does not allow you to insert more than one space between words,
12686 since a space is considered as the separation between two words, not a
12687 character or symbol of its own.
12688 This is a very fine thing but sometimes annoying, for example, when typing
12689 program code or plain \SpecialChar LaTeX
12692 \begin_inset Flex Code
12695 \begin_layout Plain Layout
12702 Note that \SpecialChar LyX
12703 will create protected blanks for the additional blanks when
12704 in another mode than \SpecialChar LaTeX
12708 \begin_layout Description
12709 \begin_inset Flex Code
12712 \begin_layout Plain Layout
12718 These tags are used with XHTML output.
12720 \begin_inset CommandInset ref
12722 reference "subsec:Paragraph-Style-XHTML"
12729 \begin_layout Description
12730 \begin_inset Flex Code
12733 \begin_layout Plain Layout
12739 [FIXME] (Used only with XML-type formats.)
12742 \begin_layout Description
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12753 \begin_inset Flex Code
12756 \begin_layout Plain Layout
12765 \begin_inset space \thinspace{}
12769 \begin_inset Flex Code
12772 \begin_layout Plain Layout
12779 \begin_inset Flex Code
12782 \begin_layout Plain Layout
12788 , marks the style as to be included in the document preamble and not in
12790 This is useful for document classes that want such information as the title
12791 and author to appear in the preamble.
12792 Note that this works only for styles for which the
12793 \begin_inset Flex Code
12796 \begin_layout Plain Layout
12803 \begin_inset Flex Code
12806 \begin_layout Plain Layout
12813 \begin_inset Flex Code
12816 \begin_layout Plain Layout
12825 \begin_layout Description
12826 \begin_inset Flex Code
12829 \begin_layout Plain Layout
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12848 \begin_inset space \thinspace{}
12852 \begin_inset Flex Code
12855 \begin_layout Plain Layout
12862 \begin_inset Flex Code
12865 \begin_layout Plain Layout
12871 , marks the style as being part of a title block (see also the
12872 \begin_inset Flex Code
12875 \begin_layout Plain Layout
12882 \begin_inset Flex Code
12885 \begin_layout Plain Layout
12894 \begin_layout Description
12895 \begin_inset Flex Code
12898 \begin_layout Plain Layout
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12917 \begin_inset space \thinspace{}
12921 \begin_inset Flex Code
12924 \begin_layout Plain Layout
12930 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12931 of its contents in its item in the table of contents.
12932 Otherwise, only the label, if it exists, appears.
12935 \begin_layout Description
12936 \begin_inset Flex Code
12939 \begin_layout Plain Layout
12946 \begin_inset Flex Code
12949 \begin_layout Plain Layout
12955 ] The \SpecialChar LaTeX
12956 command sequence declaring an item in a list.
12957 The command is to be defined without the preceding backslash (the default
12959 \begin_inset Quotes eld
12963 \begin_inset Quotes erd
12967 \begin_inset Flex Code
12970 \begin_layout Plain Layout
12978 in the \SpecialChar LaTeX
12982 \begin_layout Description
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13002 ] This provides extra space between paragraphs that have the same style.
13003 If you put other styles into an environment, each is separated with the
13005 \begin_inset Flex Code
13008 \begin_layout Plain Layout
13015 But the whole items of the environment are additionally separated with
13017 \begin_inset Flex Code
13020 \begin_layout Plain Layout
13027 Note that this is a
13032 \begin_layout Description
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13042 [FIXME] (Used only with XML-type formats.)
13045 \begin_layout Description
13046 \begin_inset Flex Code
13049 \begin_layout Plain Layout
13056 \begin_inset Flex Code
13059 \begin_layout Plain Layout
13068 \begin_inset space \thinspace{}
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13081 ] Usually \SpecialChar LyX
13082 does not allow you to leave a paragraph empty, since it would
13083 lead to empty \SpecialChar LaTeX
13085 There are some cases where this could be desirable however: in a letter
13086 template, the required fields can be provided as empty fields, so that
13087 people do not forget them; in some special classes, a style can be used
13088 as some kind of break, which does not contain actual text.
13091 \begin_layout Description
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13102 \begin_inset Flex Code
13105 \begin_layout Plain Layout
13111 ] The vertical space between the label and the text body.
13112 Only used for labels that are above the text body (
13113 \begin_inset Flex Code
13116 \begin_layout Plain Layout
13123 \begin_inset Newline newline
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13131 Centered_Top_Environment
13139 \begin_layout Description
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13150 \begin_inset Flex Code
13153 \begin_layout Plain Layout
13159 ] The name of the counter for automatic numbering.
13160 In order to have the counter appear with your label, you will need to reference
13162 \begin_inset Flex Code
13165 \begin_layout Plain Layout
13174 This will work with
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13185 \begin_inset Flex Code
13188 \begin_layout Plain Layout
13195 \begin_inset Flex Code
13198 \begin_layout Plain Layout
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13215 \begin_inset Newline newline
13223 \begin_inset Flex Code
13226 \begin_layout Plain Layout
13233 \begin_inset Flex Code
13236 \begin_layout Plain Layout
13242 , though this case is a bit complicated.
13243 Suppose you declare
13244 \begin_inset Quotes eld
13248 \begin_inset Flex Code
13251 \begin_layout Plain Layout
13252 LabelCounter myenum
13258 \begin_inset Quotes erd
13262 Then the actual counters used are
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13283 \begin_inset Flex Code
13286 \begin_layout Plain Layout
13293 \begin_inset Flex Code
13296 \begin_layout Plain Layout
13302 , much as in \SpecialChar LaTeX
13304 These counters must all be declared separately.
13305 \begin_inset Newline newline
13309 \begin_inset CommandInset ref
13311 reference "subsec:Counters"
13315 for details on counters.
13318 \begin_layout Description
13319 \begin_inset Flex Code
13322 \begin_layout Plain Layout
13328 The font used for the label.
13330 \begin_inset CommandInset ref
13332 reference "subsec:Font-description"
13339 \begin_layout Description
13340 \begin_inset Flex Code
13343 \begin_layout Plain Layout
13350 \begin_inset Flex Code
13353 \begin_layout Plain Layout
13359 ] Text that indicates how far a label should be indented.
13362 \begin_layout Description
13363 \begin_inset Flex Code
13366 \begin_layout Plain Layout
13373 \begin_inset Flex Code
13376 \begin_layout Plain Layout
13382 ] Text that indicates the amount of horizontal space between the label and
13384 Only used for labels that are not above the text body.
13387 \begin_layout Description
13388 \begin_inset Flex Code
13391 \begin_layout Plain Layout
13398 \begin_inset Flex Code
13401 \begin_layout Plain Layout
13407 ] The string used for the label.
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13418 is set, this string can be contain the special formatting commands described
13420 \begin_inset CommandInset ref
13422 reference "subsec:Counters"
13429 \begin_layout Description
13430 \begin_inset Flex Code
13433 \begin_layout Plain Layout
13434 LabelStringAppendix
13440 \begin_inset Flex Code
13443 \begin_layout Plain Layout
13449 ] This is used inside the appendix instead of
13450 \begin_inset Newline newline
13454 \begin_inset Flex Code
13457 \begin_layout Plain Layout
13465 \begin_inset Flex Code
13468 \begin_layout Plain Layout
13475 \begin_inset Newline newline
13479 \begin_inset Flex Code
13482 \begin_layout Plain Layout
13483 LabelStringAppendix
13491 \begin_layout Description
13492 \begin_inset Flex Code
13495 \begin_layout Plain Layout
13501 [FIXME] (Used only with XML-type formats.)
13504 \begin_layout Description
13505 \begin_inset Flex Code
13508 \begin_layout Plain Layout
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13523 , Manual, Static, Above,
13524 \begin_inset Newline newline
13527 Centered, Sensitive, Enumerate,
13528 \begin_inset Newline newline
13531 Itemize, Bibliography
13540 \begin_layout Description
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13550 means the label is the very first word (up to the first real blank).
13551 Use protected spaces if you want more than one word as the label.
13555 \begin_layout Description
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13565 means the label is simply what is declared as
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13576 This will be displayed
13577 \begin_inset Quotes eld
13581 \begin_inset Quotes erd
13584 , at the beginning of the paragraph.
13586 \begin_inset Flex Code
13589 \begin_layout Plain Layout
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13605 , then it will be displayed only in the first paragraph of any sequence
13606 of paragraphs with the same
13607 \begin_inset Flex Code
13610 \begin_layout Plain Layout
13619 \begin_layout Description
13620 \begin_inset Flex Code
13623 \begin_layout Plain Layout
13630 \begin_inset space ~
13634 \begin_inset space ~
13638 \begin_inset Flex Code
13641 \begin_layout Plain Layout
13647 are special cases of
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13658 The label will be printed above the paragraph either at the beginning of
13659 the line or centered.
13662 \begin_layout Description
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13672 is a special case for the caption-labels
13673 \begin_inset Quotes eld
13677 \begin_inset Quotes erd
13681 \begin_inset Quotes eld
13685 \begin_inset Quotes erd
13689 \begin_inset Newline newline
13693 \begin_inset Flex Code
13696 \begin_layout Plain Layout
13702 means the (hardcoded) label string depends on the kind of float: It is
13703 hardcoded to be `FloatType N', where N is the value of the counter associated
13705 For the case that a caption is inserted outside of a float the
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13716 \begin_inset Quotes eld
13720 \begin_inset Quotes erd
13726 \begin_layout Description
13727 \begin_inset Flex Code
13730 \begin_layout Plain Layout
13736 produces the usual sort of enumeration labels.
13737 The number type needs to be set in the
13742 \begin_inset CommandInset ref
13744 reference "subsec:Counters"
13751 \begin_layout Description
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13761 produces various bullets at the different levels.
13762 The bullet types displayed can be set via
13763 \begin_inset Flex Noun
13766 \begin_layout Plain Layout
13767 Document\SpecialChar menuseparator
13768 Settings\SpecialChar menuseparator
13777 \begin_layout Description
13778 \begin_inset Flex Code
13781 \begin_layout Plain Layout
13787 should be used only with
13788 \begin_inset Flex Code
13791 \begin_layout Plain Layout
13792 LatexType BibEnvironment
13801 \begin_layout Description
13802 \begin_inset Flex Code
13805 \begin_layout Plain Layout
13811 Note that this will completely override any prior
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13821 declaration for this style.
13823 \begin_inset Quotes eld
13827 \begin_inset Flex Code
13830 \begin_layout Plain Layout
13837 \begin_inset Quotes erd
13842 \begin_inset CommandInset ref
13844 reference "subsec:I18n"
13848 for details on its use.
13851 \begin_layout Description
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13871 ] The name of the corresponding \SpecialChar LaTeX
13873 Either the environment or command name.
13876 \begin_layout Description
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13896 ] An optional parameter for the corresponding
13897 \begin_inset Flex Code
13900 \begin_layout Plain Layout
13907 This parameter cannot be changed from within \SpecialChar LyX
13909 \begin_inset Flex Code
13912 \begin_layout Plain Layout
13918 for customizable parameters).
13919 This will be output as is after all \SpecialChar LaTeX
13921 \begin_inset Flex Code
13924 \begin_layout Plain Layout
13933 \begin_layout Description
13934 \begin_inset Flex Code
13937 \begin_layout Plain Layout
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13952 , Command, Environment, Item_Environment,
13953 \begin_inset Newline newline
13956 List_Environment, Bib_Environment
13961 ] How the style should be translated into \SpecialChar LaTeX
13966 \begin_layout Plain Layout
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13976 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13977 Visit the SGML class files for specific examples.
13986 \begin_layout Description
13987 \begin_inset Flex Code
13990 \begin_layout Plain Layout
13996 means nothing special.
13999 \begin_layout Description
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14020 {\SpecialChar ldots
14029 \begin_layout Description
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14040 \begin_inset Flex Code
14043 \begin_layout Plain Layout
14050 }\SpecialChar ldots
14066 \begin_layout Description
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14077 \begin_inset Flex Code
14080 \begin_layout Plain Layout
14087 \begin_inset Flex Code
14090 \begin_layout Plain Layout
14098 is generated for each paragraph of this environment.
14102 \begin_layout Description
14103 \begin_inset Flex Code
14106 \begin_layout Plain Layout
14113 \begin_inset Flex Code
14116 \begin_layout Plain Layout
14123 \begin_inset Newline newline
14127 \begin_inset Flex Code
14130 \begin_layout Plain Layout
14136 is passed as an argument to the environment.
14137 \begin_inset Newline newline
14141 \begin_inset Flex Code
14144 \begin_layout Plain Layout
14150 can be defined in the
14151 \begin_inset Flex Noun
14154 \begin_layout Plain Layout
14155 Edit\SpecialChar menuseparator
14157 \begin_inset space ~
14168 \begin_layout Description
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14188 but adds the necessary mandatory argument (the longest label) to the begin
14189 statement of the bibliography environment:
14190 \begin_inset Newline newline
14194 \begin_inset Flex Code
14197 \begin_layout Plain Layout
14200 begin{thebibliography}{99}
14206 It is therefore only useful for bibliography environments.
14207 The default longest label
14208 \begin_inset Quotes eld
14212 \begin_inset Quotes erd
14215 can be changed by the user in the paragraph settings of a bibliography
14219 \begin_layout Standard
14220 Putting the last few things together, the \SpecialChar LaTeX
14221 output will be either:
14224 \begin_layout LyX-Code
14227 LatexName[LatexParam]{\SpecialChar ldots
14231 \begin_layout Standard
14235 \begin_layout LyX-Code
14238 begin{LatexName}[LatexParam] \SpecialChar ldots
14244 \begin_layout Standard
14245 depending upon the \SpecialChar LaTeX
14250 \begin_layout Description
14251 \begin_inset Flex Code
14254 \begin_layout Plain Layout
14261 \begin_inset Flex Code
14264 \begin_layout Plain Layout
14270 ] A string that is put at the beginning of the style content.
14271 A line break in the output can be indicated by
14272 \begin_inset Flex Code
14275 \begin_layout Plain Layout
14284 \begin_layout Description
14285 \begin_inset Flex Code
14288 \begin_layout Plain Layout
14295 \begin_inset Flex Code
14298 \begin_layout Plain Layout
14304 ] If you put styles into environments, the different
14305 \begin_inset Flex Code
14308 \begin_layout Plain Layout
14314 are not simply added, but added with a factor
14315 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14319 Note that this parameter is also used when
14320 \begin_inset Flex Code
14323 \begin_layout Plain Layout
14330 \begin_inset Flex Code
14333 \begin_layout Plain Layout
14340 \begin_inset Flex Code
14343 \begin_layout Plain Layout
14350 Then it is added to the manual or dynamic margin.
14351 \begin_inset Newline newline
14355 \begin_inset Quotes eld
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 \begin_inset Quotes erd
14372 means that the paragraph is indented with the width of
14373 \begin_inset Quotes eld
14377 \begin_inset Flex Code
14380 \begin_layout Plain Layout
14387 \begin_inset Quotes erd
14390 in the normal font.
14391 You can get a negative width by prefixing the string with
14392 \begin_inset Quotes eld
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14406 \begin_inset Quotes erd
14410 This way was chosen so that the look is the same with each used screen
14414 \begin_layout Description
14415 \begin_inset Flex Code
14418 \begin_layout Plain Layout
14425 \begin_inset Flex Code
14428 \begin_layout Plain Layout
14433 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14439 \begin_inset Newline newline
14442 The kind of margin that the style has on the left side.
14446 \begin_layout Description
14447 \begin_inset Flex Code
14450 \begin_layout Plain Layout
14456 just means a fixed margin.
14459 \begin_layout Description
14460 \begin_inset Flex Code
14463 \begin_layout Plain Layout
14469 means that the left margin depends on the string entered in the
14470 \begin_inset Flex Noun
14473 \begin_layout Plain Layout
14474 Edit\SpecialChar menuseparator
14476 \begin_inset space ~
14485 This is used to typeset nice lists without tabulators.
14488 \begin_layout Description
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14498 means that the margin depends on the size of the label.
14499 This is used for automatic enumerated headlines.
14500 It is obvious that the headline
14501 \begin_inset Quotes eld
14504 5.4.3.2.1 Very long headline
14505 \begin_inset Quotes erd
14508 must have a wider left margin (as wide as
14509 \begin_inset Quotes eld
14513 \begin_inset Quotes erd
14516 plus the space) than
14517 \begin_inset Quotes eld
14520 3.2 Very long headline
14521 \begin_inset Quotes erd
14525 \begin_inset Quotes eld
14529 \begin_inset Quotes erd
14532 are not able to do this.
14535 \begin_layout Description
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14545 is similar, but only the very first row of the paragraph is dynamic, while
14546 the others are static; this is used, for example, for descriptions.
14549 \begin_layout Description
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14559 means the margin is chosen in a way that the longest row of this paragraph
14560 fits to the right margin.
14561 This is used to typeset an address on the right edge of the page.
14565 \begin_layout Description
14566 \begin_inset Flex Code
14569 \begin_layout Plain Layout
14576 \begin_inset Flex Code
14579 \begin_layout Plain Layout
14588 \begin_inset space \thinspace{}
14592 \begin_inset Flex Code
14595 \begin_layout Plain Layout
14601 ] Whether fragile commands in this style should be
14602 \begin_inset Flex Code
14605 \begin_layout Plain Layout
14618 whether this command should itself be protected.)
14621 \begin_layout Description
14622 \begin_inset Flex Code
14625 \begin_layout Plain Layout
14632 \begin_inset Flex Code
14635 \begin_layout Plain Layout
14642 \begin_inset space \thinspace{}
14646 \begin_inset Flex Code
14649 \begin_layout Plain Layout
14657 ] Whether newlines are translated into \SpecialChar LaTeX
14659 \begin_inset Flex Code
14662 \begin_layout Plain Layout
14673 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14675 inside \SpecialChar LyX
14679 \begin_layout Description
14680 \begin_inset Flex Code
14683 \begin_layout Plain Layout
14690 \begin_inset Flex Code
14693 \begin_layout Plain Layout
14702 \begin_inset space \thinspace{}
14706 \begin_inset Flex Code
14709 \begin_layout Plain Layout
14715 ] If set to true, and if
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14735 ) paragraphs are being indented, then the indentation of such a paragraph
14736 following one of this type will be suppressed.
14737 (So this will not affect the display of non-default paragraphs.)
14740 \begin_layout Description
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14751 \begin_inset Flex Code
14754 \begin_layout Plain Layout
14760 ] Name of a style that has replaced this style.
14761 This is used to rename a style, while keeping backward compatibility.
14764 \begin_layout Description
14765 \begin_inset Flex Code
14768 \begin_layout Plain Layout
14775 \begin_inset Flex Code
14778 \begin_layout Plain Layout
14785 \begin_inset space \thinspace{}
14789 \begin_inset Flex Code
14792 \begin_layout Plain Layout
14798 ] Determines whether consecutive paragraphs of the same type are treated
14799 as belonging together.
14800 This has the effect that the
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14810 is only printed once before such a group.
14811 By default, this is true for
14812 \begin_inset Flex Code
14815 \begin_layout Plain Layout
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14841 and false for all other types.
14844 \begin_layout Description
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14867 \begin_inset space \thinspace{}
14871 \begin_inset Flex Code
14874 \begin_layout Plain Layout
14880 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14882 but only by a line break; together with
14883 \begin_inset Flex Code
14886 \begin_layout Plain Layout
14892 , this allows to emulate a plain text editor (like the ERT inset).
14895 \begin_layout Description
14896 \begin_inset Flex Code
14899 \begin_layout Plain Layout
14906 \begin_inset Flex Code
14909 \begin_layout Plain Layout
14915 ] The indent of the very first line of a paragraph.
14917 \begin_inset Newline newline
14921 \begin_inset Flex Code
14924 \begin_layout Plain Layout
14930 will be fixed for a certain style.
14931 The exception is the default style, since the indentation for these paragraphs
14932 can be prohibited with
14933 \begin_inset Flex Code
14936 \begin_layout Plain Layout
14944 \begin_inset Flex Code
14947 \begin_layout Plain Layout
14953 style paragraphs inside environments use the
14954 \begin_inset Flex Code
14957 \begin_layout Plain Layout
14963 of the environment, not their native one.
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14974 paragraphs inside an enumeration are not indented.
14977 \begin_layout Description
14978 \begin_inset Flex Code
14981 \begin_layout Plain Layout
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14997 ] The vertical space between two paragraphs of this style.
15000 \begin_layout Description
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15011 \begin_inset Flex Code
15014 \begin_layout Plain Layout
15021 allows the user to choose either
15022 \begin_inset Quotes eld
15026 \begin_inset Quotes erd
15030 \begin_inset Quotes eld
15034 \begin_inset Quotes erd
15037 to separate paragraphs.
15039 \begin_inset Quotes eld
15043 \begin_inset Quotes erd
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15058 \begin_inset Quotes eld
15062 \begin_inset Quotes erd
15066 \begin_inset Flex Code
15069 \begin_layout Plain Layout
15075 is ignored and all paragraphs are separated by the
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15086 The vertical space is calculated with
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15092 \begin_inset space ~
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15110 is the height of a row with the normal font.
15111 This way, the look stays the same with different screen fonts.
15114 \begin_layout Description
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15125 \begin_inset Flex Code
15128 \begin_layout Plain Layout
15137 \begin_inset space \thinspace{}
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15150 ] Whether the contents of this paragraph should be output in raw form, meaning
15151 without special translations that \SpecialChar LaTeX
15155 \begin_layout Description
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15179 Defines individual characters that should be output in raw form, meaning
15180 without special translations that \SpecialChar LaTeX
15184 \begin_layout Description
15185 \begin_inset Flex Code
15188 \begin_layout Plain Layout
15194 Information to be included in the \SpecialChar LaTeX
15195 preamble when this style is used.
15196 Used to define macros, load packages, etc., required by this particular
15199 \begin_inset Quotes eld
15203 \begin_inset Flex Code
15206 \begin_layout Plain Layout
15213 \begin_inset Quotes erd
15219 \begin_layout Description
15220 \begin_inset Flex Code
15223 \begin_layout Plain Layout
15230 \begin_inset Flex Code
15233 \begin_layout Plain Layout
15239 ] The prefix to use when creating labels referring to paragraphs of this
15241 This allows the use of formatted references.
15244 \begin_layout Description
15245 \begin_inset Flex Code
15248 \begin_layout Plain Layout
15255 \begin_inset Flex Code
15258 \begin_layout Plain Layout
15264 ] Whether the style requires the feature
15265 \begin_inset Flex Code
15268 \begin_layout Plain Layout
15275 \begin_inset CommandInset ref
15277 reference "chap:List-of-functions"
15281 for the list of features).
15282 If you require a package with specific options, you can additionally use
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15293 as a general text class parameter (see
15294 \begin_inset CommandInset ref
15296 reference "subsec:General-text-class"
15303 \begin_layout Description
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15314 \begin_inset Flex Code
15317 \begin_layout Plain Layout
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15335 ] Resets the \SpecialChar LaTeX
15336 arguments of this style (as defined via the
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 This is useful if you have copied a style via
15348 \begin_inset Flex Code
15351 \begin_layout Plain Layout
15357 , but you do not want to inherit its (required and optional) arguments.
15360 \begin_layout Description
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15383 \begin_inset Flex Code
15386 \begin_layout Plain Layout
15392 ] Resumes a counter that is usually reset at each new sequence of layouts.
15393 This is currently only useful when
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset Flex Code
15407 \begin_layout Plain Layout
15416 \begin_layout Description
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15427 \begin_inset Flex Code
15430 \begin_layout Plain Layout
15436 ] A string that is put at the end of the layout content.
15437 A line break in the output can be indicated by
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15450 \begin_layout Description
15451 \begin_inset Flex Code
15454 \begin_layout Plain Layout
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15483 \begin_layout Description
15484 \begin_inset Flex Code
15487 \begin_layout Plain Layout
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15526 \begin_inset Flex Code
15529 \begin_layout Plain Layout
15531 \begin_inset space ~
15539 ] This defines what the default spacing should be in the style.
15541 \begin_inset Flex Code
15544 \begin_layout Plain Layout
15551 \begin_inset Flex Code
15554 \begin_layout Plain Layout
15561 \begin_inset Flex Code
15564 \begin_layout Plain Layout
15570 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15571 If you specify the argument
15572 \begin_inset Flex Code
15575 \begin_layout Plain Layout
15581 , then you must also provide a value argument which will be the actual multiplie
15583 Note that, contrary to other parameters,
15584 \begin_inset Flex Code
15587 \begin_layout Plain Layout
15593 implies the generation of specific \SpecialChar LaTeX
15594 code, using the \SpecialChar LaTeX
15598 \begin_inset Flex Code
15601 \begin_layout Plain Layout
15610 \begin_layout Description
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15631 \begin_inset space \thinspace{}
15635 \begin_inset Flex Code
15638 \begin_layout Plain Layout
15646 ] Allow spell-checking paragraphs of this style.
15650 \begin_layout Description
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15673 \begin_inset Flex Code
15676 \begin_layout Plain Layout
15682 ] Steps the master counter of a given counter at the beginning of a new
15683 sequence of layouts.
15684 This is currently only useful when
15685 \begin_inset Flex Code
15688 \begin_layout Plain Layout
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15707 \begin_layout Description
15708 \begin_inset Flex Code
15711 \begin_layout Plain Layout
15717 The font used for the text body .
15719 \begin_inset CommandInset ref
15721 reference "subsec:Font-description"
15728 \begin_layout Description
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15754 The level of the style in the table of contents.
15755 This is used for automatic numbering of section headings.
15758 \begin_layout Description
15759 \begin_inset Flex Code
15762 \begin_layout Plain Layout
15771 \begin_inset Flex Code
15774 \begin_layout Plain Layout
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15795 \begin_inset Flex Code
15798 \begin_layout Plain Layout
15804 ] This tag determines whether the first line indentation of this paragraph
15805 can be toggled via the Paragraph settings dialog.
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15822 is set, indentation can be toggled if the document settings use
15823 \begin_inset Quotes eld
15827 \begin_inset Quotes erd
15830 paragraph style, with
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15840 , indentation can always be toggled, notwithstanding the document settings,
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15851 , indentation can never be toggled.
15854 \begin_layout Description
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15865 \begin_inset Flex Code
15868 \begin_layout Plain Layout
15874 ] The vertical space with which the very first of a chain of paragraphs
15875 with this style is separated from the previous paragraph.
15876 If the previous paragraph has another style, the separations are not simply
15877 added, but the maximum is taken.
15880 \begin_layout Subsection
15881 \begin_inset CommandInset label
15887 Internationalization of Paragraph Styles
15890 \begin_layout Standard
15892 has long supported internationalization of layout information, but, until
15893 version 2.0, this applied only to the user interface and not to, say, PDF
15895 Thus, French authors were forced to resort to ugly hacks if they wanted
15900 1' instead of `Theorem 1'.
15901 Thanks to Georg Baum, that is no longer the case.
15904 \begin_layout Standard
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15915 defines text that is to appear in the typeset document, it may use
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15935 to support non-English and even multi-language documents correctly.
15936 The following excerpt (from the
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15946 file) shows how this works:
15949 \begin_layout LyX-Code
15954 \begin_layout LyX-Code
15957 theoremstyle{remark}
15960 \begin_layout LyX-Code
15963 newtheorem{claim}[thm]{
15970 \begin_layout LyX-Code
15974 \begin_layout LyX-Code
15978 \begin_layout LyX-Code
15983 claimname}{_(Claim)}
15986 \begin_layout LyX-Code
15990 \begin_layout LyX-Code
15994 \begin_layout LyX-Code
16003 claimname}{_(Claim)}}
16006 \begin_layout LyX-Code
16011 \begin_layout Standard
16012 In principle, any legal \SpecialChar LaTeX
16014 \begin_inset Flex Code
16017 \begin_layout Plain Layout
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16033 tags, but in practice they will typically look as they do here.
16034 The key to correct translation of the typeset text is the definition of
16035 the \SpecialChar LaTeX
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16049 \begin_inset Flex Code
16052 \begin_layout Plain Layout
16064 \begin_layout Standard
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16075 tag provides for internationalization based upon the overall language of
16077 The contents of the tag will be included in the preamble, just as with
16079 \begin_inset Flex Code
16082 \begin_layout Plain Layout
16089 What makes it special is the use of the
16090 \begin_inset Quotes eld
16094 \begin_inset Quotes erd
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16107 , which will be replaced, when \SpecialChar LyX
16108 produces \SpecialChar LaTeX
16109 output, with the translation of
16110 its argument into the document language.
16113 \begin_layout Standard
16115 \begin_inset Flex Code
16118 \begin_layout Plain Layout
16124 tag is more complex, since it is meant to provide support for multi-language
16125 documents and so offers an interface to the
16126 \begin_inset Flex Code
16129 \begin_layout Plain Layout
16136 Its contents will be added to the preamble once for each language that
16137 appears in the document.
16138 In this case, the argument to
16139 \begin_inset Flex Code
16142 \begin_layout Plain Layout
16148 will be replaced with its translation into the language in question; the
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16159 is replaced by the language name (as used by the babel package).
16162 \begin_layout Standard
16163 A German document that also included a French section would thus have the
16164 following in the preamble:
16167 \begin_layout LyX-Code
16176 claimname}{Affirmation}}
16177 \begin_inset Newline newline
16188 claimname}{Behauptung}}
16189 \begin_inset Newline newline
16196 claimname}{Behauptung}
16199 \begin_layout Standard
16202 \begin_inset Flex Code
16205 \begin_layout Plain Layout
16211 will then conspire to produce the correct text in the output.
16214 \begin_layout Standard
16215 One important point to note here is that the translations are provided by
16217 itself, through the file
16218 \begin_inset Flex Code
16221 \begin_layout Plain Layout
16228 This means, in effect, that
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16239 \begin_inset Flex Code
16242 \begin_layout Plain Layout
16248 are really only of use in layout files that are provided with \SpecialChar LyX
16250 entered in user-created layout files will not be seen by \SpecialChar LyX
16251 's internationalizatio
16252 n routines unless the
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16262 file is modified accordingly.
16263 That said, however, any layout created with the intention that it will
16264 be included with \SpecialChar LyX
16265 should use these tags where appropriate.
16266 Please note that the paragraph style translations provided by \SpecialChar LyX
16268 change with a minor update (e.
16269 \begin_inset space \thinspace{}
16273 \begin_inset space \space{}
16276 from version 2.1.x to 2.1.y).
16277 It is however quite likely that a major update (e.
16278 \begin_inset space \thinspace{}
16282 \begin_inset space \space{}
16285 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16288 \begin_layout Subsection
16290 \begin_inset CommandInset label
16292 name "subsec:Floats"
16299 \begin_layout Standard
16300 It is necessary to define the floats (
16301 \begin_inset Flex Noun
16304 \begin_layout Plain Layout
16311 \begin_inset Flex Noun
16314 \begin_layout Plain Layout
16320 , \SpecialChar ldots
16321 ) in the text class itself.
16322 Standard floats are included in the file
16323 \begin_inset Flex Code
16326 \begin_layout Plain Layout
16332 , so you may have to do no more than add
16335 \begin_layout LyX-Code
16336 Input stdfloats.inc
16339 \begin_layout Standard
16340 to your layout file.
16341 If you want to implement a text class that proposes some other float types
16342 (like the AGU class bundled with \SpecialChar LyX
16343 ), the information below will hopefully
16347 \begin_layout Description
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16358 \begin_inset Flex Code
16361 \begin_layout Plain Layout
16367 =!htbpH] Allowed placement options for this float type.
16368 The value is a string of placement characters.
16369 Possible characters include:
16374 \begin_inset Quotes eld
16378 \begin_inset Quotes erd
16386 \begin_inset Quotes eld
16390 \begin_inset Quotes erd
16398 \begin_inset Quotes eld
16402 \begin_inset Quotes erd
16410 \begin_inset Quotes eld
16414 \begin_inset Quotes erd
16422 \begin_inset Quotes eld
16426 \begin_inset Quotes erd
16434 \begin_inset Quotes eld
16438 \begin_inset Quotes erd
16442 The order of the characters in the string does not matter.
16443 If no placement options are allowed, use the string
16450 \begin_layout Description
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16473 \begin_inset space \thinspace{}
16479 \begin_inset Flex Code
16482 \begin_layout Plain Layout
16492 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16499 \begin_inset Flex Code
16502 \begin_layout Plain Layout
16508 if the float does not support this feature.
16511 \begin_layout Description
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16534 \begin_inset space \thinspace{}
16540 \begin_inset Flex Code
16543 \begin_layout Plain Layout
16553 ] Defines whether the float has a starred variant that spans columns in
16554 a two column paragraph.
16556 \begin_inset Flex Code
16559 \begin_layout Plain Layout
16565 if the float does not support this feature.
16568 \begin_layout Description
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16589 \begin_inset Quotes erd
16593 \begin_inset Quotes erd
16596 ] The file name extension of an auxiliary file for the list of figures (or
16599 writes the captions to this file.
16602 \begin_layout Description
16603 \begin_inset Flex Code
16606 \begin_layout Plain Layout
16613 \begin_inset Flex Code
16616 \begin_layout Plain Layout
16623 \begin_inset Quotes erd
16627 \begin_inset Quotes erd
16630 ] The string that will be used in the menus and also for the caption.
16631 This is translated to the current language if babel is used.
16634 \begin_layout Description
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16644 These tags control the XHTML output.
16646 \begin_inset CommandInset ref
16648 reference "sec:Tags-for-XHTML"
16655 \begin_layout Description
16656 \begin_inset Flex Code
16659 \begin_layout Plain Layout
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16680 \begin_inset space \thinspace{}
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16693 ] Indicates whether the float is already defined in the document class or
16694 if instead the \SpecialChar LaTeX
16696 \begin_inset Flex Code
16699 \begin_layout Plain Layout
16705 needs to be loaded to define it on-the-fly.
16707 \begin_inset Flex Code
16710 \begin_layout Plain Layout
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16727 It should be set to
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16737 if the float is already defined by the \SpecialChar LaTeX
16741 \begin_layout Description
16742 \begin_inset Flex Code
16745 \begin_layout Plain Layout
16752 \begin_inset Flex Code
16755 \begin_layout Plain Layout
16762 \begin_inset Quotes erd
16766 \begin_inset Quotes erd
16769 ] The command used to generate a list of floats of this type; the leading
16778 \begin_inset Flex Code
16781 \begin_layout Plain Layout
16787 is false, since there is no standard way to generate this command.
16789 \begin_inset Flex Code
16792 \begin_layout Plain Layout
16798 is true, since in that case there is a standard way to define the command.
16801 \begin_layout Description
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16812 \begin_inset Flex Code
16815 \begin_layout Plain Layout
16822 \begin_inset Quotes erd
16826 \begin_inset Quotes erd
16829 ] A title for a list of floats of this kind (list of figures, tables, or
16831 It is used for the screen label within \SpecialChar LyX
16832 , it is used by \SpecialChar LaTeX
16834 it is used as the title in the XHTML output.
16835 It will be translated to the document language.
16838 \begin_layout Description
16839 \begin_inset Flex Code
16842 \begin_layout Plain Layout
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16859 \begin_inset Quotes erd
16863 \begin_inset Quotes erd
16866 ] This (optional) argument determines whether floats of this class will
16867 be numbered within some sectional unit of the document.
16869 \begin_inset Flex Code
16872 \begin_layout Plain Layout
16879 \begin_inset Quotes eld
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 \begin_inset Quotes erd
16896 , the floats will be numbered within chapters.
16900 \begin_layout Description
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16911 \begin_inset Flex Code
16914 \begin_layout Plain Layout
16921 \begin_inset Quotes erd
16925 \begin_inset Quotes erd
16928 ] The default placement for the given class of floats.
16929 The string should be as in standard \SpecialChar LaTeX
16931 \begin_inset Flex Code
16934 \begin_layout Plain Layout
16941 \begin_inset Flex Code
16944 \begin_layout Plain Layout
16951 \begin_inset Flex Code
16954 \begin_layout Plain Layout
16961 \begin_inset Flex Code
16964 \begin_layout Plain Layout
16970 for top, bottom, page, and here, respectively.
16974 \begin_layout Plain Layout
16975 Note that the order of these letters in the string is irrelevant, like in
16982 On top of that there is a new type,
16983 \begin_inset Flex Code
16986 \begin_layout Plain Layout
16992 , which does not really correspond to a float, since it means: put it
16993 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17001 Note however that the
17002 \begin_inset Flex Code
17005 \begin_layout Plain Layout
17011 specifier is special and, because of implementation details, cannot be
17012 used in non-built in float types.
17013 If you do not understand what this means, just use
17014 \begin_inset Quotes eld
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17028 \begin_inset Quotes erd
17034 \begin_layout Description
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17045 \begin_inset Flex Code
17048 \begin_layout Plain Layout
17054 ] The prefix to use when creating labels referring to floats of this type.
17055 This allows the use of formatted references.
17056 Note that you can remove any
17057 \begin_inset Flex Code
17060 \begin_layout Plain Layout
17066 set by a copied style by using the special value
17067 \begin_inset Quotes eld
17071 \begin_inset Quotes erd
17074 , which must be all caps.
17077 \begin_layout Description
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17098 \begin_inset Quotes erd
17102 \begin_inset Quotes erd
17105 ] The style used when defining the float using
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17120 \begin_layout Description
17121 \begin_inset Flex Code
17124 \begin_layout Plain Layout
17131 \begin_inset Flex Code
17134 \begin_layout Plain Layout
17141 \begin_inset Quotes erd
17145 \begin_inset Quotes erd
17149 \begin_inset Quotes eld
17153 \begin_inset Quotes erd
17156 of the new class of floats, like program or algorithm.
17157 After the appropriate
17158 \begin_inset Flex Code
17161 \begin_layout Plain Layout
17170 \begin_inset Flex Code
17173 \begin_layout Plain Layout
17182 \begin_inset Flex Code
17185 \begin_layout Plain Layout
17196 \begin_layout Description
17197 \begin_inset Flex Code
17200 \begin_layout Plain Layout
17207 \begin_inset Flex Code
17210 \begin_layout Plain Layout
17217 \begin_inset space \thinspace{}
17221 \begin_inset Flex Code
17224 \begin_layout Plain Layout
17232 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17234 \begin_inset Flex Code
17237 \begin_layout Plain Layout
17243 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17247 \begin_layout Standard
17248 Note that defining a float with type
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17260 automatically defines the corresponding counter with name
17261 \begin_inset Flex Code
17264 \begin_layout Plain Layout
17275 \begin_layout Subsection
17276 Flex insets and InsetLayout
17277 \begin_inset CommandInset label
17279 name "subsec:Flex-insets-and"
17286 \begin_layout Standard
17287 Flex insets come in three different kinds:
17290 \begin_layout Itemize
17292 \begin_inset Flex Code
17295 \begin_layout Plain Layout
17301 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17303 \begin_inset Flex Code
17306 \begin_layout Plain Layout
17315 \begin_inset Flex Code
17318 \begin_layout Plain Layout
17329 \begin_layout Itemize
17331 \begin_inset Flex Code
17334 \begin_layout Plain Layout
17340 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17342 footnote, and the like.
17343 An obvious example is an endnote inset, which is defined in the
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17356 \begin_layout Itemize
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 ): For use with DocBook classes.
17370 \begin_layout Standard
17371 Flex insets are defined using the
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17381 tag, which shall be explained in a moment.
17384 \begin_layout Standard
17386 \begin_inset Flex Code
17389 \begin_layout Plain Layout
17395 tag also serves another function: It can be used to customize the general
17396 layout of many different types of insets.
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17407 can be used to customize the layout parameters for footnotes, marginal
17408 notes, note insets, \SpecialChar TeX
17409 code (ERT) insets, branches, listings, indexes, boxes,
17410 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17413 \begin_layout Standard
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17424 definition must begin with a line of the form:
17427 \begin_layout LyX-Code
17431 \begin_layout Standard
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17442 indicates the inset whose layout is being defined, and here there are four
17446 \begin_layout Enumerate
17447 The layout for a pre-existing inset is being modified.
17448 In this case, can be
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17458 any one of the following:
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17469 \begin_inset Flex Code
17472 \begin_layout Plain Layout
17479 \begin_inset Flex Code
17482 \begin_layout Plain Layout
17489 \begin_inset Flex Code
17492 \begin_layout Plain Layout
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17509 \begin_inset Flex Code
17512 \begin_layout Plain Layout
17519 \begin_inset Flex Code
17522 \begin_layout Plain Layout
17529 \begin_inset Flex Code
17532 \begin_layout Plain Layout
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17559 \begin_inset Flex Code
17562 \begin_layout Plain Layout
17569 \begin_inset Flex Code
17572 \begin_layout Plain Layout
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17619 \begin_inset Flex Code
17622 \begin_layout Plain Layout
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17639 \begin_inset Flex Code
17642 \begin_layout Plain Layout
17649 \begin_inset Flex Code
17652 \begin_layout Plain Layout
17661 \begin_layout Enumerate
17662 The layout for a Flex inset is being defined.
17664 \begin_inset Flex Code
17667 \begin_layout Plain Layout
17673 must be of the form
17674 \begin_inset Quotes eld
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17688 \begin_inset Quotes erd
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17701 may be be any valid identifier not used by a pre-existing Flex inset.
17702 The identifier may include spaces, but in that case the whole thing must
17703 be wrapped in quotes.
17704 Note that the definition of a flex inset
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17718 entry, declaring which type of inset it defines.
17721 \begin_layout Enumerate
17722 The layout for user specific branch is being defined.
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17733 must be of the form
17734 \begin_inset Quotes eld
17738 \begin_inset Flex Code
17741 \begin_layout Plain Layout
17748 \begin_inset Quotes erd
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17761 may be be any valid identifier of branch defined in user's document.
17762 The identifier may include spaces, but in that case the whole thing must
17763 be wrapped in quotes.
17764 The main purpose of this feature is to allow \SpecialChar LaTeX
17765 wrapping around specific
17766 branches as user needs.
17769 \begin_layout Enumerate
17770 The layout of a user (or class) specific caption is being defined.
17772 \begin_inset Flex Code
17775 \begin_layout Plain Layout
17781 must be of the form
17782 \begin_inset Quotes eld
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17796 \begin_inset Quotes erd
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17809 specifies the name of the caption as it appears in the menu.
17810 Have a look at the standard caption (
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17820 ), the specific captions of the KOMA-Script classes (
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17843 \begin_inset space ~
17847 \begin_inset Newline linebreak
17853 \begin_inset Flex Code
17856 \begin_layout Plain Layout
17862 ) for applications.
17865 \begin_layout Standard
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17876 definition can contain the following entries:
17879 \begin_layout Description
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17899 =""] This inset will appear in the table of contents of the given type.
17900 An empty string disables.
17901 See also the OutlinerName and the IsTocCaption commands.
17902 This is only implemented for Flex insets.
17906 \begin_layout Description
17907 \begin_inset Flex Code
17910 \begin_layout Plain Layout
17917 \begin_inset Flex Code
17920 \begin_layout Plain Layout
17926 ] Defines argument number of a command\SpecialChar breakableslash
17927 environment associated with the current
17929 The definition must end with
17930 \begin_inset Flex Code
17933 \begin_layout Plain Layout
17941 \begin_inset CommandInset ref
17943 reference "subsec:Paragraph-Styles"
17950 \begin_layout Description
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17960 Preamble for changing language commands; see
17961 \begin_inset CommandInset ref
17963 reference "subsec:I18n"
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17990 ] The color for the inset's background.
17992 \begin_inset CommandInset ref
17994 reference "chap:Names-of-colors"
17998 for a list of the available color names.
18001 \begin_layout Description
18002 \begin_inset Flex Code
18005 \begin_layout Plain Layout
18012 \begin_inset Flex Code
18015 \begin_layout Plain Layout
18024 \begin_inset space \thinspace{}
18028 \begin_inset Flex Code
18031 \begin_layout Plain Layout
18037 ] Whether to use the content of the inset as the label, when the inset is
18042 \begin_layout Description
18043 \begin_inset Flex Code
18046 \begin_layout Plain Layout
18053 \begin_inset Flex Code
18056 \begin_layout Plain Layout
18062 ] As with paragraph styles, see
18063 \begin_inset CommandInset ref
18065 reference "subsec:Paragraph-Styles"
18070 Note that you need to specify the complete type, e.
18071 \begin_inset space \thinspace{}
18075 \begin_inset space ~
18079 \begin_inset Flex Code
18082 \begin_layout Plain Layout
18083 CopyStyle Flex:<name>
18091 \begin_layout Description
18092 \begin_inset Flex Code
18095 \begin_layout Plain Layout
18102 \begin_inset Flex Code
18105 \begin_layout Plain Layout
18114 \begin_inset space \thinspace{}
18118 \begin_inset Flex Code
18121 \begin_layout Plain Layout
18127 ] Indicates whether the user may employ the Paragraph Settings dialog to
18128 customize the paragraph.
18131 \begin_layout Description
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18142 \begin_inset Flex Code
18145 \begin_layout Plain Layout
18152 \begin_inset Flex Code
18155 \begin_layout Plain Layout
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18171 , describing the rendering style used for the inset's frame and buttons.
18172 Footnotes generally use
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18182 , ERT insets generally
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18192 , and character styles
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18205 \begin_layout Description
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18216 \begin_inset Flex Code
18219 \begin_layout Plain Layout
18228 \begin_inset space \thinspace{}
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18246 \begin_inset Flex Code
18249 \begin_layout Plain Layout
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18266 Indicates whether the environment will stand on its own in the output or
18267 will appear inline with the surrounding text.
18268 If set to false, it is supposed that the \SpecialChar LaTeX
18269 environment ignores white space
18270 (including one newline character) after the
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18287 \begin_inset Flex Code
18290 \begin_layout Plain Layout
18306 \begin_layout Description
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18316 Required at the end of the
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18329 \begin_layout Description
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18339 The font used for both the text body
18345 \begin_inset CommandInset ref
18347 reference "subsec:Font-description"
18352 Note that defining this font automatically defines the
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18362 to the same value, so define this first and define
18363 \begin_inset Flex Code
18366 \begin_layout Plain Layout
18372 later if you want them to be different.
18375 \begin_layout Description
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18380 FixedWidthPreambleEncoding
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18398 \begin_inset space \thinspace{}
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18411 ] Force a fixed width encoding for the translated contents of
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18422 \begin_inset Flex Code
18425 \begin_layout Plain Layout
18431 code generated by this layout.
18432 This is needed for special \SpecialChar LaTeX
18437 that do not work with variable width encodings such as
18442 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18443 backends such as Xe\SpecialChar TeX
18445 Lua\SpecialChar TeX
18449 \begin_layout Description
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18454 ForceLocalFontSwitch
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18472 \begin_inset space \thinspace{}
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 ] When using babel, always use a local font switch (
18486 \begin_inset Flex Code
18489 \begin_layout Plain Layout
18497 ), never a global one (such as
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18512 \begin_layout Description
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18535 \begin_inset space \thinspace{}
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18549 \begin_inset Quotes eld
18553 \begin_inset Quotes erd
18556 language, leading to Left-to-Right (Latin) output, e.
18557 \begin_inset space \thinspace{}
18561 \begin_inset space \space{}
18564 in \SpecialChar TeX
18569 \begin_layout Description
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18592 \begin_inset space \thinspace{}
18596 \begin_inset Flex Code
18599 \begin_layout Plain Layout
18605 ] Force a a line break in the \SpecialChar LaTeX
18606 output before the inset starts and after
18608 This assures the inset itself is output on its own lines, for parsing purposes.
18611 \begin_layout Description
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18634 \begin_inset space \thinspace{}
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18647 ] Indicates whether the
18648 \begin_inset Flex Code
18651 \begin_layout Plain Layout
18657 should be used or, instead, the user can change the paragraph style used
18662 \begin_layout Description
18663 \begin_inset Flex Code
18666 \begin_layout Plain Layout
18673 \begin_inset Flex Code
18676 \begin_layout Plain Layout
18685 \begin_inset space \thinspace{}
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18698 ] As with paragraph styles, see
18699 \begin_inset CommandInset ref
18701 reference "subsec:Paragraph-Styles"
18708 \begin_layout Description
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18718 These tags control the XHTML output.
18720 \begin_inset CommandInset ref
18722 reference "sec:Tags-for-XHTML"
18729 \begin_layout Description
18730 \begin_inset Flex Code
18733 \begin_layout Plain Layout
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18752 \begin_inset space \thinspace{}
18756 \begin_inset Flex Code
18759 \begin_layout Plain Layout
18765 ] Whether to include the contents of this inset in the strings generated
18766 for the `Outline' pane for all table of contents, regardless of the AddToToc
18768 One would not, for example, want the content of a footnote in a section
18769 header to be included in the TOC displayed in the outline, but one would
18770 normally want the content of a character style displayed.
18771 Default is false: not to include.
18774 \begin_layout Description
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 \begin_inset Flex Code
18788 \begin_layout Plain Layout
18797 \begin_inset space \thinspace{}
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18810 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18811 of its contents in its item in the table of contents.
18812 Otherwise, only the label appears.
18815 \begin_layout Description
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18840 \begin_inset space \thinspace{}
18844 \begin_inset Flex Code
18847 \begin_layout Plain Layout
18853 ] As with paragraph styles, see
18854 \begin_inset CommandInset ref
18856 reference "subsec:Paragraph-Styles"
18863 \begin_layout Description
18864 \begin_inset Flex Code
18867 \begin_layout Plain Layout
18873 The font used for the label.
18875 \begin_inset CommandInset ref
18877 reference "subsec:Font-description"
18882 Note that this definition can never appear before
18883 \begin_inset Flex Code
18886 \begin_layout Plain Layout
18892 , lest it be ineffective.
18895 \begin_layout Description
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18906 \begin_inset Flex Code
18909 \begin_layout Plain Layout
18916 \begin_inset Quotes erd
18920 \begin_inset Quotes erd
18923 ] What will be displayed on the button or elsewhere as the inset label.
18925 \begin_inset Flex Code
18928 \begin_layout Plain Layout
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18945 ) modify this label on the fly.
18948 \begin_layout Description
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18958 Language dependent preamble; see
18959 \begin_inset CommandInset ref
18961 reference "subsec:I18n"
18968 \begin_layout Description
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18979 \begin_inset Flex Code
18982 \begin_layout Plain Layout
18988 ] The name of the corresponding \SpecialChar LaTeX
18990 Either the environment or command name.
18993 \begin_layout Description
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19004 \begin_inset Flex Code
19007 \begin_layout Plain Layout
19013 ] The optional parameter for the corresponding
19014 \begin_inset Flex Code
19017 \begin_layout Plain Layout
19023 stuff, including possible bracket pairs like
19024 \begin_inset Flex Code
19027 \begin_layout Plain Layout
19034 This parameter cannot be changed from within \SpecialChar LyX
19036 \begin_inset Flex Code
19039 \begin_layout Plain Layout
19045 for customizable parameters).
19046 It will be output as is after all \SpecialChar LaTeX
19048 \begin_inset Flex Code
19051 \begin_layout Plain Layout
19060 \begin_layout Description
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19071 \begin_inset Flex Code
19074 \begin_layout Plain Layout
19075 Command, Environment, None
19080 ] How the style should be translated into \SpecialChar LaTeX
19085 \begin_layout Plain Layout
19086 \begin_inset Flex Code
19089 \begin_layout Plain Layout
19095 is perhaps a bit misleading, since these rules apply to SGML classes too.
19096 Visit the SGML class files for specific examples.
19105 \begin_layout Description
19106 \begin_inset Flex Code
19109 \begin_layout Plain Layout
19115 means nothing special
19118 \begin_layout Description
19119 \begin_inset Flex Code
19122 \begin_layout Plain Layout
19129 \begin_inset Flex Code
19132 \begin_layout Plain Layout
19139 {\SpecialChar ldots
19148 \begin_layout Description
19149 \begin_inset Flex Code
19152 \begin_layout Plain Layout
19159 \begin_inset Flex Code
19162 \begin_layout Plain Layout
19169 }\SpecialChar ldots
19184 \begin_layout Standard
19185 Putting the last few things together, the \SpecialChar LaTeX
19186 output will be either:
19189 \begin_layout LyX-Code
19192 LatexName[LatexParam]{\SpecialChar ldots
19196 \begin_layout Standard
19200 \begin_layout LyX-Code
19203 begin{LatexName}[LatexParam] \SpecialChar ldots
19209 \begin_layout Standard
19210 depending upon the \SpecialChar LaTeX
19215 \begin_layout Description
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19235 ] A string that is put at the beginning of the layout content.
19236 A line break in the output can be indicated by
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19249 \begin_layout Description
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19299 (indicating a dummy definition ending definitions of charstyles, etc).
19300 This entry is required in and is only meaningful for Flex insets.
19301 Among other things, it determines on which menu this inset will appear.
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19322 will automatically set
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19344 \begin_inset Flex Code
19347 \begin_layout Plain Layout
19353 can be set to true, or
19354 \begin_inset Flex Code
19357 \begin_layout Plain Layout
19364 \begin_inset Flex Code
19367 \begin_layout Plain Layout
19373 insets by setting it
19378 \begin_inset Flex Code
19381 \begin_layout Plain Layout
19390 \begin_layout Description
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19413 \begin_inset space \thinspace{}
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19426 ] Whether multiple paragraphs are permitted in this inset.
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19437 to the same value and
19438 \begin_inset Flex Code
19441 \begin_layout Plain Layout
19447 to the opposite value.
19448 These can be reset to other values, if they are used
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19466 \begin_layout Description
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19489 \begin_inset space \thinspace{}
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19502 ] Whether fragile commands in this inset should be
19503 \begin_inset Flex Code
19506 \begin_layout Plain Layout
19519 whether the command should itself be protected.) Default is false.
19522 \begin_layout Description
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19542 ] Deletes an existing
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19555 \begin_layout Description
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19585 that has replaced this
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19596 This is used to rename an
19597 \begin_inset Flex Code
19600 \begin_layout Plain Layout
19606 , while keeping backward compatibility.
19609 \begin_layout Description
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19632 \begin_inset space \thinspace{}
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19645 ] As with paragraph styles, see
19646 \begin_inset CommandInset ref
19648 reference "subsec:Paragraph-Styles"
19656 \begin_layout Description
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19679 \begin_inset space \thinspace{}
19683 \begin_inset Flex Code
19686 \begin_layout Plain Layout
19692 ] As with paragraph styles, see
19693 \begin_inset CommandInset ref
19695 reference "subsec:Paragraph-Styles"
19703 \begin_layout Description
19704 \begin_inset Flex Code
19707 \begin_layout Plain Layout
19713 As with paragraph styles, see
19714 \begin_inset CommandInset ref
19716 reference "subsec:Paragraph-Styles"
19723 \begin_layout Description
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19734 \begin_inset Flex Code
19737 \begin_layout Plain Layout
19743 ] The prefix to use when creating labels referring to insets of this type.
19744 This allows the use of formatted references.
19747 \begin_layout Description
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19767 ] As with paragraph styles, see
19768 \begin_inset CommandInset ref
19770 reference "subsec:Paragraph-Styles"
19777 \begin_layout Description
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19800 \begin_inset space \thinspace{}
19804 \begin_inset Flex Code
19807 \begin_layout Plain Layout
19813 ] Resets the \SpecialChar LaTeX
19814 arguments of this layout (as defined via the
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 This is useful if you have copied a style via
19826 \begin_inset Flex Code
19829 \begin_layout Plain Layout
19835 , but you do not want to inherit its (required and optional) arguments.
19838 \begin_layout Description
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19859 \begin_inset space \thinspace{}
19863 \begin_inset Flex Code
19866 \begin_layout Plain Layout
19874 ] Whether this inset should use the font of its surrounding environment
19876 Default is false: use the font of the surrounding environment.
19879 \begin_layout Description
19880 \begin_inset Flex Code
19883 \begin_layout Plain Layout
19890 \begin_inset Flex Code
19893 \begin_layout Plain Layout
19899 ] A string that is put at the end of the layout content.
19900 A line break in the output can be indicated by
19901 \begin_inset Flex Code
19904 \begin_layout Plain Layout
19913 \begin_layout Description
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 \begin_inset space \thinspace{}
19938 \begin_inset Flex Code
19941 \begin_layout Plain Layout
19949 ] Allow spell-checking the contents of this inset.
19953 \begin_layout Subsection
19955 \begin_inset CommandInset label
19957 name "subsec:Counters"
19964 \begin_layout Standard
19965 It is necessary to define the counters (
19966 \begin_inset Flex Noun
19969 \begin_layout Plain Layout
19976 \begin_inset Flex Noun
19979 \begin_layout Plain Layout
19985 , \SpecialChar ldots
19986 ) in the text class itself.
19987 The standard counters are defined in the file
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19997 , so you may have to do no more than add
20000 \begin_layout LyX-Code
20001 Input stdcounters.inc
20004 \begin_layout Standard
20005 to your layout file to get them to work.
20006 But if you want to define custom counters, then you can do so.
20007 The counter declaration must begin with:
20010 \begin_layout LyX-Code
20011 Counter CounterName
20014 \begin_layout Standard
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20025 ' is replaced by the name of the counter.
20026 And it must end with
20027 \begin_inset Quotes eld
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20041 \begin_inset Quotes erd
20045 The following parameters can also be used:
20048 \begin_layout Description
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20059 \begin_inset Flex Code
20062 \begin_layout Plain Layout
20068 ] Sets the initial value for the counter, to which it will be reset whenever
20070 Normally, one will want the default, 1.
20073 \begin_layout Description
20074 \begin_inset Flex Code
20077 \begin_layout Plain Layout
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20094 \begin_inset Quotes erd
20098 \begin_inset Quotes erd
20101 ] When defined, this string defines how the counter is displayed.
20102 Setting this value sets
20103 \begin_inset Flex Code
20106 \begin_layout Plain Layout
20107 LabelStringAppendix
20113 The following special constructs can be used in the string:
20117 \begin_layout Itemize
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20129 will be replaced by the expansion of the
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20144 LabelStringAppendix
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20163 \begin_layout Itemize
20164 counter values can be expressed using \SpecialChar LaTeX
20166 \begin_inset Newline newline
20170 \begin_inset Flex Code
20173 \begin_layout Plain Layout
20190 \begin_inset Flex Code
20193 \begin_layout Plain Layout
20205 \begin_layout Plain Layout
20215 Actually, the situation is a bit more complicated: any
20234 other than those described below will produce arabic numerals.
20235 It would not be surprising to see this change in the future.
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 : 1, 2, 3,\SpecialChar ldots
20252 \begin_inset Flex Code
20255 \begin_layout Plain Layout
20261 for lower-case letters: a, b, c, \SpecialChar ldots
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20272 for upper-case letters: A, B, C, \SpecialChar ldots
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20283 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20294 for upper-case roman numerals: I, II, III\SpecialChar ldots
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20305 for hebrew numerals.
20309 \begin_layout Standard
20310 If LabelString is not defined, a default value is constructed as follows:
20311 if the counter has a master counter
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20332 \begin_inset Newline newline
20336 \begin_inset Flex Code
20339 \begin_layout Plain Layout
20349 is used; otherwise the string
20350 \begin_inset Flex Code
20353 \begin_layout Plain Layout
20364 \begin_layout Description
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20369 LabelStringAppendix
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20385 \begin_inset Quotes erd
20389 \begin_inset Quotes erd
20393 \begin_inset Flex Code
20396 \begin_layout Plain Layout
20402 , but for use in the Appendix.
20405 \begin_layout Description
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20426 \begin_inset Quotes erd
20430 \begin_inset Quotes erd
20433 ] A format for use with formatted references to this counter.
20434 For example, one might want to have references to section numbers appear
20436 \begin_inset Quotes eld
20440 \begin_inset Quotes erd
20444 The string should contain
20445 \begin_inset Quotes eld
20449 \begin_inset Quotes erd
20453 This will be replaced by the counter number itself.
20454 So, for sections, it would be: Section ##.
20457 \begin_layout Description
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20478 \begin_inset Quotes erd
20482 \begin_inset Quotes erd
20485 ] If this is set to the name of another counter, the present counter will
20486 be reset every time the other one is increased.
20488 \begin_inset Flex Code
20491 \begin_layout Plain Layout
20498 \begin_inset Flex Code
20501 \begin_layout Plain Layout
20510 \begin_layout Subsection
20512 \begin_inset CommandInset label
20514 name "subsec:Font-description"
20521 \begin_layout Standard
20522 A font description looks like this:
20525 \begin_layout LyX-Code
20542 \begin_layout LyX-Code
20546 \begin_layout LyX-Code
20550 \begin_layout Standard
20551 The following commands are available:
20554 \begin_layout Description
20555 \begin_inset Flex Code
20558 \begin_layout Plain Layout
20565 \begin_inset Flex Code
20568 \begin_layout Plain Layout
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20607 \begin_inset Flex Code
20610 \begin_layout Plain Layout
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20647 \begin_inset Flex Code
20650 \begin_layout Plain Layout
20657 \begin_inset Flex Code
20660 \begin_layout Plain Layout
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20687 \begin_inset Flex Code
20690 \begin_layout Plain Layout
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20769 \begin_layout Description
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20780 \begin_inset Flex Code
20783 \begin_layout Plain Layout
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20814 \begin_layout Description
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20834 ] Valid arguments are:
20835 \begin_inset Flex Code
20838 \begin_layout Plain Layout
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20855 \begin_inset Flex Code
20858 \begin_layout Plain Layout
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20955 Each of these turns on or off the corresponding attribute.
20957 \begin_inset Flex Code
20960 \begin_layout Plain Layout
20966 turns on emphasis, and
20967 \begin_inset Flex Code
20970 \begin_layout Plain Layout
20978 \begin_inset Newline newline
20981 If the latter seems puzzling, remember that the font settings for the present
20982 context are generally inherited from the surrounding context.
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20993 would turn off the emphasis that was anyway in effect, say, in a theorem
20997 \begin_layout Description
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21020 \begin_inset Flex Code
21023 \begin_layout Plain Layout
21032 \begin_layout Description
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21043 \begin_inset Flex Code
21046 \begin_layout Plain Layout
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21087 \begin_layout Description
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21130 \begin_inset Flex Code
21133 \begin_layout Plain Layout
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21160 \begin_inset Flex Code
21163 \begin_layout Plain Layout
21170 \begin_inset Flex Code
21173 \begin_layout Plain Layout
21182 \begin_layout Subsection
21183 \begin_inset CommandInset label
21185 name "subsec:Citation-engine-description"
21189 Cite engine description
21192 \begin_layout Standard
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21203 blocks, as used mainly in cite engine files (see
21204 \begin_inset CommandInset ref
21206 reference "subsec:Cite-Engine-Files"
21213 ), define the citation commands provided by a specific
21214 \begin_inset Quotes eld
21218 \begin_inset Quotes erd
21222 A cite engine, in \SpecialChar LyX
21223 terms, is way specific way to format citations, using
21224 numbers, author names and/or years.
21225 Currently, \SpecialChar LyX
21226 supports three such engine types, namely:
21229 \begin_layout Enumerate
21230 \begin_inset Flex Code
21233 \begin_layout Plain Layout
21239 : the default Bib\SpecialChar TeX
21240 way to format citations, a simple numeric style (e.
21241 \begin_inset space \thinspace{}
21245 \begin_inset Quotes eld
21249 \begin_inset Quotes erd
21255 \begin_layout Enumerate
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21265 : Harvard-styled citations using author names and publication year (e.
21266 \begin_inset space \thinspace{}
21270 \begin_inset Quotes eld
21273 Smith and Miller (2017b)
21274 \begin_inset Quotes erd
21280 \begin_layout Enumerate
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21290 : extended numerical citations that also allow for author or title next
21292 \begin_inset space \thinspace{}
21296 \begin_inset Quotes eld
21299 Smith and Miller [1]
21300 \begin_inset Quotes erd
21306 \begin_layout Standard
21307 \begin_inset Flex Code
21310 \begin_layout Plain Layout
21316 blocks look like this:
21319 \begin_layout LyX-Code
21323 \begin_layout LyX-Code
21327 \begin_layout LyX-Code
21331 \begin_layout LyX-Code
21332 citeyearpar[][]=parencite*
21335 \begin_layout LyX-Code
21339 \begin_layout LyX-Code
21343 \begin_layout Standard
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21354 denotes the engine.
21355 The individual lines respectively define a cite command or cite command
21356 paradigm supported by this engine.
21357 The line can be as simple as a cite command that is used both to name the
21358 respective \SpecialChar LyX
21359 command and the \SpecialChar LaTeX
21360 output or more complex in order to differentiate
21362 The full syntax is:
21365 \begin_layout LyX-Code
21366 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21369 \begin_layout Itemize
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21379 : The name as used in the
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21393 \begin_layout Standard
21394 For portability reasons, we try to use the same name for same-formatted
21395 commands in different cite packages (thus many names stem from natbib,
21396 and thus we need to differentiate a
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21406 sometimes, if the \SpecialChar LaTeX
21407 command names differ).
21411 \begin_layout Itemize
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21421 : a (comma-separated) list of commands that fall back to the given
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21431 in the current engine.
21432 This eases the switch of citation packages and engines.
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21444 \begin_inset Flex Code
21447 \begin_layout Plain Layout
21453 in layout definitions.
21456 \begin_layout Itemize
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21466 : The actual \SpecialChar LaTeX
21467 command that is output.
21471 \begin_layout Standard
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21493 \begin_inset Flex Code
21496 \begin_layout Plain Layout
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21512 will be output to \SpecialChar LaTeX
21516 \begin_layout Standard
21520 \begin_layout Itemize
21521 Capitalization indicates that the command also has a capitalized form (
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21535 \begin_inset Flex Code
21538 \begin_layout Plain Layout
21547 These usually enforce up-casing of name prefixes (
21552 \begin_inset Formula $\Rightarrow$
21562 \begin_layout Itemize
21564 \begin_inset Flex Code
21567 \begin_layout Plain Layout
21573 indicate the number of optional arguments (there can be 0–2).
21576 \begin_layout Itemize
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21587 indicates there is a starred version of the command (
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21617 \begin_layout Standard
21618 By default, the starred version means: Output all authors even if it should
21620 \begin_inset Quotes eld
21624 \begin_inset Quotes erd
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21640 \begin_layout Standard
21641 If the star has a different meaning for a given command, it can be specified
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21647 <!_stardesc!_stardesctooltip>
21653 Maximal two translatable macro keywords, marked by the prefix
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21664 The first points to the string that replaces the
21665 \begin_inset Quotes eld
21669 \begin_inset Quotes erd
21672 checkbox label in the citation dialog, the second one to an optional tool
21673 tip for this checkbox.
21677 \begin_layout Standard
21678 Note that these two macros have to be defined in a
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21688 (see next section), dropping the
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21698 from the prefix, like this:
21701 \begin_layout LyX-Code
21702 _stardesc Sta&rred command label
21705 \begin_layout LyX-Code
21706 _stardesctooltip Tooltip for the starred command checkbox.
21710 \begin_layout Itemize
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21721 indicates that this command features
21722 \begin_inset Quotes eld
21725 qualified citation lists
21726 \begin_inset Quotes erd
21734 -specific feature for multi-reference citations where an individual pre-
21735 and postnote can be given to each reference in the list.
21736 Please refer to the
21740 manual for details.
21743 \begin_layout Subsection
21744 \begin_inset CommandInset label
21746 name "subsec:Citation-format-description"
21750 Cite format description
21753 \begin_layout Standard
21755 \begin_inset Flex Code
21758 \begin_layout Plain Layout
21764 blocks are used to describe how bibliographic information should be displayed,
21765 both within \SpecialChar LyX
21766 itself (in the citation dialog and in tooltips, for example)
21767 and in XHTML output.
21768 Such a block might look like this:
21771 \begin_layout LyX-Code
21775 \begin_layout LyX-Code
21779 \begin_layout LyX-Code
21783 \begin_layout LyX-Code
21787 \begin_layout Standard
21791 \begin_layout LyX-Code
21795 \begin_layout LyX-Code
21799 \begin_layout LyX-Code
21803 \begin_layout LyX-Code
21807 \begin_layout Standard
21808 In the first case, the individual lines define how the bibliographic information
21809 associated with an article or book, respectively, is to be displayed, and
21810 such a definition can be given for any
21811 \begin_inset Quotes els
21815 \begin_inset Quotes ers
21818 that might be present in a Bib\SpecialChar TeX
21821 defines a default format in the source code that will be used if no specific
21822 definition has been given.
21824 predefines several formats in the file
21825 \begin_inset Flex Code
21828 \begin_layout Plain Layout
21834 , which is included in most of \SpecialChar LyX
21835 's document classes.
21838 \begin_layout Standard
21839 In the second case, the lines define how a specific citation command (in
21841 \begin_inset Flex Code
21844 \begin_layout Plain Layout
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21864 ) is to be displayed on the citation inset label, in the citation dialog,
21865 menu or XHTML output.
21867 defines such formats for the citation style variants it supports via
21869 Document\SpecialChar menuseparator
21870 Setting\SpecialChar menuseparator
21871 Bibliography\SpecialChar ldots
21875 \begin_inset Flex Code
21878 \begin_layout Plain Layout
21884 files that are shipped with \SpecialChar LyX
21886 \begin_inset CommandInset ref
21888 reference "subsec:Cite-Engine-Files"
21898 \begin_layout Standard
21899 The definitions use a simple language that allows Bib\SpecialChar TeX
21900 keys to be replaced
21902 Keys should be enclosed in
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21923 So a simple definition might look like this:
21926 \begin_layout LyX-Code
21928 \begin_inset Quotes eld
21932 \begin_inset Quotes erd
21938 \begin_layout Standard
21939 This would print the author, followed by a comma, followed by the title,
21940 in quotes, followed by a period.
21943 \begin_layout Standard
21944 Of course, sometimes you may want to print a key only if it exists.
21945 This can be done by using a conditional construction, such as:
21946 \begin_inset Flex Code
21949 \begin_layout Plain Layout
21951 \begin_inset space ~
21961 \begin_inset Flex Code
21964 \begin_layout Plain Layout
21970 key exists, then print
21971 \begin_inset Quotes eld
21975 \begin_inset space ~
21979 \begin_inset Quotes erd
21982 followed by the volume key.
21983 It is also possible to have an else clause in the conditional, such as:
21984 \begin_inset Newline newline
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21992 {%author%[[%author%]][[%editor%, ed.]]}
21998 \begin_inset Newline newline
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22011 key is printed if it exists; otherwise, the editor key is printed, followed
22013 \begin_inset Quotes eld
22017 \begin_inset space ~
22021 \begin_inset Quotes erd
22024 Note that the key is again enclosed in
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22034 signs; the entire conditional is enclosed in braces; and the if and else
22035 clauses are enclosed in double brackets,
22036 \begin_inset Quotes eld
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22050 \begin_inset Quotes eld
22054 \begin_inset Quotes eld
22058 \begin_inset Flex Code
22061 \begin_layout Plain Layout
22068 \begin_inset Quotes erd
22072 There must be no space between any of these.
22075 \begin_layout Standard
22076 Next to the entry keys, there are some special keys that can be used for
22077 these conditionals:
22080 \begin_layout Itemize
22081 \begin_inset Flex Code
22084 \begin_layout Plain Layout
22085 {%dialog%[[true]][[false]]}
22091 \begin_inset Quotes eld
22095 \begin_inset Quotes erd
22098 part for dialogs and menus, the
22099 \begin_inset Quotes eld
22103 \begin_inset Quotes erd
22106 part for other contexts (workarea, export)
22109 \begin_layout Itemize
22110 \begin_inset Flex Code
22113 \begin_layout Plain Layout
22114 {%export%[[true]][[false]]}
22120 \begin_inset Quotes eld
22124 \begin_inset Quotes erd
22127 part for export and menus, the
22128 \begin_inset Quotes eld
22132 \begin_inset Quotes erd
22135 part for other contexts (workarea, dialog)
22138 \begin_layout Itemize
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22149 \begin_inset Quotes eld
22153 \begin_inset Quotes erd
22156 part if another item follows (e.
22157 \begin_inset space \thinspace{}
22160 g., in a citation with multiple keys)
22163 \begin_layout Itemize
22164 \begin_inset Flex Code
22167 \begin_layout Plain Layout
22168 {%second%[[true]][[false]]}
22174 \begin_inset Quotes eld
22178 \begin_inset Quotes erd
22181 if this is the second of multiple items, else the
22182 \begin_inset Quotes eld
22186 \begin_inset Quotes erd
22192 \begin_layout Itemize
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22197 {%ifstar%[[true]][[false]]}
22203 \begin_inset Quotes eld
22207 \begin_inset Quotes erd
22210 part for starred citation commands (such as
22211 \begin_inset Flex Code
22214 \begin_layout Plain Layout
22222 ), the false part for unstarred
22225 \begin_layout Itemize
22226 \begin_inset Flex Code
22229 \begin_layout Plain Layout
22230 {%ifentrytype:<type>%[[true]][[false]]}
22236 \begin_inset Quotes eld
22240 \begin_inset Quotes erd
22243 if the current entry type matches
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22253 , else the false part (e.g., in a citation definition:
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22258 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22266 \begin_layout Itemize
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22271 {%ifmultiple:<authortype>%[[true]][[false]]}
22277 \begin_inset Quotes eld
22281 \begin_inset Quotes erd
22284 if the current author type (author, editor etc.) has multiple authors, else
22285 the false part (e.g., in a bibliography definition:
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22290 {%ifmultiple:editor%[[eds.]][[ed.]]}
22298 \begin_layout Itemize
22299 \begin_inset Flex Code
22302 \begin_layout Plain Layout
22303 {%ifqualified%[[true]][[false]]}
22309 \begin_inset Quotes eld
22313 \begin_inset Quotes erd
22316 part if the current citation is a qualified citation list (a specific
22320 format for multi-reference citations), the false part if this is not the
22324 \begin_layout Standard
22326 \begin_inset Flex Code
22329 \begin_layout Plain Layout
22335 prints the author key as it is recorded in the bibliography file.
22336 This might not be what you want, since it will result in a string such
22338 \begin_inset Quotes eld
22341 Miller, Peter and Smith, Mary and White, Jane
22342 \begin_inset Quotes erd
22346 \begin_inset Quotes eld
22350 \begin_inset Quotes erd
22353 is used by Bib\SpecialChar TeX
22354 to delimit authors).
22356 therefore provides some methods to get properly formatted name lists (which
22357 will also get translated).
22358 The following keys are provided:
22361 \begin_layout Enumerate
22362 For name lists with pre- and surname, suitable for the main authors/editors
22363 of a bibliography item.
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22374 part denotes the kind of list that is requested (e.g.
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22389 \begin_layout Itemize
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22394 %abbrvnames:<nametype>%
22399 : Provides a name list which is abbreviated (with
22400 \begin_inset Quotes eld
22404 \begin_inset Quotes erd
22408 \begin_inset Flex Code
22411 \begin_layout Plain Layout
22420 \begin_layout Itemize
22421 \begin_inset Flex Code
22424 \begin_layout Plain Layout
22425 %fullnames:<nametype>%
22430 : Provides a full name list (never abbreviated with
22431 \begin_inset Quotes eld
22435 \begin_inset Quotes erd
22441 \begin_layout Itemize
22442 \begin_inset Flex Code
22445 \begin_layout Plain Layout
22446 %forceabbrvnames:<nametype>%
22451 : Provides a name list which is always abbreviated (with
22452 \begin_inset Quotes eld
22456 \begin_inset Quotes erd
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22473 \begin_layout Enumerate
22474 Alternative name lists with pre- and surname, if the order of pre- and surname
22475 inside the bibliography item differs (as in:
22476 \begin_inset Quotes eld
22479 Miller, John: Some text, in: Mary Smith, ed.: A volume
22480 \begin_inset Quotes erd
22487 \begin_layout Itemize
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22492 %abbrvbynames:<nametype>%
22497 : Provides a name list which is abbreviated (with
22498 \begin_inset Quotes eld
22502 \begin_inset Quotes erd
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22518 \begin_layout Itemize
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22523 %fullbynames:<nametype>%
22528 : Provides a full name list (never abbreviated with
22529 \begin_inset Quotes eld
22533 \begin_inset Quotes erd
22539 \begin_layout Itemize
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22544 %forceabbrvbynames:<nametype>%
22549 : Provides a name list which is always abbreviated (with
22550 \begin_inset Quotes eld
22554 \begin_inset Quotes erd
22558 \begin_inset Flex Code
22561 \begin_layout Plain Layout
22571 \begin_layout Enumerate
22572 And finally name lists which consist of family names only, as used in author-yea
22574 These do not take a
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22584 part, but always return either an author list or, if this does not exist,
22585 an editor list (as common in author-year labels):
22589 \begin_layout Itemize
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22599 : Provides a name list which is abbreviated (with
22600 \begin_inset Quotes eld
22604 \begin_inset Quotes erd
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22620 \begin_layout Itemize
22621 \begin_inset Flex Code
22624 \begin_layout Plain Layout
22630 : Provides a full name list (never abbreviated with
22631 \begin_inset Quotes eld
22635 \begin_inset Quotes erd
22641 \begin_layout Itemize
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22646 %forceabbrvciteauthor%
22651 : Provides a name list which is always abbreviated (with
22652 \begin_inset Quotes eld
22656 \begin_inset Quotes erd
22660 \begin_inset Flex Code
22663 \begin_layout Plain Layout
22673 \begin_layout Standard
22674 The order of pre- and surname in the former two lists can be adjusted by
22678 \begin_layout Itemize
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22683 !firstnameform %surname%, %prename%
22688 (first author in lists of type 1)
22691 \begin_layout Itemize
22692 \begin_inset Flex Code
22695 \begin_layout Plain Layout
22696 !othernameform %surname%, %prename%
22701 (other authors in lists of type 1)
22704 \begin_layout Itemize
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22709 !firstbynameform %prename% %surname%
22714 (first author in lists of type 2)
22717 \begin_layout Itemize
22718 \begin_inset Flex Code
22721 \begin_layout Plain Layout
22722 !otherbynameform %prename% %surname%
22727 (other authors in lists of type 2)
22730 \begin_layout Standard
22731 This allows you to configure namings like
22732 \begin_inset Quotes eld
22735 Miller, Peter and Mary Smith: \SpecialChar ldots
22736 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22738 \begin_inset Quotes erd
22744 \begin_layout Standard
22745 There is one other piece of syntax available in definitions, which looks
22747 \begin_inset Flex Code
22750 \begin_layout Plain Layout
22757 This defines a piece of formatting information that is to be used when
22759 \begin_inset Quotes eld
22763 \begin_inset Quotes erd
22767 Obviously, we do not want to output HTML tags when writing plain text,
22768 so they should be wrapped in
22769 \begin_inset Quotes eld
22773 \begin_inset Quotes erd
22777 \begin_inset Quotes eld
22781 \begin_inset Quotes erd
22787 \begin_layout Standard
22788 Two special sorts of definitions are also possible in a
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22799 An example of the first would be:
22802 \begin_layout LyX-Code
22804 \begin_inset Quotes eld
22808 \begin_inset Quotes erd
22814 \begin_layout Standard
22815 This is an abbreviation, or macro, and it can be used by treating it as
22817 \begin_inset Flex Code
22820 \begin_layout Plain Layout
22829 \begin_inset Flex Code
22832 \begin_layout Plain Layout
22838 exactly as it would treat its definition.
22839 So, let us issue the obvious
22847 \begin_layout LyX-Code
22851 \begin_layout Standard
22852 or anything like it.
22854 shouldn't go into an infinite loop, but it may go into a long one before
22858 \begin_layout Standard
22859 The second sort of special definition might look like this:
22862 \begin_layout LyX-Code
22866 \begin_layout Standard
22867 This defines a translatable piece of text, which allows relevant parts of
22868 the bibliography or citation to be translated.
22869 It can be included in a definition by treating it as a key:
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22880 Several of these are predefined in
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22891 \begin_inset Flex Code
22894 \begin_layout Plain Layout
22901 Note that these are not macros, in the sense just defined.
22902 They will not be expanded.
22905 \begin_layout Standard
22906 So here then is an example that use all these features:
22907 \begin_inset VSpace defskip
22913 \begin_layout Standard
22917 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22920 \begin_layout Standard
22921 \begin_inset VSpace defskip
22924 This defines a macro that prints the author, followed by a comma, if the
22926 \begin_inset Flex Code
22929 \begin_layout Plain Layout
22935 key is defined, or else prints the name of the editor, followed by the
22937 \begin_inset Flex Code
22940 \begin_layout Plain Layout
22946 or its translation (it is by default
22947 \begin_inset Quotes eld
22951 \begin_inset Quotes erd
22955 \begin_inset Flex Code
22958 \begin_layout Plain Layout
22965 Note that this is in fact defined in
22966 \begin_inset Flex Code
22969 \begin_layout Plain Layout
22975 , so you can use it in your own definitions, or re-definitions, if you load
22979 \begin_layout Section
22980 \begin_inset CommandInset label
22982 name "sec:Tags-for-XHTML"
22986 Tags for XHTML output
22989 \begin_layout Standard
22990 As with \SpecialChar LaTeX
22991 or DocBook, the format of \SpecialChar LyX
22992 's XHTML output is also controlled by
22993 layout information.
22994 In general, \SpecialChar LyX
22995 provides sensible defaults and, as mentioned earlier, it will
22996 even construct default CSS style rules from the other layout tags.
22997 For example, \SpecialChar LyX
22998 will attempt to use the information provided in the
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23008 declaration for the Chapter style to write CSS that will appropriately
23009 format chapter headings.
23012 \begin_layout Standard
23013 In many cases, then, you may not have to do anything at all to get acceptable
23014 XHTML output for your own environments, custom insets, and so forth.
23015 But in some cases you will, and so \SpecialChar LyX
23016 provides a number of layout tags that
23017 can be used to customize the XHTML and CSS that are generated.
23020 \begin_layout Standard
23021 Note that there are two tags,
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23032 \begin_inset Flex Code
23035 \begin_layout Plain Layout
23041 that may appear outside style and inset declarations.
23043 \begin_inset CommandInset ref
23045 reference "subsec:General-text-class"
23049 for details on these.
23052 \begin_layout Subsection
23053 \begin_inset CommandInset label
23055 name "subsec:Paragraph-Style-XHTML"
23062 \begin_layout Standard
23063 The sort of XHTML \SpecialChar LyX
23064 outputs for a paragraph depends upon whether we are dealing
23065 with a normal paragraph, a command, or an environment, where this is itself
23066 determined by the contents of the corresponding
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23081 \begin_layout Standard
23082 For a command or normal paragraph, the output XHTML has the following form:
23085 \begin_layout LyX-Code
23089 \begin_inset Quotes erd
23093 \begin_inset Quotes erd
23099 \begin_layout LyX-Code
23103 \begin_inset Quotes erd
23107 \begin_inset Quotes erd
23113 \begin_layout LyX-Code
23116 Contents of the paragraph.
23119 \begin_layout LyX-Code
23125 \begin_layout Standard
23126 The label tags are of course omitted if the paragraph does not have a label.
23129 \begin_layout Standard
23130 For an environment that is not some sort of list, the XHTML takes this form:
23133 \begin_layout LyX-Code
23137 \begin_inset Quotes erd
23141 \begin_inset Quotes erd
23147 \begin_layout LyX-Code
23151 \begin_inset Quotes erd
23155 \begin_inset Quotes erd
23159 \begin_inset Quotes erd
23163 \begin_inset Quotes erd
23166 >Environment Label</labeltag>First paragraph.</itemtag>
23169 \begin_layout LyX-Code
23172 <itemtag>Second paragraph.</itemtag>
23175 \begin_layout LyX-Code
23181 \begin_layout Standard
23182 Note that the label is output only for the first paragraph, as it should
23183 be for a theorem, for example.
23187 \begin_layout Standard
23188 For a list, we have one of these forms:
23191 \begin_layout LyX-Code
23195 \begin_inset Quotes erd
23199 \begin_inset Quotes erd
23205 \begin_layout LyX-Code
23209 \begin_inset Quotes erd
23213 \begin_inset Quotes erd
23217 \begin_inset Quotes erd
23221 \begin_inset Quotes erd
23224 >List Label</labeltag>First item.</itemtag>
23227 \begin_layout LyX-Code
23231 \begin_inset Quotes erd
23235 \begin_inset Quotes erd
23239 \begin_inset Quotes erd
23243 \begin_inset Quotes erd
23246 >List Label</labeltag>Second item.</itemtag>
23249 \begin_layout LyX-Code
23255 \begin_layout LyX-Code
23259 \begin_layout LyX-Code
23263 \begin_inset Quotes erd
23267 \begin_inset Quotes erd
23273 \begin_layout LyX-Code
23277 \begin_inset Quotes erd
23281 \begin_inset Quotes erd
23284 >List Label</labeltag><itemtag attr=
23285 \begin_inset Quotes erd
23289 \begin_inset Quotes erd
23292 >First item.</itemtag>
23295 \begin_layout LyX-Code
23299 \begin_inset Quotes erd
23303 \begin_inset Quotes erd
23306 >List Label</labeltag><itemtag attr=
23307 \begin_inset Quotes erd
23311 \begin_inset Quotes erd
23314 >Second item.</itemtag>
23317 \begin_layout LyX-Code
23323 \begin_layout Standard
23324 Note the different orders of
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23335 \begin_inset Flex Code
23338 \begin_layout Plain Layout
23345 Which order we get depends upon the setting of
23346 \begin_inset Flex Code
23349 \begin_layout Plain Layout
23356 \begin_inset Flex Code
23359 \begin_layout Plain Layout
23365 is false (the default), you get the first of these, with the label within
23366 the item; if true, you get the second, with the label outside the item.
23369 \begin_layout Standard
23370 The specific tags and attributes output for each paragraph type can be controlle
23371 d by means of the layout tags we are about to describe.
23372 As mentioned earlier, however, \SpecialChar LyX
23373 uses sensible defaults for many of these,
23374 so you often may not need to do very much to get good XHTML output.
23375 Think of the available tags as there so you can tweak things to your liking.
23378 \begin_layout Description
23379 \begin_inset Flex Code
23382 \begin_layout Plain Layout
23389 \begin_inset Flex Code
23392 \begin_layout Plain Layout
23398 ] Specifies attribute information to be output with the main tag.
23400 \begin_inset Quotes eld
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23414 \begin_inset Quotes erd
23418 By default, \SpecialChar LyX
23420 \begin_inset Quotes eld
23424 \begin_inset Flex Code
23427 \begin_layout Plain Layout
23434 \begin_inset Quotes erd
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23447 is the \SpecialChar LyX
23448 name of the layout, made lowercase, for example: chapter.
23453 contain any style information.
23455 \begin_inset Flex Code
23458 \begin_layout Plain Layout
23467 \begin_layout Description
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23478 \begin_inset Flex Code
23481 \begin_layout Plain Layout
23491 ] Whether to output the default CSS information \SpecialChar LyX
23492 generates for this layout,
23493 even if additional information is explicitly provided via
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23514 allows you to alter or augment the generated CSS, rather than to override
23517 \begin_inset Flex Code
23520 \begin_layout Plain Layout
23529 \begin_layout Description
23530 \begin_inset Flex Code
23533 \begin_layout Plain Layout
23540 \begin_inset Flex Code
23543 \begin_layout Plain Layout
23549 ] The tag to be used for individual paragraphs of environments, replacing
23551 \begin_inset Flex Code
23554 \begin_layout Plain Layout
23560 in the examples above.
23562 \begin_inset Flex Code
23565 \begin_layout Plain Layout
23574 \begin_layout Description
23575 \begin_inset Flex Code
23578 \begin_layout Plain Layout
23585 \begin_inset Flex Code
23588 \begin_layout Plain Layout
23594 ] Attributes for the item tag.
23596 \begin_inset Newline newline
23600 \begin_inset Quotes eld
23604 \begin_inset Flex Code
23607 \begin_layout Plain Layout
23608 class=`layoutname_item'
23614 \begin_inset Quotes erd
23622 contain any style information.
23624 \begin_inset Flex Code
23627 \begin_layout Plain Layout
23636 \begin_layout Description
23637 \begin_inset Flex Code
23640 \begin_layout Plain Layout
23647 \begin_inset Flex Code
23650 \begin_layout Plain Layout
23656 ] The tag to be used for paragraph and item labels, replacing
23657 \begin_inset Flex Code
23660 \begin_layout Plain Layout
23666 in the examples above.
23668 \begin_inset Flex Code
23671 \begin_layout Plain Layout
23678 \begin_inset Flex Code
23681 \begin_layout Plain Layout
23688 \begin_inset Flex Code
23691 \begin_layout Plain Layout
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23702 Centered_Top_Environment
23707 , in which case it defaults to
23708 \begin_inset Flex Code
23711 \begin_layout Plain Layout
23720 \begin_layout Description
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23731 \begin_inset Flex Code
23734 \begin_layout Plain Layout
23740 ] Attributes for the label tag.
23742 \begin_inset Newline newline
23746 \begin_inset Quotes eld
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23754 class=`layoutname_label'
23760 \begin_inset Quotes erd
23768 contain any style information.
23770 \begin_inset Flex Code
23773 \begin_layout Plain Layout
23782 \begin_layout Description
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23793 \begin_inset Flex Code
23796 \begin_layout Plain Layout
23806 ] Meaningful only for list-like environments, this tag controls whether
23807 the label tag is output before or inside the item tag.
23808 This is used, for example, in the description environment, where we want
23810 \begin_inset Flex Code
23813 \begin_layout Plain Layout
23814 <dt>\SpecialChar ldots
23815 </dt><dd>\SpecialChar ldots
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23832 : The label tag is output inside the item tag.
23835 \begin_layout Description
23836 \begin_inset Flex Code
23839 \begin_layout Plain Layout
23845 Information to be output in the
23846 \begin_inset Flex Code
23849 \begin_layout Plain Layout
23855 section when this style is used.
23856 This might, for example, be used to include a
23857 \begin_inset Flex Code
23860 \begin_layout Plain Layout
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23879 \begin_layout Description
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23889 CSS style information to be included when this style is used.
23890 Note that this will automatically be wrapped in a layout-generated
23891 \begin_inset Flex Code
23894 \begin_layout Plain Layout
23900 block, so only the CSS itself need be included.
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23914 \begin_layout Description
23915 \begin_inset Flex Code
23918 \begin_layout Plain Layout
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23934 ] The tag to be used for the main label, replacing
23935 \begin_inset Flex Code
23938 \begin_layout Plain Layout
23944 in the examples above.
23946 \begin_inset Flex Code
23949 \begin_layout Plain Layout
23958 \begin_layout Description
23959 \begin_inset Flex Code
23962 \begin_layout Plain Layout
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23982 ] Marks this style as the one to be used to generate the
23983 \begin_inset Flex Code
23986 \begin_layout Plain Layout
23992 tag for the XHTML file.
23993 By default, it is false.
23995 \begin_inset Flex Code
23998 \begin_layout Plain Layout
24004 file sets it to true for the
24005 \begin_inset Flex Code
24008 \begin_layout Plain Layout
24018 \begin_layout Subsection
24022 \begin_layout Standard
24023 The XHTML output of insets can also be controlled by information in layout
24028 \begin_layout Plain Layout
24029 At present, this is true only for
24030 \begin_inset Quotes eld
24034 \begin_inset Quotes erd
24037 insets (insets you can type into) and is not true for
24038 \begin_inset Quotes eld
24042 \begin_inset Quotes erd
24045 insets (insets that are associated with dialog boxes).
24050 Here, too, \SpecialChar LyX
24051 tries to provide sensible defaults, and it constructs default
24053 But everything can be customized.
24056 \begin_layout Standard
24057 The XHTML \SpecialChar LyX
24058 outputs for an inset has the following form:
24061 \begin_layout LyX-Code
24063 \begin_inset Quotes erd
24067 \begin_inset Quotes erd
24073 \begin_layout LyX-Code
24074 <labeltag>Label</labeltag>
24077 \begin_layout LyX-Code
24079 \begin_inset Quotes erd
24083 \begin_inset Quotes erd
24086 >Contents of the inset.</innertag>
24089 \begin_layout LyX-Code
24093 \begin_layout Standard
24094 If the inset permits multiple paragraphs—that is, if
24095 \begin_inset Flex Code
24098 \begin_layout Plain Layout
24104 is true—then the contents of the inset will itself be output as paragraphs
24105 formatted according to the styles used for those paragraphs (standard,
24106 quote, and the like).
24107 The label tag is of course omitted if the paragraph does not have a label
24108 and, at present, is always
24109 \begin_inset Flex Code
24112 \begin_layout Plain Layout
24119 The inner tag is optional and, by default, does not appear.
24122 \begin_layout Standard
24123 The specific tags and attributes output for each inset can be controlled
24124 by means of the following layout tags.
24127 \begin_layout Description
24128 \begin_inset Flex Code
24131 \begin_layout Plain Layout
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24147 ] Specifies attribute information to be output with the main tag.
24149 \begin_inset Quotes eld
24153 \begin_inset Flex Code
24156 \begin_layout Plain Layout
24157 class=`myinset' onclick=`\SpecialChar ldots
24164 \begin_inset Quotes erd
24168 By default, \SpecialChar LyX
24170 \begin_inset Quotes eld
24174 \begin_inset Flex Code
24177 \begin_layout Plain Layout
24184 \begin_inset Quotes erd
24188 \begin_inset Flex Code
24191 \begin_layout Plain Layout
24197 is the \SpecialChar LyX
24198 name of the inset, made lowercase and with non-alphanumeric characters
24199 converted to underscores, for example: footnote.
24202 \begin_layout Description
24203 \begin_inset Flex Code
24206 \begin_layout Plain Layout
24213 \begin_inset Flex Code
24216 \begin_layout Plain Layout
24226 ] Whether to output the default CSS information \SpecialChar LyX
24227 generates for this layout,
24228 even if additional information is explicitly provided via
24229 \begin_inset Flex Code
24232 \begin_layout Plain Layout
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24249 allows you to alter or augment the generated CSS, rather than to override
24254 \begin_layout Description
24255 \begin_inset Flex Code
24258 \begin_layout Plain Layout
24265 \begin_inset Flex Code
24268 \begin_layout Plain Layout
24274 ] Attributes for the inner tag.
24276 \begin_inset Newline newline
24280 \begin_inset Quotes eld
24284 \begin_inset Flex Code
24287 \begin_layout Plain Layout
24288 class=`insetname_inner'
24294 \begin_inset Quotes erd
24300 \begin_layout Description
24301 \begin_inset Flex Code
24304 \begin_layout Plain Layout
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24320 ] The inner tag, replacing
24321 \begin_inset Flex Code
24324 \begin_layout Plain Layout
24330 in the examples above.
24331 By default, there is none.
24334 \begin_layout Description
24335 \begin_inset Flex Code
24338 \begin_layout Plain Layout
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24356 ] Whether this inset represents a standalone block of text (such as a footnote)
24357 or instead represents material that is included in the surrounding text
24358 (such as a branch).
24362 \begin_layout Description
24363 \begin_inset Flex Code
24366 \begin_layout Plain Layout
24373 \begin_inset Flex Code
24376 \begin_layout Plain Layout
24382 ] A label for this inset, possibly including a reference to a counter.
24383 For example, for footnote, it might be:
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24396 This is optional, and there is no default.
24399 \begin_layout Description
24400 \begin_inset Flex Code
24403 \begin_layout Plain Layout
24409 Information to be output in the
24410 \begin_inset Flex Code
24413 \begin_layout Plain Layout
24419 section when this style is used.
24420 This might, for example, be used to include a
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24443 \begin_layout Description
24444 \begin_inset Flex Code
24447 \begin_layout Plain Layout
24453 CSS style information to be included when this style is used.
24454 Note that this will automatically be wrapped in a layout-generated
24455 \begin_inset Flex Code
24458 \begin_layout Plain Layout
24464 block, so only the CSS itself need be included.
24467 \begin_layout Description
24468 \begin_inset Flex Code
24471 \begin_layout Plain Layout
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24487 ] The tag to be used for the main label, replacing
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24497 in the examples above.
24498 The default depends upon the setting of
24499 \begin_inset Flex Code
24502 \begin_layout Plain Layout
24509 \begin_inset Flex Code
24512 \begin_layout Plain Layout
24518 is true, the default is
24519 \begin_inset Flex Code
24522 \begin_layout Plain Layout
24528 ; if it is false, the default is
24529 \begin_inset Flex Code
24532 \begin_layout Plain Layout
24541 \begin_layout Subsection
24545 \begin_layout Standard
24546 The XHTML output for floats too can be controlled by layout information.
24547 The output has the following form:
24550 \begin_layout LyX-Code
24552 \begin_inset Quotes erd
24556 \begin_inset Quotes erd
24562 \begin_layout LyX-Code
24563 Contents of the float.
24566 \begin_layout LyX-Code
24570 \begin_layout Standard
24571 The caption, if there is one, is a separate inset and will be output as
24573 Its appearance can be controlled via the InsetLayout for caption insets.
24577 \begin_layout Description
24578 \begin_inset Flex Code
24581 \begin_layout Plain Layout
24588 \begin_inset Flex Code
24591 \begin_layout Plain Layout
24597 ] Specifies attribute information to be output with the main tag.
24599 \begin_inset Quotes eld
24603 \begin_inset Flex Code
24606 \begin_layout Plain Layout
24607 class=`myfloat' onclick=`\SpecialChar ldots
24614 \begin_inset Quotes erd
24618 By default, \SpecialChar LyX
24620 \begin_inset Quotes eld
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24628 class=`float float-floattype'
24634 \begin_inset Quotes erd
24638 \begin_inset Flex Code
24641 \begin_layout Plain Layout
24647 is \SpecialChar LyX
24648 's name for this type of float, as determined by the float declaration
24650 \begin_inset CommandInset ref
24652 reference "subsec:Floats"
24656 ), though made lowercase and with non-alphanumeric characters converted
24657 to underscores, for example: float-table.
24660 \begin_layout Description
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24670 CSS style information to be included when this float is used.
24671 Note that this will automatically be wrapped in a layout-generated
24672 \begin_inset Flex Code
24675 \begin_layout Plain Layout
24681 block, so only the CSS itself need be included.
24684 \begin_layout Description
24685 \begin_inset Flex Code
24688 \begin_layout Plain Layout
24695 \begin_inset Flex Code
24698 \begin_layout Plain Layout
24704 ] The tag to be used for this float, replacing
24705 \begin_inset Quotes eld
24709 \begin_inset Flex Code
24712 \begin_layout Plain Layout
24719 \begin_inset Quotes erd
24722 in the example above.
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24733 and will rarely need changing.
24736 \begin_layout Subsection
24737 Bibliography formatting
24740 \begin_layout Standard
24741 The bibliography can be formatted using
24742 \begin_inset Flex Code
24745 \begin_layout Plain Layout
24753 \begin_inset CommandInset ref
24755 reference "subsec:Citation-format-description"
24762 \begin_layout Subsection
24767 \begin_layout Standard
24768 We have several times mentioned that \SpecialChar LyX
24769 will generate default CSS style rules
24770 for both insets and paragraph styles, based upon the other layout information
24772 In this section, we shall say a word about which layout information \SpecialChar LyX
24777 \begin_layout Standard
24778 At present, \SpecialChar LyX
24779 auto-generates CSS only for font information, making use of
24781 \begin_inset Flex Code
24784 \begin_layout Plain Layout
24791 \begin_inset Flex Code
24794 \begin_layout Plain Layout
24801 \begin_inset Flex Code
24804 \begin_layout Plain Layout
24811 \begin_inset Flex Code
24814 \begin_layout Plain Layout
24821 \begin_inset Flex Code
24824 \begin_layout Plain Layout
24831 \begin_inset CommandInset ref
24833 reference "subsec:Font-description"
24838 The translation is mostly straightforward and obvious.
24840 \begin_inset Quotes eld
24844 \begin_inset Flex Code
24847 \begin_layout Plain Layout
24854 \begin_inset Quotes erd
24858 \begin_inset Quotes eld
24862 \begin_inset Flex Code
24865 \begin_layout Plain Layout
24866 font-family: sans-serif;
24872 \begin_inset Quotes erd
24876 The correspondence of \SpecialChar LyX
24877 sizes and CSS sizes is a little less obvious but
24878 nonetheless intuitive.
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24890 \begin_inset Flex URL
24893 \begin_layout Plain Layout
24903 \begin_layout Chapter
24904 Including External Material
24905 \begin_inset CommandInset label
24907 name "chap:Including-External-Material"
24914 \begin_layout Standard
24915 \begin_inset Box Shadowbox
24925 height_special "totalheight"
24930 backgroundcolor "none"
24933 \begin_layout Plain Layout
24934 WARNING: This portion of the documentation has not been updated for some
24936 We certainly hope that it is still accurate, but there are no guarantees.
24944 \begin_layout Standard
24945 The use of material from sources external to \SpecialChar LyX
24946 is covered in detail in the
24952 This part of the manual covers what needs to happen behind the scenes for
24953 new sorts of material to be included.
24956 \begin_layout Section
24960 \begin_layout Standard
24961 The external material feature is based on the concept of a
24966 A template is a specification of how \SpecialChar LyX
24967 should interface with a certain kind
24969 As bundled, \SpecialChar LyX
24970 comes with predefined templates for Xfig figures, various
24971 raster format images, chess diagrams, and LilyPond music notation.
24972 You can check the actual list by using the menu
24973 \begin_inset Flex Noun
24976 \begin_layout Plain Layout
24977 Insert\SpecialChar menuseparator
24978 File\SpecialChar menuseparator
24985 Furthermore, it is possible to roll your own template to support a specific
24987 Later we'll describe in more detail what is involved, and hopefully you
24988 will submit all the templates you create so we can include them in a later
24993 \begin_layout Standard
24994 Another basic idea of the external material feature is to distinguish between
24995 the original file that serves as a base for final material and the produced
24996 file that is included in your exported or printed document.
24997 For example, consider the case of a figure produced with
24998 \begin_inset Flex Code
25001 \begin_layout Plain Layout
25008 The Xfig application itself works on an original file with the
25009 \begin_inset Flex Code
25012 \begin_layout Plain Layout
25019 Within Xfig, you create and change your figure, and when you are done,
25021 \begin_inset Flex Code
25024 \begin_layout Plain Layout
25031 When you want to include the figure in your document, you invoke
25032 \begin_inset Flex Code
25035 \begin_layout Plain Layout
25041 in order to create a PostScript file that can readily be included in your
25045 \begin_inset Flex Code
25048 \begin_layout Plain Layout
25054 file is the original file, and the PostScript file is the produced file.
25057 \begin_layout Standard
25058 This distinction is important in order to allow updating of the material
25059 while you are in the process of writing the document.
25060 Furthermore, it provides us with the flexibility that is needed to support
25061 multiple export formats.
25062 For instance, in the case of a plain text file, it is not exactly an award-winn
25063 ing idea to include the figure as raw PostScript.
25064 Instead, you would either prefer to just include a reference to the figure
25065 or try to invoke some graphics to ASCII converter to make the final result
25066 look similar to the real graphics.
25067 The external material management allows you to do this, because it is parametri
25068 zed on the different export formats that \SpecialChar LyX
25072 \begin_layout Standard
25073 Besides supporting the production of different products according to the
25074 exported format, it supports tight integration with editing and viewing
25076 In the case of an Xfig figure, you are able to invoke Xfig on the original
25077 file with a single click from within the external material dialog in \SpecialChar LyX
25079 and also preview the produced PostScript file with Ghostview with another
25081 No more fiddling around with the command line and/or file browsers to locate
25082 and manipulate the original or produced files.
25083 In this way, you are finally able to take full advantage of the many different
25084 applications that are relevant to use when you write your documents, and
25085 ultimately be more productive.
25088 \begin_layout Section
25089 The external template configuration files
25092 \begin_layout Standard
25093 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25095 However, be aware that doing this in an careless manner most probably
25099 introduce an easily exploitable security hole.
25100 So before you do this, please read the discussion about security in
25101 \begin_inset CommandInset ref
25103 reference "sec:Security-discussion"
25110 \begin_layout Standard
25111 Having said that, we encourage you to submit any interesting templates that
25116 \begin_layout Standard
25117 The external templates are defined in the
25118 \begin_inset Flex Code
25121 \begin_layout Plain Layout
25127 files that are stored in the
25128 \begin_inset Flex Code
25131 \begin_layout Plain Layout
25132 LyXDir/lib/xtemplates/
25138 Each template is defined in a file of its own.
25139 You can place your own templates in
25140 \begin_inset Flex Code
25143 \begin_layout Plain Layout
25144 UserDir/xtemplates/
25149 or copy existing templates to that directory in order to modify them.
25152 \begin_layout Standard
25153 A typical template looks like this:
25156 \begin_layout LyX-Code
25160 \begin_layout LyX-Code
25161 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25164 \begin_layout LyX-Code
25168 \begin_layout LyX-Code
25172 \begin_layout LyX-Code
25176 \begin_layout LyX-Code
25180 \begin_layout LyX-Code
25184 \begin_layout LyX-Code
25185 AutomaticProduction true
25188 \begin_layout LyX-Code
25192 \begin_layout LyX-Code
25196 \begin_layout LyX-Code
25200 \begin_layout LyX-Code
25201 TransformCommand Rotate RotationLatexCommand
25204 \begin_layout LyX-Code
25205 TransformCommand Resize ResizeLatexCommand
25208 \begin_layout LyX-Code
25209 Product "$$RotateFront$$ResizeFront
25212 \begin_layout LyX-Code
25217 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25220 \begin_layout LyX-Code
25221 $$ResizeBack$$RotateBack"
25224 \begin_layout LyX-Code
25228 \begin_layout LyX-Code
25229 UpdateResult "$$AbsPath$$Basename.pstex_t"
25232 \begin_layout LyX-Code
25233 Requirement "graphicx"
25236 \begin_layout LyX-Code
25237 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25240 \begin_layout LyX-Code
25241 ReferencedFile latex "$$AbsPath$$Basename.eps"
25244 \begin_layout LyX-Code
25245 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25248 \begin_layout LyX-Code
25252 \begin_layout LyX-Code
25256 \begin_layout LyX-Code
25257 TransformCommand Rotate RotationLatexCommand
25260 \begin_layout LyX-Code
25261 TransformCommand Resize ResizeLatexCommand
25264 \begin_layout LyX-Code
25265 Product "$$RotateFront$$ResizeFront
25268 \begin_layout LyX-Code
25273 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25276 \begin_layout LyX-Code
25277 $$ResizeBack$$RotateBack"
25280 \begin_layout LyX-Code
25281 UpdateFormat pdftex
25284 \begin_layout LyX-Code
25285 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25288 \begin_layout LyX-Code
25289 Requirement "graphicx"
25292 \begin_layout LyX-Code
25293 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25296 \begin_layout LyX-Code
25297 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25300 \begin_layout LyX-Code
25304 \begin_layout LyX-Code
25308 \begin_layout LyX-Code
25309 Product "[XFig: $$FName]"
25312 \begin_layout LyX-Code
25316 \begin_layout LyX-Code
25320 \begin_layout LyX-Code
25321 Product "<graphic fileref=
25323 "$$AbsOrRelPathMaster$$Basename.eps
25328 \begin_layout LyX-Code
25332 \begin_layout LyX-Code
25336 \begin_layout LyX-Code
25337 UpdateResult "$$AbsPath$$Basename.eps"
25340 \begin_layout LyX-Code
25341 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25344 \begin_layout LyX-Code
25345 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25348 \begin_layout LyX-Code
25352 \begin_layout LyX-Code
25356 \begin_layout Standard
25357 As you can see, the template is enclosed in
25358 \begin_inset Flex Code
25361 \begin_layout Plain Layout
25369 \begin_inset Flex Code
25372 \begin_layout Plain Layout
25379 It contains a header specifying some general settings and, for each supported
25380 primary document file format, a section
25381 \begin_inset Flex Code
25384 \begin_layout Plain Layout
25392 \begin_inset Flex Code
25395 \begin_layout Plain Layout
25404 \begin_layout Subsection
25405 The template header
25408 \begin_layout Description
25409 \begin_inset Flex Code
25412 \begin_layout Plain Layout
25413 AutomaticProduction
25414 \begin_inset space ~
25422 Whether the file represented by the template must be generated by \SpecialChar LyX
25424 This command must occur exactly once.
25427 \begin_layout Description
25428 \begin_inset Flex Code
25431 \begin_layout Plain Layout
25433 \begin_inset space ~
25441 A glob pattern that is used in the file dialog to filter out the desired
25443 If there is more than one possible file extension (e.
25444 \begin_inset space \thinspace{}
25448 \begin_inset space \space{}
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25462 \begin_inset Flex Code
25465 \begin_layout Plain Layout
25471 ), use something like
25472 \begin_inset Flex Code
25475 \begin_layout Plain Layout
25482 This command must occur exactly once.
25485 \begin_layout Description
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25491 \begin_inset space ~
25499 The text that is displayed on the button.
25500 This command must occur exactly once.
25503 \begin_layout Description
25504 \begin_inset Flex Code
25507 \begin_layout Plain Layout
25509 \begin_inset space ~
25513 \begin_inset space ~
25521 The help text that is used in the External dialog.
25522 Provide enough information to explain to the user just what the template
25523 can provide him with.
25524 This command must occur exactly once.
25527 \begin_layout Description
25528 \begin_inset Flex Code
25531 \begin_layout Plain Layout
25533 \begin_inset space ~
25541 The file format of the original file.
25542 This must be the name of a format that is known to \SpecialChar LyX
25544 \begin_inset CommandInset ref
25546 reference "sec:Formats"
25552 \begin_inset Quotes eld
25556 \begin_inset Flex Code
25559 \begin_layout Plain Layout
25566 \begin_inset Quotes erd
25569 if the template can handle original files of more than one format.
25571 will attempt to interrogate the file itself in order to deduce its format
25573 This command must occur exactly once.
25576 \begin_layout Description
25577 \begin_inset Flex Code
25580 \begin_layout Plain Layout
25582 \begin_inset space ~
25590 A unique name for the template.
25591 It must not contain substitution macros (see below).
25594 \begin_layout Description
25595 \begin_inset Flex Code
25598 \begin_layout Plain Layout
25600 \begin_inset space ~
25603 Rotate|Resize|Clip|Extra
25608 This command specifies which transformations are supported by this template.
25609 It may occur zero or more times.
25610 This command enables the corresponding tabs in the external dialog.
25612 \begin_inset Flex Code
25615 \begin_layout Plain Layout
25621 command must have either a corresponding
25622 \begin_inset Flex Code
25625 \begin_layout Plain Layout
25632 \begin_inset Flex Code
25635 \begin_layout Plain Layout
25642 \begin_inset Flex Code
25645 \begin_layout Plain Layout
25652 Otherwise the transformation will not be supported by that format.
25655 \begin_layout Subsection
25659 \begin_layout Description
25660 \begin_inset Flex Code
25663 \begin_layout Plain Layout
25665 \begin_inset space ~
25668 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25673 The primary document file format that this format definition is for.
25674 Not every template has a sensible representation in all document file formats.
25675 Please define nevertheless a
25676 \begin_inset Flex Code
25679 \begin_layout Plain Layout
25685 section for all templates.
25686 Use a dummy text when no representation is available.
25687 Then you can at least see a reference to the external material in the exported
25691 \begin_layout Description
25692 \begin_inset Flex Code
25695 \begin_layout Plain Layout
25697 \begin_inset space ~
25701 \begin_inset space ~
25709 This command defines an additional macro
25710 \begin_inset Flex Code
25713 \begin_layout Plain Layout
25719 for substitution in
25720 \begin_inset Flex Code
25723 \begin_layout Plain Layout
25731 \begin_inset Flex Code
25734 \begin_layout Plain Layout
25740 itself may contain substitution macros.
25741 The advantage over using
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25752 \begin_inset Flex Code
25755 \begin_layout Plain Layout
25761 is that the substituted value of
25762 \begin_inset Flex Code
25765 \begin_layout Plain Layout
25771 is sanitized so that it is a valid optional argument in the document format.
25772 This command may occur zero or more times.
25775 \begin_layout Description
25776 \begin_inset Flex Code
25779 \begin_layout Plain Layout
25781 \begin_inset space ~
25789 The text that is inserted in the exported document.
25790 This is actually the most important command and can be quite complex.
25791 This command must occur exactly once.
25794 \begin_layout Description
25795 \begin_inset Flex Code
25798 \begin_layout Plain Layout
25800 \begin_inset space ~
25808 This command specifies a preamble snippet that will be included in the
25811 It has to be defined using
25812 \begin_inset Flex Code
25815 \begin_layout Plain Layout
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25833 This command may occur zero or more times.
25836 \begin_layout Description
25837 \begin_inset Flex Code
25840 \begin_layout Plain Layout
25842 \begin_inset space ~
25846 \begin_inset space ~
25854 This command denotes files that are created by the conversion process and
25855 are needed for a particular export format.
25856 If the filename is relative, it is interpreted relative to the master document.
25857 This command may be given zero or more times.
25860 \begin_layout Description
25861 \begin_inset Flex Code
25864 \begin_layout Plain Layout
25866 \begin_inset space ~
25874 The name of a required \SpecialChar LaTeX
25876 The package is included via
25877 \begin_inset Flex Code
25880 \begin_layout Plain Layout
25888 in the \SpecialChar LaTeX
25890 This command may occur zero or more times.
25893 \begin_layout Description
25894 \begin_inset Flex Code
25897 \begin_layout Plain Layout
25899 \begin_inset space ~
25903 \begin_inset space ~
25906 RotationLatexCommand
25911 This command specifies that the built in \SpecialChar LaTeX
25912 command should be used for rotation.
25913 This command may occur once or not at all.
25916 \begin_layout Description
25917 \begin_inset Flex Code
25920 \begin_layout Plain Layout
25922 \begin_inset space ~
25926 \begin_inset space ~
25934 This command specifies that the built in \SpecialChar LaTeX
25935 command should be used for resizing.
25936 This command may occur once or not at all.
25939 \begin_layout Description
25940 \begin_inset Flex Code
25943 \begin_layout Plain Layout
25945 \begin_inset space ~
25949 \begin_inset space ~
25952 RotationLatexOption
25957 This command specifies that rotation is done via an optional argument.
25958 This command may occur once or not at all.
25961 \begin_layout Description
25962 \begin_inset Flex Code
25965 \begin_layout Plain Layout
25967 \begin_inset space ~
25971 \begin_inset space ~
25979 This command specifies that resizing is done via an optional argument.
25980 This command may occur once or not at all.
25983 \begin_layout Description
25984 \begin_inset Flex Code
25987 \begin_layout Plain Layout
25989 \begin_inset space ~
25993 \begin_inset space ~
26001 This command specifies that clipping is done via an optional argument.
26002 This command may occur once or not at all.
26005 \begin_layout Description
26006 \begin_inset Flex Code
26009 \begin_layout Plain Layout
26011 \begin_inset space ~
26015 \begin_inset space ~
26023 This command specifies that an extra optional argument is used.
26024 This command may occur once or not at all.
26027 \begin_layout Description
26028 \begin_inset Flex Code
26031 \begin_layout Plain Layout
26033 \begin_inset space ~
26041 The file format of the converted file.
26042 This must be the name of a format that is known to \SpecialChar LyX
26044 \begin_inset Flex Noun
26047 \begin_layout Plain Layout
26048 Tools\SpecialChar menuseparator
26049 Preferences\SpecialChar menuseparator
26050 File Handling\SpecialChar menuseparator
26057 This command must occur exactly once.
26058 If the resulting file format is PDF, you need to specify the format
26059 \begin_inset Flex Code
26062 \begin_layout Plain Layout
26069 This is the PDF format used for including graphics.
26070 The other defined PDF formats are for document export.
26073 \begin_layout Description
26074 \begin_inset Flex Code
26077 \begin_layout Plain Layout
26079 \begin_inset space ~
26087 The file name of the converted file.
26088 The file name must be absolute.
26089 This command must occur exactly once.
26092 \begin_layout Subsection
26093 Preamble definitions
26096 \begin_layout Standard
26097 The external template configuration file may contain additional preamble
26098 definitions enclosed by
26099 \begin_inset Flex Code
26102 \begin_layout Plain Layout
26110 \begin_inset Flex Code
26113 \begin_layout Plain Layout
26120 They can be used by the templates in the
26121 \begin_inset Flex Code
26124 \begin_layout Plain Layout
26133 \begin_layout Section
26134 The substitution mechanism
26137 \begin_layout Standard
26138 When the external material facility invokes an external program, it is done
26139 on the basis of a command defined in the template configuration file.
26140 These commands can contain various macros that are expanded before execution.
26141 Execution always take place in the directory of the containing document.
26144 \begin_layout Standard
26145 Also, whenever external material is to be displayed, the name will be produced
26146 by the substitution mechanism, and most other commands in the template
26147 definition support substitution as well.
26150 \begin_layout Standard
26151 The available macros are the following:
26154 \begin_layout Description
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26159 $$AbsOrRelPathMaster
26164 The file path, absolute or relative to the master \SpecialChar LyX
26168 \begin_layout Description
26169 \begin_inset Flex Code
26172 \begin_layout Plain Layout
26173 $$AbsOrRelPathParent
26178 The file path, absolute or relative to the \SpecialChar LyX
26182 \begin_layout Description
26183 \begin_inset Flex Code
26186 \begin_layout Plain Layout
26192 The absolute file path.
26195 \begin_layout Description
26196 \begin_inset Flex Code
26199 \begin_layout Plain Layout
26205 The filename without path and without the extension.
26208 \begin_layout Description
26209 \begin_inset Flex Code
26212 \begin_layout Plain Layout
26214 \begin_inset Quotes eld
26218 \begin_inset Quotes erd
26226 This macro will expand to the contents of the file with the name
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26239 \begin_layout Description
26240 \begin_inset Flex Code
26243 \begin_layout Plain Layout
26249 The file extension (including the dot).
26252 \begin_layout Description
26253 \begin_inset Flex Code
26256 \begin_layout Plain Layout
26262 This will be the string
26263 \begin_inset Quotes eld
26267 \begin_inset Quotes erd
26270 if the file is in JPEG format, otherwise it will be the string
26271 \begin_inset Quotes eld
26275 \begin_inset Quotes erd
26279 This is useful to avoid uneeded conversions for output formats that support
26280 both PNG and JPEG fomats.
26281 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26286 \begin_layout Description
26287 \begin_inset Flex Code
26290 \begin_layout Plain Layout
26296 The filename of the file specified in the external material dialog.
26297 This is either an absolute name, or it is relative to the \SpecialChar LyX
26301 \begin_layout Description
26302 \begin_inset Flex Code
26305 \begin_layout Plain Layout
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26321 (absolute name or relative to the \SpecialChar LyX
26325 \begin_layout Description
26326 \begin_inset Flex Code
26329 \begin_layout Plain Layout
26335 The file path, relative to the master \SpecialChar LyX
26339 \begin_layout Description
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26349 The file path, relative to the \SpecialChar LyX
26353 \begin_layout Description
26354 \begin_inset Flex Code
26357 \begin_layout Plain Layout
26363 This macro will expand to the absolute path of the system directory.
26364 This is typically used to point to the various helper scripts that are
26365 bundled with \SpecialChar LyX
26369 \begin_layout Description
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26379 A name and full path to a temporary file which will be automatically deleted
26380 whenever the containing document is closed, or the external material insertion
26384 \begin_layout Standard
26385 All path macros contain a trailing directory separator, so you can construct
26387 \begin_inset space \thinspace{}
26391 \begin_inset space \space{}
26394 the absolute filename with
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26399 $$AbsPath$$Basename$$Extension
26407 \begin_layout Standard
26408 The macros above are substituted in all commands unless otherwise noted.
26410 \begin_inset Flex Code
26413 \begin_layout Plain Layout
26419 supports additionally the following substitutions if they are enabled by
26421 \begin_inset Flex Code
26424 \begin_layout Plain Layout
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26443 \begin_layout Description
26444 \begin_inset Flex Code
26447 \begin_layout Plain Layout
26453 The front part of the resize command.
26456 \begin_layout Description
26457 \begin_inset Flex Code
26460 \begin_layout Plain Layout
26466 The back part of the resize command.
26469 \begin_layout Description
26470 \begin_inset Flex Code
26473 \begin_layout Plain Layout
26479 The front part of the rotation command.
26482 \begin_layout Description
26483 \begin_inset Flex Code
26486 \begin_layout Plain Layout
26492 The back part of the rotation command.
26495 \begin_layout Standard
26496 The value string of the
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26506 command supports additionally the following substitutions if they are enabled
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26518 \begin_inset Flex Code
26521 \begin_layout Plain Layout
26530 \begin_layout Description
26531 \begin_inset Flex Code
26534 \begin_layout Plain Layout
26543 \begin_layout Description
26544 \begin_inset Flex Code
26547 \begin_layout Plain Layout
26556 \begin_layout Description
26557 \begin_inset Flex Code
26560 \begin_layout Plain Layout
26569 \begin_layout Description
26570 \begin_inset Flex Code
26573 \begin_layout Plain Layout
26579 The rotation option.
26582 \begin_layout Standard
26583 You may ask why there are so many path macros.
26584 There are mainly two reasons:
26587 \begin_layout Enumerate
26588 Relative and absolute file names should remain relative or absolute, respectivel
26590 Users may have reasons to prefer either form.
26591 Relative names are useful for portable documents that should work on different
26592 machines, for example.
26593 Absolute names may be required by some programs.
26596 \begin_layout Enumerate
26598 treats relative file names differently than \SpecialChar LyX
26599 and other programs in nested
26601 For \SpecialChar LyX
26602 , a relative file name is always relative to the document that contains
26604 For \SpecialChar LaTeX
26605 , it is always relative to the master document.
26606 These two definitions are identical if you have only one document, but
26607 differ if you have a master document that includes part documents.
26608 That means that relative filenames must be transformed when presented to
26611 Fortunately \SpecialChar LyX
26612 does this automatically for you if you choose the right macros.
26615 \begin_layout Standard
26616 So which path macro should be used in new template definitions? The rule
26620 \begin_layout Itemize
26622 \begin_inset Flex Code
26625 \begin_layout Plain Layout
26631 if an absolute path is required.
26634 \begin_layout Itemize
26636 \begin_inset Flex Code
26639 \begin_layout Plain Layout
26640 $$AbsOrRelPathMaster
26645 if the substituted string is some kind of \SpecialChar LaTeX
26649 \begin_layout Itemize
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26655 $$AbsOrRelPathParent
26660 in order to preserve the user's choice.
26663 \begin_layout Standard
26664 There are special cases where this rule does not work and e.
26665 \begin_inset space \thinspace{}
26669 \begin_inset space \space{}
26672 relative names are needed, but normally it will work just fine.
26673 One example for such a case is the command
26674 \begin_inset Flex Code
26677 \begin_layout Plain Layout
26678 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26683 in the XFig template above: We can't use the absolute name because the
26685 \begin_inset Flex Code
26688 \begin_layout Plain Layout
26694 files needs the relative name in order to rewrite the file content.
26697 \begin_layout Section
26698 Security discussion
26699 \begin_inset CommandInset label
26701 name "sec:Security-discussion"
26708 \begin_layout Standard
26709 The external material feature interfaces with a lot of external programs
26710 and does so automatically, so we have to consider the security implications
26712 In particular, since you have the option of including your own filenames
26713 and/or parameter strings and those are expanded into a command, it seems
26714 that it would be possible to create a malicious document which executes
26715 arbitrary commands when a user views or prints the document.
26716 This is something we definitely want to avoid.
26719 \begin_layout Standard
26720 However, since the external program commands are specified in the template
26721 configuration file only, there are no security issues if \SpecialChar LyX
26722 is properly configure
26723 d with safe templates only.
26724 This is so because the external programs are invoked with the
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26734 -system call rather than the
26735 \begin_inset Flex Code
26738 \begin_layout Plain Layout
26744 system-call, so it's not possible to execute arbitrary commands from the
26745 filename or parameter section via the shell.
26748 \begin_layout Standard
26749 This also implies that you are restricted in what command strings you can
26750 use in the external material templates.
26751 In particular, pipes and redirection are not readily available.
26752 This has to be so if \SpecialChar LyX
26753 should remain safe.
26754 If you want to use some of the shell features, you should write a safe
26755 script to do this in a controlled manner, and then invoke the script from
26756 the command string.
26760 \begin_layout Standard
26761 It is possible to design a template that interacts directly with the shell,
26762 but since this would allow a malicious user to execute arbitrary commands
26763 by writing clever filenames and/or parameters, we generally recommend that
26764 you only use safe scripts that work with the
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26774 system call in a controlled manner.
26775 Of course, for use in a controlled environment, it can be tempting to just
26776 fall back to use ordinary shell scripts.
26777 If you do so, be aware that you
26781 provide an easily exploitable security hole in your system.
26782 Of course it stands to reason that such unsafe templates will never be
26783 included in the standard \SpecialChar LyX
26784 distribution, although we do encourage people
26785 to submit new templates in the open source tradition.
26786 But \SpecialChar LyX
26787 as shipped from the official distribution channels will never have
26791 \begin_layout Standard
26792 Including external material provides a lot of power, and you have to be
26793 careful not to introduce security hazards with this power.
26794 A subtle error in a single line in an innocent looking script can open
26795 the door to huge security problems.
26796 So if you do not fully understand the issues, we recommend that you consult
26797 a knowledgeable security professional or the \SpecialChar LyX
26798 development team if you have
26799 any questions about whether a given template is safe or not.
26800 And do this before you use it in an uncontrolled environment.
26803 \begin_layout Chapter
26805 List of supported \SpecialChar LyX
26806 functions to be used in layouts
26807 \begin_inset CommandInset label
26809 name "chap:List-of-functions"
26816 \begin_layout Standard
26818 \begin_inset Tabular
26819 <lyxtabular version="3" rows="11" columns="8">
26820 <features tabularvalignment="middle">
26821 <column alignment="left" valignment="top">
26822 <column alignment="left" valignment="top">
26823 <column alignment="left" valignment="top">
26824 <column alignment="left" valignment="top">
26825 <column alignment="left" valignment="top">
26826 <column alignment="left" valignment="top">
26827 <column alignment="left" valignment="top">
26828 <column alignment="left" valignment="top">
26830 <cell alignment="left" valignment="top" usebox="none">
26833 \begin_layout Plain Layout
26839 <cell alignment="left" valignment="top" usebox="none">
26842 \begin_layout Plain Layout
26848 <cell alignment="left" valignment="top" usebox="none">
26851 \begin_layout Plain Layout
26857 <cell alignment="left" valignment="top" usebox="none">
26860 \begin_layout Plain Layout
26866 <cell alignment="center" valignment="top" usebox="none">
26869 \begin_layout Plain Layout
26875 <cell alignment="center" valignment="top" usebox="none">
26878 \begin_layout Plain Layout
26884 <cell alignment="center" valignment="top" usebox="none">
26887 \begin_layout Plain Layout
26893 <cell alignment="center" valignment="top" usebox="none">
26896 \begin_layout Plain Layout
26904 <cell alignment="left" valignment="top" usebox="none">
26907 \begin_layout Plain Layout
26913 <cell alignment="left" valignment="top" usebox="none">
26916 \begin_layout Plain Layout
26922 <cell alignment="left" valignment="top" usebox="none">
26925 \begin_layout Plain Layout
26931 <cell alignment="left" valignment="top" usebox="none">
26934 \begin_layout Plain Layout
26940 <cell alignment="center" valignment="top" usebox="none">
26943 \begin_layout Plain Layout
26949 <cell alignment="center" valignment="top" usebox="none">
26952 \begin_layout Plain Layout
26958 <cell alignment="center" valignment="top" usebox="none">
26961 \begin_layout Plain Layout
26967 <cell alignment="center" valignment="top" usebox="none">
26970 \begin_layout Plain Layout
26978 <cell alignment="left" valignment="top" usebox="none">
26981 \begin_layout Plain Layout
26987 <cell alignment="left" valignment="top" usebox="none">
26990 \begin_layout Plain Layout
26996 <cell alignment="left" valignment="top" usebox="none">
26999 \begin_layout Plain Layout
27005 <cell alignment="left" valignment="top" usebox="none">
27008 \begin_layout Plain Layout
27014 <cell alignment="center" valignment="top" usebox="none">
27017 \begin_layout Plain Layout
27023 <cell alignment="center" valignment="top" usebox="none">
27026 \begin_layout Plain Layout
27032 <cell alignment="center" valignment="top" usebox="none">
27035 \begin_layout Plain Layout
27041 <cell alignment="center" valignment="top" usebox="none">
27044 \begin_layout Plain Layout
27052 <cell alignment="left" valignment="top" usebox="none">
27055 \begin_layout Plain Layout
27061 <cell alignment="left" valignment="top" usebox="none">
27064 \begin_layout Plain Layout
27070 <cell alignment="left" valignment="top" usebox="none">
27073 \begin_layout Plain Layout
27079 <cell alignment="left" valignment="top" usebox="none">
27082 \begin_layout Plain Layout
27088 <cell alignment="center" valignment="top" usebox="none">
27091 \begin_layout Plain Layout
27097 <cell alignment="center" valignment="top" usebox="none">
27100 \begin_layout Plain Layout
27106 <cell alignment="center" valignment="top" usebox="none">
27109 \begin_layout Plain Layout
27115 <cell alignment="center" valignment="top" usebox="none">
27118 \begin_layout Plain Layout
27126 <cell alignment="left" valignment="top" usebox="none">
27129 \begin_layout Plain Layout
27135 <cell alignment="left" valignment="top" usebox="none">
27138 \begin_layout Plain Layout
27144 <cell alignment="left" valignment="top" usebox="none">
27147 \begin_layout Plain Layout
27153 <cell alignment="left" valignment="top" usebox="none">
27156 \begin_layout Plain Layout
27162 <cell alignment="center" valignment="top" usebox="none">
27165 \begin_layout Plain Layout
27171 <cell alignment="center" valignment="top" usebox="none">
27174 \begin_layout Plain Layout
27180 <cell alignment="center" valignment="top" usebox="none">
27183 \begin_layout Plain Layout
27189 <cell alignment="center" valignment="top" usebox="none">
27192 \begin_layout Plain Layout
27200 <cell alignment="left" valignment="top" usebox="none">
27203 \begin_layout Plain Layout
27209 <cell alignment="left" valignment="top" usebox="none">
27212 \begin_layout Plain Layout
27218 <cell alignment="left" valignment="top" usebox="none">
27221 \begin_layout Plain Layout
27227 <cell alignment="left" valignment="top" usebox="none">
27230 \begin_layout Plain Layout
27236 <cell alignment="center" valignment="top" usebox="none">
27239 \begin_layout Plain Layout
27245 <cell alignment="center" valignment="top" usebox="none">
27248 \begin_layout Plain Layout
27254 <cell alignment="center" valignment="top" usebox="none">
27257 \begin_layout Plain Layout
27263 <cell alignment="center" valignment="top" usebox="none">
27266 \begin_layout Plain Layout
27274 <cell alignment="left" valignment="top" usebox="none">
27277 \begin_layout Plain Layout
27283 <cell alignment="left" valignment="top" usebox="none">
27286 \begin_layout Plain Layout
27292 <cell alignment="left" valignment="top" usebox="none">
27295 \begin_layout Plain Layout
27301 <cell alignment="left" valignment="top" usebox="none">
27304 \begin_layout Plain Layout
27310 <cell alignment="center" valignment="top" usebox="none">
27313 \begin_layout Plain Layout
27319 <cell alignment="center" valignment="top" usebox="none">
27322 \begin_layout Plain Layout
27328 <cell alignment="center" valignment="top" usebox="none">
27331 \begin_layout Plain Layout
27337 <cell alignment="center" valignment="top" usebox="none">
27340 \begin_layout Plain Layout
27348 <cell alignment="left" valignment="top" usebox="none">
27351 \begin_layout Plain Layout
27357 <cell alignment="left" valignment="top" usebox="none">
27360 \begin_layout Plain Layout
27366 <cell alignment="left" valignment="top" usebox="none">
27369 \begin_layout Plain Layout
27375 <cell alignment="left" valignment="top" usebox="none">
27378 \begin_layout Plain Layout
27384 <cell alignment="center" valignment="top" usebox="none">
27387 \begin_layout Plain Layout
27393 <cell alignment="center" valignment="top" usebox="none">
27396 \begin_layout Plain Layout
27402 <cell alignment="center" valignment="top" usebox="none">
27405 \begin_layout Plain Layout
27411 <cell alignment="center" valignment="top" usebox="none">
27414 \begin_layout Plain Layout
27422 <cell alignment="left" valignment="top" usebox="none">
27425 \begin_layout Plain Layout
27431 <cell alignment="left" valignment="top" usebox="none">
27434 \begin_layout Plain Layout
27440 <cell alignment="left" valignment="top" usebox="none">
27443 \begin_layout Plain Layout
27449 <cell alignment="left" valignment="top" usebox="none">
27452 \begin_layout Plain Layout
27458 <cell alignment="center" valignment="top" usebox="none">
27461 \begin_layout Plain Layout
27467 <cell alignment="center" valignment="top" usebox="none">
27470 \begin_layout Plain Layout
27476 <cell alignment="center" valignment="top" usebox="none">
27479 \begin_layout Plain Layout
27485 <cell alignment="center" valignment="top" usebox="none">
27488 \begin_layout Plain Layout
27496 <cell alignment="left" valignment="top" usebox="none">
27499 \begin_layout Plain Layout
27505 <cell alignment="left" valignment="top" usebox="none">
27508 \begin_layout Plain Layout
27514 <cell alignment="left" valignment="top" usebox="none">
27517 \begin_layout Plain Layout
27523 <cell alignment="left" valignment="top" usebox="none">
27526 \begin_layout Plain Layout
27532 <cell alignment="center" valignment="top" usebox="none">
27535 \begin_layout Plain Layout
27541 <cell alignment="center" valignment="top" usebox="none">
27544 \begin_layout Plain Layout
27550 <cell alignment="center" valignment="top" usebox="none">
27553 \begin_layout Plain Layout
27559 <cell alignment="center" valignment="top" usebox="none">
27562 \begin_layout Plain Layout
27570 <cell alignment="center" valignment="top" usebox="none">
27573 \begin_layout Plain Layout
27579 <cell alignment="center" valignment="top" usebox="none">
27582 \begin_layout Plain Layout
27588 <cell alignment="center" valignment="top" usebox="none">
27591 \begin_layout Plain Layout
27597 <cell alignment="center" valignment="top" usebox="none">
27600 \begin_layout Plain Layout
27606 <cell alignment="center" valignment="top" usebox="none">
27609 \begin_layout Plain Layout
27615 <cell alignment="center" valignment="top" usebox="none">
27618 \begin_layout Plain Layout
27624 <cell alignment="center" valignment="top" usebox="none">
27627 \begin_layout Plain Layout
27633 <cell alignment="center" valignment="top" usebox="none">
27636 \begin_layout Plain Layout
27650 \begin_layout Chapter
27651 Names of available colors to be used in layouts
27652 \begin_inset CommandInset label
27654 name "chap:Names-of-colors"
27661 \begin_layout Standard
27662 The colors listed below are the standard colors and those that you can adjust
27663 in the \SpecialChar LyX
27667 \begin_layout Section
27671 \begin_layout Standard
27672 The following are no real colors, but rather act on color definitions:
27675 \begin_layout Description
27676 ignore The color is ignored
27679 \begin_layout Description
27680 inherit The color is inherited
27683 \begin_layout Description
27696 No particular color – clear or default
27699 \begin_layout Section
27703 \begin_layout Standard
27704 These are fixed colors that cannot me customized:
27707 \begin_layout Description
27711 \begin_layout Description
27715 \begin_layout Description
27719 \begin_layout Description
27723 \begin_layout Description
27727 \begin_layout Description
27731 \begin_layout Description
27735 \begin_layout Description
27739 \begin_layout Description
27743 \begin_layout Description
27747 \begin_layout Description
27751 \begin_layout Description
27755 \begin_layout Description
27759 \begin_layout Description
27763 \begin_layout Description
27767 \begin_layout Description
27771 \begin_layout Description
27775 \begin_layout Description
27779 \begin_layout Description
27783 \begin_layout Section
27787 \begin_layout Standard
27788 These are the colors allocated to specific elements in
27791 arg "dialog-show prefs"
27797 \begin_layout Description
27798 added_space Added space color
27801 \begin_layout Description
27802 addedtext Added text color
27805 \begin_layout Description
27806 appendix Appendix marker color
27809 \begin_layout Description
27810 background Background color
27813 \begin_layout Description
27814 bottomarea Bottom area color
27817 \begin_layout Description
27818 branchlabel Label color for branches
27821 \begin_layout Description
27822 buttonbg Color used for button background
27825 \begin_layout Description
27826 buttonframe Color for inset button frames
27829 \begin_layout Description
27830 buttonhoverbg Color used for button background under focus
27833 \begin_layout Description
27834 changebar Changebar color
27837 \begin_layout Description
27838 changedtextauthor1 Changed text color author 1
27841 \begin_layout Description
27842 changedtextauthor2 Changed text color author 2
27845 \begin_layout Description
27846 changedtextauthor3 Changed text color author 3
27849 \begin_layout Description
27850 changedtextauthor4 Changed text color author 4
27853 \begin_layout Description
27854 changedtextauthor5 Changed text color author 5
27857 \begin_layout Description
27858 collapsible Collapsible insets text color
27861 \begin_layout Description
27862 collapsibleframe Collapsible insets framecolor
27865 \begin_layout Description
27866 command Text color for command insets
27869 \begin_layout Description
27870 commandbg Background color for command insets
27873 \begin_layout Description
27874 commandframe Frame color for command insets
27877 \begin_layout Description
27878 commentbg Background color of comments
27881 \begin_layout Description
27882 commentlabel Label color for comments
27885 \begin_layout Description
27886 cursor Cursor color
27889 \begin_layout Description
27890 deletedtext Deleted text color
27893 \begin_layout Description
27894 deletedtextmodifier Deleted text modifying color
27897 \begin_layout Description
27898 depthbar Color for the depth bars in the margin
27901 \begin_layout Description
27902 eolmarker End of line marker color
27905 \begin_layout Description
27906 error Color of the \SpecialChar LaTeX
27910 \begin_layout Description
27911 footlabel Label color for footnotes
27914 \begin_layout Description
27915 foreground Foreground color
27918 \begin_layout Description
27919 graphicsbg Graphics inset background color
27922 \begin_layout Description
27923 greyedoutbg Background color of greyedout inset
27926 \begin_layout Description
27927 greyedoutlabel Label color for greyedout insets
27930 \begin_layout Description
27931 greyedouttext Color for greyedout inset text
27934 \begin_layout Description
27935 indexlabel Label color for index insets
27938 \begin_layout Description
27939 inlinecompletion Inline completion color
27942 \begin_layout Description
27943 insetbg Inset marker background color
27946 \begin_layout Description
27947 insetframe Inset marker frame color
27950 \begin_layout Description
27951 language Color for marking foreign language words
27954 \begin_layout Description
27955 latex Text color in \SpecialChar LaTeX
27959 \begin_layout Description
27960 listingsbg Background color of listings inset
27963 \begin_layout Description
27964 marginlabel Label color for margin notes
27967 \begin_layout Description
27968 math Math inset text color
27971 \begin_layout Description
27972 mathbg Math inset background color
27975 \begin_layout Description
27976 mathcorners Math inset frame color not under focus
27979 \begin_layout Description
27980 mathframe Math inset frame color under focus
27983 \begin_layout Description
27984 mathline Math line color
27987 \begin_layout Description
27988 mathmacrobg Macro math inset background color
27991 \begin_layout Description
27992 mathmacroblend Macro math blended color
27995 \begin_layout Description
27996 mathmacroframe Macro math frame color
27999 \begin_layout Description
28000 mathmacrohoverbg Macro math inset background color hovered
28003 \begin_layout Description
28004 mathmacrolabel Macro math label color
28007 \begin_layout Description
28008 mathmacronewarg Macro template color for new parameters
28011 \begin_layout Description
28012 mathmacrooldarg Macro template color for old parameters
28015 \begin_layout Description
28016 newpage New page color
28019 \begin_layout Description
28020 nonunique_inlinecompletion Inline completion color for the non-unique part
28023 \begin_layout Description
28024 notebg Background color of notes
28027 \begin_layout Description
28028 notelabel Label color for notes
28031 \begin_layout Description
28032 pagebreak Page break/line break color
28035 \begin_layout Description
28036 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28039 \begin_layout Description
28040 phantomtext Text color for phantom insets
28043 \begin_layout Description
28044 preview The color used for previews
28047 \begin_layout Description
28048 previewframe Preview frame color
28051 \begin_layout Description
28052 regexpframe Color for regexp frame
28055 \begin_layout Description
28056 scroll Color that indicates when a row can be scrolled
28059 \begin_layout Description
28060 selection Background color of selected text
28063 \begin_layout Description
28064 selectiontext Foreground color of selected text
28067 \begin_layout Description
28068 shadedbg Background color of shaded box
28071 \begin_layout Description
28072 special Special chars text color
28075 \begin_layout Description
28076 tabularline Table line color
28079 \begin_layout Description
28080 tabularonoffline Table line color
28083 \begin_layout Description
28084 urllabel Label color for URL insets
28087 \begin_layout Description
28088 urltext Color for URL inset text