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 0
86 \use_package amssymb 0
89 \use_package mathdots 1
90 \use_package mathtools 0
92 \use_package stackrel 0
93 \use_package stmaryrd 0
94 \use_package undertilde 0
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
6187 (If these variables are not predefined, you have to define them.) You'll
6188 probably need root permissions to create or modify the `local' tree, but
6189 not for your `user' tree.
6190 \begin_inset Newline newline
6193 In general, it is recommended to install in the user tree because your user
6194 will not be modified or even overwritten when you upgrade your system.
6195 It will typically also be backed up together with everything else when
6196 you backup your home directory (which, of course, you do on a regular basis).
6199 \begin_layout Enumerate
6200 On Windows, if you want the new package to be available for all users on
6201 your system, change to the folder where \SpecialChar LaTeX
6202 is installed and then change to
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6218 (For MiK\SpecialChar TeX
6219 , this would be by default the folder
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6241 \begin_layout Plain Layout
6242 Note that this will be the correct path only on English installations.
6243 On a German one, it would be
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6261 , and similarly for other languages.
6266 Create there a new folder
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6276 and copy all files of the package into it.
6278 \begin_inset Newline newline
6281 If the package should only available for you or you don't have admin permissions
6282 , do the same, but in the local \SpecialChar LaTeX
6285 \begin_inset space \thinspace{}
6288 g., for MiK\SpecialChar TeX
6290 \begin_inset space ~
6293 2.8 under Windows XP, this would be the folder:
6294 \begin_inset Newline newline
6300 \begin_inset Flex Code
6303 \begin_layout Plain Layout
6306 Documents and Settings
6318 \begin_inset Newline newline
6324 \begin_inset Phantom HPhantom
6327 \begin_layout Plain Layout
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6354 \begin_inset Newline newline
6357 On Vista, it would be:
6358 \begin_inset Newline newline
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6391 \begin_layout Enumerate
6392 Now one only need to tell \SpecialChar LaTeX
6393 that there are new files.
6394 This depends on the used \SpecialChar LaTeX
6399 \begin_layout Enumerate
6400 For \SpecialChar TeX
6401 Live execute the command
6402 \begin_inset Flex Code
6405 \begin_layout Plain Layout
6412 If you installed the package for all users, then you will probably need
6413 to have root permissions for that.
6416 \begin_layout Enumerate
6417 For MiK\SpecialChar TeX
6418 , if you have installed the package for all users, start the program
6420 \begin_inset Quotes eld
6424 \begin_inset space ~
6428 \begin_inset Quotes erd
6431 and press the button marked
6432 \begin_inset Quotes eld
6436 \begin_inset Quotes erd
6440 Otherwise start the program
6441 \begin_inset Quotes eld
6445 \begin_inset Quotes erd
6452 \begin_layout Enumerate
6453 Finally, you need to tell \SpecialChar LyX
6454 that there are new packages available.
6455 So, in \SpecialChar LyX
6457 \begin_inset Flex Noun
6460 \begin_layout Plain Layout
6463 \SpecialChar menuseparator
6469 and then restart \SpecialChar LyX
6473 \begin_layout Standard
6474 Now the package is installed.
6475 In our example, the document class
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6481 \begin_inset space ~
6489 will now be available under
6490 \begin_inset Flex Noun
6493 \begin_layout Plain Layout
6494 Document\SpecialChar menuseparator
6495 Settings\SpecialChar menuseparator
6505 \begin_layout Standard
6506 If you would like to use a \SpecialChar LaTeX
6507 document class that is not even listed in the
6509 \begin_inset Flex Noun
6512 \begin_layout Plain Layout
6513 Document\SpecialChar menuseparator
6514 Settings\SpecialChar menuseparator
6520 , then you need to create a `layout' file for it.
6521 That is the topic of the next section.
6524 \begin_layout Section
6525 Types of layout files
6528 \begin_layout Standard
6529 This section describes the various sorts of \SpecialChar LyX
6530 files that contain layout informati
6532 These files describe various paragraph and character styles, determining
6533 how \SpecialChar LyX
6534 should display them and how they should be translated into \SpecialChar LaTeX
6536 XHTML, or whatever output format is being used.
6540 \begin_layout Standard
6541 We shall try to provide a thorough description of the process of writing
6543 However, there are so many different types of documents supported even
6544 by just \SpecialChar LaTeX
6545 that we can't hope to cover every different possibility or problem
6546 you might encounter.
6547 The \SpecialChar LyX
6548 users' list is frequented by people with lots of experience with layout
6549 design who are willing to share what they've learned, so please feel free
6550 to ask questions there.
6553 \begin_layout Standard
6554 As you prepare to write a new layout, it is extremely helpful to look at
6555 the layouts distributed with \SpecialChar LyX
6557 If you write a \SpecialChar LyX
6558 layout for a \SpecialChar LaTeX
6559 document class that might also be used by
6560 others, or write a module that might be useful to others, then you should
6561 consider posting your layout to the
6562 \begin_inset CommandInset href
6564 name "layout section on the LyX wiki"
6565 target "http://wiki.lyx.org/Layouts/Layouts"
6570 or even to the \SpecialChar LyX
6571 developers' list, so that it might be included in \SpecialChar LyX
6576 \begin_layout Plain Layout
6577 Note that \SpecialChar LyX
6578 is licensed under the General Public License, so any material
6579 that is contributed to \SpecialChar LyX
6580 must be similarly licensed.
6588 \begin_layout Subsection
6590 \begin_inset CommandInset label
6592 name "subsec:Layout-modules"
6599 \begin_layout Standard
6600 We have spoken to this point about `layout files'.
6601 But there are different sorts of files that contain layout information.
6602 Layout files, strictly so called, have the
6603 \begin_inset Flex Code
6606 \begin_layout Plain Layout
6612 extension and provide \SpecialChar LyX
6613 with information about document classes.
6614 Since \SpecialChar LyX
6615 1.6 layout information can also be contained in layout
6620 \begin_inset Flex Code
6623 \begin_layout Plain Layout
6630 Modules are to \SpecialChar LaTeX
6631 packages much as layouts are to \SpecialChar LaTeX
6632 classes, and some modules—such
6634 \begin_inset Flex Code
6637 \begin_layout Plain Layout
6643 module—specifically provide support for one package.
6644 In a sense, layout modules are similar to included
6648 \begin_layout Plain Layout
6649 These can have any extension, but by convention have the
6650 \begin_inset Flex Code
6653 \begin_layout Plain Layout
6665 \begin_inset Flex Code
6668 \begin_layout Plain Layout
6674 —in that modules are not specific to a given document class but may be used
6675 with many different classes.
6676 The difference is that using an included file with
6677 \begin_inset Flex Code
6680 \begin_layout Plain Layout
6686 requires editing that file.
6687 Modules, by contrast, are selected in the
6688 \begin_inset Flex Noun
6691 \begin_layout Plain Layout
6692 Document\SpecialChar menuseparator
6701 \begin_layout Standard
6702 Building modules is the easiest way to get started with layout editing,
6703 since it can be as simple as adding a single new paragraph style or flex
6705 But modules may, in principle, contain anything a layout file can contain.
6708 \begin_layout Standard
6709 After creating a new module and copying it to the
6710 \begin_inset Flex Code
6713 \begin_layout Plain Layout
6719 folder, you will need to reconfigure and then restart \SpecialChar LyX
6722 However, changes you make to the module will be seen immediately, if you
6724 \begin_inset Flex Noun
6727 \begin_layout Plain Layout
6728 Document\SpecialChar menuseparator
6734 , highlight something, and then hit
6735 \begin_inset Quotes eld
6739 \begin_inset Quotes erd
6745 It is strongly recommended that you save your work before doing this
6750 it is strongly recommended that you not attempt to edit modules while simultaneo
6751 usly working on actual documents
6754 Though of course the developers strive to keep \SpecialChar LyX
6755 stable in such situations,
6756 syntax errors and the like in your module file could cause strange behavior.
6759 \begin_layout Subsubsection
6763 \begin_layout Standard
6764 Modules are to \SpecialChar LyX
6765 as packages are to \SpecialChar LaTeX
6767 Sometimes, however, you find yourself wanting a specific inset or character
6768 style just for one document and writing a module that will also be available
6769 to other documents makes little sense.
6770 What you need is \SpecialChar LyX
6772 \begin_inset Quotes eld
6776 \begin_inset Quotes erd
6782 \begin_layout Standard
6783 You will find it under
6785 Document\SpecialChar menuseparator
6786 Settings\SpecialChar menuseparator
6790 The large text box allows you to enter anything that you might enter in
6791 a layout file or module.
6792 You can think of a document's local layout, in fact, as a module that belongs
6794 So, in particular, you must enter a
6795 \begin_inset Flex Code
6798 \begin_layout Plain Layout
6805 Any format is acceptable, but one would normally use the format current
6807 (In \SpecialChar LyX
6808 2.2, the current layout format is 60.)
6811 \begin_layout Standard
6812 When you have entered something in the
6813 \begin_inset Flex Code
6816 \begin_layout Plain Layout
6822 pane, \SpecialChar LyX
6824 \begin_inset Quotes eld
6828 \begin_inset Quotes erd
6831 button at the bottom.
6832 Clicking this button will cause \SpecialChar LyX
6833 to determine whether what you have entered
6834 is valid layout information for the chosen format.
6836 will report the result but, unfortunately, will not tell you what errors
6837 there might have been.
6838 These will be written to the terminal, however, if \SpecialChar LyX
6839 is started from a terminal.
6840 You will not be permitted to save your local layout until you have entered
6844 \begin_layout Standard
6845 The warnings at the end of the previous section apply here, too.
6846 Do not play with local layout while you are actually working, especially
6847 if you have not saved your document.
6848 That said, using local layout with a test document can be a very convenient
6849 way to try out layout ideas, or even to start developing a module.
6852 \begin_layout Subsection
6854 \begin_inset Flex Noun
6857 \begin_layout Plain Layout
6866 \begin_layout Standard
6867 There are two situations you are likely to encounter when wanting to support
6868 a new \SpecialChar LaTeX
6869 document class, involving style (
6870 \begin_inset Flex Code
6873 \begin_layout Plain Layout
6879 ) files and \SpecialChar LaTeX2e
6881 \begin_inset Flex Code
6884 \begin_layout Plain Layout
6891 Supporting a style file is usually fairly easy.
6892 Supporting a new class file is a bit harder.
6893 We'll discuss the former in this section and the latter in the next.
6894 Similar remarks apply, of course, if you want to support a new DocBook
6898 \begin_layout Standard
6899 The easier case is the one in which your new document class is provided
6900 as a style file that is to be used in conjunction with an already supported
6902 For the sake of the example, we'll assume that the style file is called
6904 \begin_inset Flex Noun
6907 \begin_layout Plain Layout
6913 and that it is meant to be used with
6914 \begin_inset Flex Noun
6917 \begin_layout Plain Layout
6923 , which is a standard class.
6927 \begin_layout Standard
6928 Start by copying the existing class's layout file into your local directory:
6932 \begin_layout Plain Layout
6933 Of course, which directory is your local directory will vary by platform,
6934 and \SpecialChar LyX
6935 allows you to specify your local directory on startup, too, using
6937 \begin_inset Flex Code
6940 \begin_layout Plain Layout
6954 \begin_layout LyX-Code
6955 cp report.layout ~/.lyx/layouts/myclass.layout
6958 \begin_layout Standard
6960 \begin_inset Flex Code
6963 \begin_layout Plain Layout
6969 and change the line:
6972 \begin_layout LyX-Code
6975 DeclareLaTeXClass{report}
6978 \begin_layout Standard
6982 \begin_layout LyX-Code
6985 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6988 \begin_layout Standard
6992 \begin_layout LyX-Code
6994 \begin_inset Newline newline
7000 \begin_inset Newline newline
7006 \begin_layout Standard
7007 near the top of the file.
7010 \begin_layout Standard
7011 Start \SpecialChar LyX
7013 \begin_inset Flex Noun
7016 \begin_layout Plain Layout
7017 Tools\SpecialChar menuseparator
7024 Then restart \SpecialChar LyX
7025 and try creating a new document.
7027 \begin_inset Flex Noun
7030 \begin_layout Plain Layout
7036 " as a document class option in the
7037 \begin_inset Flex Noun
7040 \begin_layout Plain Layout
7041 Document\SpecialChar menuseparator
7048 It is likely that some of the sectioning commands and such in your new
7049 class will work differently from how they worked in the base class—
7050 \begin_inset Flex Code
7053 \begin_layout Plain Layout
7059 in this example—so you can fiddle around with the settings for the different
7060 sections if you wish.
7061 The layout information for sections is contained in
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7071 , but you do not need to copy and change this file.
7072 Instead, you can simply add your changes to your layout file, after the
7074 \begin_inset Flex Code
7077 \begin_layout Plain Layout
7083 , which itself includes
7084 \begin_inset Flex Code
7087 \begin_layout Plain Layout
7094 For example, you might add these lines:
7097 \begin_layout LyX-Code
7101 \begin_layout LyX-Code
7105 \begin_layout LyX-Code
7109 \begin_layout LyX-Code
7113 \begin_layout LyX-Code
7117 \begin_layout Standard
7118 to change the font for chapter headings to sans-serif.
7119 This will override (or, in this case, add to) the existing declaration
7120 for the Chapter style.
7124 \begin_layout Standard
7125 Your new package may also provide commands or environments not present in
7127 In this case, you will want to add these to the layout file.
7129 \begin_inset CommandInset ref
7131 reference "sec:TextClass"
7135 for information on how to do so.
7138 \begin_layout Standard
7140 \begin_inset Flex Noun
7143 \begin_layout Plain Layout
7149 can be used with several different document classes, and even if it cannot,
7150 you might find it easiest just to write a module that you can load with
7152 The simplest possible such module would be:
7155 \begin_layout LyX-Code
7158 DeclareLyXModule{My Package}
7161 \begin_layout LyX-Code
7165 \begin_layout LyX-Code
7166 #Support for mypkg.sty.
7169 \begin_layout LyX-Code
7171 \begin_inset Newline newline
7177 \begin_layout LyX-Code
7179 \begin_inset Newline newline
7185 \begin_layout LyX-Code
7187 \begin_inset Newline newline
7193 \begin_inset Newline newline
7199 \begin_layout Standard
7200 A more complex module might modify the behavior of some existing constructs
7201 or define some new ones.
7203 \begin_inset CommandInset ref
7205 reference "sec:TextClass"
7212 \begin_layout Subsection
7214 \begin_inset Flex Noun
7217 \begin_layout Plain Layout
7226 \begin_layout Standard
7227 There are two possibilities here.
7228 One is that the class file is itself based upon an existing document class.
7229 For example, many thesis classes are based upon
7230 \begin_inset Flex Noun
7233 \begin_layout Plain Layout
7240 To see whether yours is, look for a line like
7243 \begin_layout LyX-Code
7249 \begin_layout Standard
7251 If so, then you may proceed largely as in the previous section, though
7253 \begin_inset Flex Code
7256 \begin_layout Plain Layout
7257 Declare\SpecialChar LaTeX
7263 line will be different.
7264 If your new class is
7265 \begin_inset Flex Code
7268 \begin_layout Plain Layout
7274 and it is based upon
7275 \begin_inset Flex Code
7278 \begin_layout Plain Layout
7284 , then the line should read:
7288 \begin_layout Plain Layout
7289 And it will be easiest if you save the file to
7290 \begin_inset Flex Code
7293 \begin_layout Plain Layout
7300 assumes that the document class has the same name as the layout file.
7309 \begin_layout LyX-Code
7312 DeclareLaTeXClass[thesis,book]{thesis}
7315 \begin_layout Standard
7316 If, on the other hand, the new class is not based upon an existing class,
7317 you will probably have to
7318 \begin_inset Quotes eld
7322 \begin_inset Quotes erd
7326 We strongly suggest copying an existing layout file which uses a similar
7328 class and then modifying it, if you can do so.
7329 At least use an existing file as a starting point so you can find out what
7330 items you need to worry about.
7331 Again, the specifics are covered below.
7334 \begin_layout Subsection
7336 \begin_inset CommandInset label
7338 name "subsec:Creating-Templates"
7345 \begin_layout Standard
7346 Once you have written a layout file for a new document class, you might
7347 want to consider writing a
7352 A template acts as a kind of tutorial for your layout, showing how it might
7353 be used, though containing dummy content.
7354 You can of course look at the various templates included with \SpecialChar LyX
7358 \begin_layout Standard
7359 Templates are created just like usual documents: using \SpecialChar LyX
7361 The only difference is that usual documents contain all possible settings,
7362 including the font scheme and the paper size.
7363 Usually a user doesn't want a template to overwrite his preferred settings
7364 for such parameters.
7365 For that reason, the designer of a template should remove the corresponding
7367 \begin_inset Flex Code
7370 \begin_layout Plain Layout
7379 \begin_inset Flex Code
7382 \begin_layout Plain Layout
7390 from the template \SpecialChar LyX
7392 This can be done with any simple text-editor, for example
7393 \begin_inset Flex Code
7396 \begin_layout Plain Layout
7403 \begin_inset Flex Code
7406 \begin_layout Plain Layout
7415 \begin_layout Standard
7416 Put the edited template files you create in
7417 \begin_inset Flex Code
7420 \begin_layout Plain Layout
7426 , copy the ones you use from the global template directory in
7427 \begin_inset Flex Code
7430 \begin_layout Plain Layout
7436 to the same place, and redefine the template path in the
7437 \begin_inset Flex Noun
7440 \begin_layout Plain Layout
7441 Tools\SpecialChar menuseparator
7442 Preferences\SpecialChar menuseparator
7451 \begin_layout Standard
7452 Note, by the way, that there is a template which has a particular meaning:
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7464 This template is loaded every time you create a new document with
7465 \begin_inset Flex Noun
7468 \begin_layout Plain Layout
7469 File\SpecialChar menuseparator
7475 in order to provide useful defaults.
7476 To create this template from inside \SpecialChar LyX
7477 , all you have to do is to open a document
7478 with the correct settings, and use the
7479 \begin_inset Flex Noun
7482 \begin_layout Plain Layout
7483 Save as Document Defaults
7491 \begin_layout Subsection
7492 Upgrading old layout files
7495 \begin_layout Standard
7496 The format of layout files changes with each \SpecialChar LyX
7497 release, so old layout files
7498 need to be converted to the new format.
7500 reads a layout file in an older format, it automatically calls the
7502 \begin_inset Flex Code
7505 \begin_layout Plain Layout
7511 to convert it to a temporary file in current format.
7512 The original file is left untouched.
7513 If you use the layout file often, then, you may want to convert it permanently,
7514 so that \SpecialChar LyX
7515 does not have to do so itself every time.
7516 To do this, you can call the converter manually:
7519 \begin_layout Enumerate
7521 \begin_inset Flex Code
7524 \begin_layout Plain Layout
7531 \begin_inset Flex Code
7534 \begin_layout Plain Layout
7543 \begin_layout Enumerate
7545 \begin_inset Newline newline
7549 \begin_inset Flex Code
7552 \begin_layout Plain Layout
7553 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7559 \begin_inset Newline newline
7563 \begin_inset Flex Code
7566 \begin_layout Plain Layout
7572 is the name of your \SpecialChar LyX
7576 \begin_layout Standard
7577 Note that manual conversion does not affect included files, so these will
7578 have to be converted separately.
7581 \begin_layout Subsection
7582 \begin_inset CommandInset label
7584 name "subsec:Cite-Engine-Files"
7591 \begin_layout Standard
7592 A specific form of layout files are the so-called
7593 \begin_inset Flex Code
7596 \begin_layout Plain Layout
7602 files that are located in the
7603 \begin_inset Flex Code
7606 \begin_layout Plain Layout
7613 Their purpose is to define the specifics of \SpecialChar LaTeX
7614 packages aimed at bibliography
7627 , but also the way how normal Bib\SpecialChar TeX
7628 citations (without additional packages)
7629 are handled in \SpecialChar LyX
7630 is defined in such a file.
7634 \begin_layout Standard
7635 More specifically, it is defined which packages \SpecialChar LyX
7636 needs to load, which citation
7637 commands are available, how these are to be displayed in \SpecialChar LyX
7639 the dialogs, the context menus) as well as in the XHTML and plain text
7641 Furthermore, the files specify available style variants (author-year, numerical
7642 , etc.) and their specifics.
7643 The cite engine files are also used to generate the options that are available
7646 Document\SpecialChar menuseparator
7647 Settings\SpecialChar ldots
7648 \SpecialChar menuseparator
7649 Bibliography\SpecialChar menuseparator
7655 \begin_layout Standard
7656 Even though a cite engine file is essentially a normal layout file that
7657 could theoretically include any layout information, it usually primarily
7658 includes some specific parameters such as
7659 \begin_inset Flex Code
7662 \begin_layout Plain Layout
7669 \begin_inset Flex Code
7672 \begin_layout Plain Layout
7679 \begin_inset Flex Code
7682 \begin_layout Plain Layout
7689 \begin_inset Flex Code
7692 \begin_layout Plain Layout
7699 The syntax of the latter two is described in
7700 \begin_inset CommandInset ref
7702 reference "subsec:Citation-engine-description"
7710 \begin_inset CommandInset ref
7712 reference "subsec:Citation-format-description"
7716 , as well as in the files themselves.
7719 \begin_layout Section
7720 \begin_inset CommandInset label
7722 name "sec:TextClass"
7726 The layout file format
7729 \begin_layout Standard
7730 The following sections describe how layout files are structured and written.
7731 Our advice is to go slowly, save and test often.
7732 It is really not that hard, except that the multitude of options can become
7733 overwhelming, especially if you try to check out too many at once.
7734 It becomes easier if you use existing layouts of \SpecialChar LyX
7735 as examples/reference
7736 or if you modify an existing layout to your needs.
7739 \begin_layout Standard
7740 Note that all the tags used in layout files are case-insensitive.
7742 \begin_inset Flex Code
7745 \begin_layout Plain Layout
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7762 \begin_inset Flex Code
7765 \begin_layout Plain Layout
7771 are really the same tag.
7772 The possible arguments are printed in brackets after the tag's name.
7773 The default argument is typeset
7774 \begin_inset Flex Code
7777 \begin_layout Plain Layout
7786 If the argument has a data type like
7787 \begin_inset Quotes eld
7791 \begin_inset Quotes erd
7795 \begin_inset Quotes eld
7799 \begin_inset Quotes erd
7802 , the default is shown like this:
7803 \begin_inset Flex Code
7806 \begin_layout Plain Layout
7817 \begin_layout Subsection
7818 The document class declaration and classification
7821 \begin_layout Standard
7822 Lines in a layout file which begin with
7823 \begin_inset Flex Code
7826 \begin_layout Plain Layout
7833 There is one exception to this rule.
7835 \begin_inset Flex Code
7838 \begin_layout Plain Layout
7844 files should begin with lines like:
7847 \begin_layout LyX-Code
7850 #% Do not delete the line below; configure depends on this
7853 \begin_layout LyX-Code
7858 DeclareLaTeXClass{Article (Standard Class)}
7861 \begin_layout LyX-Code
7866 DeclareCategory{Articles}
7869 \begin_layout Standard
7870 The second and third lines are used when you (re)configure \SpecialChar LyX
7872 The layout file is read by the \SpecialChar LaTeX
7874 \begin_inset Flex Code
7877 \begin_layout Plain Layout
7883 , in a special mode where
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7894 The first line is just a \SpecialChar LaTeX
7895 comment, the second one contains the mandatory
7896 declaration of the text class and the third line contains the optional
7897 classification of the class.
7898 If these lines appear in a file named
7899 \begin_inset Flex Code
7902 \begin_layout Plain Layout
7908 , then they define a text class of name
7909 \begin_inset Flex Code
7912 \begin_layout Plain Layout
7918 (the name of the layout file) which uses the \SpecialChar LaTeX
7920 \begin_inset Flex Code
7923 \begin_layout Plain Layout
7929 (the default is to use the same name as the layout).
7931 \begin_inset Quotes eld
7934 Article (Standard Class)
7935 \begin_inset Quotes erd
7938 that appears above is used as a description of the text class in the
7939 \begin_inset Flex Noun
7942 \begin_layout Plain Layout
7943 Document\SpecialChar menuseparator
7951 \begin_inset Quotes eld
7955 \begin_inset Quotes erd
7958 in the example) is also used in the
7959 \begin_inset Flex Noun
7962 \begin_layout Plain Layout
7963 Document\SpecialChar menuseparator
7969 dialog: the text classes are grouped by these categories (which are usually
7970 genres, so typical categories are
7971 \begin_inset Quotes eld
7975 \begin_inset Quotes erd
7979 \begin_inset Quotes eld
7983 \begin_inset Quotes erd
7987 \begin_inset Quotes eld
7991 \begin_inset Quotes erd
7995 \begin_inset Quotes eld
7999 \begin_inset Quotes erd
8003 \begin_inset Quotes eld
8007 \begin_inset Quotes erd
8011 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8019 If no category has been declared, the class will be put in the
8020 \begin_inset Quotes eld
8024 \begin_inset Quotes erd
8030 \begin_layout Standard
8031 Let's assume that you wrote your own text class that uses the
8032 \begin_inset Flex Code
8035 \begin_layout Plain Layout
8041 document class, but where you changed the appearance of the section headings.
8042 If you put it in a file
8043 \begin_inset Flex Code
8046 \begin_layout Plain Layout
8052 , the header of this file should be:
8055 \begin_layout LyX-Code
8058 #% Do not delete the line below; configure depends on this
8061 \begin_layout LyX-Code
8066 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8069 \begin_layout LyX-Code
8074 DeclareCategory{Articles}
8077 \begin_layout Standard
8078 This declares a text class
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8088 , associated with the \SpecialChar LaTeX
8090 \begin_inset Flex Code
8093 \begin_layout Plain Layout
8100 \begin_inset Quotes eld
8103 Article (with My Own Headings)
8104 \begin_inset Quotes erd
8108 If your text class depends on several packages, you can declare it as:
8111 \begin_layout LyX-Code
8114 #% Do not delete the line below; configure depends on this
8117 \begin_layout LyX-Code
8122 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8125 \begin_layout LyX-Code
8130 DeclareCategory{Articles}
8133 \begin_layout Standard
8134 This indicates that your text class uses the
8135 \begin_inset Flex Code
8138 \begin_layout Plain Layout
8145 Finally, it is also possible to declare classes for DocBook code.
8146 Typical declarations will look like:
8149 \begin_layout LyX-Code
8152 #% Do not delete the line below; configure depends on this
8155 \begin_layout LyX-Code
8160 DeclareDocBookClass[article]{SGML (DocBook Article)}
8163 \begin_layout LyX-Code
8168 DeclareCategory{Articles (DocBook)}
8171 \begin_layout Standard
8172 Note that these declarations can also be given an optional parameter declaring
8173 the name of the document class (but not a list).
8176 \begin_layout Standard
8177 So, to be as explicit as possible, the form of the layout declaration is:
8180 \begin_layout LyX-Code
8185 DeclareLaTeXClass[class,package.sty]{layout description}
8188 \begin_layout LyX-Code
8193 DeclareCategory{category}
8196 \begin_layout Standard
8197 The class need only be specified if the name of the \SpecialChar LaTeX
8199 name of the layout file are different or if there are packages to load.
8200 If the name of the class file is not specified, then \SpecialChar LyX
8202 that it is the same as the name of the layout file.
8205 \begin_layout Standard
8206 When the text class has been modified to your taste, all you have to do
8207 is to copy it either to
8208 \begin_inset Flex Code
8211 \begin_layout Plain Layout
8218 \begin_inset Flex Code
8221 \begin_layout Plain Layout
8228 \begin_inset Flex Noun
8231 \begin_layout Plain Layout
8232 Tools\SpecialChar menuseparator
8238 , exit \SpecialChar LyX
8240 Then your new text class should be available along with the others.
8243 \begin_layout Standard
8244 Once the layout file is installed, you can edit it and see your changes
8245 without having to reconfigure or to restart \SpecialChar LyX
8251 \begin_layout Plain Layout
8252 In versions of \SpecialChar LyX
8253 prior to 1.6, this was not true.
8254 As a result, editing layout files was very time consuming, since you had
8255 constantly to restart \SpecialChar LyX
8261 You can force a reload of the current layout by using the \SpecialChar LyX
8263 \begin_inset Flex Noun
8266 \begin_layout Plain Layout
8273 There is no default binding for this function—though, of course, you can
8274 bind it to a key yourself.
8275 But you will normally use this function simply by entering it in the mini-buffe
8280 \begin_layout Standard
8286 \begin_inset Flex Noun
8289 \begin_layout Plain Layout
8295 is very much an `advanced feature'.
8300 recommended that you save your work before using this function.
8305 recommended that you not attempt to edit layout information while simultaneousl
8306 y working on a document that you care about.
8307 Use a test document.
8308 Syntax errors and the like in your layout file could cause peculiar behavior.
8309 In particular, such errors could cause \SpecialChar LyX
8310 to regard the current layout as
8311 invalid and to attempt to switch to some other layout.
8315 \begin_layout Plain Layout
8316 Really bad syntax errors may even caused \SpecialChar LyX
8318 This is because certain sorts of errors may make \SpecialChar LyX
8329 The \SpecialChar LyX
8330 team strives to keep \SpecialChar LyX
8331 stable in such situations, but safe is better
8336 \begin_layout Plain Layout
8337 While we're giving advice: make regular backups.
8338 And be nice to your mother.
8346 \begin_layout Subsection
8347 The Module declaration
8350 \begin_layout Standard
8351 A module must begin with a line like the following:
8354 \begin_layout LyX-Code
8357 DeclareLyXModule[endnotes.sty]{Endnotes}
8360 \begin_layout Standard
8361 The mandatory argument, in curly brackets, is the name of the module, as
8363 \begin_inset Flex Noun
8366 \begin_layout Plain Layout
8367 Document\SpecialChar menuseparator
8368 Settings\SpecialChar menuseparator
8375 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8377 on which the module depends.
8378 It is also possible to use the form
8379 \begin_inset Flex Noun
8382 \begin_layout Plain Layout
8388 as an optional argument, which declares that the module can only be used
8389 when there exists a conversion chain between the formats `
8390 \begin_inset Flex Code
8393 \begin_layout Plain Layout
8400 \begin_inset Flex Code
8403 \begin_layout Plain Layout
8412 \begin_layout Standard
8413 The module declaration should then be followed by lines like the following
8417 \begin_layout Plain Layout
8418 Preferably in English if the module should be published with \SpecialChar LyX
8420 This description will appear in the list of messages to be translated and
8421 will be thus translated with the next interface update.
8429 \begin_layout LyX-Code
8433 \begin_layout LyX-Code
8434 #Adds an endnote command, in addition to footnotes.
8438 \begin_layout LyX-Code
8439 #You will need to add
8441 theendnotes in TeX code where you
8444 \begin_layout LyX-Code
8445 #want the endnotes to appear.
8449 \begin_layout LyX-Code
8453 \begin_layout LyX-Code
8454 #Requires: somemodule | othermodule
8457 \begin_layout LyX-Code
8458 #Excludes: badmodule
8461 \begin_layout Standard
8462 The description is used in
8463 \begin_inset Flex Noun
8466 \begin_layout Plain Layout
8467 Document\SpecialChar menuseparator
8468 Settings\SpecialChar menuseparator
8474 to provide the user with information about what the module does.
8476 \begin_inset Flex Code
8479 \begin_layout Plain Layout
8485 line is used to identify other modules with which this one must be used;
8487 \begin_inset Flex Code
8490 \begin_layout Plain Layout
8496 line is used to identify modules with which this one may not be used.
8497 Both are optional, and, as shown, multiple modules should be separated
8498 with the pipe symbol: |.
8499 Note that the required modules are treated disjunctively:
8503 of the required modules must be used.
8508 excluded module may be used.
8509 Note that modules are identified here by their filenames without the
8510 \begin_inset Flex Code
8513 \begin_layout Plain Layout
8521 \begin_inset Flex Code
8524 \begin_layout Plain Layout
8531 \begin_inset Flex Code
8534 \begin_layout Plain Layout
8543 \begin_layout Subsection
8544 The CiteEngine file declaration
8547 \begin_layout Standard
8548 A cite engine file must begin with a line like the following:
8551 \begin_layout LyX-Code
8554 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8557 \begin_layout Standard
8558 The mandatory argument, in curly brackets, is the name of the module, as
8560 \begin_inset Flex Noun
8563 \begin_layout Plain Layout
8564 Document\SpecialChar menuseparator
8565 Settings\SpecialChar menuseparator
8572 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8574 on which the cite engine depends.
8577 \begin_layout Standard
8578 The cite engine declaration should then be followed by lines like the following
8582 \begin_layout Plain Layout
8583 Preferably in English if the module should be published with \SpecialChar LyX
8585 This description will appear in the list of messages to be translated and
8586 will be thus translated with the next interface update.
8594 \begin_layout LyX-Code
8598 \begin_layout LyX-Code
8599 # Biblatex supports many author-year and numerical styles.
8602 \begin_layout LyX-Code
8603 # It is mainly aimed at the Humanities.
8607 \begin_layout LyX-Code
8608 # customizable, fully localized and provides many features
8611 \begin_layout LyX-Code
8612 # that are not possible with BibTeX.
8613 The use of 'biber' as
8616 \begin_layout LyX-Code
8617 # bibliography processor is advised.
8620 \begin_layout LyX-Code
8624 \begin_layout Standard
8625 The description is used in
8626 \begin_inset Flex Noun
8629 \begin_layout Plain Layout
8630 Document\SpecialChar menuseparator
8631 Settings\SpecialChar menuseparator
8637 to provide the user with information about the cite engine.
8640 \begin_layout Subsection
8644 \begin_layout Standard
8645 The first non-comment line of any layout file, included file, or module
8650 contain the file format number:
8653 \begin_layout Description
8654 \begin_inset Flex Code
8657 \begin_layout Plain Layout
8664 \begin_inset Flex Code
8667 \begin_layout Plain Layout
8673 ] The format number of the layout file.
8676 \begin_layout Standard
8677 This tag was introduced with \SpecialChar LyX
8679 \begin_inset space ~
8683 Layout files from older \SpecialChar LyX
8684 versions do not have an explicit file format and
8685 are considered to have
8686 \begin_inset Flex Code
8689 \begin_layout Plain Layout
8691 \begin_inset space ~
8700 The format for the present version of \SpecialChar LyX
8702 But each version of \SpecialChar LyX
8703 is capable of reading earlier versions' layout files,
8704 just as they are capable of reading files produced by earlier versions
8707 There is, however, no provision for converting to earlier formats.
8710 \begin_layout Subsection
8711 \begin_inset CommandInset label
8713 name "subsec:General-text-class"
8717 General text class parameters
8720 \begin_layout Standard
8721 These are general parameters that govern the behavior of an entire document
8727 mean that they must appear in
8728 \begin_inset Flex Code
8731 \begin_layout Plain Layout
8737 files rather than in modules.
8738 A module can contain any layout tag.)
8741 \begin_layout Description
8742 \begin_inset Flex Code
8745 \begin_layout Plain Layout
8751 Adds information that will be output in the
8752 \begin_inset Flex Code
8755 \begin_layout Plain Layout
8761 block when the document is output to XHTML.
8762 Typically, this would be used to output CSS style information, but it can
8763 be used for anything that can appear in
8764 \begin_inset Flex Code
8767 \begin_layout Plain Layout
8775 \begin_inset Quotes eld
8779 \begin_inset Flex Code
8782 \begin_layout Plain Layout
8789 \begin_inset Quotes erd
8795 \begin_layout Description
8796 \begin_inset Flex Code
8799 \begin_layout Plain Layout
8805 Adds information to the document preamble.
8807 \begin_inset Newline newline
8811 \begin_inset Quotes eld
8815 \begin_inset Flex Code
8818 \begin_layout Plain Layout
8825 \begin_inset Quotes erd
8831 \begin_layout Description
8832 \begin_inset Flex Code
8835 \begin_layout Plain Layout
8841 Defines the possibilities for displaying citation references.
8843 \begin_inset CommandInset ref
8845 reference "subsec:Citation-engine-description"
8854 \begin_inset Quotes eld
8858 \begin_inset Flex Code
8861 \begin_layout Plain Layout
8868 \begin_inset Quotes erd
8872 Primarily used in cite engine files (see
8873 \begin_inset CommandInset ref
8875 reference "subsec:Cite-Engine-Files"
8885 \begin_layout Description
8886 \begin_inset Flex Code
8889 \begin_layout Plain Layout
8895 Defines formats for use in the display of bibliographic information.
8897 \begin_inset CommandInset ref
8899 reference "subsec:Citation-format-description"
8905 \begin_inset Quotes eld
8909 \begin_inset Flex Code
8912 \begin_layout Plain Layout
8919 \begin_inset Quotes erd
8923 Primarily used in cite engine files (see
8924 \begin_inset CommandInset ref
8926 reference "subsec:Cite-Engine-Files"
8936 \begin_layout Description
8937 \begin_inset Flex Code
8940 \begin_layout Plain Layout
8947 \begin_inset Flex Code
8950 \begin_layout Plain Layout
8959 \begin_inset Flex Code
8962 \begin_layout Plain Layout
8968 ] Determines whether
8972 or Bib\SpecialChar TeX
8973 is used to generate a Bibliography.
8974 Primarily used in cite engine files (see
8975 \begin_inset CommandInset ref
8977 reference "subsec:Cite-Engine-Files"
8987 \begin_layout Description
8988 \begin_inset Flex Code
8991 \begin_layout Plain Layout
8997 Describes various global options supported by the document class.
8999 \begin_inset CommandInset ref
9001 reference "subsec:ClassOptions"
9007 \begin_inset Quotes eld
9011 \begin_inset Flex Code
9014 \begin_layout Plain Layout
9021 \begin_inset Quotes erd
9027 \begin_layout Description
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9038 \begin_inset Flex Code
9041 \begin_layout Plain Layout
9050 \begin_inset space \thinspace{}
9054 \begin_inset Flex Code
9057 \begin_layout Plain Layout
9063 ] Whether the class should
9067 to having one or two columns.
9068 Can be changed in the
9069 \begin_inset Flex Noun
9072 \begin_layout Plain Layout
9073 Document\SpecialChar menuseparator
9082 \begin_layout Description
9083 \begin_inset Flex Code
9086 \begin_layout Plain Layout
9093 \begin_inset Flex Code
9096 \begin_layout Plain Layout
9102 ] This sequence defines the properties for a counter.
9103 If the counter does not yet exist, it is created; if it does exist, it
9106 \begin_inset Quotes eld
9110 \begin_inset Flex Code
9113 \begin_layout Plain Layout
9120 \begin_inset Quotes erd
9124 \begin_inset Newline newline
9128 \begin_inset CommandInset ref
9130 reference "subsec:Counters"
9134 for details on counters.
9137 \begin_layout Description
9138 \begin_inset Flex Code
9141 \begin_layout Plain Layout
9147 Sets the default font used to display the document.
9149 \begin_inset CommandInset ref
9151 reference "subsec:Font-description"
9155 for how to declare fonts.
9157 \begin_inset Quotes eld
9161 \begin_inset Flex Code
9164 \begin_layout Plain Layout
9171 \begin_inset Quotes erd
9177 \begin_layout Description
9178 \begin_inset Flex Code
9181 \begin_layout Plain Layout
9188 \begin_inset Flex Code
9191 \begin_layout Plain Layout
9197 ] Specifies a module to be included by default with this document class.
9198 The module is specified as filename without the
9199 \begin_inset Flex Code
9202 \begin_layout Plain Layout
9209 The user can still remove the module, but it will be active at the outset.
9210 (This applies only when new files are created, or when this class is chosen
9211 for an existing document.)
9214 \begin_layout Description
9215 \begin_inset Flex Code
9218 \begin_layout Plain Layout
9225 \begin_inset Flex Code
9228 \begin_layout Plain Layout
9234 ] This is the style that will be assigned to new paragraphs, usually
9235 \begin_inset Flex Noun
9238 \begin_layout Plain Layout
9245 This will default to the first defined style if not given, but you are
9246 encouraged to use this directive.
9249 \begin_layout Description
9250 \begin_inset Flex Code
9253 \begin_layout Plain Layout
9260 \begin_inset Flex Code
9263 \begin_layout Plain Layout
9269 ] This tag indicates that the module (which is specified by filename without
9271 \begin_inset Flex Code
9274 \begin_layout Plain Layout
9280 extension) cannot be used with this document class.
9281 This might be used in a journal-specific layout file to prevent, say, the
9283 \begin_inset Flex Code
9286 \begin_layout Plain Layout
9292 module that numbers theorems by section.
9297 be used in a module.
9298 Modules have their own way of excluding other modules (see
9299 \begin_inset CommandInset ref
9301 reference "subsec:Layout-modules"
9308 \begin_layout Description
9309 \begin_inset Flex Code
9312 \begin_layout Plain Layout
9318 Defines a new float.
9320 \begin_inset CommandInset ref
9322 reference "subsec:Floats"
9328 \begin_inset Quotes eld
9332 \begin_inset Flex Code
9335 \begin_layout Plain Layout
9342 \begin_inset Quotes erd
9348 \begin_layout Description
9349 \begin_inset Flex Code
9352 \begin_layout Plain Layout
9358 Sets the information that will be output in the
9359 \begin_inset Flex Code
9362 \begin_layout Plain Layout
9368 block when this document class is output to XHTML.
9369 Note that this will completely override any prior
9370 \begin_inset Flex Code
9373 \begin_layout Plain Layout
9380 \begin_inset Flex Code
9383 \begin_layout Plain Layout
9391 \begin_inset Newline newline
9395 \begin_inset Flex Code
9398 \begin_layout Plain Layout
9404 if you just want to add material to the preamble.) Must end with
9405 \begin_inset Quotes eld
9409 \begin_inset Flex Code
9412 \begin_layout Plain Layout
9419 \begin_inset Quotes erd
9425 \begin_layout Description
9426 \begin_inset Flex Code
9429 \begin_layout Plain Layout
9436 \begin_inset Flex Code
9439 \begin_layout Plain Layout
9445 ] The style to use for the table of contents, bibliography, and so forth,
9446 when the document is output to HTML.
9447 For articles, this should normally be
9448 \begin_inset Flex Code
9451 \begin_layout Plain Layout
9458 \begin_inset Flex Code
9461 \begin_layout Plain Layout
9468 If it is not given, then \SpecialChar LyX
9469 will attempt to figure out which layout to use.
9472 \begin_layout Description
9473 \begin_inset Flex Code
9476 \begin_layout Plain Layout
9483 \begin_inset Flex Code
9486 \begin_layout Plain Layout
9492 ] Modifies the properties of the given counter.
9493 If the counter does not exist, the statement is ignored.
9495 \begin_inset Quotes eld
9499 \begin_inset Flex Code
9502 \begin_layout Plain Layout
9509 \begin_inset Quotes erd
9513 \begin_inset Newline newline
9517 \begin_inset CommandInset ref
9519 reference "subsec:Counters"
9523 for details on counters.
9526 \begin_layout Description
9527 \begin_inset Flex Code
9530 \begin_layout Plain Layout
9537 \begin_inset Flex Code
9540 \begin_layout Plain Layout
9546 ] This allows you to include another layout definition file within yours
9547 to avoid duplicating commands.
9548 Common examples are the standard layout files, for example,
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9558 , which contains most of the basic layouts.
9561 \begin_layout Description
9562 \begin_inset Flex Code
9565 \begin_layout Plain Layout
9572 \begin_inset Flex Code
9575 \begin_layout Plain Layout
9581 ] This section (re-)defines the layout of an inset.
9582 It can be applied to an existing inset or to a new, user-defined inset,
9583 e.g., a new character style.
9585 \begin_inset Quotes eld
9589 \begin_inset Flex Code
9592 \begin_layout Plain Layout
9599 \begin_inset Quotes erd
9603 \begin_inset Newline newline
9607 \begin_inset CommandInset ref
9609 reference "subsec:Flex-insets-and"
9613 for more information.
9617 \begin_layout Description
9618 \begin_inset Flex Code
9621 \begin_layout Plain Layout
9628 \begin_inset Flex Code
9631 \begin_layout Plain Layout
9637 ] A string that indicates the width of the left margin on the screen, for
9639 \begin_inset Quotes eld
9643 \begin_inset Flex Code
9646 \begin_layout Plain Layout
9653 \begin_inset Quotes erd
9657 (Note that this is not a `length', like
9658 \begin_inset Quotes eld
9662 \begin_inset Quotes erd
9668 \begin_layout Description
9669 \begin_inset Flex Code
9672 \begin_layout Plain Layout
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9688 ] An integer that determines the maximal number of names displayed in an
9689 author-year citation before the citation switches to
9690 \begin_inset Quotes eld
9694 \begin_inset Quotes erd
9698 Primarily used in cite engine files (see
9699 \begin_inset CommandInset ref
9701 reference "subsec:Cite-Engine-Files"
9711 \begin_layout Description
9712 \begin_inset Flex Code
9715 \begin_layout Plain Layout
9722 \begin_inset Flex Code
9725 \begin_layout Plain Layout
9731 ] Modifies the properties of the given paragraph style.
9732 If the style does not exist, this section is ignored.
9734 \begin_inset Quotes eld
9738 \begin_inset Flex Code
9741 \begin_layout Plain Layout
9748 \begin_inset Quotes erd
9754 \begin_layout Description
9755 \begin_inset Flex Code
9758 \begin_layout Plain Layout
9765 \begin_inset Flex Code
9768 \begin_layout Plain Layout
9774 ] Deletes an existing counter, usually one defined in an included file.
9777 \begin_layout Description
9778 \begin_inset Flex Code
9781 \begin_layout Plain Layout
9788 \begin_inset Flex Code
9791 \begin_layout Plain Layout
9797 ] Deletes an existing float.
9798 This is particularly useful when you want to suppress a float that has
9799 been defined in an input file.
9802 \begin_layout Description
9803 \begin_inset Flex Code
9806 \begin_layout Plain Layout
9813 \begin_inset Flex Code
9816 \begin_layout Plain Layout
9822 ] Deletes an existing style.
9825 \begin_layout Description
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9846 \begin_inset Flex Code
9849 \begin_layout Plain Layout
9855 ] Define a new table of contents with type
9856 \begin_inset Flex Code
9859 \begin_layout Plain Layout
9866 \begin_inset Flex Code
9869 \begin_layout Plain Layout
9876 See also the AddToToc commands.
9879 \begin_layout Description
9880 \begin_inset Flex Code
9883 \begin_layout Plain Layout
9890 \begin_inset Flex Code
9893 \begin_layout Plain Layout
9899 ] The file format (as defined in the \SpecialChar LyX
9900 preferences) produced by this document
9902 It is mainly useful when
9903 \begin_inset Flex Code
9906 \begin_layout Plain Layout
9913 \begin_inset Flex Code
9916 \begin_layout Plain Layout
9922 and one wants to define a new type of literate document.
9923 The format is reset to
9924 \begin_inset Quotes eld
9928 \begin_inset Flex Code
9931 \begin_layout Plain Layout
9938 \begin_inset Quotes erd
9942 \begin_inset Quotes eld
9946 \begin_inset Flex Code
9949 \begin_layout Plain Layout
9956 \begin_inset Quotes erd
9959 when the corresponding
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9969 parameter is encountered.
9972 \begin_layout Description
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9983 \begin_inset Flex Code
9986 \begin_layout Plain Layout
9997 \begin_inset Flex Code
10000 \begin_layout Plain Layout
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10016 ] Specifies what sort of output documents using this class will produce.
10019 \begin_layout Description
10020 \begin_inset Flex Code
10023 \begin_layout Plain Layout
10030 \begin_inset Flex Code
10033 \begin_layout Plain Layout
10040 \begin_inset Flex Code
10043 \begin_layout Plain Layout
10049 ] Specifies options, given in the second string, for the package named by
10052 \begin_inset Quotes eld
10056 \begin_inset Flex Code
10059 \begin_layout Plain Layout
10060 PackageOptions natbib square
10066 \begin_inset Quotes erd
10070 \begin_inset Flex Code
10073 \begin_layout Plain Layout
10079 to be loaded with the
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10090 (For \SpecialChar TeX
10091 perts, this causes \SpecialChar LyX
10093 \begin_inset Flex Code
10096 \begin_layout Plain Layout
10099 PassOptionsToPackage{natbib}{square}
10105 \begin_inset Flex Code
10108 \begin_layout Plain Layout
10117 \begin_layout Description
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10140 \begin_inset Flex Code
10143 \begin_layout Plain Layout
10150 \begin_inset Flex Code
10153 \begin_layout Plain Layout
10159 ] The default pagestyle.
10160 Can be changed in the
10161 \begin_inset Flex Noun
10164 \begin_layout Plain Layout
10165 Document\SpecialChar menuseparator
10174 \begin_layout Description
10175 \begin_inset Flex Code
10178 \begin_layout Plain Layout
10184 Sets the preamble for the \SpecialChar LaTeX
10186 Note that this will completely override any prior
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10197 \begin_inset Flex Code
10200 \begin_layout Plain Layout
10208 \begin_inset Flex Code
10211 \begin_layout Plain Layout
10217 if you just want to add material to the preamble.) Must end with
10218 \begin_inset Quotes eld
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10232 \begin_inset Quotes erd
10238 \begin_layout Description
10239 \begin_inset Flex Code
10242 \begin_layout Plain Layout
10249 \begin_inset Flex Code
10252 \begin_layout Plain Layout
10259 \begin_inset Flex Code
10262 \begin_layout Plain Layout
10271 \begin_inset space \thinspace{}
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10284 ] Whether the class already provides the feature
10285 \begin_inset Flex Code
10288 \begin_layout Plain Layout
10295 A feature is in general the name of a package (e.
10296 \begin_inset space \thinspace{}
10300 \begin_inset space \space{}
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10314 \begin_inset Flex Code
10317 \begin_layout Plain Layout
10324 \begin_inset space \thinspace{}
10328 \begin_inset space \space{}
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10342 \begin_inset Flex Code
10345 \begin_layout Plain Layout
10353 \begin_inset CommandInset ref
10355 reference "chap:List-of-functions"
10359 for the list of features.
10362 \begin_layout Description
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10373 \begin_inset Flex Code
10376 \begin_layout Plain Layout
10382 ] Indicates that this layout provides the functionality of the module mentioned,
10383 which should be specified by the filename without the
10384 \begin_inset Flex Code
10387 \begin_layout Plain Layout
10394 This will typically be used if the layout includes the module directly,
10395 rather than using the
10396 \begin_inset Flex Code
10399 \begin_layout Plain Layout
10405 tag to indicate that it ought to be used.
10406 It could also be used in a module that provided an alternate implementation
10407 of the same functionality.
10410 \begin_layout Description
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10421 \begin_inset Flex Code
10424 \begin_layout Plain Layout
10430 ] Creates a new paragraph style if it does not already exist.
10431 If the style does exist, this section is ignored.
10433 \begin_inset Quotes eld
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10447 \begin_inset Quotes erd
10453 \begin_layout Description
10454 \begin_inset Flex Code
10457 \begin_layout Plain Layout
10464 \begin_inset Flex Code
10467 \begin_layout Plain Layout
10473 ] Whether the class requires the feature
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10484 Multiple features must be separated by commas.
10485 Note that you can only request supported features.
10487 \begin_inset CommandInset ref
10489 reference "chap:List-of-functions"
10493 for the list of features.).
10494 If you require a package with specific options, you can additionally use
10496 \begin_inset Flex Code
10499 \begin_layout Plain Layout
10508 \begin_layout Description
10509 \begin_inset Flex Code
10512 \begin_layout Plain Layout
10519 \begin_inset Flex Code
10522 \begin_layout Plain Layout
10528 ] A string that indicates the width of the right margin on the screen, for
10530 \begin_inset Quotes eld
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10544 \begin_inset Quotes erd
10550 \begin_layout Description
10551 \begin_inset Flex Code
10554 \begin_layout Plain Layout
10561 \begin_inset Flex Code
10564 \begin_layout Plain Layout
10570 ] Sets which divisions get numbered.
10572 \begin_inset Newline newline
10576 \begin_inset Flex Code
10579 \begin_layout Plain Layout
10585 counter in \SpecialChar LaTeX
10589 \begin_layout Description
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10612 \begin_inset space \thinspace{}
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10625 ] Whether the class-default should be printing on one or both sides of the
10627 Can be changed in the
10628 \begin_inset Flex Noun
10631 \begin_layout Plain Layout
10632 Document\SpecialChar menuseparator
10641 \begin_layout Description
10642 \begin_inset Flex Code
10645 \begin_layout Plain Layout
10652 \begin_inset Flex Code
10655 \begin_layout Plain Layout
10661 ] This sequence defines a paragraph style.
10662 If the style does not yet exist, it is created; if it does exist, its parameter
10665 \begin_inset Quotes eld
10669 \begin_inset Flex Code
10672 \begin_layout Plain Layout
10679 \begin_inset Quotes erd
10683 \begin_inset Newline newline
10687 \begin_inset CommandInset ref
10689 reference "subsec:Paragraph-Styles"
10693 for details on paragraph styles.
10696 \begin_layout Description
10697 \begin_inset Flex Code
10700 \begin_layout Plain Layout
10707 \begin_inset Flex Code
10710 \begin_layout Plain Layout
10716 ] The name of the command or environment to be used with
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10729 \begin_layout Description
10730 \begin_inset Flex Code
10733 \begin_layout Plain Layout
10740 \begin_inset Flex Code
10743 \begin_layout Plain Layout
10752 \begin_inset Flex Code
10755 \begin_layout Plain Layout
10761 ] Indicates what kind of markup is used to define the title of a document.
10763 \begin_inset Flex Code
10766 \begin_layout Plain Layout
10772 means that the macro with name
10773 \begin_inset Flex Code
10776 \begin_layout Plain Layout
10782 will be inserted after the last layout which has
10783 \begin_inset Quotes eld
10787 \begin_inset Flex Code
10790 \begin_layout Plain Layout
10792 \begin_inset space ~
10801 \begin_inset Quotes erd
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10815 corresponds to the case where all layouts which have
10816 \begin_inset Quotes eld
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10825 \begin_inset space ~
10834 \begin_inset Quotes erd
10837 should be enclosed into the
10838 \begin_inset Flex Code
10841 \begin_layout Plain Layout
10850 \begin_layout Description
10851 \begin_inset Flex Code
10854 \begin_layout Plain Layout
10861 \begin_inset Flex Code
10864 \begin_layout Plain Layout
10870 ] Sets which divisions are included in the table of contents.
10872 \begin_inset Flex Code
10875 \begin_layout Plain Layout
10881 counter in \SpecialChar LaTeX
10885 \begin_layout Subsection
10886 \begin_inset Flex Code
10889 \begin_layout Plain Layout
10896 \begin_inset CommandInset label
10898 name "subsec:ClassOptions"
10905 \begin_layout Standard
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10916 section can contain the following entries:
10919 \begin_layout Description
10920 \begin_inset Flex Code
10923 \begin_layout Plain Layout
10930 \begin_inset Flex Code
10933 \begin_layout Plain Layout
10939 ] The list of available font sizes for the document's main font, separated
10941 \begin_inset Quotes eld
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10955 \begin_inset Quotes erd
10961 \begin_layout Description
10962 \begin_inset Flex Code
10965 \begin_layout Plain Layout
10971 Used to set the DTD line with XML-based output classes.
10973 \begin_inset space \thinspace{}
10977 \begin_inset Quotes eld
10980 -//OASIS//DTD DocBook V4.2//EN
10981 \begin_inset Quotes erd
10987 \begin_layout Description
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10998 \begin_inset Flex Code
11001 \begin_layout Plain Layout
11002 string="empty|plain|headings|fancy"
11007 ] The list of available page sty\SpecialChar softhyphen
11009 \begin_inset Quotes eld
11013 \begin_inset Flex Code
11016 \begin_layout Plain Layout
11023 \begin_inset Quotes erd
11029 \begin_layout Description
11030 \begin_inset Flex Code
11033 \begin_layout Plain Layout
11040 \begin_inset Flex Code
11043 \begin_layout Plain Layout
11049 ] Some document class options, separated by a comma, that will be added
11050 to the optional part of the
11051 \begin_inset Flex Code
11054 \begin_layout Plain Layout
11065 \begin_layout Standard
11067 \begin_inset Flex Code
11070 \begin_layout Plain Layout
11076 section must end with
11077 \begin_inset Quotes eld
11081 \begin_inset Flex Code
11084 \begin_layout Plain Layout
11091 \begin_inset Quotes erd
11097 \begin_layout Subsection
11099 \begin_inset CommandInset label
11101 name "subsec:Paragraph-Styles"
11108 \begin_layout Standard
11109 A paragraph style description looks like this:
11113 \begin_layout Plain Layout
11114 Note that this will either define a new style or modify an existing one.
11122 \begin_layout LyX-Code
11129 \begin_layout LyX-Code
11133 \begin_layout LyX-Code
11137 \begin_layout Standard
11138 where the following commands are allowed:
11141 \begin_layout Description
11142 \begin_inset Flex Code
11145 \begin_layout Plain Layout
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11161 =""] This paragraph will appear in the table of contents of the given type.
11162 An empty string disables.
11163 See also the OutlinerName and the IsTocCaption commands.
11167 \begin_layout Description
11168 \begin_inset Flex Code
11171 \begin_layout Plain Layout
11178 \begin_inset Flex Code
11181 \begin_layout Plain Layout
11186 , left, right, center
11191 ] Paragraph alignment.
11194 \begin_layout Description
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11205 \begin_inset Flex Code
11208 \begin_layout Plain Layout
11213 , left, right, center
11218 ] A comma separated list of permitted alignments.
11219 (Some \SpecialChar LaTeX
11220 styles prohibit certain alignments, since those wouldn't make sense.
11221 For example a right-aligned or centered enumeration isn't possible.)
11224 \begin_layout Description
11225 \begin_inset Flex Code
11228 \begin_layout Plain Layout
11235 \begin_inset Flex Code
11238 \begin_layout Plain Layout
11244 ] Defines argument number <int> of a command\SpecialChar breakableslash
11245 environment associated with
11247 This is useful for things like section headings, and only makes sense with
11250 Every (optional or required) argument of a command or environment – except
11251 for the required argument that is associated with the content of the paragraph
11252 itself – has a separate definition, where the number specifies the order
11254 The definition must end with
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11265 So a command with two optional arguments has:
11269 \begin_layout Quote
11275 \begin_layout Quote
11281 \begin_layout Quote
11287 \begin_layout Quote
11293 \begin_layout Quote
11299 \begin_layout Quote
11305 \begin_layout Standard
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11316 definition, the following specifications are possible:
11319 \begin_layout Itemize
11320 \begin_inset Flex Code
11323 \begin_layout Plain Layout
11330 \begin_inset Flex Code
11333 \begin_layout Plain Layout
11339 The string that will appear both in the menu (to insert this argument)
11340 and on the argument inset button (unless you also specify a separate
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11351 For the menu, you can define an accelerator by appending the respective
11352 character to the string, divided by
11353 \begin_inset Quotes eld
11357 \begin_inset Quotes erd
11361 \begin_inset space \thinspace{}
11365 \begin_inset space \space{}
11369 \begin_inset Quotes eld
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11383 \begin_inset Quotes erd
11389 \begin_layout Itemize
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11409 A separate string for the menu.
11410 You can define an accelerator by appending the respective character to
11411 the string, divided by
11412 \begin_inset Quotes eld
11416 \begin_inset Quotes erd
11420 \begin_inset space \thinspace{}
11424 \begin_inset space \space{}
11428 \begin_inset Quotes eld
11432 \begin_inset Flex Code
11435 \begin_layout Plain Layout
11442 \begin_inset Quotes erd
11446 This specification is optional.
11447 If it is not given the
11448 \begin_inset Flex Code
11451 \begin_layout Plain Layout
11457 will be used instead for the menu.
11460 \begin_layout Itemize
11461 \begin_inset Flex Code
11464 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11480 A longer explanatory text that appears in the tooltip when hovering over
11481 the argument inset.
11484 \begin_layout Itemize
11485 \begin_inset Flex Code
11488 \begin_layout Plain Layout
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11507 \begin_inset space \thinspace{}
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11520 ] Declare if this is a mandatory (1) or an optional (0) argument.
11521 Mandatory arguments will be output empty if not given, while optional arguments
11522 will not be output at all.
11523 By default, mandatory arguments are delimited by
11524 \begin_inset Flex Code
11527 \begin_layout Plain Layout
11533 , while optional arguments are delimited by
11534 \begin_inset Flex Code
11537 \begin_layout Plain Layout
11546 \begin_layout Itemize
11547 \begin_inset Flex Code
11550 \begin_layout Plain Layout
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11566 defines another argument (by its number) which this argument requires to
11567 be output if it is itself output.
11569 \begin_inset space \thinspace{}
11572 g., in \SpecialChar LaTeX
11573 commands, optional arguments often require previous optional arguments
11574 to be output (at least empty), as in
11575 \begin_inset Flex Code
11578 \begin_layout Plain Layout
11581 command[][argument]{text}
11587 This can be achieved by the statement
11588 \begin_inset Flex Code
11591 \begin_layout Plain Layout
11598 \begin_inset Flex Code
11601 \begin_layout Plain Layout
11610 \begin_layout Itemize
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11630 defines a custom left delimiter (instead of
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11641 \begin_inset Flex Code
11644 \begin_layout Plain Layout
11651 A line break in the output can be indicated by
11652 \begin_inset Flex Code
11655 \begin_layout Plain Layout
11664 \begin_layout Itemize
11665 \begin_inset Flex Code
11668 \begin_layout Plain Layout
11675 \begin_inset Flex Code
11678 \begin_layout Plain Layout
11684 defines a custom right delimiter (instead of
11685 \begin_inset Flex Code
11688 \begin_layout Plain Layout
11695 \begin_inset Flex Code
11698 \begin_layout Plain Layout
11705 A line break in the output can be indicated by
11706 \begin_inset Flex Code
11709 \begin_layout Plain Layout
11718 \begin_layout Itemize
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11738 defines an argument that is inserted if and only if no user-specified arguments
11740 \begin_inset space \thinspace{}
11744 \begin_inset space \space{}
11747 if no argument inset has been inserted (note that also an empty argument
11748 inset omits the DefaultArg).
11749 Multiple arguments need to be separated by comma.
11752 \begin_layout Itemize
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11772 defines an argument that is inserted in any case (alone or in addition
11773 to user-specified arguments).
11774 Multiple arguments need to be separated by comma.
11777 \begin_layout Itemize
11778 \begin_inset Flex Code
11781 \begin_layout Plain Layout
11787 The font used for the argument content, see
11788 \begin_inset CommandInset ref
11790 reference "subsec:Font-description"
11797 \begin_layout Itemize
11798 \begin_inset Flex Code
11801 \begin_layout Plain Layout
11807 The font used for the label; see
11808 \begin_inset CommandInset ref
11810 reference "subsec:Font-description"
11817 \begin_layout Itemize
11818 \begin_inset Flex Code
11821 \begin_layout Plain Layout
11828 \begin_inset Flex Code
11831 \begin_layout Plain Layout
11836 , Minimalistic, Conglomerate
11841 ] describes the rendering style used for the inset's frame and buttons.
11844 \begin_layout Itemize
11845 \begin_inset Flex Code
11848 \begin_layout Plain Layout
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11865 \begin_inset Flex Code
11868 \begin_layout Plain Layout
11874 , this argument is automatically inserted when the respective style is selected.
11875 Currently, only one argument per style\SpecialChar breakableslash
11876 layout can be automatically inserted.
11879 \begin_layout Itemize
11880 \begin_inset Flex Code
11883 \begin_layout Plain Layout
11890 \begin_inset Flex Code
11893 \begin_layout Plain Layout
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11909 , this argument will be inserted with a copy of the co-text (either selected
11910 text or the whole paragraph) as content.
11913 \begin_layout Itemize
11914 \begin_inset Flex Code
11917 \begin_layout Plain Layout
11924 \begin_inset Flex Code
11927 \begin_layout Plain Layout
11937 ] Whether the contents of this argument should be output in raw form, meaning
11938 without special translations that \SpecialChar LaTeX
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11950 status is inherited by the inset or paragraph layout the argument belongs
11951 to, true and false change the status for the given argument only.
11954 \begin_layout Itemize
11955 \begin_inset Flex Code
11958 \begin_layout Plain Layout
11965 \begin_inset Flex Code
11968 \begin_layout Plain Layout
11969 string of characters
11978 Defines individual characters that should be output in raw form, meaning
11979 without special translations that \SpecialChar LaTeX
11981 Note that, contrary to PassThru, this needs to be explicitly defined for
11983 That is, arguments do not inherit PassThruChars from their parent inset
11987 \begin_layout Itemize
11988 \begin_inset Flex Code
11991 \begin_layout Plain Layout
11998 \begin_inset Flex Code
12001 \begin_layout Plain Layout
12010 \begin_inset space \thinspace{}
12014 \begin_inset Flex Code
12017 \begin_layout Plain Layout
12023 ] If this is set to 1, the argument will output its content in the corresponding
12024 item in the table of contents.
12028 \begin_layout Standard
12029 By default, the text entered in the \SpecialChar LyX
12030 workarea in the respective layout is
12031 the last (mandatory) argument of a command if the
12032 \begin_inset Flex Code
12035 \begin_layout Plain Layout
12042 \begin_inset Flex Code
12045 \begin_layout Plain Layout
12052 However, arguments with the prefix
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12062 are output after this workarea argument.
12063 Note that post-argument numbering restarts at 1, so the first argument
12064 following the workarea argument is
12065 \begin_inset Flex Code
12068 \begin_layout Plain Layout
12075 Post-arguments are ignored in any other
12076 \begin_inset Flex Code
12079 \begin_layout Plain Layout
12086 \begin_inset Flex Code
12089 \begin_layout Plain Layout
12098 \begin_layout Standard
12100 \begin_inset Flex Code
12103 \begin_layout Plain Layout
12112 \begin_inset Flex Code
12115 \begin_layout Plain Layout
12124 \begin_inset Flex Code
12127 \begin_layout Plain Layout
12133 followed by the number (e.
12134 \begin_inset space \thinspace{}
12138 \begin_inset space \space{}
12142 \begin_inset Flex Code
12145 \begin_layout Plain Layout
12155 \begin_layout Description
12156 \begin_inset Flex Code
12159 \begin_layout Plain Layout
12165 Note that this will completely override any prior
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12175 declaration for this style.
12177 \begin_inset Quotes eld
12181 \begin_inset Flex Code
12184 \begin_layout Plain Layout
12191 \begin_inset Quotes erd
12196 \begin_inset CommandInset ref
12198 reference "subsec:I18n"
12202 for details on its use.
12205 \begin_layout Description
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12229 \begin_layout Plain Layout
12230 Note that a `float' here is a real number, such as: 1.5.
12235 The vertical space with which the last of a chain of paragraphs with this
12236 style is separated from the following paragraph.
12237 If the next paragraph has another style, the separations are not simply
12238 added, but the maximum is taken.
12241 \begin_layout Description
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12252 \begin_inset Flex Code
12255 \begin_layout Plain Layout
12261 ] The category for this style.
12262 This is used to group related styles in the style combobox on the toolbar.
12263 Any string can be used, but you may want to use existing categories with
12268 \begin_layout Description
12269 \begin_inset Flex Code
12272 \begin_layout Plain Layout
12278 Depth of XML command.
12279 Used only with XML-type formats.
12282 \begin_layout Description
12283 \begin_inset Flex Code
12286 \begin_layout Plain Layout
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12302 ] Copies all the features of an existing style into the current one.
12306 \begin_layout Description
12307 \begin_inset Flex Code
12310 \begin_layout Plain Layout
12317 \begin_inset Flex Code
12320 \begin_layout Plain Layout
12326 ] The name of a style whose preamble should be output
12331 This allows to ensure some ordering of the preamble snippets when macros
12332 definitions depend on one another.
12336 \begin_layout Plain Layout
12337 Note that, besides that functionality, there is no way to ensure any ordering
12339 The ordering that you see in a given version of \SpecialChar LyX
12340 may change without warning
12349 \begin_layout Description
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12360 \begin_inset Flex Code
12363 \begin_layout Plain Layout
12368 , Box, Filled_Box, Static
12373 ] The type of label that stands at the end of the paragraph (or sequence
12375 \begin_inset Flex Code
12378 \begin_layout Plain Layout
12385 \begin_inset Newline newline
12389 \begin_inset Flex Code
12392 \begin_layout Plain Layout
12399 \begin_inset Flex Code
12402 \begin_layout Plain Layout
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12420 \begin_inset Flex Code
12423 \begin_layout Plain Layout
12430 \begin_inset Quotes eld
12434 \begin_inset Quotes erd
12438 \begin_inset Flex Code
12441 \begin_layout Plain Layout
12448 \begin_inset space \space{}
12452 \begin_inset Flex Code
12455 \begin_layout Plain Layout
12461 ) is a white (resp.
12462 \begin_inset space ~
12465 black) square suitable for end of proof markers,
12466 \begin_inset Flex Code
12469 \begin_layout Plain Layout
12475 is an explicit text string.
12478 \begin_layout Description
12479 \begin_inset Flex Code
12482 \begin_layout Plain Layout
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12498 ] The string used for a label with a
12499 \begin_inset Flex Code
12502 \begin_layout Plain Layout
12509 \begin_inset Newline newline
12513 \begin_inset Flex Code
12516 \begin_layout Plain Layout
12526 \begin_layout Description
12527 \begin_inset Flex Code
12530 \begin_layout Plain Layout
12536 The font used for both the text body
12542 \begin_inset CommandInset ref
12544 reference "subsec:Font-description"
12549 Note that defining this font automatically defines the
12550 \begin_inset Flex Code
12553 \begin_layout Plain Layout
12560 So you should define this one first if you also want to define
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12573 \begin_layout Description
12574 \begin_inset Flex Code
12577 \begin_layout Plain Layout
12584 \begin_inset Flex Code
12587 \begin_layout Plain Layout
12593 ] Used for backporting new styles to stable \SpecialChar LyX
12595 The first stable version that supports this tag is \SpecialChar LyX
12597 The argument is a number which may either be 0, -1 or any value greater
12600 \begin_inset Flex Code
12603 \begin_layout Plain Layout
12609 flag of a style is greater than zero, it will always be written to the
12611 If a .lyx file is read, the style definitions from the document header are
12612 added to the document class.
12613 Therefore even older \SpecialChar LyX
12614 versions can handle the style.
12616 \begin_inset Flex Code
12619 \begin_layout Plain Layout
12625 is a version number: if the style is read, and the version number is less
12626 than the version number of the already existing style in the document class,
12627 the new style is ignored.
12628 If the version number is greater, the new style replaces the existing style.
12629 A value of -1 means an infinite version number, i.
12630 \begin_inset space \thinspace{}
12634 \begin_inset space \space{}
12637 the style is always used.
12640 \begin_layout Description
12641 \begin_inset Flex Code
12644 \begin_layout Plain Layout
12651 \begin_inset Flex Code
12654 \begin_layout Plain Layout
12663 \begin_inset space \thinspace{}
12667 \begin_inset Flex Code
12670 \begin_layout Plain Layout
12676 ] Usually \SpecialChar LyX
12677 does not allow you to insert more than one space between words,
12678 since a space is considered as the separation between two words, not a
12679 character or symbol of its own.
12680 This is a very fine thing but sometimes annoying, for example, when typing
12681 program code or plain \SpecialChar LaTeX
12684 \begin_inset Flex Code
12687 \begin_layout Plain Layout
12694 Note that \SpecialChar LyX
12695 will create protected blanks for the additional blanks when
12696 in another mode than \SpecialChar LaTeX
12700 \begin_layout Description
12701 \begin_inset Flex Code
12704 \begin_layout Plain Layout
12710 These tags are used with XHTML output.
12712 \begin_inset CommandInset ref
12714 reference "subsec:Paragraph-Style-XHTML"
12721 \begin_layout Description
12722 \begin_inset Flex Code
12725 \begin_layout Plain Layout
12731 [FIXME] (Used only with XML-type formats.)
12734 \begin_layout Description
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12745 \begin_inset Flex Code
12748 \begin_layout Plain Layout
12757 \begin_inset space \thinspace{}
12761 \begin_inset Flex Code
12764 \begin_layout Plain Layout
12771 \begin_inset Flex Code
12774 \begin_layout Plain Layout
12780 , marks the style as to be included in the document preamble and not in
12782 This is useful for document classes that want such information as the title
12783 and author to appear in the preamble.
12784 Note that this works only for styles for which the
12785 \begin_inset Flex Code
12788 \begin_layout Plain Layout
12795 \begin_inset Flex Code
12798 \begin_layout Plain Layout
12805 \begin_inset Flex Code
12808 \begin_layout Plain Layout
12817 \begin_layout Description
12818 \begin_inset Flex Code
12821 \begin_layout Plain Layout
12828 \begin_inset Flex Code
12831 \begin_layout Plain Layout
12840 \begin_inset space \thinspace{}
12844 \begin_inset Flex Code
12847 \begin_layout Plain Layout
12854 \begin_inset Flex Code
12857 \begin_layout Plain Layout
12863 , marks the style as being part of a title block (see also the
12864 \begin_inset Flex Code
12867 \begin_layout Plain Layout
12874 \begin_inset Flex Code
12877 \begin_layout Plain Layout
12886 \begin_layout Description
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12897 \begin_inset Flex Code
12900 \begin_layout Plain Layout
12909 \begin_inset space \thinspace{}
12913 \begin_inset Flex Code
12916 \begin_layout Plain Layout
12922 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12923 of its contents in its item in the table of contents.
12924 Otherwise, only the label, if it exists, appears.
12927 \begin_layout Description
12928 \begin_inset Flex Code
12931 \begin_layout Plain Layout
12938 \begin_inset Flex Code
12941 \begin_layout Plain Layout
12947 ] The \SpecialChar LaTeX
12948 command sequence declaring an item in a list.
12949 The command is to be defined without the preceding backslash (the default
12951 \begin_inset Quotes eld
12955 \begin_inset Quotes erd
12959 \begin_inset Flex Code
12962 \begin_layout Plain Layout
12970 in the \SpecialChar LaTeX
12974 \begin_layout Description
12975 \begin_inset Flex Code
12978 \begin_layout Plain Layout
12985 \begin_inset Flex Code
12988 \begin_layout Plain Layout
12994 ] This provides extra space between paragraphs that have the same style.
12995 If you put other styles into an environment, each is separated with the
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13007 But the whole items of the environment are additionally separated with
13009 \begin_inset Flex Code
13012 \begin_layout Plain Layout
13019 Note that this is a
13024 \begin_layout Description
13025 \begin_inset Flex Code
13028 \begin_layout Plain Layout
13034 [FIXME] (Used only with XML-type formats.)
13037 \begin_layout Description
13038 \begin_inset Flex Code
13041 \begin_layout Plain Layout
13048 \begin_inset Flex Code
13051 \begin_layout Plain Layout
13060 \begin_inset space \thinspace{}
13064 \begin_inset Flex Code
13067 \begin_layout Plain Layout
13073 ] Usually \SpecialChar LyX
13074 does not allow you to leave a paragraph empty, since it would
13075 lead to empty \SpecialChar LaTeX
13077 There are some cases where this could be desirable however: in a letter
13078 template, the required fields can be provided as empty fields, so that
13079 people do not forget them; in some special classes, a style can be used
13080 as some kind of break, which does not contain actual text.
13083 \begin_layout Description
13084 \begin_inset Flex Code
13087 \begin_layout Plain Layout
13094 \begin_inset Flex Code
13097 \begin_layout Plain Layout
13103 ] The vertical space between the label and the text body.
13104 Only used for labels that are above the text body (
13105 \begin_inset Flex Code
13108 \begin_layout Plain Layout
13115 \begin_inset Newline newline
13119 \begin_inset Flex Code
13122 \begin_layout Plain Layout
13123 Centered_Top_Environment
13131 \begin_layout Description
13132 \begin_inset Flex Code
13135 \begin_layout Plain Layout
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13151 ] The name of the counter for automatic numbering.
13152 In order to have the counter appear with your label, you will need to reference
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13166 This will work with
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13177 \begin_inset Flex Code
13180 \begin_layout Plain Layout
13187 \begin_inset Flex Code
13190 \begin_layout Plain Layout
13197 \begin_inset Flex Code
13200 \begin_layout Plain Layout
13207 \begin_inset Newline newline
13215 \begin_inset Flex Code
13218 \begin_layout Plain Layout
13225 \begin_inset Flex Code
13228 \begin_layout Plain Layout
13234 , though this case is a bit complicated.
13235 Suppose you declare
13236 \begin_inset Quotes eld
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13244 LabelCounter myenum
13250 \begin_inset Quotes erd
13254 Then the actual counters used are
13255 \begin_inset Flex Code
13258 \begin_layout Plain Layout
13265 \begin_inset Flex Code
13268 \begin_layout Plain Layout
13275 \begin_inset Flex Code
13278 \begin_layout Plain Layout
13285 \begin_inset Flex Code
13288 \begin_layout Plain Layout
13294 , much as in \SpecialChar LaTeX
13296 These counters must all be declared separately.
13297 \begin_inset Newline newline
13301 \begin_inset CommandInset ref
13303 reference "subsec:Counters"
13307 for details on counters.
13310 \begin_layout Description
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13320 The font used for the label.
13322 \begin_inset CommandInset ref
13324 reference "subsec:Font-description"
13331 \begin_layout Description
13332 \begin_inset Flex Code
13335 \begin_layout Plain Layout
13342 \begin_inset Flex Code
13345 \begin_layout Plain Layout
13351 ] Text that indicates how far a label should be indented.
13354 \begin_layout Description
13355 \begin_inset Flex Code
13358 \begin_layout Plain Layout
13365 \begin_inset Flex Code
13368 \begin_layout Plain Layout
13374 ] Text that indicates the amount of horizontal space between the label and
13376 Only used for labels that are not above the text body.
13379 \begin_layout Description
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13390 \begin_inset Flex Code
13393 \begin_layout Plain Layout
13399 ] The string used for the label.
13401 \begin_inset Flex Code
13404 \begin_layout Plain Layout
13410 is set, this string can be contain the special formatting commands described
13412 \begin_inset CommandInset ref
13414 reference "subsec:Counters"
13421 \begin_layout Description
13422 \begin_inset Flex Code
13425 \begin_layout Plain Layout
13426 LabelStringAppendix
13432 \begin_inset Flex Code
13435 \begin_layout Plain Layout
13441 ] This is used inside the appendix instead of
13442 \begin_inset Newline newline
13446 \begin_inset Flex Code
13449 \begin_layout Plain Layout
13457 \begin_inset Flex Code
13460 \begin_layout Plain Layout
13467 \begin_inset Newline newline
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13475 LabelStringAppendix
13483 \begin_layout Description
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13493 [FIXME] (Used only with XML-type formats.)
13496 \begin_layout Description
13497 \begin_inset Flex Code
13500 \begin_layout Plain Layout
13507 \begin_inset Flex Code
13510 \begin_layout Plain Layout
13515 , Manual, Static, Above,
13516 \begin_inset Newline newline
13519 Centered, Sensitive, Enumerate,
13520 \begin_inset Newline newline
13523 Itemize, Bibliography
13532 \begin_layout Description
13533 \begin_inset Flex Code
13536 \begin_layout Plain Layout
13542 means the label is the very first word (up to the first real blank).
13543 Use protected spaces if you want more than one word as the label.
13547 \begin_layout Description
13548 \begin_inset Flex Code
13551 \begin_layout Plain Layout
13557 means the label is simply what is declared as
13558 \begin_inset Flex Code
13561 \begin_layout Plain Layout
13568 This will be displayed
13569 \begin_inset Quotes eld
13573 \begin_inset Quotes erd
13576 , at the beginning of the paragraph.
13578 \begin_inset Flex Code
13581 \begin_layout Plain Layout
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13597 , then it will be displayed only in the first paragraph of any sequence
13598 of paragraphs with the same
13599 \begin_inset Flex Code
13602 \begin_layout Plain Layout
13611 \begin_layout Description
13612 \begin_inset Flex Code
13615 \begin_layout Plain Layout
13622 \begin_inset space ~
13626 \begin_inset space ~
13630 \begin_inset Flex Code
13633 \begin_layout Plain Layout
13639 are special cases of
13640 \begin_inset Flex Code
13643 \begin_layout Plain Layout
13650 The label will be printed above the paragraph either at the beginning of
13651 the line or centered.
13654 \begin_layout Description
13655 \begin_inset Flex Code
13658 \begin_layout Plain Layout
13664 is a special case for the caption-labels
13665 \begin_inset Quotes eld
13669 \begin_inset Quotes erd
13673 \begin_inset Quotes eld
13677 \begin_inset Quotes erd
13681 \begin_inset Newline newline
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13694 means the (hardcoded) label string depends on the kind of float: It is
13695 hardcoded to be `FloatType N', where N is the value of the counter associated
13697 For the case that a caption is inserted outside of a float the
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Quotes eld
13712 \begin_inset Quotes erd
13718 \begin_layout Description
13719 \begin_inset Flex Code
13722 \begin_layout Plain Layout
13728 produces the usual sort of enumeration labels.
13729 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13730 small Roman numerals, and uppercase letters for the four possible depths.
13733 \begin_layout Description
13734 \begin_inset Flex Code
13737 \begin_layout Plain Layout
13743 produces various bullets at the different levels.
13744 It is also hardcoded.
13747 \begin_layout Description
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13757 should be used only with
13758 \begin_inset Flex Code
13761 \begin_layout Plain Layout
13762 LatexType BibEnvironment
13771 \begin_layout Description
13772 \begin_inset Flex Code
13775 \begin_layout Plain Layout
13781 Note that this will completely override any prior
13782 \begin_inset Flex Code
13785 \begin_layout Plain Layout
13791 declaration for this style.
13793 \begin_inset Quotes eld
13797 \begin_inset Flex Code
13800 \begin_layout Plain Layout
13807 \begin_inset Quotes erd
13812 \begin_inset CommandInset ref
13814 reference "subsec:I18n"
13818 for details on its use.
13821 \begin_layout Description
13822 \begin_inset Flex Code
13825 \begin_layout Plain Layout
13832 \begin_inset Flex Code
13835 \begin_layout Plain Layout
13841 ] The name of the corresponding \SpecialChar LaTeX
13843 Either the environment or command name.
13846 \begin_layout Description
13847 \begin_inset Flex Code
13850 \begin_layout Plain Layout
13857 \begin_inset Flex Code
13860 \begin_layout Plain Layout
13866 ] An optional parameter for the corresponding
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13877 This parameter cannot be changed from within \SpecialChar LyX
13879 \begin_inset Flex Code
13882 \begin_layout Plain Layout
13888 for customizable parameters).
13889 This will be output as is after all \SpecialChar LaTeX
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13903 \begin_layout Description
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13914 \begin_inset Flex Code
13917 \begin_layout Plain Layout
13922 , Command, Environment, Item_Environment,
13923 \begin_inset Newline newline
13926 List_Environment, Bib_Environment
13931 ] How the style should be translated into \SpecialChar LaTeX
13936 \begin_layout Plain Layout
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13946 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13947 Visit the SGML class files for specific examples.
13956 \begin_layout Description
13957 \begin_inset Flex Code
13960 \begin_layout Plain Layout
13966 means nothing special.
13969 \begin_layout Description
13970 \begin_inset Flex Code
13973 \begin_layout Plain Layout
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13990 {\SpecialChar ldots
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
14036 \begin_layout Description
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14047 \begin_inset Flex Code
14050 \begin_layout Plain Layout
14057 \begin_inset Flex Code
14060 \begin_layout Plain Layout
14068 is generated for each paragraph of this environment.
14072 \begin_layout Description
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14093 \begin_inset Newline newline
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14106 is passed as an argument to the environment.
14107 \begin_inset Newline newline
14111 \begin_inset Flex Code
14114 \begin_layout Plain Layout
14120 can be defined in the
14121 \begin_inset Flex Noun
14124 \begin_layout Plain Layout
14125 Edit\SpecialChar menuseparator
14127 \begin_inset space ~
14138 \begin_layout Description
14139 \begin_inset Flex Code
14142 \begin_layout Plain Layout
14149 \begin_inset Flex Code
14152 \begin_layout Plain Layout
14158 but adds the necessary mandatory argument (the longest label) to the begin
14159 statement of the bibliography environment:
14160 \begin_inset Newline newline
14164 \begin_inset Flex Code
14167 \begin_layout Plain Layout
14170 begin{thebibliography}{99}
14176 It is therefore only useful for bibliography environments.
14177 The default longest label
14178 \begin_inset Quotes eld
14182 \begin_inset Quotes erd
14185 can be changed by the user in the paragraph settings of a bibliography
14189 \begin_layout Standard
14190 Putting the last few things together, the \SpecialChar LaTeX
14191 output will be either:
14194 \begin_layout LyX-Code
14197 LatexName[LatexParam]{\SpecialChar ldots
14201 \begin_layout Standard
14205 \begin_layout LyX-Code
14208 begin{LatexName}[LatexParam] \SpecialChar ldots
14214 \begin_layout Standard
14215 depending upon the \SpecialChar LaTeX
14220 \begin_layout Description
14221 \begin_inset Flex Code
14224 \begin_layout Plain Layout
14231 \begin_inset Flex Code
14234 \begin_layout Plain Layout
14240 ] A string that is put at the beginning of the style content.
14241 A line break in the output can be indicated by
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14254 \begin_layout Description
14255 \begin_inset Flex Code
14258 \begin_layout Plain Layout
14265 \begin_inset Flex Code
14268 \begin_layout Plain Layout
14274 ] If you put styles into environments, the different
14275 \begin_inset Flex Code
14278 \begin_layout Plain Layout
14284 are not simply added, but added with a factor
14285 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14289 Note that this parameter is also used when
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14300 \begin_inset Flex Code
14303 \begin_layout Plain Layout
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14320 Then it is added to the manual or dynamic margin.
14321 \begin_inset Newline newline
14325 \begin_inset Quotes eld
14329 \begin_inset Flex Code
14332 \begin_layout Plain Layout
14339 \begin_inset Quotes erd
14342 means that the paragraph is indented with the width of
14343 \begin_inset Quotes eld
14347 \begin_inset Flex Code
14350 \begin_layout Plain Layout
14357 \begin_inset Quotes erd
14360 in the normal font.
14361 You can get a negative width by prefixing the string with
14362 \begin_inset Quotes eld
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14376 \begin_inset Quotes erd
14380 This way was chosen so that the look is the same with each used screen
14384 \begin_layout Description
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14403 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14409 \begin_inset Newline newline
14412 The kind of margin that the style has on the left side.
14416 \begin_layout Description
14417 \begin_inset Flex Code
14420 \begin_layout Plain Layout
14426 just means a fixed margin.
14429 \begin_layout Description
14430 \begin_inset Flex Code
14433 \begin_layout Plain Layout
14439 means that the left margin depends on the string entered in the
14440 \begin_inset Flex Noun
14443 \begin_layout Plain Layout
14444 Edit\SpecialChar menuseparator
14446 \begin_inset space ~
14455 This is used to typeset nice lists without tabulators.
14458 \begin_layout Description
14459 \begin_inset Flex Code
14462 \begin_layout Plain Layout
14468 means that the margin depends on the size of the label.
14469 This is used for automatic enumerated headlines.
14470 It is obvious that the headline
14471 \begin_inset Quotes eld
14474 5.4.3.2.1 Very long headline
14475 \begin_inset Quotes erd
14478 must have a wider left margin (as wide as
14479 \begin_inset Quotes eld
14483 \begin_inset Quotes erd
14486 plus the space) than
14487 \begin_inset Quotes eld
14490 3.2 Very long headline
14491 \begin_inset Quotes erd
14495 \begin_inset Quotes eld
14499 \begin_inset Quotes erd
14502 are not able to do this.
14505 \begin_layout Description
14506 \begin_inset Flex Code
14509 \begin_layout Plain Layout
14515 is similar, but only the very first row of the paragraph is dynamic, while
14516 the others are static; this is used, for example, for descriptions.
14519 \begin_layout Description
14520 \begin_inset Flex Code
14523 \begin_layout Plain Layout
14529 means the margin is chosen in a way that the longest row of this paragraph
14530 fits to the right margin.
14531 This is used to typeset an address on the right edge of the page.
14535 \begin_layout Description
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14546 \begin_inset Flex Code
14549 \begin_layout Plain Layout
14558 \begin_inset space \thinspace{}
14562 \begin_inset Flex Code
14565 \begin_layout Plain Layout
14571 ] Whether fragile commands in this style should be
14572 \begin_inset Flex Code
14575 \begin_layout Plain Layout
14588 whether this command should itself be protected.)
14591 \begin_layout Description
14592 \begin_inset Flex Code
14595 \begin_layout Plain Layout
14602 \begin_inset Flex Code
14605 \begin_layout Plain Layout
14612 \begin_inset space \thinspace{}
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14627 ] Whether newlines are translated into \SpecialChar LaTeX
14629 \begin_inset Flex Code
14632 \begin_layout Plain Layout
14643 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14645 inside \SpecialChar LyX
14649 \begin_layout Description
14650 \begin_inset Flex Code
14653 \begin_layout Plain Layout
14660 \begin_inset Flex Code
14663 \begin_layout Plain Layout
14672 \begin_inset space \thinspace{}
14676 \begin_inset Flex Code
14679 \begin_layout Plain Layout
14685 ] If set to true, and if
14686 \begin_inset Flex Code
14689 \begin_layout Plain Layout
14696 \begin_inset Flex Code
14699 \begin_layout Plain Layout
14705 ) paragraphs are being indented, then the indentation of such a paragraph
14706 following one of this type will be suppressed.
14707 (So this will not affect the display of non-default paragraphs.)
14710 \begin_layout Description
14711 \begin_inset Flex Code
14714 \begin_layout Plain Layout
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14730 ] Name of a style that has replaced this style.
14731 This is used to rename a style, while keeping backward compatibility.
14734 \begin_layout Description
14735 \begin_inset Flex Code
14738 \begin_layout Plain Layout
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14755 \begin_inset space \thinspace{}
14759 \begin_inset Flex Code
14762 \begin_layout Plain Layout
14768 ] Determines whether consecutive pragraphs of the same type are treated
14769 as belonging together.
14770 This has the effect that the
14771 \begin_inset Flex Code
14774 \begin_layout Plain Layout
14780 is only printed once before such a group.
14781 By default, this is true for
14782 \begin_inset Flex Code
14785 \begin_layout Plain Layout
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14811 and false for all other types.
14814 \begin_layout Description
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14825 \begin_inset Flex Code
14828 \begin_layout Plain Layout
14837 \begin_inset space \thinspace{}
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14850 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14852 but only by a line break; together with
14853 \begin_inset Flex Code
14856 \begin_layout Plain Layout
14862 , this allows to emulate a plain text editor (like the ERT inset).
14865 \begin_layout Description
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 ] The indent of the very first line of a paragraph.
14887 \begin_inset Newline newline
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14900 will be fixed for a certain style.
14901 The exception is the default style, since the indentation for these paragraphs
14902 can be prohibited with
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14923 style paragraphs inside environments use the
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14933 of the environment, not their native one.
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14944 paragraphs inside an enumeration are not indented.
14947 \begin_layout Description
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14967 ] The vertical space between two paragraphs of this style.
14970 \begin_layout Description
14971 \begin_inset Flex Code
14974 \begin_layout Plain Layout
14981 \begin_inset Flex Code
14984 \begin_layout Plain Layout
14991 allows the user to choose either
14992 \begin_inset Quotes eld
14996 \begin_inset Quotes erd
15000 \begin_inset Quotes eld
15004 \begin_inset Quotes erd
15007 to separate paragraphs.
15009 \begin_inset Quotes eld
15013 \begin_inset Quotes erd
15017 \begin_inset Flex Code
15020 \begin_layout Plain Layout
15028 \begin_inset Quotes eld
15032 \begin_inset Quotes erd
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15045 is ignored and all paragraphs are separated by the
15046 \begin_inset Flex Code
15049 \begin_layout Plain Layout
15056 The vertical space is calculated with
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15062 \begin_inset space ~
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15080 is the height of a row with the normal font.
15081 This way, the look stays the same with different screen fonts.
15084 \begin_layout Description
15085 \begin_inset Flex Code
15088 \begin_layout Plain Layout
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15107 \begin_inset space \thinspace{}
15111 \begin_inset Flex Code
15114 \begin_layout Plain Layout
15120 ] Whether the contents of this paragraph should be output in raw form, meaning
15121 without special translations that \SpecialChar LaTeX
15125 \begin_layout Description
15126 \begin_inset Flex Code
15129 \begin_layout Plain Layout
15136 \begin_inset Flex Code
15139 \begin_layout Plain Layout
15149 Defines individual characters that should be output in raw form, meaning
15150 without special translations that \SpecialChar LaTeX
15154 \begin_layout Description
15155 \begin_inset Flex Code
15158 \begin_layout Plain Layout
15164 Information to be included in the \SpecialChar LaTeX
15165 preamble when this style is used.
15166 Used to define macros, load packages, etc., required by this particular
15169 \begin_inset Quotes eld
15173 \begin_inset Flex Code
15176 \begin_layout Plain Layout
15183 \begin_inset Quotes erd
15189 \begin_layout Description
15190 \begin_inset Flex Code
15193 \begin_layout Plain Layout
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15209 ] The prefix to use when creating labels referring to paragraphs of this
15211 This allows the use of formatted references.
15214 \begin_layout Description
15215 \begin_inset Flex Code
15218 \begin_layout Plain Layout
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15234 ] Whether the style requires the feature
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15245 \begin_inset CommandInset ref
15247 reference "chap:List-of-functions"
15251 for the list of features).
15252 If you require a package with specific options, you can additionally use
15254 \begin_inset Flex Code
15257 \begin_layout Plain Layout
15263 as a general text class parameter (see
15264 \begin_inset CommandInset ref
15266 reference "subsec:General-text-class"
15273 \begin_layout Description
15274 \begin_inset Flex Code
15277 \begin_layout Plain Layout
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15305 ] Resets the \SpecialChar LaTeX
15306 arguments of this style (as defined via the
15307 \begin_inset Flex Code
15310 \begin_layout Plain Layout
15317 This is useful if you have copied a style via
15318 \begin_inset Flex Code
15321 \begin_layout Plain Layout
15327 , but you do not want to inherit its (required and optional) arguments.
15330 \begin_layout Description
15331 \begin_inset Flex Code
15334 \begin_layout Plain Layout
15341 \begin_inset Flex Code
15344 \begin_layout Plain Layout
15353 \begin_inset Flex Code
15356 \begin_layout Plain Layout
15362 ] Resumes a counter that is usually reset at each new sequence of layouts.
15363 This is currently only useful when
15364 \begin_inset Flex Code
15367 \begin_layout Plain Layout
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15386 \begin_layout Description
15387 \begin_inset Flex Code
15390 \begin_layout Plain Layout
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15406 ] A string that is put at the end of the layout content.
15407 A line break in the output can be indicated by
15408 \begin_inset Flex Code
15411 \begin_layout Plain Layout
15420 \begin_layout Description
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15431 \begin_inset Flex Code
15434 \begin_layout Plain Layout
15441 \begin_inset Flex Code
15444 \begin_layout Plain Layout
15453 \begin_layout Description
15454 \begin_inset Flex Code
15457 \begin_layout Plain Layout
15464 \begin_inset Flex Code
15467 \begin_layout Plain Layout
15476 \begin_inset Flex Code
15479 \begin_layout Plain Layout
15486 \begin_inset Flex Code
15489 \begin_layout Plain Layout
15496 \begin_inset Flex Code
15499 \begin_layout Plain Layout
15501 \begin_inset space ~
15509 ] This defines what the default spacing should be in the style.
15511 \begin_inset Flex Code
15514 \begin_layout Plain Layout
15521 \begin_inset Flex Code
15524 \begin_layout Plain Layout
15531 \begin_inset Flex Code
15534 \begin_layout Plain Layout
15540 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15541 If you specify the argument
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15551 , then you must also provide a value argument which will be the actual multiplie
15553 Note that, contrary to other parameters,
15554 \begin_inset Flex Code
15557 \begin_layout Plain Layout
15563 implies the generation of specific \SpecialChar LaTeX
15564 code, using the \SpecialChar LaTeX
15568 \begin_inset Flex Code
15571 \begin_layout Plain Layout
15580 \begin_layout Description
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15591 \begin_inset Flex Code
15594 \begin_layout Plain Layout
15601 \begin_inset space \thinspace{}
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15616 ] Allow spell-checking paragraphs of this style.
15620 \begin_layout Description
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15631 \begin_inset Flex Code
15634 \begin_layout Plain Layout
15643 \begin_inset Flex Code
15646 \begin_layout Plain Layout
15652 ] Steps the master counter of a given counter at the beginning of a new
15653 sequence of layouts.
15654 This is currently only useful when
15655 \begin_inset Flex Code
15658 \begin_layout Plain Layout
15665 \begin_inset Flex Code
15668 \begin_layout Plain Layout
15677 \begin_layout Description
15678 \begin_inset Flex Code
15681 \begin_layout Plain Layout
15687 The font used for the text body .
15689 \begin_inset CommandInset ref
15691 reference "subsec:Font-description"
15698 \begin_layout Description
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15724 The level of the style in the table of contents.
15725 This is used for automatic numbering of section headings.
15728 \begin_layout Description
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15755 \begin_inset Flex Code
15758 \begin_layout Plain Layout
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15774 ] This tag determines whether the first line indentation of this paragraph
15775 can be toggled via the Paragraph settings dialog.
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15792 is set, indentation can be toggled if the document settings use
15793 \begin_inset Quotes eld
15797 \begin_inset Quotes erd
15800 paragraph style, with
15801 \begin_inset Flex Code
15804 \begin_layout Plain Layout
15810 , indentation can always be toggled, notwithstanding the document settings,
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15821 , indentation can never be toggled.
15824 \begin_layout Description
15825 \begin_inset Flex Code
15828 \begin_layout Plain Layout
15835 \begin_inset Flex Code
15838 \begin_layout Plain Layout
15844 ] The vertical space with which the very first of a chain of paragraphs
15845 with this style is separated from the previous paragraph.
15846 If the previous paragraph has another style, the separations are not simply
15847 added, but the maximum is taken.
15850 \begin_layout Subsection
15851 \begin_inset CommandInset label
15857 Internationalization of Paragraph Styles
15860 \begin_layout Standard
15862 has long supported internationalization of layout information, but, until
15863 version 2.0, this applied only to the user interface and not to, say, PDF
15865 Thus, French authors were forced to resort to ugly hacks if they wanted
15870 1' instead of `Theorem 1'.
15871 Thanks to Georg Baum, that is no longer the case.
15874 \begin_layout Standard
15876 \begin_inset Flex Code
15879 \begin_layout Plain Layout
15885 defines text that is to appear in the typeset document, it may use
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15905 to support non-English and even multi-language documents correctly.
15906 The following excerpt (from the
15907 \begin_inset Flex Code
15910 \begin_layout Plain Layout
15916 file) shows how this works:
15919 \begin_layout LyX-Code
15924 \begin_layout LyX-Code
15927 theoremstyle{remark}
15930 \begin_layout LyX-Code
15933 newtheorem{claim}[thm]{
15940 \begin_layout LyX-Code
15944 \begin_layout LyX-Code
15948 \begin_layout LyX-Code
15953 claimname}{_(Claim)}
15956 \begin_layout LyX-Code
15960 \begin_layout LyX-Code
15964 \begin_layout LyX-Code
15973 claimname}{_(Claim)}}
15976 \begin_layout LyX-Code
15981 \begin_layout Standard
15982 In principle, any legal \SpecialChar LaTeX
15984 \begin_inset Flex Code
15987 \begin_layout Plain Layout
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16003 tags, but in practice they will typically look as they do here.
16004 The key to correct translation of the typeset text is the definition of
16005 the \SpecialChar LaTeX
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16034 \begin_layout Standard
16036 \begin_inset Flex Code
16039 \begin_layout Plain Layout
16045 tag provides for internationalization based upon the overall language of
16047 The contents of the tag will be included in the preamble, just as with
16049 \begin_inset Flex Code
16052 \begin_layout Plain Layout
16059 What makes it special is the use of the
16060 \begin_inset Quotes eld
16064 \begin_inset Quotes erd
16068 \begin_inset Flex Code
16071 \begin_layout Plain Layout
16077 , which will be replaced, when \SpecialChar LyX
16078 produces \SpecialChar LaTeX
16079 output, with the translation of
16080 its argument into the document language.
16083 \begin_layout Standard
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16094 tag is more complex, since it is meant to provide support for multi-language
16095 documents and so offers an interface to the
16096 \begin_inset Flex Code
16099 \begin_layout Plain Layout
16106 Its contents will be added to the preamble once for each language that
16107 appears in the document.
16108 In this case, the argument to
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16118 will be replaced with its translation into the language in question; the
16120 \begin_inset Flex Code
16123 \begin_layout Plain Layout
16129 is replaced by the language name (as used by the babel package).
16132 \begin_layout Standard
16133 A German document that also included a French section would thus have the
16134 following in the preamble:
16137 \begin_layout LyX-Code
16146 claimname}{Affirmation}}
16147 \begin_inset Newline newline
16158 claimname}{Behauptung}}
16159 \begin_inset Newline newline
16166 claimname}{Behauptung}
16169 \begin_layout Standard
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16181 will then conspire to produce the correct text in the output.
16184 \begin_layout Standard
16185 One important point to note here is that the translations are provided by
16187 itself, through the file
16188 \begin_inset Flex Code
16191 \begin_layout Plain Layout
16198 This means, in effect, that
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16209 \begin_inset Flex Code
16212 \begin_layout Plain Layout
16218 are really only of use in layout files that are provided with \SpecialChar LyX
16220 entered in user-created layout files will not be seen by \SpecialChar LyX
16221 's internationalizatio
16222 n routines unless the
16223 \begin_inset Flex Code
16226 \begin_layout Plain Layout
16232 file is modified accordingly.
16233 That said, however, any layout created with the intention that it will
16234 be included with \SpecialChar LyX
16235 should use these tags where appropriate.
16236 Please note that the paragraph style translations provided by \SpecialChar LyX
16238 change with a minor update (e.
16239 \begin_inset space \thinspace{}
16243 \begin_inset space \space{}
16246 from version 2.1.x to 2.1.y).
16247 It is however quite likely that a major update (e.
16248 \begin_inset space \thinspace{}
16252 \begin_inset space \space{}
16255 from 2.0.x to 2.1.y) will introduce new translations or corrections.
16258 \begin_layout Subsection
16260 \begin_inset CommandInset label
16262 name "subsec:Floats"
16269 \begin_layout Standard
16270 It is necessary to define the floats (
16271 \begin_inset Flex Noun
16274 \begin_layout Plain Layout
16281 \begin_inset Flex Noun
16284 \begin_layout Plain Layout
16290 , \SpecialChar ldots
16291 ) in the text class itself.
16292 Standard floats are included in the file
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16302 , so you may have to do no more than add
16305 \begin_layout LyX-Code
16306 Input stdfloats.inc
16309 \begin_layout Standard
16310 to your layout file.
16311 If you want to implement a text class that proposes some other float types
16312 (like the AGU class bundled with \SpecialChar LyX
16313 ), the information below will hopefully
16317 \begin_layout Description
16318 \begin_inset Flex Code
16321 \begin_layout Plain Layout
16328 \begin_inset Flex Code
16331 \begin_layout Plain Layout
16337 =!htbpH] Allowed placement options for this float type.
16338 The value is a string of placement characters.
16339 Possible characters include:
16344 \begin_inset Quotes eld
16348 \begin_inset Quotes erd
16356 \begin_inset Quotes eld
16360 \begin_inset Quotes erd
16368 \begin_inset Quotes eld
16372 \begin_inset Quotes erd
16380 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16392 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16404 \begin_inset Quotes eld
16408 \begin_inset Quotes erd
16412 The order of the characters in the string does not matter.
16413 If no placement options are allowed, use the string
16420 \begin_layout Description
16421 \begin_inset Flex Code
16424 \begin_layout Plain Layout
16431 \begin_inset Flex Code
16434 \begin_layout Plain Layout
16443 \begin_inset space \thinspace{}
16449 \begin_inset Flex Code
16452 \begin_layout Plain Layout
16462 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16469 \begin_inset Flex Code
16472 \begin_layout Plain Layout
16478 if the float does not support this feature.
16481 \begin_layout Description
16482 \begin_inset Flex Code
16485 \begin_layout Plain Layout
16492 \begin_inset Flex Code
16495 \begin_layout Plain Layout
16504 \begin_inset space \thinspace{}
16510 \begin_inset Flex Code
16513 \begin_layout Plain Layout
16523 ] Defines whether the float has a starred variant that spans columns in
16524 a two column paragraph.
16526 \begin_inset Flex Code
16529 \begin_layout Plain Layout
16535 if the float does not support this feature.
16538 \begin_layout Description
16539 \begin_inset Flex Code
16542 \begin_layout Plain Layout
16549 \begin_inset Flex Code
16552 \begin_layout Plain Layout
16559 \begin_inset Quotes erd
16563 \begin_inset Quotes erd
16566 ] The file name extension of an auxiliary file for the list of figures (or
16569 writes the captions to this file.
16572 \begin_layout Description
16573 \begin_inset Flex Code
16576 \begin_layout Plain Layout
16583 \begin_inset Flex Code
16586 \begin_layout Plain Layout
16593 \begin_inset Quotes erd
16597 \begin_inset Quotes erd
16600 ] The string that will be used in the menus and also for the caption.
16601 This is translated to the current language if babel is used.
16604 \begin_layout Description
16605 \begin_inset Flex Code
16608 \begin_layout Plain Layout
16614 These tags control the XHTML output.
16616 \begin_inset CommandInset ref
16618 reference "sec:Tags-for-XHTML"
16625 \begin_layout Description
16626 \begin_inset Flex Code
16629 \begin_layout Plain Layout
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16650 \begin_inset space \thinspace{}
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16663 ] Indicates whether the float is already defined in the document class or
16664 if instead the \SpecialChar LaTeX
16666 \begin_inset Flex Code
16669 \begin_layout Plain Layout
16675 needs to be loaded to define it on-the-fly.
16677 \begin_inset Flex Code
16680 \begin_layout Plain Layout
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16697 It should be set to
16698 \begin_inset Flex Code
16701 \begin_layout Plain Layout
16707 if the float is already defined by the \SpecialChar LaTeX
16711 \begin_layout Description
16712 \begin_inset Flex Code
16715 \begin_layout Plain Layout
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16732 \begin_inset Quotes erd
16736 \begin_inset Quotes erd
16739 ] The command used to generate a list of floats of this type; the leading
16748 \begin_inset Flex Code
16751 \begin_layout Plain Layout
16757 is false, since there is no standard way to generate this command.
16759 \begin_inset Flex Code
16762 \begin_layout Plain Layout
16768 is true, since in that case there is a standard way to define the command.
16771 \begin_layout Description
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16792 \begin_inset Quotes erd
16796 \begin_inset Quotes erd
16799 ] A title for a list of floats of this kind (list of figures, tables, or
16801 It is used for the screen label within \SpecialChar LyX
16802 , it is used by \SpecialChar LaTeX
16804 it is used as the title in the XHTML output.
16805 It will be translated to the document language.
16808 \begin_layout Description
16809 \begin_inset Flex Code
16812 \begin_layout Plain Layout
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16829 \begin_inset Quotes erd
16833 \begin_inset Quotes erd
16836 ] This (optional) argument determines whether floats of this class will
16837 be numbered within some sectional unit of the document.
16839 \begin_inset Flex Code
16842 \begin_layout Plain Layout
16849 \begin_inset Quotes eld
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16863 \begin_inset Quotes erd
16866 , the floats will be numbered within chapters.
16870 \begin_layout Description
16871 \begin_inset Flex Code
16874 \begin_layout Plain Layout
16881 \begin_inset Flex Code
16884 \begin_layout Plain Layout
16891 \begin_inset Quotes erd
16895 \begin_inset Quotes erd
16898 ] The default placement for the given class of floats.
16899 The string should be as in standard \SpecialChar LaTeX
16901 \begin_inset Flex Code
16904 \begin_layout Plain Layout
16911 \begin_inset Flex Code
16914 \begin_layout Plain Layout
16921 \begin_inset Flex Code
16924 \begin_layout Plain Layout
16931 \begin_inset Flex Code
16934 \begin_layout Plain Layout
16940 for top, bottom, page, and here, respectively.
16944 \begin_layout Plain Layout
16945 Note that the order of these letters in the string is irrelevant, like in
16952 On top of that there is a new type,
16953 \begin_inset Flex Code
16956 \begin_layout Plain Layout
16962 , which does not really correspond to a float, since it means: put it
16963 \begin_inset Quotes eld
16967 \begin_inset Quotes erd
16971 Note however that the
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16981 specifier is special and, because of implementation details, cannot be
16982 used in non-built in float types.
16983 If you do not understand what this means, just use
16984 \begin_inset Quotes eld
16988 \begin_inset Flex Code
16991 \begin_layout Plain Layout
16998 \begin_inset Quotes erd
17004 \begin_layout Description
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17024 ] The prefix to use when creating labels referring to floats of this type.
17025 This allows the use of formatted references.
17026 Note that you can remove any
17027 \begin_inset Flex Code
17030 \begin_layout Plain Layout
17036 set by a copied style by using the special value
17037 \begin_inset Quotes eld
17041 \begin_inset Quotes erd
17044 , which must be all caps.
17047 \begin_layout Description
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17068 \begin_inset Quotes erd
17072 \begin_inset Quotes erd
17075 ] The style used when defining the float using
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17090 \begin_layout Description
17091 \begin_inset Flex Code
17094 \begin_layout Plain Layout
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17111 \begin_inset Quotes erd
17115 \begin_inset Quotes erd
17119 \begin_inset Quotes eld
17123 \begin_inset Quotes erd
17126 of the new class of floats, like program or algorithm.
17127 After the appropriate
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17140 \begin_inset Flex Code
17143 \begin_layout Plain Layout
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17166 \begin_layout Description
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17177 \begin_inset Flex Code
17180 \begin_layout Plain Layout
17187 \begin_inset space \thinspace{}
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17202 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17213 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17217 \begin_layout Standard
17218 Note that defining a float with type
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17230 automatically defines the corresponding counter with name
17231 \begin_inset Flex Code
17234 \begin_layout Plain Layout
17245 \begin_layout Subsection
17246 Flex insets and InsetLayout
17247 \begin_inset CommandInset label
17249 name "subsec:Flex-insets-and"
17256 \begin_layout Standard
17257 Flex insets come in three different kinds:
17260 \begin_layout Itemize
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17271 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17285 \begin_inset Flex Code
17288 \begin_layout Plain Layout
17299 \begin_layout Itemize
17301 \begin_inset Flex Code
17304 \begin_layout Plain Layout
17310 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17312 footnote, and the like.
17313 An obvious example is an endnote inset, which is defined in the
17314 \begin_inset Flex Code
17317 \begin_layout Plain Layout
17326 \begin_layout Itemize
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17337 ): For use with DocBook classes.
17340 \begin_layout Standard
17341 Flex insets are defined using the
17342 \begin_inset Flex Code
17345 \begin_layout Plain Layout
17351 tag, which shall be explained in a moment.
17354 \begin_layout Standard
17356 \begin_inset Flex Code
17359 \begin_layout Plain Layout
17365 tag also serves another function: It can be used to customize the general
17366 layout of many different types of insets.
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17377 can be used to customize the layout parameters for footnotes, marginal
17378 notes, note insets, \SpecialChar TeX
17379 code (ERT) insets, branches, listings, indexes, boxes,
17380 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17383 \begin_layout Standard
17385 \begin_inset Flex Code
17388 \begin_layout Plain Layout
17394 definition must begin with a line of the form:
17397 \begin_layout LyX-Code
17401 \begin_layout Standard
17403 \begin_inset Flex Code
17406 \begin_layout Plain Layout
17412 indicates the inset whose layout is being defined, and here there are four
17416 \begin_layout Enumerate
17417 The layout for a pre-existing inset is being modified.
17418 In this case, can be
17419 \begin_inset Flex Code
17422 \begin_layout Plain Layout
17428 any one of the following:
17429 \begin_inset Flex Code
17432 \begin_layout Plain Layout
17439 \begin_inset Flex Code
17442 \begin_layout Plain Layout
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
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
17631 \begin_layout Enumerate
17632 The layout for a Flex inset is being defined.
17634 \begin_inset Flex Code
17637 \begin_layout Plain Layout
17643 must be of the form
17644 \begin_inset Quotes eld
17648 \begin_inset Flex Code
17651 \begin_layout Plain Layout
17658 \begin_inset Quotes erd
17662 \begin_inset Flex Code
17665 \begin_layout Plain Layout
17671 may be be any valid identifier not used by a pre-existing Flex inset.
17672 The identifier may include spaces, but in that case the whole thing must
17673 be wrapped in quotes.
17674 Note that the definition of a flex inset
17679 \begin_inset Flex Code
17682 \begin_layout Plain Layout
17688 entry, declaring which type of inset it defines.
17691 \begin_layout Enumerate
17692 The layout for user specific branch is being defined.
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17703 must be of the form
17704 \begin_inset Quotes eld
17708 \begin_inset Flex Code
17711 \begin_layout Plain Layout
17718 \begin_inset Quotes erd
17722 \begin_inset Flex Code
17725 \begin_layout Plain Layout
17731 may be be any valid identifier of branch defined in user's document.
17732 The identifier may include spaces, but in that case the whole thing must
17733 be wrapped in quotes.
17734 The main purpose of this feature is to allow \SpecialChar LaTeX
17735 wrapping around specific
17736 branches as user needs.
17739 \begin_layout Enumerate
17740 The layout of a user (or class) specific caption is being defined.
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17751 must be of the form
17752 \begin_inset Quotes eld
17756 \begin_inset Flex Code
17759 \begin_layout Plain Layout
17766 \begin_inset Quotes erd
17770 \begin_inset Flex Code
17773 \begin_layout Plain Layout
17779 specifies the name of the caption as it appears in the menu.
17780 Have a look at the standard caption (
17781 \begin_inset Flex Code
17784 \begin_layout Plain Layout
17790 ), the specific captions of the KOMA-Script classes (
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17813 \begin_inset space ~
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17828 ) for applications.
17831 \begin_layout Standard
17833 \begin_inset Flex Code
17836 \begin_layout Plain Layout
17842 definition can contain the following entries:
17845 \begin_layout Description
17846 \begin_inset Flex Code
17849 \begin_layout Plain Layout
17856 \begin_inset Flex Code
17859 \begin_layout Plain Layout
17865 =""] This inset will appear in the table of contents of the given type.
17866 An empty string disables.
17867 See also the OutlinerName and the IsTocCaption commands.
17868 This is only implemented for Flex insets.
17872 \begin_layout Description
17873 \begin_inset Flex Code
17876 \begin_layout Plain Layout
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17892 ] Defines argument number of a command\SpecialChar breakableslash
17893 environment associated with the current
17895 The definition must end with
17896 \begin_inset Flex Code
17899 \begin_layout Plain Layout
17907 \begin_inset CommandInset ref
17909 reference "subsec:Paragraph-Styles"
17916 \begin_layout Description
17917 \begin_inset Flex Code
17920 \begin_layout Plain Layout
17926 Preamble for changing language commands; see
17927 \begin_inset CommandInset ref
17929 reference "subsec:I18n"
17936 \begin_layout Description
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17956 ] The color for the inset's background.
17958 \begin_inset CommandInset ref
17960 reference "chap:Names-of-colors"
17964 for a list of the available color names.
17967 \begin_layout Description
17968 \begin_inset Flex Code
17971 \begin_layout Plain Layout
17978 \begin_inset Flex Code
17981 \begin_layout Plain Layout
17990 \begin_inset space \thinspace{}
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18003 ] Whether to use the content of the inset as the label, when the inset is
18008 \begin_layout Description
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18019 \begin_inset Flex Code
18022 \begin_layout Plain Layout
18028 ] As with paragraph styles, see
18029 \begin_inset CommandInset ref
18031 reference "subsec:Paragraph-Styles"
18036 Note that you need to specify the complete type, e.
18037 \begin_inset space \thinspace{}
18041 \begin_inset space ~
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18049 CopyStyle Flex:<name>
18057 \begin_layout Description
18058 \begin_inset Flex Code
18061 \begin_layout Plain Layout
18068 \begin_inset Flex Code
18071 \begin_layout Plain Layout
18080 \begin_inset space \thinspace{}
18084 \begin_inset Flex Code
18087 \begin_layout Plain Layout
18093 ] Indicates whether the user may employ the Paragraph Settings dialog to
18094 customize the paragraph.
18097 \begin_layout Description
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18108 \begin_inset Flex Code
18111 \begin_layout Plain Layout
18118 \begin_inset Flex Code
18121 \begin_layout Plain Layout
18128 \begin_inset Flex Code
18131 \begin_layout Plain Layout
18137 , describing the rendering style used for the inset's frame and buttons.
18138 Footnotes generally use
18139 \begin_inset Flex Code
18142 \begin_layout Plain Layout
18148 , ERT insets generally
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18158 , and character styles
18159 \begin_inset Flex Code
18162 \begin_layout Plain Layout
18171 \begin_layout Description
18172 \begin_inset Flex Code
18175 \begin_layout Plain Layout
18182 \begin_inset Flex Code
18185 \begin_layout Plain Layout
18194 \begin_inset space \thinspace{}
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18212 \begin_inset Flex Code
18215 \begin_layout Plain Layout
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18232 Indicates whether the environment will stand on its own in the output or
18233 will appear inline with the surrounding text.
18234 If set to false, it is supposed that the \SpecialChar LaTeX
18235 environment ignores white space
18236 (including one newline character) after the
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18253 \begin_inset Flex Code
18256 \begin_layout Plain Layout
18272 \begin_layout Description
18273 \begin_inset Flex Code
18276 \begin_layout Plain Layout
18282 Required at the end of the
18283 \begin_inset Flex Code
18286 \begin_layout Plain Layout
18295 \begin_layout Description
18296 \begin_inset Flex Code
18299 \begin_layout Plain Layout
18305 The font used for both the text body
18311 \begin_inset CommandInset ref
18313 reference "subsec:Font-description"
18318 Note that defining this font automatically defines the
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18328 to the same value, so define this first and define
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18338 later if you want them to be different.
18341 \begin_layout Description
18342 \begin_inset Flex Code
18345 \begin_layout Plain Layout
18346 FixedWidthPreambleEncoding
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18364 \begin_inset space \thinspace{}
18368 \begin_inset Flex Code
18371 \begin_layout Plain Layout
18377 ] Force a fixed width encoding for the translated contents of
18378 \begin_inset Flex Code
18381 \begin_layout Plain Layout
18388 \begin_inset Flex Code
18391 \begin_layout Plain Layout
18397 code generated by this layout.
18398 This is needed for special \SpecialChar LaTeX
18403 that do not work with variable width encodings such as
18408 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18409 backends such as Xe\SpecialChar TeX
18411 Lua\SpecialChar TeX
18415 \begin_layout Description
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18420 ForceLocalFontSwitch
18426 \begin_inset Flex Code
18429 \begin_layout Plain Layout
18438 \begin_inset space \thinspace{}
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18451 ] When using babel, always use a local font switch (
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18463 ), never a global one (such as
18464 \begin_inset Flex Code
18467 \begin_layout Plain Layout
18478 \begin_layout Description
18479 \begin_inset Flex Code
18482 \begin_layout Plain Layout
18489 \begin_inset Flex Code
18492 \begin_layout Plain Layout
18501 \begin_inset space \thinspace{}
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18515 \begin_inset Quotes eld
18519 \begin_inset Quotes erd
18522 language, leading to Left-to-Right (Latin) output, e.
18523 \begin_inset space \thinspace{}
18527 \begin_inset space \space{}
18530 in \SpecialChar TeX
18535 \begin_layout Description
18536 \begin_inset Flex Code
18539 \begin_layout Plain Layout
18546 \begin_inset Flex Code
18549 \begin_layout Plain Layout
18558 \begin_inset space \thinspace{}
18562 \begin_inset Flex Code
18565 \begin_layout Plain Layout
18571 ] Force a a line break in the \SpecialChar LaTeX
18572 output before the inset starts and after
18574 This assures the inset itself is output on its own lines, for parsing purposes.
18577 \begin_layout Description
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18600 \begin_inset space \thinspace{}
18604 \begin_inset Flex Code
18607 \begin_layout Plain Layout
18613 ] Indicates whether the
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 should be used or, instead, the user can change the paragraph style used
18628 \begin_layout Description
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18651 \begin_inset space \thinspace{}
18655 \begin_inset Flex Code
18658 \begin_layout Plain Layout
18664 ] As with paragraph styles, see
18665 \begin_inset CommandInset ref
18667 reference "subsec:Paragraph-Styles"
18674 \begin_layout Description
18675 \begin_inset Flex Code
18678 \begin_layout Plain Layout
18684 These tags control the XHTML output.
18686 \begin_inset CommandInset ref
18688 reference "sec:Tags-for-XHTML"
18695 \begin_layout Description
18696 \begin_inset Flex Code
18699 \begin_layout Plain Layout
18706 \begin_inset Flex Code
18709 \begin_layout Plain Layout
18718 \begin_inset space \thinspace{}
18722 \begin_inset Flex Code
18725 \begin_layout Plain Layout
18731 ] Whether to include the contents of this inset in the strings generated
18732 for the `Outline' pane for all table of contents, regardless of the AddToToc
18734 One would not, for example, want the content of a footnote in a section
18735 header to be included in the TOC displayed in the outline, but one would
18736 normally want the content of a character style displayed.
18737 Default is false: not to include.
18740 \begin_layout Description
18741 \begin_inset Flex Code
18744 \begin_layout Plain Layout
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18763 \begin_inset space \thinspace{}
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18776 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18777 of its contents in its item in the table of contents.
18778 Otherwise, only the label appears.
18781 \begin_layout Description
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18794 \begin_inset Flex Code
18797 \begin_layout Plain Layout
18806 \begin_inset space \thinspace{}
18810 \begin_inset Flex Code
18813 \begin_layout Plain Layout
18819 ] As with paragraph styles, see
18820 \begin_inset CommandInset ref
18822 reference "subsec:Paragraph-Styles"
18829 \begin_layout Description
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18839 The font used for the label.
18841 \begin_inset CommandInset ref
18843 reference "subsec:Font-description"
18848 Note that this definition can never appear before
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18858 , lest it be ineffective.
18861 \begin_layout Description
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18882 \begin_inset Quotes erd
18886 \begin_inset Quotes erd
18889 ] What will be displayed on the button or elsewhere as the inset label.
18891 \begin_inset Flex Code
18894 \begin_layout Plain Layout
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18911 ) modify this label on the fly.
18914 \begin_layout Description
18915 \begin_inset Flex Code
18918 \begin_layout Plain Layout
18924 Language dependent preamble; see
18925 \begin_inset CommandInset ref
18927 reference "subsec:I18n"
18934 \begin_layout Description
18935 \begin_inset Flex Code
18938 \begin_layout Plain Layout
18945 \begin_inset Flex Code
18948 \begin_layout Plain Layout
18954 ] The name of the corresponding \SpecialChar LaTeX
18956 Either the environment or command name.
18959 \begin_layout Description
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18970 \begin_inset Flex Code
18973 \begin_layout Plain Layout
18979 ] The optional parameter for the corresponding
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18989 stuff, including possible bracket pairs like
18990 \begin_inset Flex Code
18993 \begin_layout Plain Layout
19000 This parameter cannot be changed from within \SpecialChar LyX
19002 \begin_inset Flex Code
19005 \begin_layout Plain Layout
19011 for customizable parameters).
19012 It will be output as is after all \SpecialChar LaTeX
19014 \begin_inset Flex Code
19017 \begin_layout Plain Layout
19026 \begin_layout Description
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19041 Command, Environment, None
19046 ] How the style should be translated into \SpecialChar LaTeX
19051 \begin_layout Plain Layout
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19061 is perhaps a bit misleading, since these rules apply to SGML classes too.
19062 Visit the SGML class files for specific examples.
19071 \begin_layout Description
19072 \begin_inset Flex Code
19075 \begin_layout Plain Layout
19081 means nothing special
19084 \begin_layout Description
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19105 {\SpecialChar ldots
19114 \begin_layout Description
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19135 }\SpecialChar ldots
19150 \begin_layout Standard
19151 Putting the last few things together, the \SpecialChar LaTeX
19152 output will be either:
19155 \begin_layout LyX-Code
19158 LatexName[LatexParam]{\SpecialChar ldots
19162 \begin_layout Standard
19166 \begin_layout LyX-Code
19169 begin{LatexName}[LatexParam] \SpecialChar ldots
19175 \begin_layout Standard
19176 depending upon the \SpecialChar LaTeX
19181 \begin_layout Description
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 ] A string that is put at the beginning of the layout content.
19202 A line break in the output can be indicated by
19203 \begin_inset Flex Code
19206 \begin_layout Plain Layout
19215 \begin_layout Description
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19236 \begin_inset Flex Code
19239 \begin_layout Plain Layout
19246 \begin_inset Flex Code
19249 \begin_layout Plain Layout
19256 \begin_inset Flex Code
19259 \begin_layout Plain Layout
19265 (indicating a dummy definition ending definitions of charstyles, etc).
19266 This entry is required in and is only meaningful for Flex insets.
19267 Among other things, it determines on which menu this inset will appear.
19269 \begin_inset Flex Code
19272 \begin_layout Plain Layout
19279 \begin_inset Flex Code
19282 \begin_layout Plain Layout
19288 will automatically set
19289 \begin_inset Flex Code
19292 \begin_layout Plain Layout
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19310 \begin_inset Flex Code
19313 \begin_layout Plain Layout
19319 can be set to true, or
19320 \begin_inset Flex Code
19323 \begin_layout Plain Layout
19330 \begin_inset Flex Code
19333 \begin_layout Plain Layout
19339 insets by setting it
19344 \begin_inset Flex Code
19347 \begin_layout Plain Layout
19356 \begin_layout Description
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19379 \begin_inset space \thinspace{}
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19392 ] Whether multiple paragraphs are permitted in this inset.
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19403 to the same value and
19404 \begin_inset Flex Code
19407 \begin_layout Plain Layout
19413 to the opposite value.
19414 These can be reset to other values, if they are used
19419 \begin_inset Flex Code
19422 \begin_layout Plain Layout
19432 \begin_layout Description
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19455 \begin_inset space \thinspace{}
19459 \begin_inset Flex Code
19462 \begin_layout Plain Layout
19468 ] Whether fragile commands in this inset should be
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19485 whether the command should itself be protected.) Default is false.
19488 \begin_layout Description
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19508 ] Deletes an existing
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19521 \begin_layout Description
19522 \begin_inset Flex Code
19525 \begin_layout Plain Layout
19532 \begin_inset Flex Code
19535 \begin_layout Plain Layout
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19551 that has replaced this
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19562 This is used to rename an
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19572 , while keeping backward compatibility.
19575 \begin_layout Description
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19598 \begin_inset space \thinspace{}
19602 \begin_inset Flex Code
19605 \begin_layout Plain Layout
19611 ] As with paragraph styles, see
19612 \begin_inset CommandInset ref
19614 reference "subsec:Paragraph-Styles"
19622 \begin_layout Description
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19645 \begin_inset space \thinspace{}
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19658 ] As with paragraph styles, see
19659 \begin_inset CommandInset ref
19661 reference "subsec:Paragraph-Styles"
19669 \begin_layout Description
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19679 As with paragraph styles, see
19680 \begin_inset CommandInset ref
19682 reference "subsec:Paragraph-Styles"
19689 \begin_layout Description
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19709 ] The prefix to use when creating labels referring to insets of this type.
19710 This allows the use of formatted references.
19713 \begin_layout Description
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19733 ] As with paragraph styles, see
19734 \begin_inset CommandInset ref
19736 reference "subsec:Paragraph-Styles"
19743 \begin_layout Description
19744 \begin_inset Flex Code
19747 \begin_layout Plain Layout
19754 \begin_inset Flex Code
19757 \begin_layout Plain Layout
19766 \begin_inset space \thinspace{}
19770 \begin_inset Flex Code
19773 \begin_layout Plain Layout
19779 ] Resets the \SpecialChar LaTeX
19780 arguments of this layout (as defined via the
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19791 This is useful if you have copied a style via
19792 \begin_inset Flex Code
19795 \begin_layout Plain Layout
19801 , but you do not want to inherit its (required and optional) arguments.
19804 \begin_layout Description
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 \begin_inset space \thinspace{}
19829 \begin_inset Flex Code
19832 \begin_layout Plain Layout
19840 ] Whether this inset should use the font of its surrounding environment
19842 Default is false: use the font of the surrounding environment.
19845 \begin_layout Description
19846 \begin_inset Flex Code
19849 \begin_layout Plain Layout
19856 \begin_inset Flex Code
19859 \begin_layout Plain Layout
19865 ] A string that is put at the end of the layout content.
19866 A line break in the output can be indicated by
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19879 \begin_layout Description
19880 \begin_inset Flex Code
19883 \begin_layout Plain Layout
19890 \begin_inset Flex Code
19893 \begin_layout Plain Layout
19900 \begin_inset space \thinspace{}
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19915 ] Allow spell-checking the contents of this inset.
19919 \begin_layout Subsection
19921 \begin_inset CommandInset label
19923 name "subsec:Counters"
19930 \begin_layout Standard
19931 It is necessary to define the counters (
19932 \begin_inset Flex Noun
19935 \begin_layout Plain Layout
19942 \begin_inset Flex Noun
19945 \begin_layout Plain Layout
19951 , \SpecialChar ldots
19952 ) in the text class itself.
19953 The standard counters are defined in the file
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19963 , so you may have to do no more than add
19966 \begin_layout LyX-Code
19967 Input stdcounters.inc
19970 \begin_layout Standard
19971 to your layout file to get them to work.
19972 But if you want to define custom counters, then you can do so.
19973 The counter declaration must begin with:
19976 \begin_layout LyX-Code
19977 Counter CounterName
19980 \begin_layout Standard
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19991 ' is replaced by the name of the counter.
19992 And it must end with
19993 \begin_inset Quotes eld
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20007 \begin_inset Quotes erd
20011 The following parameters can also be used:
20014 \begin_layout Description
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20034 ] Sets the initial value for the counter, to which it will be reset whenever
20036 Normally, one will want the default, 1.
20039 \begin_layout Description
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Quotes erd
20064 \begin_inset Quotes erd
20067 ] When defined, this string defines how the counter is displayed.
20068 Setting this value sets
20069 \begin_inset Flex Code
20072 \begin_layout Plain Layout
20073 LabelStringAppendix
20079 The following special constructs can be used in the string:
20083 \begin_layout Itemize
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20095 will be replaced by the expansion of the
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20106 \begin_inset Flex Code
20109 \begin_layout Plain Layout
20110 LabelStringAppendix
20116 \begin_inset Flex Code
20119 \begin_layout Plain Layout
20129 \begin_layout Itemize
20130 counter values can be expressed using \SpecialChar LaTeX
20132 \begin_inset Newline newline
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20171 \begin_layout Plain Layout
20181 Actually, the situation is a bit more complicated: any
20200 other than those described below will produce arabic numerals.
20201 It would not be surprising to see this change in the future.
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20216 : 1, 2, 3,\SpecialChar ldots
20218 \begin_inset Flex Code
20221 \begin_layout Plain Layout
20227 for lower-case letters: a, b, c, \SpecialChar ldots
20229 \begin_inset Flex Code
20232 \begin_layout Plain Layout
20238 for upper-case letters: A, B, C, \SpecialChar ldots
20240 \begin_inset Flex Code
20243 \begin_layout Plain Layout
20249 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20260 for upper-case roman numerals: I, II, III\SpecialChar ldots
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20271 for hebrew numerals.
20275 \begin_layout Standard
20276 If LabelString is not defined, a default value is constructed as follows:
20277 if the counter has a master counter
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20298 \begin_inset Newline newline
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20315 is used; otherwise the string
20316 \begin_inset Flex Code
20319 \begin_layout Plain Layout
20330 \begin_layout Description
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20335 LabelStringAppendix
20341 \begin_inset Flex Code
20344 \begin_layout Plain Layout
20351 \begin_inset Quotes erd
20355 \begin_inset Quotes erd
20359 \begin_inset Flex Code
20362 \begin_layout Plain Layout
20368 , but for use in the Appendix.
20371 \begin_layout Description
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20392 \begin_inset Quotes erd
20396 \begin_inset Quotes erd
20399 ] A format for use with formatted references to this counter.
20400 For example, one might want to have references to section numbers appear
20402 \begin_inset Quotes eld
20406 \begin_inset Quotes erd
20410 The string should contain
20411 \begin_inset Quotes eld
20415 \begin_inset Quotes erd
20419 This will be replaced by the counter number itself.
20420 So, for sections, it would be: Section ##.
20423 \begin_layout Description
20424 \begin_inset Flex Code
20427 \begin_layout Plain Layout
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20444 \begin_inset Quotes erd
20448 \begin_inset Quotes erd
20451 ] If this is set to the name of another counter, the present counter will
20452 be reset every time the other one is increased.
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20476 \begin_layout Subsection
20478 \begin_inset CommandInset label
20480 name "subsec:Font-description"
20487 \begin_layout Standard
20488 A font description looks like this:
20491 \begin_layout LyX-Code
20505 \begin_layout LyX-Code
20509 \begin_layout LyX-Code
20513 \begin_layout Standard
20514 The following commands are available:
20517 \begin_layout Description
20518 \begin_inset Flex Code
20521 \begin_layout Plain Layout
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20540 \begin_inset Flex Code
20543 \begin_layout Plain Layout
20550 \begin_inset Flex Code
20553 \begin_layout Plain Layout
20560 \begin_inset Flex Code
20563 \begin_layout Plain Layout
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20610 \begin_inset Flex Code
20613 \begin_layout Plain Layout
20620 \begin_inset Flex Code
20623 \begin_layout Plain Layout
20630 \begin_inset Flex Code
20633 \begin_layout Plain Layout
20640 \begin_inset Flex Code
20643 \begin_layout Plain Layout
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20660 \begin_inset Flex Code
20663 \begin_layout Plain Layout
20670 \begin_inset Flex Code
20673 \begin_layout Plain Layout
20680 \begin_inset Flex Code
20683 \begin_layout Plain Layout
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20710 \begin_inset Flex Code
20713 \begin_layout Plain Layout
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20732 \begin_layout Description
20733 \begin_inset Flex Code
20736 \begin_layout Plain Layout
20743 \begin_inset Flex Code
20746 \begin_layout Plain Layout
20755 \begin_inset Flex Code
20758 \begin_layout Plain Layout
20765 \begin_inset Flex Code
20768 \begin_layout Plain Layout
20777 \begin_layout Description
20778 \begin_inset Flex Code
20781 \begin_layout Plain Layout
20788 \begin_inset Flex Code
20791 \begin_layout Plain Layout
20797 ] Valid arguments are:
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Flex Code
20851 \begin_layout Plain Layout
20858 \begin_inset Flex Code
20861 \begin_layout Plain Layout
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20908 \begin_inset Flex Code
20911 \begin_layout Plain Layout
20918 Each of these turns on or off the corresponding attribute.
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20929 turns on emphasis, and
20930 \begin_inset Flex Code
20933 \begin_layout Plain Layout
20941 \begin_inset Newline newline
20944 If the latter seems puzzling, remember that the font settings for the present
20945 context are generally inherited from the surrounding context.
20947 \begin_inset Flex Code
20950 \begin_layout Plain Layout
20956 would turn off the emphasis that was anyway in effect, say, in a theorem
20960 \begin_layout Description
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20971 \begin_inset Flex Code
20974 \begin_layout Plain Layout
20983 \begin_inset Flex Code
20986 \begin_layout Plain Layout
20995 \begin_layout Description
20996 \begin_inset Flex Code
20999 \begin_layout Plain Layout
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21050 \begin_layout Description
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21061 \begin_inset Flex Code
21064 \begin_layout Plain Layout
21071 \begin_inset Flex Code
21074 \begin_layout Plain Layout
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21133 \begin_inset Flex Code
21136 \begin_layout Plain Layout
21145 \begin_layout Subsection
21146 \begin_inset CommandInset label
21148 name "subsec:Citation-engine-description"
21152 Citation engine description
21155 \begin_layout Standard
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21166 blocks, as used mainly in cite engine files (see
21167 \begin_inset CommandInset ref
21169 reference "subsec:Cite-Engine-Files"
21176 ), define the citation commands provided by a specific
21177 \begin_inset Quotes eld
21181 \begin_inset Quotes erd
21185 A cite engine, in \SpecialChar LyX
21186 terms, is way specific way to format citations, using
21187 numbers, author names and/or years.
21188 Currently, \SpecialChar LyX
21189 supports three such engine types, namely:
21192 \begin_layout Enumerate
21193 \begin_inset Flex Code
21196 \begin_layout Plain Layout
21202 : the default Bib\SpecialChar TeX
21203 way to format citations, a simple numeric style (e.
21204 \begin_inset space \thinspace{}
21208 \begin_inset Quotes eld
21212 \begin_inset Quotes erd
21218 \begin_layout Enumerate
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21228 : Harvard-styled citations using author names and publication year (e.
21229 \begin_inset space \thinspace{}
21233 \begin_inset Quotes eld
21236 Smith and Miller (2017b)
21237 \begin_inset Quotes erd
21243 \begin_layout Enumerate
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21253 : extended numerical citations that also allow for author or title next
21255 \begin_inset space \thinspace{}
21259 \begin_inset Quotes eld
21262 Smith and Miller [1]
21263 \begin_inset Quotes erd
21269 \begin_layout Standard
21270 \begin_inset Flex Code
21273 \begin_layout Plain Layout
21279 blocks look like this:
21282 \begin_layout LyX-Code
21286 \begin_layout LyX-Code
21290 \begin_layout LyX-Code
21294 \begin_layout LyX-Code
21295 citeyearpar[][]=parencite*
21298 \begin_layout LyX-Code
21302 \begin_layout LyX-Code
21306 \begin_layout Standard
21308 \begin_inset Flex Code
21311 \begin_layout Plain Layout
21317 denotes the engine.
21318 The individual lines respectively define a cite command or cite command
21319 paradigm supported by this engine.
21320 The line can be as simple as a cite command that is used both to name the
21321 respective \SpecialChar LyX
21322 command and the \SpecialChar LaTeX
21323 output or more complex in order to differentiate
21325 The full syntax is:
21328 \begin_layout LyX-Code
21329 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21332 \begin_layout Itemize
21333 \begin_inset Flex Code
21336 \begin_layout Plain Layout
21342 : The name as used in the
21343 \begin_inset Flex Code
21346 \begin_layout Plain Layout
21356 \begin_layout Standard
21357 For portability reasons, we try to use the same name for same-formatted
21358 commands in different cite packages (thus many names stem from natbib,
21359 and thus we need to differentiate a
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21369 sometimes, if the \SpecialChar LaTeX
21370 command names differ).
21374 \begin_layout Itemize
21375 \begin_inset Flex Code
21378 \begin_layout Plain Layout
21384 : a (comma-separated) list of commands that fall back to the given
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21394 in the current engine.
21395 This eases the switch of citation packages and engines.
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21416 in layout definitions.
21419 \begin_layout Itemize
21420 \begin_inset Flex Code
21423 \begin_layout Plain Layout
21429 : The actual \SpecialChar LaTeX
21430 command that is output.
21434 \begin_layout Standard
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21475 will be output to \SpecialChar LaTeX
21479 \begin_layout Standard
21483 \begin_layout Itemize
21484 Capitalization indicates that the command also has a capitalized form (
21485 \begin_inset Flex Code
21488 \begin_layout Plain Layout
21498 \begin_inset Flex Code
21501 \begin_layout Plain Layout
21510 These usually enforce up-casing of name prefixes (
21515 \begin_inset Formula $\Rightarrow$
21525 \begin_layout Itemize
21527 \begin_inset Flex Code
21530 \begin_layout Plain Layout
21536 indicate the number of optional arguments (there can be 0–2).
21539 \begin_layout Itemize
21541 \begin_inset Flex Code
21544 \begin_layout Plain Layout
21550 indicates there is a starred version of the command (
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21564 \begin_inset Flex Code
21567 \begin_layout Plain Layout
21580 \begin_layout Standard
21581 By default, the starred version means: Output all authors even if it should
21583 \begin_inset Quotes eld
21587 \begin_inset Quotes erd
21591 \begin_inset Flex Code
21594 \begin_layout Plain Layout
21603 \begin_layout Standard
21604 If the star has a different meaning for a given command, it can be specified
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21610 <!_stardesc!_stardesctooltip>
21616 Maximal two translatable macro keywords, marked by the prefix
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21627 The first points to the string that replaces the
21628 \begin_inset Quotes eld
21632 \begin_inset Quotes erd
21635 checkbox label in the citation dialog, the second one to an optional tool
21636 tip for this checkbox.
21640 \begin_layout Standard
21641 Note that these two macros have to be defined in a
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21651 (see next section), dropping the
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21661 from the prefix, like this:
21664 \begin_layout LyX-Code
21665 _stardesc Sta&rred command label
21668 \begin_layout LyX-Code
21669 _stardesctooltip Tooltip for the starred command checkbox.
21673 \begin_layout Itemize
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21684 indicates that this command features
21685 \begin_inset Quotes eld
21688 qualified citation lists
21689 \begin_inset Quotes erd
21697 -specific feature for multi-reference citations where an individual pre-
21698 and postnote can be given to each reference in the list.
21699 Please refer to the
21703 manual for details.
21706 \begin_layout Subsection
21707 \begin_inset CommandInset label
21709 name "subsec:Citation-format-description"
21713 Citation format description
21716 \begin_layout Standard
21718 \begin_inset Flex Code
21721 \begin_layout Plain Layout
21727 blocks are used to describe how bibliographic information should be displayed,
21728 both within \SpecialChar LyX
21729 itself (in the citation dialog and in tooltips, for example)
21730 and in XHTML output.
21731 Such a block might look like this:
21734 \begin_layout LyX-Code
21738 \begin_layout LyX-Code
21742 \begin_layout LyX-Code
21746 \begin_layout LyX-Code
21750 \begin_layout Standard
21754 \begin_layout LyX-Code
21758 \begin_layout LyX-Code
21762 \begin_layout LyX-Code
21766 \begin_layout LyX-Code
21770 \begin_layout Standard
21771 In the first case, the individual lines define how the bibliographic information
21772 associated with an article or book, respectively, is to be displayed, and
21773 such a definition can be given for any
21774 \begin_inset Quotes els
21778 \begin_inset Quotes ers
21781 that might be present in a Bib\SpecialChar TeX
21784 defines a default format in the source code that will be used if no specific
21785 definition has been given.
21787 predefines several formats in the file
21788 \begin_inset Flex Code
21791 \begin_layout Plain Layout
21797 , which is included in most of \SpecialChar LyX
21798 's document classes.
21801 \begin_layout Standard
21802 In the second case, the lines define how a specific citation command (in
21804 \begin_inset Flex Code
21807 \begin_layout Plain Layout
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21827 ) is to be displayed on the citation inset label, in the citation dialog,
21828 menu or XHTML output.
21830 defines such formats for the citation style variants it supports via
21832 Document\SpecialChar menuseparator
21833 Setting\SpecialChar menuseparator
21834 Bibliography\SpecialChar ldots
21838 \begin_inset Flex Code
21841 \begin_layout Plain Layout
21847 files that are shipped with \SpecialChar LyX
21849 \begin_inset CommandInset ref
21851 reference "subsec:Cite-Engine-Files"
21861 \begin_layout Standard
21862 The definitions use a simple language that allows Bib\SpecialChar TeX
21863 keys to be replaced
21865 Keys should be enclosed in
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21886 So a simple definition might look like this:
21889 \begin_layout LyX-Code
21891 \begin_inset Quotes eld
21895 \begin_inset Quotes erd
21901 \begin_layout Standard
21902 This would print the author, followed by a comma, followed by the title,
21903 in quotes, followed by a period.
21906 \begin_layout Standard
21907 Of course, sometimes you may want to print a key only if it exists.
21908 This can be done by using a conditional construction, such as:
21909 \begin_inset Flex Code
21912 \begin_layout Plain Layout
21914 \begin_inset space ~
21924 \begin_inset Flex Code
21927 \begin_layout Plain Layout
21933 key exists, then print
21934 \begin_inset Quotes eld
21938 \begin_inset space ~
21942 \begin_inset Quotes erd
21945 followed by the volume key.
21946 It is also possible to have an else clause in the conditional, such as:
21947 \begin_inset Newline newline
21951 \begin_inset Flex Code
21954 \begin_layout Plain Layout
21955 {%author%[[%author%]][[%editor%, ed.]]}
21961 \begin_inset Newline newline
21965 \begin_inset Flex Code
21968 \begin_layout Plain Layout
21974 key is printed if it exists; otherwise, the editor key is printed, followed
21976 \begin_inset Quotes eld
21980 \begin_inset space ~
21984 \begin_inset Quotes erd
21987 Note that the key is again enclosed in
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21997 signs; the entire conditional is enclosed in braces; and the if and else
21998 clauses are enclosed in double brackets,
21999 \begin_inset Quotes eld
22003 \begin_inset Flex Code
22006 \begin_layout Plain Layout
22013 \begin_inset Quotes eld
22017 \begin_inset Quotes eld
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22031 \begin_inset Quotes erd
22035 There must be no space between any of these.
22038 \begin_layout Standard
22039 Next to the entry keys, there are some special keys that can be used for
22040 these conditionals:
22043 \begin_layout Itemize
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22048 {%dialog%[[true]][[false]]}
22054 \begin_inset Quotes eld
22058 \begin_inset Quotes erd
22061 part for dialogs and menus, the
22062 \begin_inset Quotes eld
22066 \begin_inset Quotes erd
22069 part for other contexts (workarea, export)
22072 \begin_layout Itemize
22073 \begin_inset Flex Code
22076 \begin_layout Plain Layout
22077 {%export%[[true]][[false]]}
22083 \begin_inset Quotes eld
22087 \begin_inset Quotes erd
22090 part for export and menus, the
22091 \begin_inset Quotes eld
22095 \begin_inset Quotes erd
22098 part for other contexts (workarea, dialog)
22101 \begin_layout Itemize
22102 \begin_inset Flex Code
22105 \begin_layout Plain Layout
22112 \begin_inset Quotes eld
22116 \begin_inset Quotes erd
22119 part if another item follows (e.
22120 \begin_inset space \thinspace{}
22123 g., in a citation with multiple keys)
22126 \begin_layout Itemize
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22131 {%second%[[true]][[false]]}
22137 \begin_inset Quotes eld
22141 \begin_inset Quotes erd
22144 if this is the second of multiple items, else the
22145 \begin_inset Quotes eld
22149 \begin_inset Quotes erd
22155 \begin_layout Itemize
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22160 {%ifstar%[[true]][[false]]}
22166 \begin_inset Quotes eld
22170 \begin_inset Quotes erd
22173 part for starred citation commands (such as
22174 \begin_inset Flex Code
22177 \begin_layout Plain Layout
22185 ), the false part for unstarred
22188 \begin_layout Itemize
22189 \begin_inset Flex Code
22192 \begin_layout Plain Layout
22193 {%ifentrytype:<type>%[[true]][[false]]}
22199 \begin_inset Quotes eld
22203 \begin_inset Quotes erd
22206 if the current entry type matches
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22216 , else the false part (e.g., in a citation definition:
22217 \begin_inset Flex Code
22220 \begin_layout Plain Layout
22221 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22229 \begin_layout Itemize
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22234 {%ifmultiple:<authortype>%[[true]][[false]]}
22240 \begin_inset Quotes eld
22244 \begin_inset Quotes erd
22247 if the current author type (author, editor etc.) has multiple authors, else
22248 the false part (e.g., in a bibliography definition:
22249 \begin_inset Flex Code
22252 \begin_layout Plain Layout
22253 {%ifmultiple:editor%[[eds.]][[ed.]]}
22261 \begin_layout Itemize
22262 \begin_inset Flex Code
22265 \begin_layout Plain Layout
22266 {%ifqualified%[[true]][[false]]}
22272 \begin_inset Quotes eld
22276 \begin_inset Quotes erd
22279 part if the current citation is a qualified citation list (a specific
22283 format for multi-reference citations), the false part if this is not the
22287 \begin_layout Standard
22289 \begin_inset Flex Code
22292 \begin_layout Plain Layout
22298 prints the author key as it is recorded in the bibliography file.
22299 This might not be what you want, since it will result in a string such
22301 \begin_inset Quotes eld
22304 Miller, Peter and Smith, Mary and White, Jane
22305 \begin_inset Quotes erd
22309 \begin_inset Quotes eld
22313 \begin_inset Quotes erd
22316 is used by Bib\SpecialChar TeX
22317 to delimit authors).
22319 therefore provides some methods to get properly formatted name lists (which
22320 will also get translated).
22321 The following keys are provided:
22324 \begin_layout Enumerate
22325 For name lists with pre- and surname, suitable for the main authors/editors
22326 of a bibliography item.
22328 \begin_inset Flex Code
22331 \begin_layout Plain Layout
22337 part denotes the kind of list that is requested (e.g.
22339 \begin_inset Flex Code
22342 \begin_layout Plain Layout
22352 \begin_layout Itemize
22353 \begin_inset Flex Code
22356 \begin_layout Plain Layout
22357 %abbrvnames:<nametype>%
22362 : Provides a name list which is abbreviated (with
22363 \begin_inset Quotes eld
22367 \begin_inset Quotes erd
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22383 \begin_layout Itemize
22384 \begin_inset Flex Code
22387 \begin_layout Plain Layout
22388 %fullnames:<nametype>%
22393 : Provides a full name list (never abbreviated with
22394 \begin_inset Quotes eld
22398 \begin_inset Quotes erd
22404 \begin_layout Itemize
22405 \begin_inset Flex Code
22408 \begin_layout Plain Layout
22409 %forceabbrvnames:<nametype>%
22414 : Provides a name list which is always abbreviated (with
22415 \begin_inset Quotes eld
22419 \begin_inset Quotes erd
22423 \begin_inset Flex Code
22426 \begin_layout Plain Layout
22436 \begin_layout Enumerate
22437 Alternative name lists with pre- and surname, if the order of pre- and surname
22438 inside the bibliography item differs (as in:
22439 \begin_inset Quotes eld
22442 Miller, John: Some text, in: Mary Smith, ed.: A volume
22443 \begin_inset Quotes erd
22450 \begin_layout Itemize
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22455 %abbrvbynames:<nametype>%
22460 : Provides a name list which is abbreviated (with
22461 \begin_inset Quotes eld
22465 \begin_inset Quotes erd
22469 \begin_inset Flex Code
22472 \begin_layout Plain Layout
22481 \begin_layout Itemize
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22486 %fullbynames:<nametype>%
22491 : Provides a full name list (never abbreviated with
22492 \begin_inset Quotes eld
22496 \begin_inset Quotes erd
22502 \begin_layout Itemize
22503 \begin_inset Flex Code
22506 \begin_layout Plain Layout
22507 %forceabbrvbynames:<nametype>%
22512 : Provides a name list which is always abbreviated (with
22513 \begin_inset Quotes eld
22517 \begin_inset Quotes erd
22521 \begin_inset Flex Code
22524 \begin_layout Plain Layout
22534 \begin_layout Enumerate
22535 And finally name lists which consist of family names only, as used in author-yea
22537 these do not take a
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22547 part, but always return either an author list or, if this does not exist,
22548 an editor list (as common in author-year labels):
22552 \begin_layout Itemize
22553 \begin_inset Flex Code
22556 \begin_layout Plain Layout
22562 : Provides a name list which is abbreviated (with
22563 \begin_inset Quotes eld
22567 \begin_inset Quotes erd
22571 \begin_inset Flex Code
22574 \begin_layout Plain Layout
22583 \begin_layout Itemize
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22593 : Provides a full name list (never abbreviated with
22594 \begin_inset Quotes eld
22598 \begin_inset Quotes erd
22604 \begin_layout Itemize
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22609 %forceabbrvciteauthor%
22614 : Provides a name list which is always abbreviated (with
22615 \begin_inset Quotes eld
22619 \begin_inset Quotes erd
22623 \begin_inset Flex Code
22626 \begin_layout Plain Layout
22636 \begin_layout Standard
22637 The order of pre- and surname in the former two lists can be adjusted by
22641 \begin_layout Itemize
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22646 !firstnameform %surname%, %prename%
22651 (first author in lists of type 1)
22654 \begin_layout Itemize
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22659 !othernameform %surname%, %prename%
22664 (other authors in lists of type 1)
22667 \begin_layout Itemize
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22672 !firstbynameform %prename% %surname%
22677 (first author in lists of type 2)
22680 \begin_layout Itemize
22681 \begin_inset Flex Code
22684 \begin_layout Plain Layout
22685 !otherbynameform %prename% %surname%
22690 (other authors in lists of type 2)
22693 \begin_layout Standard
22694 This allows you to configure namings like
22695 \begin_inset Quotes eld
22698 Miller, Peter and Mary Smith: \SpecialChar ldots
22699 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22701 \begin_inset Quotes erd
22707 \begin_layout Standard
22708 There is one other piece of syntax available in definitions, which looks
22710 \begin_inset Flex Code
22713 \begin_layout Plain Layout
22720 This defines a piece of formatting information that is to be used when
22722 \begin_inset Quotes eld
22726 \begin_inset Quotes erd
22730 Obviously, we do not want to output HTML tags when writing plain text,
22731 so they should be wrapped in
22732 \begin_inset Quotes eld
22736 \begin_inset Quotes erd
22740 \begin_inset Quotes eld
22744 \begin_inset Quotes erd
22750 \begin_layout Standard
22751 Two special sorts of definitions are also possible in a
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 An example of the first would be:
22765 \begin_layout LyX-Code
22767 \begin_inset Quotes eld
22771 \begin_inset Quotes erd
22777 \begin_layout Standard
22778 This is an abbreviation, or macro, and it can be used by treating it as
22780 \begin_inset Flex Code
22783 \begin_layout Plain Layout
22792 \begin_inset Flex Code
22795 \begin_layout Plain Layout
22801 exactly as it would treat its definition.
22802 So, let us issue the obvious
22810 \begin_layout LyX-Code
22814 \begin_layout Standard
22815 or anything like it.
22817 shouldn't go into an infinite loop, but it may go into a long one before
22821 \begin_layout Standard
22822 The second sort of special definition might look like this:
22825 \begin_layout LyX-Code
22829 \begin_layout Standard
22830 This defines a translatable piece of text, which allows relevant parts of
22831 the bibliography or citation to be translated.
22832 It can be included in a definition by treating it as a key:
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 Several of these are predefined in
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22864 Note that these are not macros, in the sense just defined.
22865 They will not be expanded.
22868 \begin_layout Standard
22869 So here then is an example that use all these features:
22870 \begin_inset VSpace defskip
22876 \begin_layout Standard
22880 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22883 \begin_layout Standard
22884 \begin_inset VSpace defskip
22887 This defines a macro that prints the author, followed by a comma, if the
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22898 key is defined, or else prints the name of the editor, followed by the
22900 \begin_inset Flex Code
22903 \begin_layout Plain Layout
22909 or its translation (it is by default
22910 \begin_inset Quotes eld
22914 \begin_inset Quotes erd
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22928 Note that this is in fact defined in
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22938 , so you can use it in your own definitions, or re-definitions, if you load
22942 \begin_layout Section
22943 \begin_inset CommandInset label
22945 name "sec:Tags-for-XHTML"
22949 Tags for XHTML output
22952 \begin_layout Standard
22953 As with \SpecialChar LaTeX
22954 or DocBook, the format of \SpecialChar LyX
22955 's XHTML output is also controlled by
22956 layout information.
22957 In general, \SpecialChar LyX
22958 provides sensible defaults and, as mentioned earlier, it will
22959 even construct default CSS style rules from the other layout tags.
22960 For example, \SpecialChar LyX
22961 will attempt to use the information provided in the
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22971 declaration for the Chapter style to write CSS that will appropriately
22972 format chapter headings.
22975 \begin_layout Standard
22976 In many cases, then, you may not have to do anything at all to get acceptable
22977 XHTML output for your own environments, custom insets, and so forth.
22978 But in some cases you will, and so \SpecialChar LyX
22979 provides a number of layout tags that
22980 can be used to customize the XHTML and CSS that are generated.
22983 \begin_layout Standard
22984 Note that there are two tags,
22985 \begin_inset Flex Code
22988 \begin_layout Plain Layout
22995 \begin_inset Flex Code
22998 \begin_layout Plain Layout
23004 that may appear outside style and inset declarations.
23006 \begin_inset CommandInset ref
23008 reference "subsec:General-text-class"
23012 for details on these.
23015 \begin_layout Subsection
23016 \begin_inset CommandInset label
23018 name "subsec:Paragraph-Style-XHTML"
23025 \begin_layout Standard
23026 The sort of XHTML \SpecialChar LyX
23027 outputs for a paragraph depends upon whether we are dealing
23028 with a normal paragraph, a command, or an environment, where this is itself
23029 determined by the contents of the corresponding
23030 \begin_inset Flex Code
23033 \begin_layout Plain Layout
23044 \begin_layout Standard
23045 For a command or normal paragraph, the output XHTML has the following form:
23048 \begin_layout LyX-Code
23050 \begin_inset Quotes erd
23054 \begin_inset Quotes erd
23060 \begin_layout LyX-Code
23062 \begin_inset Quotes erd
23066 \begin_inset Quotes erd
23072 \begin_layout LyX-Code
23073 Contents of the paragraph.
23076 \begin_layout LyX-Code
23080 \begin_layout Standard
23081 The label tags are of course omitted if the paragraph does not have a label.
23084 \begin_layout Standard
23085 For an environment that is not some sort of list, the XHTML takes this form:
23088 \begin_layout LyX-Code
23090 \begin_inset Quotes erd
23094 \begin_inset Quotes erd
23100 \begin_layout LyX-Code
23102 \begin_inset Quotes erd
23106 \begin_inset Quotes erd
23110 \begin_inset Quotes erd
23114 \begin_inset Quotes erd
23117 >Environment Label</labeltag>First paragraph.</itemtag>
23120 \begin_layout LyX-Code
23121 <itemtag>Second paragraph.</itemtag>
23124 \begin_layout LyX-Code
23128 \begin_layout Standard
23129 Note that the label is output only for the first paragraph, as it should
23130 be for a theorem, for example.
23134 \begin_layout Standard
23135 For a list, we have one of these forms:
23138 \begin_layout LyX-Code
23140 \begin_inset Quotes erd
23144 \begin_inset Quotes erd
23150 \begin_layout LyX-Code
23152 \begin_inset Quotes erd
23156 \begin_inset Quotes erd
23160 \begin_inset Quotes erd
23164 \begin_inset Quotes erd
23167 >List Label</labeltag>First item.</itemtag>
23170 \begin_layout LyX-Code
23172 \begin_inset Quotes erd
23176 \begin_inset Quotes erd
23180 \begin_inset Quotes erd
23184 \begin_inset Quotes erd
23187 >List Label</labeltag>Second item.</itemtag>
23190 \begin_layout LyX-Code
23194 \begin_layout LyX-Code
23198 \begin_layout LyX-Code
23200 \begin_inset Quotes erd
23204 \begin_inset Quotes erd
23210 \begin_layout LyX-Code
23212 \begin_inset Quotes erd
23216 \begin_inset Quotes erd
23219 >List Label</labeltag><itemtag attr=
23220 \begin_inset Quotes erd
23224 \begin_inset Quotes erd
23227 >First item.</itemtag>
23230 \begin_layout LyX-Code
23232 \begin_inset Quotes erd
23236 \begin_inset Quotes erd
23239 >List Label</labeltag><itemtag attr=
23240 \begin_inset Quotes erd
23244 \begin_inset Quotes erd
23247 >Second item.</itemtag>
23250 \begin_layout LyX-Code
23254 \begin_layout Standard
23255 Note the different orders of
23256 \begin_inset Flex Code
23259 \begin_layout Plain Layout
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23276 Which order we get depends upon the setting of
23277 \begin_inset Flex Code
23280 \begin_layout Plain Layout
23287 \begin_inset Flex Code
23290 \begin_layout Plain Layout
23296 is false (the default), you get the first of these, with the label within
23297 the item; if true, you get the second, with the label outside the item.
23300 \begin_layout Standard
23301 The specific tags and attributes output for each paragraph type can be controlle
23302 d by means of the layout tags we are about to describe.
23303 As mentioned earlier, however, \SpecialChar LyX
23304 uses sensible defaults for many of these,
23305 so you often may not need to do very much to get good XHTML output.
23306 Think of the available tags as there so you can tweak things to your liking.
23309 \begin_layout Description
23310 \begin_inset Flex Code
23313 \begin_layout Plain Layout
23320 \begin_inset Flex Code
23323 \begin_layout Plain Layout
23329 ] Specifies attribute information to be output with the main tag.
23331 \begin_inset Quotes eld
23335 \begin_inset Flex Code
23338 \begin_layout Plain Layout
23345 \begin_inset Quotes erd
23349 By default, \SpecialChar LyX
23351 \begin_inset Quotes eld
23355 \begin_inset Flex Code
23358 \begin_layout Plain Layout
23365 \begin_inset Quotes erd
23369 \begin_inset Flex Code
23372 \begin_layout Plain Layout
23378 is the \SpecialChar LyX
23379 name of the layout, made lowercase, for example: chapter.
23384 contain any style information.
23386 \begin_inset Flex Code
23389 \begin_layout Plain Layout
23398 \begin_layout Description
23399 \begin_inset Flex Code
23402 \begin_layout Plain Layout
23409 \begin_inset Flex Code
23412 \begin_layout Plain Layout
23422 ] Whether to output the default CSS information \SpecialChar LyX
23423 generates for this layout,
23424 even if additional information is explicitly provided via
23425 \begin_inset Flex Code
23428 \begin_layout Plain Layout
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23445 allows you to alter or augment the generated CSS, rather than to override
23448 \begin_inset Flex Code
23451 \begin_layout Plain Layout
23460 \begin_layout Description
23461 \begin_inset Flex Code
23464 \begin_layout Plain Layout
23471 \begin_inset Flex Code
23474 \begin_layout Plain Layout
23480 ] The tag to be used for individual paragraphs of environments, replacing
23482 \begin_inset Flex Code
23485 \begin_layout Plain Layout
23491 in the examples above.
23493 \begin_inset Flex Code
23496 \begin_layout Plain Layout
23505 \begin_layout Description
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23516 \begin_inset Flex Code
23519 \begin_layout Plain Layout
23525 ] Attributes for the item tag.
23527 \begin_inset Quotes eld
23531 \begin_inset Flex Code
23534 \begin_layout Plain Layout
23535 class=`layoutname_item'
23541 \begin_inset Quotes erd
23549 contain any style information.
23551 \begin_inset Flex Code
23554 \begin_layout Plain Layout
23563 \begin_layout Description
23564 \begin_inset Flex Code
23567 \begin_layout Plain Layout
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23583 ] The tag to be used for paragraph and item labels, replacing
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23593 in the examples above.
23595 \begin_inset Flex Code
23598 \begin_layout Plain Layout
23605 \begin_inset Flex Code
23608 \begin_layout Plain Layout
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23625 \begin_inset Flex Code
23628 \begin_layout Plain Layout
23629 Centered_Top_Environment
23634 , in which case it defaults to
23635 \begin_inset Flex Code
23638 \begin_layout Plain Layout
23647 \begin_layout Description
23648 \begin_inset Flex Code
23651 \begin_layout Plain Layout
23658 \begin_inset Flex Code
23661 \begin_layout Plain Layout
23667 ] Attributes for the label tag.
23669 \begin_inset Quotes eld
23673 \begin_inset Flex Code
23676 \begin_layout Plain Layout
23677 class=`layoutname_label'
23683 \begin_inset Quotes erd
23691 contain any style information.
23693 \begin_inset Flex Code
23696 \begin_layout Plain Layout
23705 \begin_layout Description
23706 \begin_inset Flex Code
23709 \begin_layout Plain Layout
23716 \begin_inset Flex Code
23719 \begin_layout Plain Layout
23729 ] Meaningful only for list-like environments, this tag controls whether
23730 the label tag is output before or inside the item tag.
23731 This is used, for example, in the description environment, where we want
23733 \begin_inset Flex Code
23736 \begin_layout Plain Layout
23737 <dt>\SpecialChar ldots
23738 </dt><dd>\SpecialChar ldots
23746 \begin_inset Flex Code
23749 \begin_layout Plain Layout
23755 : The label tag is output inside the item tag.
23758 \begin_layout Description
23759 \begin_inset Flex Code
23762 \begin_layout Plain Layout
23768 Information to be output in the
23769 \begin_inset Flex Code
23772 \begin_layout Plain Layout
23778 section when this style is used.
23779 This might, for example, be used to include a
23780 \begin_inset Flex Code
23783 \begin_layout Plain Layout
23790 \begin_inset Flex Code
23793 \begin_layout Plain Layout
23802 \begin_layout Description
23803 \begin_inset Flex Code
23806 \begin_layout Plain Layout
23812 CSS style information to be included when this style is used.
23813 Note that this will automatically be wrapped in a layout-generated
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23823 block, so only the CSS itself need be included.
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23837 \begin_layout Description
23838 \begin_inset Flex Code
23841 \begin_layout Plain Layout
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23857 ] The tag to be used for the main label, replacing
23858 \begin_inset Flex Code
23861 \begin_layout Plain Layout
23867 in the examples above.
23869 \begin_inset Flex Code
23872 \begin_layout Plain Layout
23881 \begin_layout Description
23882 \begin_inset Flex Code
23885 \begin_layout Plain Layout
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23905 ] Marks this style as the one to be used to generate the
23906 \begin_inset Flex Code
23909 \begin_layout Plain Layout
23915 tag for the XHTML file.
23916 By default, it is false.
23918 \begin_inset Flex Code
23921 \begin_layout Plain Layout
23927 file sets it to true for the
23928 \begin_inset Flex Code
23931 \begin_layout Plain Layout
23941 \begin_layout Subsection
23945 \begin_layout Standard
23946 The XHTML output of insets can also be controlled by information in layout
23951 \begin_layout Plain Layout
23952 At present, this is true only for
23953 \begin_inset Quotes eld
23957 \begin_inset Quotes erd
23960 insets (insets you can type into) and is not true for
23961 \begin_inset Quotes eld
23965 \begin_inset Quotes erd
23968 insets (insets that are associated with dialog boxes).
23973 Here, too, \SpecialChar LyX
23974 tries to provide sensible defaults, and it constructs default
23976 But everything can be customized.
23979 \begin_layout Standard
23980 The XHTML \SpecialChar LyX
23981 outputs for an inset has the following form:
23984 \begin_layout LyX-Code
23986 \begin_inset Quotes erd
23990 \begin_inset Quotes erd
23996 \begin_layout LyX-Code
23997 <labeltag>Label</labeltag>
24000 \begin_layout LyX-Code
24002 \begin_inset Quotes erd
24006 \begin_inset Quotes erd
24009 >Contents of the inset.</innertag>
24012 \begin_layout LyX-Code
24016 \begin_layout Standard
24017 If the inset permits multiple paragraphs—that is, if
24018 \begin_inset Flex Code
24021 \begin_layout Plain Layout
24027 is true—then the contents of the inset will itself be output as paragraphs
24028 formatted according to the styles used for those paragraphs (standard,
24029 quote, and the like).
24030 The label tag is of course omitted if the paragraph does not have a label
24031 and, at present, is always
24032 \begin_inset Flex Code
24035 \begin_layout Plain Layout
24042 The inner tag is optional and, by default, does not appear.
24045 \begin_layout Standard
24046 The specific tags and attributes output for each inset can be controlled
24047 by means of the following layout tags.
24050 \begin_layout Description
24051 \begin_inset Flex Code
24054 \begin_layout Plain Layout
24061 \begin_inset Flex Code
24064 \begin_layout Plain Layout
24070 ] Specifies attribute information to be output with the main tag.
24072 \begin_inset Quotes eld
24076 \begin_inset Flex Code
24079 \begin_layout Plain Layout
24080 class=`myinset' onclick=`\SpecialChar ldots
24087 \begin_inset Quotes erd
24091 By default, \SpecialChar LyX
24093 \begin_inset Quotes eld
24097 \begin_inset Flex Code
24100 \begin_layout Plain Layout
24107 \begin_inset Quotes erd
24111 \begin_inset Flex Code
24114 \begin_layout Plain Layout
24120 is the \SpecialChar LyX
24121 name of the inset, made lowercase and with non-alphanumeric characters
24122 converted to underscores, for example: footnote.
24125 \begin_layout Description
24126 \begin_inset Flex Code
24129 \begin_layout Plain Layout
24136 \begin_inset Flex Code
24139 \begin_layout Plain Layout
24149 ] Whether to output the default CSS information \SpecialChar LyX
24150 generates for this layout,
24151 even if additional information is explicitly provided via
24152 \begin_inset Flex Code
24155 \begin_layout Plain Layout
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24172 allows you to alter or augment the generated CSS, rather than to override
24177 \begin_layout Description
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24188 \begin_inset Flex Code
24191 \begin_layout Plain Layout
24197 ] Attributes for the inner tag.
24199 \begin_inset Quotes eld
24203 \begin_inset Flex Code
24206 \begin_layout Plain Layout
24207 class=`insetname_inner'
24213 \begin_inset Quotes erd
24219 \begin_layout Description
24220 \begin_inset Flex Code
24223 \begin_layout Plain Layout
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24239 ] The inner tag, replacing
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24249 in the examples above.
24250 By default, there is none.
24253 \begin_layout Description
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24264 \begin_inset Flex Code
24267 \begin_layout Plain Layout
24275 ] Whether this inset represents a standalone block of text (such as a footnote)
24276 or instead represents material that is included in the surrounding text
24277 (such as a branch).
24281 \begin_layout Description
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24301 ] A label for this inset, possibly including a reference to a counter.
24302 For example, for footnote, it might be:
24303 \begin_inset Flex Code
24306 \begin_layout Plain Layout
24315 This is optional, and there is no default.
24318 \begin_layout Description
24319 \begin_inset Flex Code
24322 \begin_layout Plain Layout
24328 Information to be output in the
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24338 section when this style is used.
24339 This might, for example, be used to include a
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24350 \begin_inset Flex Code
24353 \begin_layout Plain Layout
24362 \begin_layout Description
24363 \begin_inset Flex Code
24366 \begin_layout Plain Layout
24372 CSS style information to be included when this style is used.
24373 Note that this will automatically be wrapped in a layout-generated
24374 \begin_inset Flex Code
24377 \begin_layout Plain Layout
24383 block, so only the CSS itself need be included.
24386 \begin_layout Description
24387 \begin_inset Flex Code
24390 \begin_layout Plain Layout
24397 \begin_inset Flex Code
24400 \begin_layout Plain Layout
24406 ] The tag to be used for the main label, replacing
24407 \begin_inset Flex Code
24410 \begin_layout Plain Layout
24416 in the examples above.
24417 The default depends upon the setting of
24418 \begin_inset Flex Code
24421 \begin_layout Plain Layout
24428 \begin_inset Flex Code
24431 \begin_layout Plain Layout
24437 is true, the default is
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24447 ; if it is false, the default is
24448 \begin_inset Flex Code
24451 \begin_layout Plain Layout
24460 \begin_layout Subsection
24464 \begin_layout Standard
24465 The XHTML output for floats too can be controlled by layout information.
24466 The output has the following form:
24469 \begin_layout LyX-Code
24471 \begin_inset Quotes erd
24475 \begin_inset Quotes erd
24481 \begin_layout LyX-Code
24482 Contents of the float.
24485 \begin_layout LyX-Code
24489 \begin_layout Standard
24490 The caption, if there is one, is a separate inset and will be output as
24492 Its appearance can be controlled via the InsetLayout for caption insets.
24496 \begin_layout Description
24497 \begin_inset Flex Code
24500 \begin_layout Plain Layout
24507 \begin_inset Flex Code
24510 \begin_layout Plain Layout
24516 ] Specifies attribute information to be output with the main tag.
24518 \begin_inset Quotes eld
24522 \begin_inset Flex Code
24525 \begin_layout Plain Layout
24526 class=`myfloat' onclick=`\SpecialChar ldots
24533 \begin_inset Quotes erd
24537 By default, \SpecialChar LyX
24539 \begin_inset Quotes eld
24543 \begin_inset Flex Code
24546 \begin_layout Plain Layout
24547 class=`float float-floattype'
24553 \begin_inset Quotes erd
24557 \begin_inset Flex Code
24560 \begin_layout Plain Layout
24566 is \SpecialChar LyX
24567 's name for this type of float, as determined by the float declaration
24569 \begin_inset CommandInset ref
24571 reference "subsec:Floats"
24575 ), though made lowercase and with non-alphanumeric characters converted
24576 to underscores, for example: float-table.
24579 \begin_layout Description
24580 \begin_inset Flex Code
24583 \begin_layout Plain Layout
24589 CSS style information to be included when this float is used.
24590 Note that this will automatically be wrapped in a layout-generated
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24600 block, so only the CSS itself need be included.
24603 \begin_layout Description
24604 \begin_inset Flex Code
24607 \begin_layout Plain Layout
24614 \begin_inset Flex Code
24617 \begin_layout Plain Layout
24623 ] The tag to be used for this float, replacing
24624 \begin_inset Quotes eld
24628 \begin_inset Flex Code
24631 \begin_layout Plain Layout
24638 \begin_inset Quotes erd
24641 in the example above.
24643 \begin_inset Flex Code
24646 \begin_layout Plain Layout
24652 and will rarely need changing.
24655 \begin_layout Subsection
24656 Bibliography formatting
24659 \begin_layout Standard
24660 The bibliography can be formatted using
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24672 \begin_inset CommandInset ref
24674 reference "subsec:Citation-format-description"
24681 \begin_layout Subsection
24686 \begin_layout Standard
24687 We have several times mentioned that \SpecialChar LyX
24688 will generate default CSS style rules
24689 for both insets and paragraph styles, based upon the other layout information
24691 In this section, we shall say a word about which layout information \SpecialChar LyX
24696 \begin_layout Standard
24697 At present, \SpecialChar LyX
24698 auto-generates CSS only for font information, making use of
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24710 \begin_inset Flex Code
24713 \begin_layout Plain Layout
24720 \begin_inset Flex Code
24723 \begin_layout Plain Layout
24730 \begin_inset Flex Code
24733 \begin_layout Plain Layout
24740 \begin_inset Flex Code
24743 \begin_layout Plain Layout
24750 \begin_inset CommandInset ref
24752 reference "subsec:Font-description"
24757 The translation is mostly straightforward and obvious.
24759 \begin_inset Quotes eld
24763 \begin_inset Flex Code
24766 \begin_layout Plain Layout
24773 \begin_inset Quotes erd
24777 \begin_inset Quotes eld
24781 \begin_inset Flex Code
24784 \begin_layout Plain Layout
24785 font-family: sans-serif;
24791 \begin_inset Quotes erd
24795 The correspondence of \SpecialChar LyX
24796 sizes and CSS sizes is a little less obvious but
24797 nonetheless intuitive.
24799 \begin_inset Flex Code
24802 \begin_layout Plain Layout
24809 \begin_inset Flex URL
24812 \begin_layout Plain Layout
24822 \begin_layout Chapter
24823 Including External Material
24824 \begin_inset CommandInset label
24826 name "chap:Including-External-Material"
24833 \begin_layout Standard
24834 \begin_inset Box Shadowbox
24844 height_special "totalheight"
24849 backgroundcolor "none"
24852 \begin_layout Plain Layout
24853 WARNING: This portion of the documentation has not been updated for some
24855 We certainly hope that it is still accurate, but there are no guarantees.
24863 \begin_layout Standard
24864 The use of material from sources external to \SpecialChar LyX
24865 is covered in detail in the
24871 This part of the manual covers what needs to happen behind the scenes for
24872 new sorts of material to be included.
24875 \begin_layout Section
24879 \begin_layout Standard
24880 The external material feature is based on the concept of a
24885 A template is a specification of how \SpecialChar LyX
24886 should interface with a certain kind
24888 As bundled, \SpecialChar LyX
24889 comes with predefined templates for Xfig figures, various
24890 raster format images, chess diagrams, and LilyPond music notation.
24891 You can check the actual list by using the menu
24892 \begin_inset Flex Noun
24895 \begin_layout Plain Layout
24896 Insert\SpecialChar menuseparator
24897 File\SpecialChar menuseparator
24904 Furthermore, it is possible to roll your own template to support a specific
24906 Later we'll describe in more detail what is involved, and hopefully you
24907 will submit all the templates you create so we can include them in a later
24912 \begin_layout Standard
24913 Another basic idea of the external material feature is to distinguish between
24914 the original file that serves as a base for final material and the produced
24915 file that is included in your exported or printed document.
24916 For example, consider the case of a figure produced with
24917 \begin_inset Flex Code
24920 \begin_layout Plain Layout
24927 The Xfig application itself works on an original file with the
24928 \begin_inset Flex Code
24931 \begin_layout Plain Layout
24938 Within Xfig, you create and change your figure, and when you are done,
24940 \begin_inset Flex Code
24943 \begin_layout Plain Layout
24950 When you want to include the figure in your document, you invoke
24951 \begin_inset Flex Code
24954 \begin_layout Plain Layout
24960 in order to create a PostScript file that can readily be included in your
24964 \begin_inset Flex Code
24967 \begin_layout Plain Layout
24973 file is the original file, and the PostScript file is the produced file.
24976 \begin_layout Standard
24977 This distinction is important in order to allow updating of the material
24978 while you are in the process of writing the document.
24979 Furthermore, it provides us with the flexibility that is needed to support
24980 multiple export formats.
24981 For instance, in the case of a plain text file, it is not exactly an award-winn
24982 ing idea to include the figure as raw PostScript.
24983 Instead, you would either prefer to just include a reference to the figure
24984 or try to invoke some graphics to ASCII converter to make the final result
24985 look similar to the real graphics.
24986 The external material management allows you to do this, because it is parametri
24987 zed on the different export formats that \SpecialChar LyX
24991 \begin_layout Standard
24992 Besides supporting the production of different products according to the
24993 exported format, it supports tight integration with editing and viewing
24995 In the case of an Xfig figure, you are able to invoke Xfig on the original
24996 file with a single click from within the external material dialog in \SpecialChar LyX
24998 and also preview the produced PostScript file with Ghostview with another
25000 No more fiddling around with the command line and/or file browsers to locate
25001 and manipulate the original or produced files.
25002 In this way, you are finally able to take full advantage of the many different
25003 applications that are relevant to use when you write your documents, and
25004 ultimately be more productive.
25007 \begin_layout Section
25008 The external template configuration files
25011 \begin_layout Standard
25012 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25014 However, be aware that doing this in an careless manner most probably
25018 introduce an easily exploitable security hole.
25019 So before you do this, please read the discussion about security in
25020 \begin_inset CommandInset ref
25022 reference "sec:Security-discussion"
25029 \begin_layout Standard
25030 Having said that, we encourage you to submit any interesting templates that
25035 \begin_layout Standard
25036 The external templates are defined in the
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25046 files that are stored in the
25047 \begin_inset Flex Code
25050 \begin_layout Plain Layout
25051 LyXDir/lib/xtemplates/
25057 Each template is defined in a file of its own.
25058 You can place your own templates in
25059 \begin_inset Flex Code
25062 \begin_layout Plain Layout
25063 UserDir/xtemplates/
25068 or copy existing templates to that directory in order to modify them.
25071 \begin_layout Standard
25072 A typical template looks like this:
25075 \begin_layout LyX-Code
25079 \begin_layout LyX-Code
25080 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25083 \begin_layout LyX-Code
25087 \begin_layout LyX-Code
25091 \begin_layout LyX-Code
25095 \begin_layout LyX-Code
25099 \begin_layout LyX-Code
25103 \begin_layout LyX-Code
25104 AutomaticProduction true
25107 \begin_layout LyX-Code
25111 \begin_layout LyX-Code
25115 \begin_layout LyX-Code
25119 \begin_layout LyX-Code
25120 TransformCommand Rotate RotationLatexCommand
25123 \begin_layout LyX-Code
25124 TransformCommand Resize ResizeLatexCommand
25127 \begin_layout LyX-Code
25128 Product "$$RotateFront$$ResizeFront
25131 \begin_layout LyX-Code
25136 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25139 \begin_layout LyX-Code
25140 $$ResizeBack$$RotateBack"
25143 \begin_layout LyX-Code
25147 \begin_layout LyX-Code
25148 UpdateResult "$$AbsPath$$Basename.pstex_t"
25151 \begin_layout LyX-Code
25152 Requirement "graphicx"
25155 \begin_layout LyX-Code
25156 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25159 \begin_layout LyX-Code
25160 ReferencedFile latex "$$AbsPath$$Basename.eps"
25163 \begin_layout LyX-Code
25164 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25167 \begin_layout LyX-Code
25171 \begin_layout LyX-Code
25175 \begin_layout LyX-Code
25176 TransformCommand Rotate RotationLatexCommand
25179 \begin_layout LyX-Code
25180 TransformCommand Resize ResizeLatexCommand
25183 \begin_layout LyX-Code
25184 Product "$$RotateFront$$ResizeFront
25187 \begin_layout LyX-Code
25192 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25195 \begin_layout LyX-Code
25196 $$ResizeBack$$RotateBack"
25199 \begin_layout LyX-Code
25200 UpdateFormat pdftex
25203 \begin_layout LyX-Code
25204 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25207 \begin_layout LyX-Code
25208 Requirement "graphicx"
25211 \begin_layout LyX-Code
25212 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25215 \begin_layout LyX-Code
25216 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25219 \begin_layout LyX-Code
25223 \begin_layout LyX-Code
25227 \begin_layout LyX-Code
25228 Product "[XFig: $$FName]"
25231 \begin_layout LyX-Code
25235 \begin_layout LyX-Code
25239 \begin_layout LyX-Code
25240 Product "<graphic fileref=
25242 "$$AbsOrRelPathMaster$$Basename.eps
25247 \begin_layout LyX-Code
25251 \begin_layout LyX-Code
25255 \begin_layout LyX-Code
25256 UpdateResult "$$AbsPath$$Basename.eps"
25259 \begin_layout LyX-Code
25260 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25263 \begin_layout LyX-Code
25264 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25267 \begin_layout LyX-Code
25271 \begin_layout LyX-Code
25275 \begin_layout Standard
25276 As you can see, the template is enclosed in
25277 \begin_inset Flex Code
25280 \begin_layout Plain Layout
25288 \begin_inset Flex Code
25291 \begin_layout Plain Layout
25298 It contains a header specifying some general settings and, for each supported
25299 primary document file format, a section
25300 \begin_inset Flex Code
25303 \begin_layout Plain Layout
25311 \begin_inset Flex Code
25314 \begin_layout Plain Layout
25323 \begin_layout Subsection
25324 The template header
25327 \begin_layout Description
25328 \begin_inset Flex Code
25331 \begin_layout Plain Layout
25332 AutomaticProduction
25333 \begin_inset space ~
25341 Whether the file represented by the template must be generated by \SpecialChar LyX
25343 This command must occur exactly once.
25346 \begin_layout Description
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25352 \begin_inset space ~
25360 A glob pattern that is used in the file dialog to filter out the desired
25362 If there is more than one possible file extension (e.
25363 \begin_inset space \thinspace{}
25367 \begin_inset space \space{}
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25381 \begin_inset Flex Code
25384 \begin_layout Plain Layout
25390 ), use something like
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25401 This command must occur exactly once.
25404 \begin_layout Description
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25410 \begin_inset space ~
25418 The text that is displayed on the button.
25419 This command must occur exactly once.
25422 \begin_layout Description
25423 \begin_inset Flex Code
25426 \begin_layout Plain Layout
25428 \begin_inset space ~
25432 \begin_inset space ~
25440 The help text that is used in the External dialog.
25441 Provide enough information to explain to the user just what the template
25442 can provide him with.
25443 This command must occur exactly once.
25446 \begin_layout Description
25447 \begin_inset Flex Code
25450 \begin_layout Plain Layout
25452 \begin_inset space ~
25460 The file format of the original file.
25461 This must be the name of a format that is known to \SpecialChar LyX
25463 \begin_inset CommandInset ref
25465 reference "sec:Formats"
25471 \begin_inset Quotes eld
25475 \begin_inset Flex Code
25478 \begin_layout Plain Layout
25485 \begin_inset Quotes erd
25488 if the template can handle original files of more than one format.
25490 will attempt to interrogate the file itself in order to deduce its format
25492 This command must occur exactly once.
25495 \begin_layout Description
25496 \begin_inset Flex Code
25499 \begin_layout Plain Layout
25501 \begin_inset space ~
25509 A unique name for the template.
25510 It must not contain substitution macros (see below).
25513 \begin_layout Description
25514 \begin_inset Flex Code
25517 \begin_layout Plain Layout
25519 \begin_inset space ~
25522 Rotate|Resize|Clip|Extra
25527 This command specifies which transformations are supported by this template.
25528 It may occur zero or more times.
25529 This command enables the corresponding tabs in the external dialog.
25531 \begin_inset Flex Code
25534 \begin_layout Plain Layout
25540 command must have either a corresponding
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25551 \begin_inset Flex Code
25554 \begin_layout Plain Layout
25561 \begin_inset Flex Code
25564 \begin_layout Plain Layout
25571 Otherwise the transformation will not be supported by that format.
25574 \begin_layout Subsection
25578 \begin_layout Description
25579 \begin_inset Flex Code
25582 \begin_layout Plain Layout
25584 \begin_inset space ~
25587 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25592 The primary document file format that this format definition is for.
25593 Not every template has a sensible representation in all document file formats.
25594 Please define nevertheless a
25595 \begin_inset Flex Code
25598 \begin_layout Plain Layout
25604 section for all templates.
25605 Use a dummy text when no representation is available.
25606 Then you can at least see a reference to the external material in the exported
25610 \begin_layout Description
25611 \begin_inset Flex Code
25614 \begin_layout Plain Layout
25616 \begin_inset space ~
25620 \begin_inset space ~
25628 This command defines an additional macro
25629 \begin_inset Flex Code
25632 \begin_layout Plain Layout
25638 for substitution in
25639 \begin_inset Flex Code
25642 \begin_layout Plain Layout
25650 \begin_inset Flex Code
25653 \begin_layout Plain Layout
25659 itself may contain substitution macros.
25660 The advantage over using
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25671 \begin_inset Flex Code
25674 \begin_layout Plain Layout
25680 is that the substituted value of
25681 \begin_inset Flex Code
25684 \begin_layout Plain Layout
25690 is sanitized so that it is a valid optional argument in the document format.
25691 This command may occur zero or more times.
25694 \begin_layout Description
25695 \begin_inset Flex Code
25698 \begin_layout Plain Layout
25700 \begin_inset space ~
25708 The text that is inserted in the exported document.
25709 This is actually the most important command and can be quite complex.
25710 This command must occur exactly once.
25713 \begin_layout Description
25714 \begin_inset Flex Code
25717 \begin_layout Plain Layout
25719 \begin_inset space ~
25727 This command specifies a preamble snippet that will be included in the
25730 It has to be defined using
25731 \begin_inset Flex Code
25734 \begin_layout Plain Layout
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25752 This command may occur zero or more times.
25755 \begin_layout Description
25756 \begin_inset Flex Code
25759 \begin_layout Plain Layout
25761 \begin_inset space ~
25765 \begin_inset space ~
25773 This command denotes files that are created by the conversion process and
25774 are needed for a particular export format.
25775 If the filename is relative, it is interpreted relative to the master document.
25776 This command may be given zero or more times.
25779 \begin_layout Description
25780 \begin_inset Flex Code
25783 \begin_layout Plain Layout
25785 \begin_inset space ~
25793 The name of a required \SpecialChar LaTeX
25795 The package is included via
25796 \begin_inset Flex Code
25799 \begin_layout Plain Layout
25807 in the \SpecialChar LaTeX
25809 This command may occur zero or more times.
25812 \begin_layout Description
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25818 \begin_inset space ~
25822 \begin_inset space ~
25825 RotationLatexCommand
25830 This command specifies that the built in \SpecialChar LaTeX
25831 command should be used for rotation.
25832 This command may occur once or not at all.
25835 \begin_layout Description
25836 \begin_inset Flex Code
25839 \begin_layout Plain Layout
25841 \begin_inset space ~
25845 \begin_inset space ~
25853 This command specifies that the built in \SpecialChar LaTeX
25854 command should be used for resizing.
25855 This command may occur once or not at all.
25858 \begin_layout Description
25859 \begin_inset Flex Code
25862 \begin_layout Plain Layout
25864 \begin_inset space ~
25868 \begin_inset space ~
25871 RotationLatexOption
25876 This command specifies that rotation is done via an optional argument.
25877 This command may occur once or not at all.
25880 \begin_layout Description
25881 \begin_inset Flex Code
25884 \begin_layout Plain Layout
25886 \begin_inset space ~
25890 \begin_inset space ~
25898 This command specifies that resizing is done via an optional argument.
25899 This command may occur once or not at all.
25902 \begin_layout Description
25903 \begin_inset Flex Code
25906 \begin_layout Plain Layout
25908 \begin_inset space ~
25912 \begin_inset space ~
25920 This command specifies that clipping is done via an optional argument.
25921 This command may occur once or not at all.
25924 \begin_layout Description
25925 \begin_inset Flex Code
25928 \begin_layout Plain Layout
25930 \begin_inset space ~
25934 \begin_inset space ~
25942 This command specifies that an extra optional argument is used.
25943 This command may occur once or not at all.
25946 \begin_layout Description
25947 \begin_inset Flex Code
25950 \begin_layout Plain Layout
25952 \begin_inset space ~
25960 The file format of the converted file.
25961 This must be the name of a format that is known to \SpecialChar LyX
25963 \begin_inset Flex Noun
25966 \begin_layout Plain Layout
25967 Tools\SpecialChar menuseparator
25968 Preferences\SpecialChar menuseparator
25969 File Handling\SpecialChar menuseparator
25976 This command must occur exactly once.
25977 If the resulting file format is PDF, you need to specify the format
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25988 This is the PDF format used for including graphics.
25989 The other defined PDF formats are for document export.
25992 \begin_layout Description
25993 \begin_inset Flex Code
25996 \begin_layout Plain Layout
25998 \begin_inset space ~
26006 The file name of the converted file.
26007 The file name must be absolute.
26008 This command must occur exactly once.
26011 \begin_layout Subsection
26012 Preamble definitions
26015 \begin_layout Standard
26016 The external template configuration file may contain additional preamble
26017 definitions enclosed by
26018 \begin_inset Flex Code
26021 \begin_layout Plain Layout
26029 \begin_inset Flex Code
26032 \begin_layout Plain Layout
26039 They can be used by the templates in the
26040 \begin_inset Flex Code
26043 \begin_layout Plain Layout
26052 \begin_layout Section
26053 The substitution mechanism
26056 \begin_layout Standard
26057 When the external material facility invokes an external program, it is done
26058 on the basis of a command defined in the template configuration file.
26059 These commands can contain various macros that are expanded before execution.
26060 Execution always take place in the directory of the containing document.
26063 \begin_layout Standard
26064 Also, whenever external material is to be displayed, the name will be produced
26065 by the substitution mechanism, and most other commands in the template
26066 definition support substitution as well.
26069 \begin_layout Standard
26070 The available macros are the following:
26073 \begin_layout Description
26074 \begin_inset Flex Code
26077 \begin_layout Plain Layout
26078 $$AbsOrRelPathMaster
26083 The file path, absolute or relative to the master \SpecialChar LyX
26087 \begin_layout Description
26088 \begin_inset Flex Code
26091 \begin_layout Plain Layout
26092 $$AbsOrRelPathParent
26097 The file path, absolute or relative to the \SpecialChar LyX
26101 \begin_layout Description
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26111 The absolute file path.
26114 \begin_layout Description
26115 \begin_inset Flex Code
26118 \begin_layout Plain Layout
26124 The filename without path and without the extension.
26127 \begin_layout Description
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26133 \begin_inset Quotes eld
26137 \begin_inset Quotes erd
26145 This macro will expand to the contents of the file with the name
26146 \begin_inset Flex Code
26149 \begin_layout Plain Layout
26158 \begin_layout Description
26159 \begin_inset Flex Code
26162 \begin_layout Plain Layout
26168 The file extension (including the dot).
26171 \begin_layout Description
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26181 This will be the string
26182 \begin_inset Quotes eld
26186 \begin_inset Quotes erd
26189 if the file is in JPEG format, otherwise it will be the string
26190 \begin_inset Quotes eld
26194 \begin_inset Quotes erd
26198 This is useful to avoid uneeded conversions for output formats that support
26199 both PNG and JPEG fomats.
26200 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26205 \begin_layout Description
26206 \begin_inset Flex Code
26209 \begin_layout Plain Layout
26215 The filename of the file specified in the external material dialog.
26216 This is either an absolute name, or it is relative to the \SpecialChar LyX
26220 \begin_layout Description
26221 \begin_inset Flex Code
26224 \begin_layout Plain Layout
26231 \begin_inset Flex Code
26234 \begin_layout Plain Layout
26240 (absolute name or relative to the \SpecialChar LyX
26244 \begin_layout Description
26245 \begin_inset Flex Code
26248 \begin_layout Plain Layout
26254 The file path, relative to the master \SpecialChar LyX
26258 \begin_layout Description
26259 \begin_inset Flex Code
26262 \begin_layout Plain Layout
26268 The file path, relative to the \SpecialChar LyX
26272 \begin_layout Description
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26282 This macro will expand to the absolute path of the system directory.
26283 This is typically used to point to the various helper scripts that are
26284 bundled with \SpecialChar LyX
26288 \begin_layout Description
26289 \begin_inset Flex Code
26292 \begin_layout Plain Layout
26298 A name and full path to a temporary file which will be automatically deleted
26299 whenever the containing document is closed, or the external material insertion
26303 \begin_layout Standard
26304 All path macros contain a trailing directory separator, so you can construct
26306 \begin_inset space \thinspace{}
26310 \begin_inset space \space{}
26313 the absolute filename with
26314 \begin_inset Flex Code
26317 \begin_layout Plain Layout
26318 $$AbsPath$$Basename$$Extension
26326 \begin_layout Standard
26327 The macros above are substituted in all commands unless otherwise noted.
26329 \begin_inset Flex Code
26332 \begin_layout Plain Layout
26338 supports additionally the following substitutions if they are enabled by
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26350 \begin_inset Flex Code
26353 \begin_layout Plain Layout
26362 \begin_layout Description
26363 \begin_inset Flex Code
26366 \begin_layout Plain Layout
26372 The front part of the resize command.
26375 \begin_layout Description
26376 \begin_inset Flex Code
26379 \begin_layout Plain Layout
26385 The back part of the resize command.
26388 \begin_layout Description
26389 \begin_inset Flex Code
26392 \begin_layout Plain Layout
26398 The front part of the rotation command.
26401 \begin_layout Description
26402 \begin_inset Flex Code
26405 \begin_layout Plain Layout
26411 The back part of the rotation command.
26414 \begin_layout Standard
26415 The value string of the
26416 \begin_inset Flex Code
26419 \begin_layout Plain Layout
26425 command supports additionally the following substitutions if they are enabled
26427 \begin_inset Flex Code
26430 \begin_layout Plain Layout
26437 \begin_inset Flex Code
26440 \begin_layout Plain Layout
26449 \begin_layout Description
26450 \begin_inset Flex Code
26453 \begin_layout Plain Layout
26462 \begin_layout Description
26463 \begin_inset Flex Code
26466 \begin_layout Plain Layout
26475 \begin_layout Description
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26488 \begin_layout Description
26489 \begin_inset Flex Code
26492 \begin_layout Plain Layout
26498 The rotation option.
26501 \begin_layout Standard
26502 You may ask why there are so many path macros.
26503 There are mainly two reasons:
26506 \begin_layout Enumerate
26507 Relative and absolute file names should remain relative or absolute, respectivel
26509 Users may have reasons to prefer either form.
26510 Relative names are useful for portable documents that should work on different
26511 machines, for example.
26512 Absolute names may be required by some programs.
26515 \begin_layout Enumerate
26517 treats relative file names differently than \SpecialChar LyX
26518 and other programs in nested
26520 For \SpecialChar LyX
26521 , a relative file name is always relative to the document that contains
26523 For \SpecialChar LaTeX
26524 , it is always relative to the master document.
26525 These two definitions are identical if you have only one document, but
26526 differ if you have a master document that includes part documents.
26527 That means that relative filenames must be transformed when presented to
26530 Fortunately \SpecialChar LyX
26531 does this automatically for you if you choose the right macros.
26534 \begin_layout Standard
26535 So which path macro should be used in new template definitions? The rule
26539 \begin_layout Itemize
26541 \begin_inset Flex Code
26544 \begin_layout Plain Layout
26550 if an absolute path is required.
26553 \begin_layout Itemize
26555 \begin_inset Flex Code
26558 \begin_layout Plain Layout
26559 $$AbsOrRelPathMaster
26564 if the substituted string is some kind of \SpecialChar LaTeX
26568 \begin_layout Itemize
26570 \begin_inset Flex Code
26573 \begin_layout Plain Layout
26574 $$AbsOrRelPathParent
26579 in order to preserve the user's choice.
26582 \begin_layout Standard
26583 There are special cases where this rule does not work and e.
26584 \begin_inset space \thinspace{}
26588 \begin_inset space \space{}
26591 relative names are needed, but normally it will work just fine.
26592 One example for such a case is the command
26593 \begin_inset Flex Code
26596 \begin_layout Plain Layout
26597 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26602 in the XFig template above: We can't use the absolute name because the
26604 \begin_inset Flex Code
26607 \begin_layout Plain Layout
26613 files needs the relative name in order to rewrite the file content.
26616 \begin_layout Section
26617 Security discussion
26618 \begin_inset CommandInset label
26620 name "sec:Security-discussion"
26627 \begin_layout Standard
26628 The external material feature interfaces with a lot of external programs
26629 and does so automatically, so we have to consider the security implications
26631 In particular, since you have the option of including your own filenames
26632 and/or parameter strings and those are expanded into a command, it seems
26633 that it would be possible to create a malicious document which executes
26634 arbitrary commands when a user views or prints the document.
26635 This is something we definitely want to avoid.
26638 \begin_layout Standard
26639 However, since the external program commands are specified in the template
26640 configuration file only, there are no security issues if \SpecialChar LyX
26641 is properly configure
26642 d with safe templates only.
26643 This is so because the external programs are invoked with the
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26653 -system call rather than the
26654 \begin_inset Flex Code
26657 \begin_layout Plain Layout
26663 system-call, so it's not possible to execute arbitrary commands from the
26664 filename or parameter section via the shell.
26667 \begin_layout Standard
26668 This also implies that you are restricted in what command strings you can
26669 use in the external material templates.
26670 In particular, pipes and redirection are not readily available.
26671 This has to be so if \SpecialChar LyX
26672 should remain safe.
26673 If you want to use some of the shell features, you should write a safe
26674 script to do this in a controlled manner, and then invoke the script from
26675 the command string.
26679 \begin_layout Standard
26680 It is possible to design a template that interacts directly with the shell,
26681 but since this would allow a malicious user to execute arbitrary commands
26682 by writing clever filenames and/or parameters, we generally recommend that
26683 you only use safe scripts that work with the
26684 \begin_inset Flex Code
26687 \begin_layout Plain Layout
26693 system call in a controlled manner.
26694 Of course, for use in a controlled environment, it can be tempting to just
26695 fall back to use ordinary shell scripts.
26696 If you do so, be aware that you
26700 provide an easily exploitable security hole in your system.
26701 Of course it stands to reason that such unsafe templates will never be
26702 included in the standard \SpecialChar LyX
26703 distribution, although we do encourage people
26704 to submit new templates in the open source tradition.
26705 But \SpecialChar LyX
26706 as shipped from the official distribution channels will never have
26710 \begin_layout Standard
26711 Including external material provides a lot of power, and you have to be
26712 careful not to introduce security hazards with this power.
26713 A subtle error in a single line in an innocent looking script can open
26714 the door to huge security problems.
26715 So if you do not fully understand the issues, we recommend that you consult
26716 a knowledgeable security professional or the \SpecialChar LyX
26717 development team if you have
26718 any questions about whether a given template is safe or not.
26719 And do this before you use it in an uncontrolled environment.
26722 \begin_layout Chapter
26724 List of supported \SpecialChar LyX
26725 functions to be used in layouts
26726 \begin_inset CommandInset label
26728 name "chap:List-of-functions"
26735 \begin_layout Standard
26737 \begin_inset Tabular
26738 <lyxtabular version="3" rows="11" columns="8">
26739 <features tabularvalignment="middle">
26740 <column alignment="left" valignment="top">
26741 <column alignment="left" valignment="top">
26742 <column alignment="left" valignment="top">
26743 <column alignment="left" valignment="top">
26744 <column alignment="left" valignment="top">
26745 <column alignment="left" valignment="top">
26746 <column alignment="left" valignment="top">
26747 <column alignment="left" valignment="top">
26749 <cell alignment="left" valignment="top" usebox="none">
26752 \begin_layout Plain Layout
26758 <cell alignment="left" valignment="top" usebox="none">
26761 \begin_layout Plain Layout
26767 <cell alignment="left" valignment="top" usebox="none">
26770 \begin_layout Plain Layout
26776 <cell alignment="left" valignment="top" usebox="none">
26779 \begin_layout Plain Layout
26785 <cell alignment="center" valignment="top" usebox="none">
26788 \begin_layout Plain Layout
26794 <cell alignment="center" valignment="top" usebox="none">
26797 \begin_layout Plain Layout
26803 <cell alignment="center" valignment="top" usebox="none">
26806 \begin_layout Plain Layout
26812 <cell alignment="center" valignment="top" usebox="none">
26815 \begin_layout Plain Layout
26823 <cell alignment="left" valignment="top" usebox="none">
26826 \begin_layout Plain Layout
26832 <cell alignment="left" valignment="top" usebox="none">
26835 \begin_layout Plain Layout
26841 <cell alignment="left" valignment="top" usebox="none">
26844 \begin_layout Plain Layout
26850 <cell alignment="left" valignment="top" usebox="none">
26853 \begin_layout Plain Layout
26859 <cell alignment="center" valignment="top" usebox="none">
26862 \begin_layout Plain Layout
26868 <cell alignment="center" valignment="top" usebox="none">
26871 \begin_layout Plain Layout
26877 <cell alignment="center" valignment="top" usebox="none">
26880 \begin_layout Plain Layout
26886 <cell alignment="center" valignment="top" usebox="none">
26889 \begin_layout Plain Layout
26897 <cell alignment="left" valignment="top" usebox="none">
26900 \begin_layout Plain Layout
26906 <cell alignment="left" valignment="top" usebox="none">
26909 \begin_layout Plain Layout
26915 <cell alignment="left" valignment="top" usebox="none">
26918 \begin_layout Plain Layout
26924 <cell alignment="left" valignment="top" usebox="none">
26927 \begin_layout Plain Layout
26933 <cell alignment="center" valignment="top" usebox="none">
26936 \begin_layout Plain Layout
26942 <cell alignment="center" valignment="top" usebox="none">
26945 \begin_layout Plain Layout
26951 <cell alignment="center" valignment="top" usebox="none">
26954 \begin_layout Plain Layout
26960 <cell alignment="center" valignment="top" usebox="none">
26963 \begin_layout Plain Layout
26971 <cell alignment="left" valignment="top" usebox="none">
26974 \begin_layout Plain Layout
26980 <cell alignment="left" valignment="top" usebox="none">
26983 \begin_layout Plain Layout
26989 <cell alignment="left" valignment="top" usebox="none">
26992 \begin_layout Plain Layout
26998 <cell alignment="left" valignment="top" usebox="none">
27001 \begin_layout Plain Layout
27007 <cell alignment="center" valignment="top" usebox="none">
27010 \begin_layout Plain Layout
27016 <cell alignment="center" valignment="top" usebox="none">
27019 \begin_layout Plain Layout
27025 <cell alignment="center" valignment="top" usebox="none">
27028 \begin_layout Plain Layout
27034 <cell alignment="center" valignment="top" usebox="none">
27037 \begin_layout Plain Layout
27045 <cell alignment="left" valignment="top" usebox="none">
27048 \begin_layout Plain Layout
27054 <cell alignment="left" valignment="top" usebox="none">
27057 \begin_layout Plain Layout
27063 <cell alignment="left" valignment="top" usebox="none">
27066 \begin_layout Plain Layout
27072 <cell alignment="left" valignment="top" usebox="none">
27075 \begin_layout Plain Layout
27081 <cell alignment="center" valignment="top" usebox="none">
27084 \begin_layout Plain Layout
27090 <cell alignment="center" valignment="top" usebox="none">
27093 \begin_layout Plain Layout
27099 <cell alignment="center" valignment="top" usebox="none">
27102 \begin_layout Plain Layout
27108 <cell alignment="center" valignment="top" usebox="none">
27111 \begin_layout Plain Layout
27119 <cell alignment="left" valignment="top" usebox="none">
27122 \begin_layout Plain Layout
27128 <cell alignment="left" valignment="top" usebox="none">
27131 \begin_layout Plain Layout
27137 <cell alignment="left" valignment="top" usebox="none">
27140 \begin_layout Plain Layout
27146 <cell alignment="left" valignment="top" usebox="none">
27149 \begin_layout Plain Layout
27155 <cell alignment="center" valignment="top" usebox="none">
27158 \begin_layout Plain Layout
27164 <cell alignment="center" valignment="top" usebox="none">
27167 \begin_layout Plain Layout
27173 <cell alignment="center" valignment="top" usebox="none">
27176 \begin_layout Plain Layout
27182 <cell alignment="center" valignment="top" usebox="none">
27185 \begin_layout Plain Layout
27193 <cell alignment="left" valignment="top" usebox="none">
27196 \begin_layout Plain Layout
27202 <cell alignment="left" valignment="top" usebox="none">
27205 \begin_layout Plain Layout
27211 <cell alignment="left" valignment="top" usebox="none">
27214 \begin_layout Plain Layout
27220 <cell alignment="left" valignment="top" usebox="none">
27223 \begin_layout Plain Layout
27229 <cell alignment="center" valignment="top" usebox="none">
27232 \begin_layout Plain Layout
27238 <cell alignment="center" valignment="top" usebox="none">
27241 \begin_layout Plain Layout
27247 <cell alignment="center" valignment="top" usebox="none">
27250 \begin_layout Plain Layout
27256 <cell alignment="center" valignment="top" usebox="none">
27259 \begin_layout Plain Layout
27267 <cell alignment="left" valignment="top" usebox="none">
27270 \begin_layout Plain Layout
27276 <cell alignment="left" valignment="top" usebox="none">
27279 \begin_layout Plain Layout
27285 <cell alignment="left" valignment="top" usebox="none">
27288 \begin_layout Plain Layout
27294 <cell alignment="left" valignment="top" usebox="none">
27297 \begin_layout Plain Layout
27303 <cell alignment="center" valignment="top" usebox="none">
27306 \begin_layout Plain Layout
27312 <cell alignment="center" valignment="top" usebox="none">
27315 \begin_layout Plain Layout
27321 <cell alignment="center" valignment="top" usebox="none">
27324 \begin_layout Plain Layout
27330 <cell alignment="center" valignment="top" usebox="none">
27333 \begin_layout Plain Layout
27341 <cell alignment="left" valignment="top" usebox="none">
27344 \begin_layout Plain Layout
27350 <cell alignment="left" valignment="top" usebox="none">
27353 \begin_layout Plain Layout
27359 <cell alignment="left" valignment="top" usebox="none">
27362 \begin_layout Plain Layout
27368 <cell alignment="left" valignment="top" usebox="none">
27371 \begin_layout Plain Layout
27377 <cell alignment="center" valignment="top" usebox="none">
27380 \begin_layout Plain Layout
27386 <cell alignment="center" valignment="top" usebox="none">
27389 \begin_layout Plain Layout
27395 <cell alignment="center" valignment="top" usebox="none">
27398 \begin_layout Plain Layout
27404 <cell alignment="center" valignment="top" usebox="none">
27407 \begin_layout Plain Layout
27415 <cell alignment="left" valignment="top" usebox="none">
27418 \begin_layout Plain Layout
27424 <cell alignment="left" valignment="top" usebox="none">
27427 \begin_layout Plain Layout
27433 <cell alignment="left" valignment="top" usebox="none">
27436 \begin_layout Plain Layout
27442 <cell alignment="left" valignment="top" usebox="none">
27445 \begin_layout Plain Layout
27451 <cell alignment="center" valignment="top" usebox="none">
27454 \begin_layout Plain Layout
27460 <cell alignment="center" valignment="top" usebox="none">
27463 \begin_layout Plain Layout
27469 <cell alignment="center" valignment="top" usebox="none">
27472 \begin_layout Plain Layout
27478 <cell alignment="center" valignment="top" usebox="none">
27481 \begin_layout Plain Layout
27489 <cell alignment="center" valignment="top" usebox="none">
27492 \begin_layout Plain Layout
27498 <cell alignment="center" valignment="top" usebox="none">
27501 \begin_layout Plain Layout
27507 <cell alignment="center" valignment="top" usebox="none">
27510 \begin_layout Plain Layout
27516 <cell alignment="center" valignment="top" usebox="none">
27519 \begin_layout Plain Layout
27525 <cell alignment="center" valignment="top" usebox="none">
27528 \begin_layout Plain Layout
27534 <cell alignment="center" valignment="top" usebox="none">
27537 \begin_layout Plain Layout
27543 <cell alignment="center" valignment="top" usebox="none">
27546 \begin_layout Plain Layout
27552 <cell alignment="center" valignment="top" usebox="none">
27555 \begin_layout Plain Layout
27569 \begin_layout Chapter
27570 Names of available colors to be used in layouts
27571 \begin_inset CommandInset label
27573 name "chap:Names-of-colors"
27580 \begin_layout Standard
27581 The colors listed here are the standard colors and the those that you can
27582 adjust in the \SpecialChar LyX
27586 \begin_layout Description
27599 No particular color – clear or default
27602 \begin_layout Description
27606 \begin_layout Description
27610 \begin_layout Description
27614 \begin_layout Description
27618 \begin_layout Description
27622 \begin_layout Description
27626 \begin_layout Description
27630 \begin_layout Description
27634 \begin_layout Description
27635 added_space Added space marker color
27638 \begin_layout Description
27639 addedtext Added text color
27642 \begin_layout Description
27643 appendix Appendix marker color
27646 \begin_layout Description
27647 background Background color
27650 \begin_layout Description
27651 bottomarea Bottom area color
27654 \begin_layout Description
27655 branchlabel Label color for branches
27658 \begin_layout Description
27659 buttonbg Color used for button background
27662 \begin_layout Description
27663 buttonhoverbg Color used for button background under focus
27666 \begin_layout Description
27667 buttonframe Color for inset button frames
27670 \begin_layout Description
27671 changebar Changebar color
27674 \begin_layout Description
27675 changedtextauthor1 Changed text color author 1
27678 \begin_layout Description
27679 changedtextauthor2 Changed text color author 2
27682 \begin_layout Description
27683 changedtextauthor3 Changed text color author 3
27686 \begin_layout Description
27687 changedtextauthor4 Changed text color author 4
27690 \begin_layout Description
27691 changedtextauthor5 Changed text color author 5
27694 \begin_layout Description
27695 collapsable_inset_frame Collapsable insets framecolor
27698 \begin_layout Description
27699 collapsable_inset_text Collapsable insets text color
27702 \begin_layout Description
27703 command Text color for command insets
27706 \begin_layout Description
27707 commandbg Background color for command insets
27710 \begin_layout Description
27711 commandframe Frame color for command insets
27714 \begin_layout Description
27715 comment color for comments
27718 \begin_layout Description
27719 commentbg Background color of comments
27722 \begin_layout Description
27723 cursor Cursor color
27726 \begin_layout Description
27727 deletedtext Deleted text color
27730 \begin_layout Description
27731 deletedtextmodifier Deleted text modifying color
27734 \begin_layout Description
27735 depthbar Color for the depth bars in the margin
27738 \begin_layout Description
27739 eolmarker End of line marker color
27742 \begin_layout Description
27743 error Color of the \SpecialChar LaTeX
27747 \begin_layout Description
27748 footlabel Label color for footnotes
27751 \begin_layout Description
27752 graphicsbg Graphics inset background color
27755 \begin_layout Description
27756 greyedout Label color for greyedout insets
27759 \begin_layout Description
27760 greyedoutbg Background color of greyedout inset
27763 \begin_layout Description
27764 greyedouttext Color for greyedout inset text
27767 \begin_layout Description
27768 indexlabel Label color for index insets
27771 \begin_layout Description
27772 ignore The color is ignored
27775 \begin_layout Description
27776 inherit The color is inherited
27779 \begin_layout Description
27780 inlinecompletion Inline completion color
27783 \begin_layout Description
27784 insetbg Inset marker background color
27787 \begin_layout Description
27788 insetframe Inset marker frame color
27791 \begin_layout Description
27792 language Color for marking foreign language words
27795 \begin_layout Description
27796 latex Text color in \SpecialChar LaTeX
27800 \begin_layout Description
27801 listingsbg Background color of listings inset
27804 \begin_layout Description
27805 marginlabel Label color for margin notes
27808 \begin_layout Description
27809 math Math inset text color
27812 \begin_layout Description
27813 mathbg Math inset background color
27816 \begin_layout Description
27817 mathcorners Math inset frame color not under focus
27820 \begin_layout Description
27821 mathframe Math inset frame color under focus
27824 \begin_layout Description
27825 mathline Math line color
27828 \begin_layout Description
27829 mathmacrobg Macro math inset background color
27832 \begin_layout Description
27833 mathmacroblend Macro math blended color
27836 \begin_layout Description
27837 mathmacroframe Macro math frame color
27840 \begin_layout Description
27841 mathmacrohoverbg Macro math inset background color hovered
27844 \begin_layout Description
27845 mathmacrolabel Macro math label color
27848 \begin_layout Description
27849 mathmacronewarg Macro template color for new parameters
27852 \begin_layout Description
27853 mathmacrooldarg Macro template color for old parameters
27856 \begin_layout Description
27857 newpage New page color
27860 \begin_layout Description
27861 nonunique_inlinecompletion Inline completion color for the non-unique part
27864 \begin_layout Description
27865 notebg Background color of notes
27868 \begin_layout Description
27869 notelabel Label color for notes
27872 \begin_layout Description
27873 pagebreak Page break/line break color
27876 \begin_layout Description
27877 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
27880 \begin_layout Description
27881 phantomtext Text color for phantom insets
27884 \begin_layout Description
27885 preview The color used for previews
27888 \begin_layout Description
27889 previewframe Preview frame color
27892 \begin_layout Description
27893 regexpframe Color for regexp frame
27896 \begin_layout Description
27897 selection Background color of selected text
27900 \begin_layout Description
27901 selectiontext Foreground color of selected text
27904 \begin_layout Description
27905 shadedbg Background color of shaded box
27908 \begin_layout Description
27909 special Special chars text color
27912 \begin_layout Description
27913 tabularline Table line color
27916 \begin_layout Description
27917 tabularonoffline Table line color
27920 \begin_layout Description
27921 urllabel Label color for URL insets
27924 \begin_layout Description
27925 urltext Color for URL inset text