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
6186 (If these variables are not predefined, you have to define them.) You'll
6187 probably need root permissions to create or modify the `local' tree, but
6188 not for your `user' tree.
6189 \begin_inset Newline newline
6192 In general, it is recommended to install in the user tree because your user
6193 will not be modified or even overwritten when you upgrade your system.
6194 It will typically also be backed up together with everything else when
6195 you backup your home directory (which, of course, you do on a regular basis).
6198 \begin_layout Enumerate
6199 On Windows, if you want the new package to be available for all users on
6200 your system, change to the folder where \SpecialChar LaTeX
6201 is installed and then change to
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6217 (For MiK\SpecialChar TeX
6218 , this would be by default the folder
6219 \begin_inset Flex Code
6222 \begin_layout Plain Layout
6240 \begin_layout Plain Layout
6241 Note that this will be the correct path only on English installations.
6242 On a German one, it would be
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6260 , and similarly for other languages.
6265 Create there a new folder
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6275 and copy all files of the package into it.
6277 \begin_inset Newline newline
6280 If the package should only available for you or you don't have admin permissions
6281 , do the same, but in the local \SpecialChar LaTeX
6284 \begin_inset space \thinspace{}
6287 g., for MiK\SpecialChar TeX
6289 \begin_inset space ~
6292 2.8 under Windows XP, this would be the folder:
6293 \begin_inset Newline newline
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6305 Documents and Settings
6317 \begin_inset Newline newline
6323 \begin_inset Phantom HPhantom
6326 \begin_layout Plain Layout
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6353 \begin_inset Newline newline
6356 On Vista, it would be:
6357 \begin_inset Newline newline
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6390 \begin_layout Enumerate
6391 Now one only need to tell \SpecialChar LaTeX
6392 that there are new files.
6393 This depends on the used \SpecialChar LaTeX
6398 \begin_layout Enumerate
6399 For \SpecialChar TeX
6400 Live execute the command
6401 \begin_inset Flex Code
6404 \begin_layout Plain Layout
6411 If you installed the package for all users, then you will probably need
6412 to have root permissions for that.
6415 \begin_layout Enumerate
6416 For MiK\SpecialChar TeX
6417 , if you have installed the package for all users, start the program
6419 \begin_inset Quotes eld
6423 \begin_inset space ~
6427 \begin_inset Quotes erd
6430 and press the button marked
6431 \begin_inset Quotes eld
6435 \begin_inset Quotes erd
6439 Otherwise start the program
6440 \begin_inset Quotes eld
6444 \begin_inset Quotes erd
6451 \begin_layout Enumerate
6452 Finally, you need to tell \SpecialChar LyX
6453 that there are new packages available.
6454 So, in \SpecialChar LyX
6456 \begin_inset Flex Noun
6459 \begin_layout Plain Layout
6462 \SpecialChar menuseparator
6468 and then restart \SpecialChar LyX
6472 \begin_layout Standard
6473 Now the package is installed.
6474 In our example, the document class
6475 \begin_inset Flex Code
6478 \begin_layout Plain Layout
6484 will now be available under
6485 \begin_inset Flex Noun
6488 \begin_layout Plain Layout
6489 Document\SpecialChar menuseparator
6490 Settings\SpecialChar menuseparator
6497 \begin_inset Quotes eld
6501 \begin_inset Quotes erd
6508 \begin_layout Standard
6509 If you would like to use a \SpecialChar LaTeX
6510 document class that is not even listed in the
6512 \begin_inset Flex Noun
6515 \begin_layout Plain Layout
6516 Document\SpecialChar menuseparator
6517 Settings\SpecialChar menuseparator
6523 , then you need to create a `layout' file for it.
6524 That is the topic of the next section.
6527 \begin_layout Section
6528 Types of layout files
6531 \begin_layout Standard
6532 This section describes the various sorts of \SpecialChar LyX
6533 files that contain layout informati
6535 These files describe various paragraph and character styles, determining
6536 how \SpecialChar LyX
6537 should display them and how they should be translated into \SpecialChar LaTeX
6539 XHTML, or whatever output format is being used.
6543 \begin_layout Standard
6544 We shall try to provide a thorough description of the process of writing
6546 However, there are so many different types of documents supported even
6547 by just \SpecialChar LaTeX
6548 that we can't hope to cover every different possibility or problem
6549 you might encounter.
6550 The \SpecialChar LyX
6551 users' list is frequented by people with lots of experience with layout
6552 design who are willing to share what they've learned, so please feel free
6553 to ask questions there.
6556 \begin_layout Standard
6557 As you prepare to write a new layout, it is extremely helpful to look at
6558 the layouts distributed with \SpecialChar LyX
6560 If you write a \SpecialChar LyX
6561 layout for a \SpecialChar LaTeX
6562 document class that might also be used by
6563 others, or write a module that might be useful to others, then you should
6564 consider posting your layout to the
6565 \begin_inset CommandInset href
6567 name "layout section on the LyX wiki"
6568 target "http://wiki.lyx.org/Layouts/Layouts"
6573 or even to the \SpecialChar LyX
6574 developers' list, so that it might be included in \SpecialChar LyX
6579 \begin_layout Plain Layout
6580 Note that \SpecialChar LyX
6581 is licensed under the General Public License, so any material
6582 that is contributed to \SpecialChar LyX
6583 must be similarly licensed.
6591 \begin_layout Subsection
6593 \begin_inset CommandInset label
6595 name "subsec:Layout-modules"
6602 \begin_layout Standard
6603 We have spoken to this point about `layout files'.
6604 But there are different sorts of files that contain layout information.
6605 Layout files, strictly so called, have the
6606 \begin_inset Flex Code
6609 \begin_layout Plain Layout
6615 extension and provide \SpecialChar LyX
6616 with information about document classes.
6617 Since \SpecialChar LyX
6618 1.6 layout information can also be contained in layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6633 Modules are to \SpecialChar LaTeX
6634 packages much as layouts are to \SpecialChar LaTeX
6635 classes, and some modules—such
6637 \begin_inset Flex Code
6640 \begin_layout Plain Layout
6646 module—specifically provide support for one package.
6647 In a sense, layout modules are similar to included
6651 \begin_layout Plain Layout
6652 These can have any extension, but by convention have the
6653 \begin_inset Flex Code
6656 \begin_layout Plain Layout
6668 \begin_inset Flex Code
6671 \begin_layout Plain Layout
6677 —in that modules are not specific to a given document class but may be used
6678 with many different classes.
6679 The difference is that using an included file with
6680 \begin_inset Flex Code
6683 \begin_layout Plain Layout
6689 requires editing that file.
6690 Modules, by contrast, are selected in the
6691 \begin_inset Flex Noun
6694 \begin_layout Plain Layout
6695 Document\SpecialChar menuseparator
6704 \begin_layout Standard
6705 Building modules is the easiest way to get started with layout editing,
6706 since it can be as simple as adding a single new paragraph style or flex
6708 But modules may, in principle, contain anything a layout file can contain.
6711 \begin_layout Standard
6712 After creating a new module and copying it to the
6713 \begin_inset Flex Code
6716 \begin_layout Plain Layout
6722 folder, you will need to reconfigure and then restart \SpecialChar LyX
6725 However, changes you make to the module will be seen immediately, if you
6727 \begin_inset Flex Noun
6730 \begin_layout Plain Layout
6731 Document\SpecialChar menuseparator
6737 , highlight something, and then hit
6738 \begin_inset Quotes eld
6742 \begin_inset Quotes erd
6748 It is strongly recommended that you save your work before doing this
6753 it is strongly recommended that you not attempt to edit modules while simultaneo
6754 usly working on actual documents
6757 Though of course the developers strive to keep \SpecialChar LyX
6758 stable in such situations,
6759 syntax errors and the like in your module file could cause strange behavior.
6762 \begin_layout Subsubsection
6766 \begin_layout Standard
6767 Modules are to \SpecialChar LyX
6768 as packages are to \SpecialChar LaTeX
6770 Sometimes, however, you find yourself wanting a specific inset or character
6771 style just for one document and writing a module that will also be available
6772 to other documents makes little sense.
6773 What you need is \SpecialChar LyX
6775 \begin_inset Quotes eld
6779 \begin_inset Quotes erd
6785 \begin_layout Standard
6786 You will find it under
6788 Document\SpecialChar menuseparator
6789 Settings\SpecialChar menuseparator
6793 The large text box allows you to enter anything that you might enter in
6794 a layout file or module.
6795 You can think of a document's local layout, in fact, as a module that belongs
6797 So, in particular, you must enter a
6798 \begin_inset Flex Code
6801 \begin_layout Plain Layout
6808 Any format is acceptable, but one would normally use the format current
6810 (In \SpecialChar LyX
6811 2.3, the current layout format is 63.)
6814 \begin_layout Standard
6815 When you have entered something in the
6816 \begin_inset Flex Code
6819 \begin_layout Plain Layout
6825 pane, \SpecialChar LyX
6827 \begin_inset Quotes eld
6831 \begin_inset Quotes erd
6834 button at the bottom.
6835 Clicking this button will cause \SpecialChar LyX
6836 to determine whether what you have entered
6837 is valid layout information for the chosen format.
6839 will report the result but, unfortunately, will not tell you what errors
6840 there might have been.
6841 These will be written to the terminal, however, if \SpecialChar LyX
6842 is started from a terminal.
6843 You will not be permitted to save your local layout until you have entered
6847 \begin_layout Standard
6848 The warnings at the end of the previous section apply here, too.
6849 Do not play with local layout while you are actually working, especially
6850 if you have not saved your document.
6851 That said, using local layout with a test document can be a very convenient
6852 way to try out layout ideas, or even to start developing a module.
6855 \begin_layout Subsection
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6869 \begin_layout Standard
6870 There are two situations you are likely to encounter when wanting to support
6871 a new \SpecialChar LaTeX
6872 document class, involving style (
6873 \begin_inset Flex Code
6876 \begin_layout Plain Layout
6882 ) files and \SpecialChar LaTeX2e
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6894 Supporting a style file is usually fairly easy.
6895 Supporting a new class file is a bit harder.
6896 We'll discuss the former in this section and the latter in the next.
6897 Similar remarks apply, of course, if you want to support a new DocBook
6901 \begin_layout Standard
6902 The easier case is the one in which your new document class is provided
6903 as a style file that is to be used in conjunction with an already supported
6905 For the sake of the example, we'll assume that the style file is called
6907 \begin_inset Flex Noun
6910 \begin_layout Plain Layout
6916 and that it is meant to be used with
6917 \begin_inset Flex Noun
6920 \begin_layout Plain Layout
6926 , which is a standard class.
6930 \begin_layout Standard
6931 Start by copying the existing class's layout file into your local directory:
6935 \begin_layout Plain Layout
6936 Of course, which directory is your local directory will vary by platform,
6937 and \SpecialChar LyX
6938 allows you to specify your local directory on startup, too, using
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6957 \begin_layout LyX-Code
6958 cp report.layout ~/.lyx/layouts/myclass.layout
6961 \begin_layout Standard
6963 \begin_inset Flex Code
6966 \begin_layout Plain Layout
6972 and change the line:
6975 \begin_layout LyX-Code
6978 DeclareLaTeXClass{Report (Standard Class)}
6981 \begin_layout Standard
6985 \begin_layout LyX-Code
6988 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6991 \begin_layout Standard
6995 \begin_layout LyX-Code
6997 \begin_inset Newline newline
7003 \begin_inset Newline newline
7009 \begin_layout Standard
7010 near the top of the file.
7013 \begin_layout Standard
7014 Start \SpecialChar LyX
7016 \begin_inset Flex Noun
7019 \begin_layout Plain Layout
7020 Tools\SpecialChar menuseparator
7027 Then restart \SpecialChar LyX
7028 and try creating a new document.
7030 \begin_inset Flex Noun
7033 \begin_layout Plain Layout
7039 " as a document class option in the
7040 \begin_inset Flex Noun
7043 \begin_layout Plain Layout
7044 Document\SpecialChar menuseparator
7051 It is likely that some of the sectioning commands and such in your new
7052 class will work differently from how they worked in the base class—
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7062 in this example—so you can fiddle around with the settings for the different
7063 sections if you wish.
7064 The layout information for sections is contained in
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7074 , but you do not need to copy and change this file.
7075 Instead, you can simply add your changes to your layout file, after the
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7086 , which itself includes
7087 \begin_inset Flex Code
7090 \begin_layout Plain Layout
7097 For example, you might add these lines:
7100 \begin_layout LyX-Code
7104 \begin_layout LyX-Code
7108 \begin_layout LyX-Code
7112 \begin_layout LyX-Code
7116 \begin_layout LyX-Code
7120 \begin_layout Standard
7121 to change the font for chapter headings to sans-serif.
7122 This will override (or, in this case, add to) the existing declaration
7123 for the Chapter style.
7127 \begin_layout Standard
7128 Your new package may also provide commands or environments not present in
7130 In this case, you will want to add these to the layout file.
7132 \begin_inset CommandInset ref
7134 reference "sec:TextClass"
7138 for information on how to do so.
7141 \begin_layout Standard
7143 \begin_inset Flex Noun
7146 \begin_layout Plain Layout
7152 can be used with several different document classes, and even if it cannot,
7153 you might find it easiest just to write a module that you can load with
7155 The simplest possible such module would be:
7158 \begin_layout LyX-Code
7161 DeclareLyXModule{My Class}
7164 \begin_layout LyX-Code
7168 \begin_layout LyX-Code
7169 #Support for myclass.sty.
7172 \begin_layout LyX-Code
7174 \begin_inset Newline newline
7180 \begin_layout LyX-Code
7182 \begin_inset Newline newline
7188 \begin_layout LyX-Code
7190 \begin_inset Newline newline
7196 \begin_inset Newline newline
7202 \begin_layout Standard
7203 A more complex module might modify the behavior of some existing constructs
7204 or define some new ones.
7206 \begin_inset CommandInset ref
7208 reference "sec:TextClass"
7215 \begin_layout Subsection
7217 \begin_inset Flex Noun
7220 \begin_layout Plain Layout
7229 \begin_layout Standard
7230 There are two possibilities here.
7231 One is that the class file is itself based upon an existing document class.
7232 For example, many thesis classes are based upon
7233 \begin_inset Flex Noun
7236 \begin_layout Plain Layout
7243 To see whether yours is, look for a line like
7246 \begin_layout LyX-Code
7252 \begin_layout Standard
7254 If so, then you may proceed largely as in the previous section, though
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7260 Declare\SpecialChar LaTeX
7266 line will be different.
7267 If your new class is
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 and it is based upon
7278 \begin_inset Flex Code
7281 \begin_layout Plain Layout
7287 , then the line should read:
7291 \begin_layout Plain Layout
7292 And it will be easiest if you save the file to
7293 \begin_inset Flex Code
7296 \begin_layout Plain Layout
7303 assumes that the document class has the same name as the layout file.
7312 \begin_layout LyX-Code
7315 DeclareLaTeXClass[thesis,book]{thesis}
7318 \begin_layout Standard
7319 If, on the other hand, the new class is not based upon an existing class,
7320 you will probably have to
7321 \begin_inset Quotes eld
7325 \begin_inset Quotes erd
7329 We strongly suggest copying an existing layout file which uses a similar
7331 class and then modifying it, if you can do so.
7332 At least use an existing file as a starting point so you can find out what
7333 items you need to worry about.
7334 Again, the specifics are covered below.
7337 \begin_layout Subsection
7339 \begin_inset CommandInset label
7341 name "subsec:Creating-Templates"
7348 \begin_layout Standard
7349 Once you have written a layout file for a new document class, you might
7350 want to consider writing a
7355 A template acts as a kind of tutorial for your layout, showing how it might
7356 be used, though containing dummy content.
7357 You can of course look at the various templates included with \SpecialChar LyX
7361 \begin_layout Standard
7362 Templates are created just like usual documents: using \SpecialChar LyX
7364 The only difference is that usual documents contain all possible settings,
7365 including the font scheme and the paper size.
7366 Usually a user doesn't want a template to overwrite his preferred settings
7367 for such parameters.
7368 For that reason, the designer of a template should remove the corresponding
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7393 from the template \SpecialChar LyX
7395 This can be done with any simple text-editor, for example
7396 \begin_inset Flex Code
7399 \begin_layout Plain Layout
7406 \begin_inset Flex Code
7409 \begin_layout Plain Layout
7418 \begin_layout Standard
7419 Put the edited template files you create in
7420 \begin_inset Flex Code
7423 \begin_layout Plain Layout
7429 , copy the ones you use from the global template directory in
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 to the same place, and redefine the template path in the
7440 \begin_inset Flex Noun
7443 \begin_layout Plain Layout
7444 Tools\SpecialChar menuseparator
7445 Preferences\SpecialChar menuseparator
7454 \begin_layout Standard
7455 Note, by the way, that there is a template which has a particular meaning:
7457 \begin_inset Flex Code
7460 \begin_layout Plain Layout
7467 This template is loaded every time you create a new document with
7468 \begin_inset Flex Noun
7471 \begin_layout Plain Layout
7472 File\SpecialChar menuseparator
7478 in order to provide useful defaults.
7479 To create this template from inside \SpecialChar LyX
7480 , all you have to do is to open a document
7481 with the correct settings, and use the
7482 \begin_inset Flex Noun
7485 \begin_layout Plain Layout
7486 Save as Document Defaults
7494 \begin_layout Subsection
7495 Upgrading old layout files
7498 \begin_layout Standard
7499 The format of layout files changes with each \SpecialChar LyX
7500 release, so old layout files
7501 need to be converted to the new format.
7503 reads a layout file in an older format, it automatically calls the
7505 \begin_inset Flex Code
7508 \begin_layout Plain Layout
7514 to convert it to a temporary file in current format.
7515 The original file is left untouched.
7516 If you use the layout file often, then, you may want to convert it permanently,
7517 so that \SpecialChar LyX
7518 does not have to do so itself every time.
7519 To do this, you can call the converter manually:
7522 \begin_layout Enumerate
7524 \begin_inset Flex Code
7527 \begin_layout Plain Layout
7534 \begin_inset Flex Code
7537 \begin_layout Plain Layout
7546 \begin_layout Enumerate
7548 \begin_inset Newline newline
7552 \begin_inset Flex Code
7555 \begin_layout Plain Layout
7556 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7562 \begin_inset Newline newline
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7575 is the name of your \SpecialChar LyX
7579 \begin_layout Standard
7580 Note that manual conversion does not affect included files, so these will
7581 have to be converted separately.
7584 \begin_layout Subsection
7585 \begin_inset CommandInset label
7587 name "subsec:Cite-Engine-Files"
7594 \begin_layout Standard
7595 A specific form of layout files are the so-called
7596 \begin_inset Flex Code
7599 \begin_layout Plain Layout
7605 files that are located in the
7606 \begin_inset Flex Code
7609 \begin_layout Plain Layout
7616 Their purpose is to define the specifics of \SpecialChar LaTeX
7617 packages aimed at bibliography
7630 , but also the way how normal Bib\SpecialChar TeX
7631 citations (without additional packages)
7632 are handled in \SpecialChar LyX
7633 is defined in such a file.
7637 \begin_layout Standard
7638 More specifically, it is defined which packages \SpecialChar LyX
7639 needs to load, which citation
7640 commands are available, how these are to be displayed in \SpecialChar LyX
7642 the dialogs, the context menus) as well as in the XHTML and plain text
7644 Furthermore, the files specify available style variants (author-year, numerical
7645 , etc.) and their specifics.
7646 The cite engine files are also used to generate the options that are available
7649 Document\SpecialChar menuseparator
7650 Settings\SpecialChar ldots
7651 \SpecialChar menuseparator
7652 Bibliography\SpecialChar menuseparator
7658 \begin_layout Standard
7659 Even though a cite engine file is essentially a normal layout file that
7660 could theoretically include any layout information, it usually primarily
7661 includes some specific parameters such as
7662 \begin_inset Flex Code
7665 \begin_layout Plain Layout
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7682 \begin_inset Flex Code
7685 \begin_layout Plain Layout
7692 \begin_inset Flex Code
7695 \begin_layout Plain Layout
7702 The syntax of the latter two is described in
7703 \begin_inset CommandInset ref
7705 reference "subsec:Citation-engine-description"
7713 \begin_inset CommandInset ref
7715 reference "subsec:Citation-format-description"
7719 , as well as in the files themselves.
7722 \begin_layout Section
7723 \begin_inset CommandInset label
7725 name "sec:TextClass"
7729 The layout file format
7732 \begin_layout Standard
7733 The following sections describe how layout files are structured and written.
7734 Our advice is to go slowly, save and test often.
7735 It is really not that hard, except that the multitude of options can become
7736 overwhelming, especially if you try to check out too many at once.
7737 It becomes easier if you use existing layouts of \SpecialChar LyX
7738 as examples/reference
7739 or if you modify an existing layout to your needs.
7742 \begin_layout Standard
7743 Note that all the tags used in layout files are case-insensitive.
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7755 \begin_inset Flex Code
7758 \begin_layout Plain Layout
7765 \begin_inset Flex Code
7768 \begin_layout Plain Layout
7774 are really the same tag.
7775 The possible arguments are printed in brackets after the tag's name.
7776 The default argument is typeset
7777 \begin_inset Flex Code
7780 \begin_layout Plain Layout
7789 If the argument has a data type like
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7798 \begin_inset Quotes eld
7802 \begin_inset Quotes erd
7805 , the default is shown like this:
7806 \begin_inset Flex Code
7809 \begin_layout Plain Layout
7820 \begin_layout Subsection
7821 The document class declaration and classification
7824 \begin_layout Standard
7825 Lines in a layout file which begin with
7826 \begin_inset Flex Code
7829 \begin_layout Plain Layout
7836 There is one exception to this rule.
7838 \begin_inset Flex Code
7841 \begin_layout Plain Layout
7847 files should begin with lines like:
7850 \begin_layout LyX-Code
7853 #% Do not delete the line below; configure depends on this
7856 \begin_layout LyX-Code
7861 DeclareLaTeXClass{Article (Standard Class)}
7864 \begin_layout LyX-Code
7869 DeclareCategory{Articles}
7872 \begin_layout Standard
7873 The second and third lines are used when you (re)configure \SpecialChar LyX
7875 The layout file is read by the \SpecialChar LaTeX
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7886 , in a special mode where
7887 \begin_inset Flex Code
7890 \begin_layout Plain Layout
7897 The first line is just a \SpecialChar LaTeX
7898 comment, the second one contains the mandatory
7899 declaration of the text class and the third line contains the optional
7900 classification of the class.
7901 If these lines appear in a file named
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7911 , then they define a text class of name
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 (the name of the layout file) which uses the \SpecialChar LaTeX
7923 \begin_inset Flex Code
7926 \begin_layout Plain Layout
7932 (the default is to use the same name as the layout).
7934 \begin_inset Quotes eld
7937 Article (Standard Class)
7938 \begin_inset Quotes erd
7941 that appears above is used as a description of the text class in the
7942 \begin_inset Flex Noun
7945 \begin_layout Plain Layout
7946 Document\SpecialChar menuseparator
7954 \begin_inset Quotes eld
7958 \begin_inset Quotes erd
7961 in the example) is also used in the
7962 \begin_inset Flex Noun
7965 \begin_layout Plain Layout
7966 Document\SpecialChar menuseparator
7972 dialog: the text classes are grouped by these categories (which are usually
7973 genres, so typical categories are
7974 \begin_inset Quotes eld
7978 \begin_inset Quotes erd
7982 \begin_inset Quotes eld
7986 \begin_inset Quotes erd
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 \begin_inset Quotes eld
8002 \begin_inset Quotes erd
8006 \begin_inset Quotes eld
8010 \begin_inset Quotes erd
8014 \begin_inset Quotes eld
8018 \begin_inset Quotes erd
8022 If no category has been declared, the class will be put in the
8023 \begin_inset Quotes eld
8027 \begin_inset Quotes erd
8033 \begin_layout Standard
8034 Let's assume that you wrote your own text class that uses the
8035 \begin_inset Flex Code
8038 \begin_layout Plain Layout
8044 document class, but where you changed the appearance of the section headings.
8045 If you put it in a file
8046 \begin_inset Flex Code
8049 \begin_layout Plain Layout
8055 , the header of this file should be:
8058 \begin_layout LyX-Code
8061 #% Do not delete the line below; configure depends on this
8064 \begin_layout LyX-Code
8069 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8072 \begin_layout LyX-Code
8077 DeclareCategory{Articles}
8080 \begin_layout Standard
8081 This declares a text class
8082 \begin_inset Flex Code
8085 \begin_layout Plain Layout
8091 , associated with the \SpecialChar LaTeX
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8103 \begin_inset Quotes eld
8106 Article (with My Own Headings)
8107 \begin_inset Quotes erd
8111 If your text class depends on several packages, you can declare it as:
8114 \begin_layout LyX-Code
8117 #% Do not delete the line below; configure depends on this
8120 \begin_layout LyX-Code
8125 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8128 \begin_layout LyX-Code
8133 DeclareCategory{Articles}
8136 \begin_layout Standard
8137 This indicates that your text class uses the
8138 \begin_inset Flex Code
8141 \begin_layout Plain Layout
8148 Finally, it is also possible to declare classes for DocBook code.
8149 Typical declarations will look like:
8152 \begin_layout LyX-Code
8155 #% Do not delete the line below; configure depends on this
8158 \begin_layout LyX-Code
8163 DeclareDocBookClass[article]{SGML (DocBook Article)}
8166 \begin_layout LyX-Code
8171 DeclareCategory{Articles (DocBook)}
8174 \begin_layout Standard
8175 Note that these declarations can also be given an optional parameter declaring
8176 the name of the document class (but not a list).
8179 \begin_layout Standard
8180 So, to be as explicit as possible, the form of the layout declaration is:
8183 \begin_layout LyX-Code
8188 DeclareLaTeXClass[class,package.sty]{layout description}
8191 \begin_layout LyX-Code
8196 DeclareCategory{category}
8199 \begin_layout Standard
8200 The class need only be specified if the name of the \SpecialChar LaTeX
8202 name of the layout file are different or if there are packages to load.
8203 If the name of the class file is not specified, then \SpecialChar LyX
8205 that it is the same as the name of the layout file.
8208 \begin_layout Standard
8209 When the text class has been modified to your taste, all you have to do
8210 is to copy it either to
8211 \begin_inset Flex Code
8214 \begin_layout Plain Layout
8221 \begin_inset Flex Code
8224 \begin_layout Plain Layout
8231 \begin_inset Flex Noun
8234 \begin_layout Plain Layout
8235 Tools\SpecialChar menuseparator
8241 , exit \SpecialChar LyX
8243 Then your new text class should be available along with the others.
8246 \begin_layout Standard
8247 Once the layout file is installed, you can edit it and see your changes
8248 without having to reconfigure or to restart \SpecialChar LyX
8253 \begin_layout Plain Layout
8254 In versions of \SpecialChar LyX
8255 prior to 1.6, this was not true.
8256 As a result, editing layout files was very time consuming, since you had
8257 constantly to restart \SpecialChar LyX
8263 You can force a reload of the current layout by using the \SpecialChar LyX
8265 \begin_inset Flex Noun
8268 \begin_layout Plain Layout
8275 There is no default binding for this function—though, of course, you can
8276 bind it to a key yourself.
8277 But you will normally use this function simply by entering it in the mini-buffe
8282 \begin_layout Standard
8288 \begin_inset Flex Noun
8291 \begin_layout Plain Layout
8297 is very much an `advanced feature'.
8302 recommended that you save your work before using this function.
8307 recommended that you not attempt to edit layout information while simultaneousl
8308 y working on a document that you care about.
8309 Use a test document.
8310 Syntax errors and the like in your layout file could cause peculiar behavior.
8311 In particular, such errors could cause \SpecialChar LyX
8312 to regard the current layout as
8313 invalid and to attempt to switch to some other layout.
8317 \begin_layout Plain Layout
8318 Really bad syntax errors may even caused \SpecialChar LyX
8320 This is because certain sorts of errors may make \SpecialChar LyX
8331 The \SpecialChar LyX
8332 team strives to keep \SpecialChar LyX
8333 stable in such situations, but safe is better
8338 \begin_layout Plain Layout
8339 While we're giving advice: make regular backups.
8340 And be nice to your mother.
8348 \begin_layout Subsection
8349 The Module declaration
8352 \begin_layout Standard
8353 A module must begin with a line like the following:
8356 \begin_layout LyX-Code
8359 DeclareLyXModule[endnotes.sty]{Endnotes}
8362 \begin_layout Standard
8363 The mandatory argument, in curly brackets, is the name of the module, as
8365 \begin_inset Flex Noun
8368 \begin_layout Plain Layout
8369 Document\SpecialChar menuseparator
8370 Settings\SpecialChar menuseparator
8377 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8379 on which the module depends.
8380 It is also possible to use the form
8381 \begin_inset Flex Noun
8384 \begin_layout Plain Layout
8390 as an optional argument, which declares that the module can only be used
8391 when there exists a conversion chain between the formats `
8392 \begin_inset Flex Code
8395 \begin_layout Plain Layout
8402 \begin_inset Flex Code
8405 \begin_layout Plain Layout
8414 \begin_layout Standard
8415 The module declaration should then be followed by lines like the following
8419 \begin_layout Plain Layout
8420 Preferably in English if the module should be published with \SpecialChar LyX
8422 This description will appear in the list of messages to be translated and
8423 will be thus translated with the next interface update.
8431 \begin_layout LyX-Code
8435 \begin_layout LyX-Code
8436 #Adds an endnote command, in addition to footnotes.
8440 \begin_layout LyX-Code
8441 #You will need to add
8443 theendnotes in TeX code where you
8446 \begin_layout LyX-Code
8447 #want the endnotes to appear.
8451 \begin_layout LyX-Code
8455 \begin_layout LyX-Code
8456 #Requires: somemodule | othermodule
8459 \begin_layout LyX-Code
8460 #Excludes: badmodule
8463 \begin_layout Standard
8464 The description is used in
8465 \begin_inset Flex Noun
8468 \begin_layout Plain Layout
8469 Document\SpecialChar menuseparator
8470 Settings\SpecialChar menuseparator
8476 to provide the user with information about what the module does.
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8487 line is used to identify other modules with which this one must be used;
8489 \begin_inset Flex Code
8492 \begin_layout Plain Layout
8498 line is used to identify modules with which this one may not be used.
8499 Both are optional, and, as shown, multiple modules should be separated
8500 with the pipe symbol: |.
8501 Note that the required modules are treated disjunctively:
8505 of the required modules must be used.
8510 excluded module may be used.
8511 Note that modules are identified here by their filenames without the
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8523 \begin_inset Flex Code
8526 \begin_layout Plain Layout
8533 \begin_inset Flex Code
8536 \begin_layout Plain Layout
8545 \begin_layout Subsection
8546 The CiteEngine file declaration
8549 \begin_layout Standard
8550 A cite engine file must begin with a line like the following:
8553 \begin_layout LyX-Code
8556 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8559 \begin_layout Standard
8560 The mandatory argument, in curly brackets, is the name of the cite style,
8561 as it should appear in
8562 \begin_inset Flex Noun
8565 \begin_layout Plain Layout
8566 Document\SpecialChar menuseparator
8567 Settings\SpecialChar menuseparator
8574 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8576 on which the cite engine depends.
8579 \begin_layout Standard
8580 The cite engine declaration should then be followed by lines like the following
8584 \begin_layout Plain Layout
8585 Preferably in English if the module should be published with \SpecialChar LyX
8587 This description will appear in the list of messages to be translated and
8588 will be thus translated with the next interface update.
8596 \begin_layout LyX-Code
8600 \begin_layout LyX-Code
8601 # Biblatex supports many author-year and numerical styles.
8604 \begin_layout LyX-Code
8605 # It is mainly aimed at the Humanities.
8609 \begin_layout LyX-Code
8610 # customizable, fully localized and provides many features
8613 \begin_layout LyX-Code
8614 # that are not possible with BibTeX.
8615 The use of 'biber' as
8618 \begin_layout LyX-Code
8619 # bibliography processor is advised.
8622 \begin_layout LyX-Code
8626 \begin_layout Standard
8627 The description is used in
8628 \begin_inset Flex Noun
8631 \begin_layout Plain Layout
8632 Document\SpecialChar menuseparator
8633 Settings\SpecialChar menuseparator
8639 to provide the user with information about the cite engine.
8642 \begin_layout Subsection
8646 \begin_layout Standard
8647 The first non-comment line of any layout file, included file, or module
8652 contain the file format number:
8655 \begin_layout Description
8656 \begin_inset Flex Code
8659 \begin_layout Plain Layout
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8675 ] The format number of the layout file.
8678 \begin_layout Standard
8679 This tag was introduced with \SpecialChar LyX
8681 \begin_inset space ~
8685 Layout files from older \SpecialChar LyX
8686 versions do not have an explicit file format and
8687 are considered to have
8688 \begin_inset Flex Code
8691 \begin_layout Plain Layout
8693 \begin_inset space ~
8702 The format for the present version of \SpecialChar LyX
8704 But each version of \SpecialChar LyX
8705 is capable of reading earlier versions' layout files,
8706 just as they are capable of reading files produced by earlier versions
8709 There is, however, no provision for converting to earlier formats.
8712 \begin_layout Subsection
8713 \begin_inset CommandInset label
8715 name "subsec:General-text-class"
8719 General text class parameters
8722 \begin_layout Standard
8723 These are general parameters that govern the behavior of an entire document
8729 mean that they must appear in
8730 \begin_inset Flex Code
8733 \begin_layout Plain Layout
8739 files rather than in modules.
8740 A module can contain any layout tag.)
8743 \begin_layout Description
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8753 Adds information that will be output in the
8754 \begin_inset Flex Code
8757 \begin_layout Plain Layout
8763 block when the document is output to XHTML.
8764 Typically, this would be used to output CSS style information, but it can
8765 be used for anything that can appear in
8766 \begin_inset Flex Code
8769 \begin_layout Plain Layout
8777 \begin_inset Quotes eld
8781 \begin_inset Flex Code
8784 \begin_layout Plain Layout
8791 \begin_inset Quotes erd
8797 \begin_layout Description
8798 \begin_inset Flex Code
8801 \begin_layout Plain Layout
8807 Adds information to the document preamble.
8809 \begin_inset Newline newline
8813 \begin_inset Quotes eld
8817 \begin_inset Flex Code
8820 \begin_layout Plain Layout
8827 \begin_inset Quotes erd
8833 \begin_layout Description
8834 \begin_inset Flex Code
8837 \begin_layout Plain Layout
8843 Defines the possibilities for displaying citation references.
8845 \begin_inset CommandInset ref
8847 reference "subsec:Citation-engine-description"
8856 \begin_inset Quotes eld
8860 \begin_inset Flex Code
8863 \begin_layout Plain Layout
8870 \begin_inset Quotes erd
8874 Primarily used in cite engine files (see
8875 \begin_inset CommandInset ref
8877 reference "subsec:Cite-Engine-Files"
8887 \begin_layout Description
8888 \begin_inset Flex Code
8891 \begin_layout Plain Layout
8897 Defines formats for use in the display of bibliographic information.
8899 \begin_inset CommandInset ref
8901 reference "subsec:Citation-format-description"
8907 \begin_inset Quotes eld
8911 \begin_inset Flex Code
8914 \begin_layout Plain Layout
8921 \begin_inset Quotes erd
8925 Primarily used in cite engine files (see
8926 \begin_inset CommandInset ref
8928 reference "subsec:Cite-Engine-Files"
8938 \begin_layout Description
8939 \begin_inset Flex Code
8942 \begin_layout Plain Layout
8949 \begin_inset Flex Code
8952 \begin_layout Plain Layout
8961 \begin_inset Flex Code
8964 \begin_layout Plain Layout
8970 ] Determines whether
8974 or Bib\SpecialChar TeX
8975 is used to generate a Bibliography.
8976 Primarily used in cite engine files (see
8977 \begin_inset CommandInset ref
8979 reference "subsec:Cite-Engine-Files"
8989 \begin_layout Description
8990 \begin_inset Flex Code
8993 \begin_layout Plain Layout
8999 Describes various global options supported by the document class.
9001 \begin_inset CommandInset ref
9003 reference "subsec:ClassOptions"
9009 \begin_inset Quotes eld
9013 \begin_inset Flex Code
9016 \begin_layout Plain Layout
9023 \begin_inset Quotes erd
9029 \begin_layout Description
9030 \begin_inset Flex Code
9033 \begin_layout Plain Layout
9040 \begin_inset Flex Code
9043 \begin_layout Plain Layout
9052 \begin_inset space \thinspace{}
9056 \begin_inset Flex Code
9059 \begin_layout Plain Layout
9065 ] Whether the class should
9069 to having one or two columns.
9070 Can be changed in the
9071 \begin_inset Flex Noun
9074 \begin_layout Plain Layout
9075 Document\SpecialChar menuseparator
9084 \begin_layout Description
9085 \begin_inset Flex Code
9088 \begin_layout Plain Layout
9095 \begin_inset Flex Code
9098 \begin_layout Plain Layout
9104 ] This sequence defines the properties for a counter.
9105 If the counter does not yet exist, it is created; if it does exist, it
9108 \begin_inset Quotes eld
9112 \begin_inset Flex Code
9115 \begin_layout Plain Layout
9122 \begin_inset Quotes erd
9126 \begin_inset Newline newline
9130 \begin_inset CommandInset ref
9132 reference "subsec:Counters"
9136 for details on counters.
9139 \begin_layout Description
9140 \begin_inset Flex Code
9143 \begin_layout Plain Layout
9149 Sets the default font used to display the document.
9151 \begin_inset CommandInset ref
9153 reference "subsec:Font-description"
9157 for how to declare fonts.
9159 \begin_inset Quotes eld
9163 \begin_inset Flex Code
9166 \begin_layout Plain Layout
9173 \begin_inset Quotes erd
9179 \begin_layout Description
9180 \begin_inset Flex Code
9183 \begin_layout Plain Layout
9190 \begin_inset Flex Code
9193 \begin_layout Plain Layout
9199 ] Specifies a module to be included by default with this document class.
9200 The module is specified as filename without the
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9211 The user can still remove the module, but it will be active at the outset.
9212 (This applies only when new files are created, or when this class is chosen
9213 for an existing document.)
9216 \begin_layout Description
9217 \begin_inset Flex Code
9220 \begin_layout Plain Layout
9227 \begin_inset Flex Code
9230 \begin_layout Plain Layout
9236 ] This is the style that will be assigned to new paragraphs, usually
9237 \begin_inset Flex Noun
9240 \begin_layout Plain Layout
9247 This will default to the first defined style if not given, but you are
9248 encouraged to use this directive.
9251 \begin_layout Description
9252 \begin_inset Flex Code
9255 \begin_layout Plain Layout
9262 \begin_inset Flex Code
9265 \begin_layout Plain Layout
9271 ] This tag indicates that the module (which is specified by filename without
9273 \begin_inset Flex Code
9276 \begin_layout Plain Layout
9282 extension) cannot be used with this document class.
9283 This might be used in a journal-specific layout file to prevent, say, the
9285 \begin_inset Flex Code
9288 \begin_layout Plain Layout
9294 module that numbers theorems by section.
9299 be used in a module.
9300 Modules have their own way of excluding other modules (see
9301 \begin_inset CommandInset ref
9303 reference "subsec:Layout-modules"
9310 \begin_layout Description
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9320 Defines a new float.
9322 \begin_inset CommandInset ref
9324 reference "subsec:Floats"
9330 \begin_inset Quotes eld
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9344 \begin_inset Quotes erd
9350 \begin_layout Description
9351 \begin_inset Flex Code
9354 \begin_layout Plain Layout
9360 Sets the information that will be output in the
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9370 block when this document class is output to XHTML.
9371 Note that this will completely override any prior
9372 \begin_inset Flex Code
9375 \begin_layout Plain Layout
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9393 \begin_inset Newline newline
9397 \begin_inset Flex Code
9400 \begin_layout Plain Layout
9406 if you just want to add material to the preamble.) Must end with
9407 \begin_inset Quotes eld
9411 \begin_inset Flex Code
9414 \begin_layout Plain Layout
9421 \begin_inset Quotes erd
9427 \begin_layout Description
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9447 ] The style to use for the table of contents, bibliography, and so forth,
9448 when the document is output to HTML.
9449 For articles, this should normally be
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9470 If it is not given, then \SpecialChar LyX
9471 will attempt to figure out which layout to use.
9474 \begin_layout Description
9475 \begin_inset Flex Code
9478 \begin_layout Plain Layout
9485 \begin_inset Flex Code
9488 \begin_layout Plain Layout
9494 ] Modifies the properties of the given counter.
9495 If the counter does not exist, the statement is ignored.
9497 \begin_inset Quotes eld
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9511 \begin_inset Quotes erd
9515 \begin_inset Newline newline
9519 \begin_inset CommandInset ref
9521 reference "subsec:Counters"
9525 for details on counters.
9528 \begin_layout Description
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9539 \begin_inset Flex Code
9542 \begin_layout Plain Layout
9548 ] This allows you to include another layout definition file within yours
9549 to avoid duplicating commands.
9550 Common examples are the standard layout files, for example,
9551 \begin_inset Flex Code
9554 \begin_layout Plain Layout
9560 , which contains most of the basic layouts.
9563 \begin_layout Description
9564 \begin_inset Flex Code
9567 \begin_layout Plain Layout
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9583 ] This section (re-)defines the layout of an inset.
9584 It can be applied to an existing inset or to a new, user-defined inset,
9585 e.g., a new character style.
9587 \begin_inset Quotes eld
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9601 \begin_inset Quotes erd
9605 \begin_inset Newline newline
9609 \begin_inset CommandInset ref
9611 reference "subsec:Flex-insets-and"
9615 for more information.
9619 \begin_layout Description
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9639 ] A string that indicates the width of the left margin on the screen, for
9641 \begin_inset Quotes eld
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9655 \begin_inset Quotes erd
9659 (Note that this is not a `length', like
9660 \begin_inset Quotes eld
9664 \begin_inset Quotes erd
9670 \begin_layout Description
9671 \begin_inset Flex Code
9674 \begin_layout Plain Layout
9681 \begin_inset Flex Code
9684 \begin_layout Plain Layout
9690 ] An integer that determines the maximal number of names displayed in an
9691 author-year citation before the citation switches to
9692 \begin_inset Quotes eld
9696 \begin_inset Quotes erd
9700 Primarily used in cite engine files (see
9701 \begin_inset CommandInset ref
9703 reference "subsec:Cite-Engine-Files"
9713 \begin_layout Description
9714 \begin_inset Flex Code
9717 \begin_layout Plain Layout
9724 \begin_inset Flex Code
9727 \begin_layout Plain Layout
9733 ] Modifies the properties of the given paragraph style.
9734 If the style does not exist, this section is ignored.
9736 \begin_inset Quotes eld
9740 \begin_inset Flex Code
9743 \begin_layout Plain Layout
9750 \begin_inset Quotes erd
9756 \begin_layout Description
9757 \begin_inset Flex Code
9760 \begin_layout Plain Layout
9767 \begin_inset Flex Code
9770 \begin_layout Plain Layout
9776 ] Deletes an existing counter, usually one defined in an included file.
9779 \begin_layout Description
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9790 \begin_inset Flex Code
9793 \begin_layout Plain Layout
9799 ] Deletes an existing float.
9800 This is particularly useful when you want to suppress a float that has
9801 been defined in an input file.
9804 \begin_layout Description
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9815 \begin_inset Flex Code
9818 \begin_layout Plain Layout
9824 ] Deletes an existing style.
9827 \begin_layout Description
9828 \begin_inset Flex Code
9831 \begin_layout Plain Layout
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9857 ] Define a new table of contents with type
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9868 \begin_inset Flex Code
9871 \begin_layout Plain Layout
9878 See also the AddToToc commands.
9881 \begin_layout Description
9882 \begin_inset Flex Code
9885 \begin_layout Plain Layout
9892 \begin_inset Flex Code
9895 \begin_layout Plain Layout
9901 ] The file format (as defined in the \SpecialChar LyX
9902 preferences) produced by this document
9904 It is mainly useful when
9905 \begin_inset Flex Code
9908 \begin_layout Plain Layout
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9924 and one wants to define a new type of literate document.
9925 The format is reset to
9926 \begin_inset Quotes eld
9930 \begin_inset Flex Code
9933 \begin_layout Plain Layout
9940 \begin_inset Quotes erd
9944 \begin_inset Quotes eld
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9958 \begin_inset Quotes erd
9961 when the corresponding
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9971 parameter is encountered.
9974 \begin_layout Description
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9985 \begin_inset Flex Code
9988 \begin_layout Plain Layout
9999 \begin_inset Flex Code
10002 \begin_layout Plain Layout
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10018 ] Specifies what sort of output documents using this class will produce.
10021 \begin_layout Description
10022 \begin_inset Flex Code
10025 \begin_layout Plain Layout
10032 \begin_inset Flex Code
10035 \begin_layout Plain Layout
10042 \begin_inset Flex Code
10045 \begin_layout Plain Layout
10051 ] Specifies options, given in the second string, for the package named by
10054 \begin_inset Quotes eld
10058 \begin_inset Flex Code
10061 \begin_layout Plain Layout
10062 PackageOptions natbib square
10068 \begin_inset Quotes erd
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10081 to be loaded with the
10082 \begin_inset Flex Code
10085 \begin_layout Plain Layout
10092 (For \SpecialChar TeX
10093 perts, this causes \SpecialChar LyX
10095 \begin_inset Flex Code
10098 \begin_layout Plain Layout
10101 PassOptionsToPackage{natbib}{square}
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10119 \begin_layout Description
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10161 ] The default pagestyle.
10162 Can be changed in the
10163 \begin_inset Flex Noun
10166 \begin_layout Plain Layout
10167 Document\SpecialChar menuseparator
10176 \begin_layout Description
10177 \begin_inset Flex Code
10180 \begin_layout Plain Layout
10186 Sets the preamble for the \SpecialChar LaTeX
10188 Note that this will completely override any prior
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 if you just want to add material to the preamble.) Must end with
10220 \begin_inset Quotes eld
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10234 \begin_inset Quotes erd
10240 \begin_layout Description
10241 \begin_inset Flex Code
10244 \begin_layout Plain Layout
10251 \begin_inset Flex Code
10254 \begin_layout Plain Layout
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10273 \begin_inset space \thinspace{}
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10286 ] Whether the class already provides the feature
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10297 A feature is in general the name of a package (e.
10298 \begin_inset space \thinspace{}
10302 \begin_inset space \space{}
10306 \begin_inset Flex Code
10309 \begin_layout Plain Layout
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10326 \begin_inset space \thinspace{}
10330 \begin_inset space \space{}
10334 \begin_inset Flex Code
10337 \begin_layout Plain Layout
10344 \begin_inset Flex Code
10347 \begin_layout Plain Layout
10355 \begin_inset CommandInset ref
10357 reference "chap:List-of-functions"
10361 for the list of features.
10364 \begin_layout Description
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10384 ] Indicates that this layout provides the functionality of the module mentioned,
10385 which should be specified by the filename without the
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10396 This will typically be used if the layout includes the module directly,
10397 rather than using the
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10407 tag to indicate that it ought to be used.
10408 It could also be used in a module that provided an alternate implementation
10409 of the same functionality.
10412 \begin_layout Description
10413 \begin_inset Flex Code
10416 \begin_layout Plain Layout
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10432 ] Creates a new paragraph style if it does not already exist.
10433 If the style does exist, this section is ignored.
10435 \begin_inset Quotes eld
10439 \begin_inset Flex Code
10442 \begin_layout Plain Layout
10449 \begin_inset Quotes erd
10455 \begin_layout Description
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 ] Whether the class requires the feature
10476 \begin_inset Flex Code
10479 \begin_layout Plain Layout
10486 Multiple features must be separated by commas.
10487 Note that you can only request supported features.
10489 \begin_inset CommandInset ref
10491 reference "chap:List-of-functions"
10495 for the list of features.).
10496 If you require a package with specific options, you can additionally use
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10510 \begin_layout Description
10511 \begin_inset Flex Code
10514 \begin_layout Plain Layout
10521 \begin_inset Flex Code
10524 \begin_layout Plain Layout
10530 ] A string that indicates the width of the right margin on the screen, for
10532 \begin_inset Quotes eld
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10546 \begin_inset Quotes erd
10552 \begin_layout Description
10553 \begin_inset Flex Code
10556 \begin_layout Plain Layout
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10572 ] Sets which divisions get numbered.
10574 \begin_inset Newline newline
10578 \begin_inset Flex Code
10581 \begin_layout Plain Layout
10587 counter in \SpecialChar LaTeX
10591 \begin_layout Description
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10614 \begin_inset space \thinspace{}
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10627 ] Whether the class-default should be printing on one or both sides of the
10629 Can be changed in the
10630 \begin_inset Flex Noun
10633 \begin_layout Plain Layout
10634 Document\SpecialChar menuseparator
10643 \begin_layout Description
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10663 ] This sequence defines a paragraph style.
10664 If the style does not yet exist, it is created; if it does exist, its parameter
10667 \begin_inset Quotes eld
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Quotes erd
10685 \begin_inset Newline newline
10689 \begin_inset CommandInset ref
10691 reference "subsec:Paragraph-Styles"
10695 for details on paragraph styles.
10698 \begin_layout Description
10699 \begin_inset Flex Code
10702 \begin_layout Plain Layout
10709 \begin_inset Flex Code
10712 \begin_layout Plain Layout
10718 ] The name of the command or environment to be used with
10719 \begin_inset Flex Code
10722 \begin_layout Plain Layout
10731 \begin_layout Description
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10763 ] Indicates what kind of markup is used to define the title of a document.
10765 \begin_inset Flex Code
10768 \begin_layout Plain Layout
10774 means that the macro with name
10775 \begin_inset Flex Code
10778 \begin_layout Plain Layout
10784 will be inserted after the last layout which has
10785 \begin_inset Quotes eld
10789 \begin_inset Flex Code
10792 \begin_layout Plain Layout
10794 \begin_inset space ~
10803 \begin_inset Quotes erd
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10817 corresponds to the case where all layouts which have
10818 \begin_inset Quotes eld
10822 \begin_inset Flex Code
10825 \begin_layout Plain Layout
10827 \begin_inset space ~
10836 \begin_inset Quotes erd
10839 should be enclosed into the
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10852 \begin_layout Description
10853 \begin_inset Flex Code
10856 \begin_layout Plain Layout
10863 \begin_inset Flex Code
10866 \begin_layout Plain Layout
10872 ] Sets which divisions are included in the table of contents.
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10883 counter in \SpecialChar LaTeX
10887 \begin_layout Subsection
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10898 \begin_inset CommandInset label
10900 name "subsec:ClassOptions"
10907 \begin_layout Standard
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10918 section can contain the following entries:
10921 \begin_layout Description
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10941 ] The list of available font sizes for the document's main font, separated
10943 \begin_inset Quotes eld
10947 \begin_inset Flex Code
10950 \begin_layout Plain Layout
10957 \begin_inset Quotes erd
10963 \begin_layout Description
10964 \begin_inset Flex Code
10967 \begin_layout Plain Layout
10973 Used to set the DTD line with XML-based output classes.
10975 \begin_inset space \thinspace{}
10979 \begin_inset Quotes eld
10982 -//OASIS//DTD DocBook V4.2//EN
10983 \begin_inset Quotes erd
10989 \begin_layout Description
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11004 string="empty|plain|headings|fancy"
11009 ] The list of available page sty\SpecialChar softhyphen
11011 \begin_inset Quotes eld
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11025 \begin_inset Quotes erd
11031 \begin_layout Description
11032 \begin_inset Flex Code
11035 \begin_layout Plain Layout
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11051 ] Some document class options, separated by a comma, that will be added
11052 to the optional part of the
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11067 \begin_layout Standard
11069 \begin_inset Flex Code
11072 \begin_layout Plain Layout
11078 section must end with
11079 \begin_inset Quotes eld
11083 \begin_inset Flex Code
11086 \begin_layout Plain Layout
11093 \begin_inset Quotes erd
11099 \begin_layout Subsection
11101 \begin_inset CommandInset label
11103 name "subsec:Paragraph-Styles"
11110 \begin_layout Standard
11111 A paragraph style description looks like this:
11115 \begin_layout Plain Layout
11116 Note that this will either define a new style or modify an existing one.
11124 \begin_layout LyX-Code
11131 \begin_layout LyX-Code
11135 \begin_layout LyX-Code
11139 \begin_layout Standard
11140 where the following commands are allowed:
11143 \begin_layout Description
11144 \begin_inset Flex Code
11147 \begin_layout Plain Layout
11154 \begin_inset Flex Code
11157 \begin_layout Plain Layout
11163 =""] This paragraph will appear in the table of contents of the given type.
11164 An empty string disables.
11165 See also the OutlinerName and the IsTocCaption commands.
11169 \begin_layout Description
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11188 , left, right, center
11193 ] Paragraph alignment.
11196 \begin_layout Description
11197 \begin_inset Flex Code
11200 \begin_layout Plain Layout
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11215 , left, right, center
11220 ] A comma separated list of permitted alignments.
11221 (Some \SpecialChar LaTeX
11222 styles prohibit certain alignments, since those wouldn't make sense.
11223 For example a right-aligned or centered enumeration isn't possible.)
11226 \begin_layout Description
11227 \begin_inset Flex Code
11230 \begin_layout Plain Layout
11237 \begin_inset Flex Code
11240 \begin_layout Plain Layout
11246 ] Defines argument number <int> of a command\SpecialChar breakableslash
11247 environment associated with
11249 This is useful for things like section headings, and only makes sense with
11252 Every (optional or required) argument of a command or environment – except
11253 for the required argument that is associated with the content of the paragraph
11254 itself – has a separate definition, where the number specifies the order
11256 The definition must end with
11257 \begin_inset Flex Code
11260 \begin_layout Plain Layout
11267 So a command with two optional arguments has:
11271 \begin_layout Quote
11277 \begin_layout Quote
11283 \begin_layout Quote
11289 \begin_layout Quote
11295 \begin_layout Quote
11301 \begin_layout Quote
11307 \begin_layout Standard
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11318 definition, the following specifications are possible:
11321 \begin_layout Itemize
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11332 \begin_inset Flex Code
11335 \begin_layout Plain Layout
11341 The string that will appear both in the menu (to insert this argument)
11342 and on the argument inset button (unless you also specify a separate
11343 \begin_inset Flex Code
11346 \begin_layout Plain Layout
11353 For the menu, you can define an accelerator by appending the respective
11354 character to the string, divided by
11355 \begin_inset Quotes eld
11359 \begin_inset Quotes erd
11363 \begin_inset space \thinspace{}
11367 \begin_inset space \space{}
11371 \begin_inset Quotes eld
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11385 \begin_inset Quotes erd
11391 \begin_layout Itemize
11392 \begin_inset Flex Code
11395 \begin_layout Plain Layout
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11411 A separate string for the menu.
11412 You can define an accelerator by appending the respective character to
11413 the string, divided by
11414 \begin_inset Quotes eld
11418 \begin_inset Quotes erd
11422 \begin_inset space \thinspace{}
11426 \begin_inset space \space{}
11430 \begin_inset Quotes eld
11434 \begin_inset Flex Code
11437 \begin_layout Plain Layout
11444 \begin_inset Quotes erd
11448 This specification is optional.
11449 If it is not given the
11450 \begin_inset Flex Code
11453 \begin_layout Plain Layout
11459 will be used instead for the menu.
11462 \begin_layout Itemize
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11473 \begin_inset Flex Code
11476 \begin_layout Plain Layout
11482 A longer explanatory text that appears in the tooltip when hovering over
11483 the argument inset.
11486 \begin_layout Itemize
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11497 \begin_inset Flex Code
11500 \begin_layout Plain Layout
11509 \begin_inset space \thinspace{}
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11522 ] Declare if this is a mandatory (1) or an optional (0) argument.
11523 Mandatory arguments will be output empty if not given, while optional arguments
11524 will not be output at all.
11525 By default, mandatory arguments are delimited by
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11535 , while optional arguments are delimited by
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11548 \begin_layout Itemize
11549 \begin_inset Flex Code
11552 \begin_layout Plain Layout
11559 \begin_inset Flex Code
11562 \begin_layout Plain Layout
11568 defines another argument (by its number) which this argument requires to
11569 be output if it is itself output.
11571 \begin_inset space \thinspace{}
11574 g., in \SpecialChar LaTeX
11575 commands, optional arguments often require previous optional arguments
11576 to be output (at least empty), as in
11577 \begin_inset Flex Code
11580 \begin_layout Plain Layout
11583 command[][argument]{text}
11589 This can be achieved by the statement
11590 \begin_inset Flex Code
11593 \begin_layout Plain Layout
11600 \begin_inset Flex Code
11603 \begin_layout Plain Layout
11612 \begin_layout Itemize
11613 \begin_inset Flex Code
11616 \begin_layout Plain Layout
11623 \begin_inset Flex Code
11626 \begin_layout Plain Layout
11632 defines a custom left delimiter (instead of
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11643 \begin_inset Flex Code
11646 \begin_layout Plain Layout
11653 A line break in the output can be indicated by
11654 \begin_inset Flex Code
11657 \begin_layout Plain Layout
11666 \begin_layout Itemize
11667 \begin_inset Flex Code
11670 \begin_layout Plain Layout
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11686 defines a custom right delimiter (instead of
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11697 \begin_inset Flex Code
11700 \begin_layout Plain Layout
11707 A line break in the output can be indicated by
11708 \begin_inset Flex Code
11711 \begin_layout Plain Layout
11720 \begin_layout Itemize
11721 \begin_inset Flex Code
11724 \begin_layout Plain Layout
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11740 defines an argument that is inserted if and only if no user-specified arguments
11742 \begin_inset space \thinspace{}
11746 \begin_inset space \space{}
11749 if no argument inset has been inserted (note that also an empty argument
11750 inset omits the DefaultArg).
11751 Multiple arguments need to be separated by comma.
11754 \begin_layout Itemize
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11765 \begin_inset Flex Code
11768 \begin_layout Plain Layout
11774 defines an argument that is inserted in any case (alone or in addition
11775 to user-specified arguments).
11776 Multiple arguments need to be separated by comma.
11779 \begin_layout Itemize
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11789 The font used for the argument content, see
11790 \begin_inset CommandInset ref
11792 reference "subsec:Font-description"
11799 \begin_layout Itemize
11800 \begin_inset Flex Code
11803 \begin_layout Plain Layout
11809 The font used for the label; see
11810 \begin_inset CommandInset ref
11812 reference "subsec:Font-description"
11819 \begin_layout Itemize
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11838 , Minimalistic, Conglomerate
11843 ] describes the rendering style used for the inset's frame and buttons.
11846 \begin_layout Itemize
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11867 \begin_inset Flex Code
11870 \begin_layout Plain Layout
11876 , this argument is automatically inserted when the respective style is selected.
11877 Currently, only one argument per style\SpecialChar breakableslash
11878 layout can be automatically inserted.
11881 \begin_layout Itemize
11882 \begin_inset Flex Code
11885 \begin_layout Plain Layout
11892 \begin_inset Flex Code
11895 \begin_layout Plain Layout
11902 \begin_inset Flex Code
11905 \begin_layout Plain Layout
11911 , this argument will be inserted with a copy of the co-text (either selected
11912 text or the whole paragraph) as content.
11915 \begin_layout Itemize
11916 \begin_inset Flex Code
11919 \begin_layout Plain Layout
11926 \begin_inset Flex Code
11929 \begin_layout Plain Layout
11939 ] Whether the contents of this argument should be output in raw form, meaning
11940 without special translations that \SpecialChar LaTeX
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11952 status is inherited by the inset or paragraph layout the argument belongs
11953 to, true and false change the status for the given argument only.
11956 \begin_layout Itemize
11957 \begin_inset Flex Code
11960 \begin_layout Plain Layout
11967 \begin_inset Flex Code
11970 \begin_layout Plain Layout
11971 string of characters
11980 Defines individual characters that should be output in raw form, meaning
11981 without special translations that \SpecialChar LaTeX
11983 Note that, contrary to PassThru, this needs to be explicitly defined for
11985 That is, arguments do not inherit PassThruChars from their parent inset
11989 \begin_layout Itemize
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
12000 \begin_inset Flex Code
12003 \begin_layout Plain Layout
12012 \begin_inset space \thinspace{}
12016 \begin_inset Flex Code
12019 \begin_layout Plain Layout
12025 ] If this is set to 1, the argument will output its content in the corresponding
12026 item in the table of contents.
12030 \begin_layout Standard
12031 By default, the text entered in the \SpecialChar LyX
12032 workarea in the respective layout is
12033 the last (mandatory) argument of a command if the
12034 \begin_inset Flex Code
12037 \begin_layout Plain Layout
12044 \begin_inset Flex Code
12047 \begin_layout Plain Layout
12054 However, arguments with the prefix
12055 \begin_inset Flex Code
12058 \begin_layout Plain Layout
12064 are output after this workarea argument.
12065 Note that post-argument numbering restarts at 1, so the first argument
12066 following the workarea argument is
12067 \begin_inset Flex Code
12070 \begin_layout Plain Layout
12077 Post-arguments are ignored in any other
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12088 \begin_inset Flex Code
12091 \begin_layout Plain Layout
12100 \begin_layout Standard
12102 \begin_inset Flex Code
12105 \begin_layout Plain Layout
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12135 followed by the number (e.
12136 \begin_inset space \thinspace{}
12140 \begin_inset space \space{}
12144 \begin_inset Flex Code
12147 \begin_layout Plain Layout
12157 \begin_layout Description
12158 \begin_inset Flex Code
12161 \begin_layout Plain Layout
12167 Note that this will completely override any prior
12168 \begin_inset Flex Code
12171 \begin_layout Plain Layout
12177 declaration for this style.
12179 \begin_inset Quotes eld
12183 \begin_inset Flex Code
12186 \begin_layout Plain Layout
12193 \begin_inset Quotes erd
12198 \begin_inset CommandInset ref
12200 reference "subsec:I18n"
12204 for details on its use.
12207 \begin_layout Description
12208 \begin_inset Flex Code
12211 \begin_layout Plain Layout
12218 \begin_inset Flex Code
12221 \begin_layout Plain Layout
12231 \begin_layout Plain Layout
12232 Note that a `float' here is a real number, such as: 1.5.
12237 The vertical space with which the last of a chain of paragraphs with this
12238 style is separated from the following paragraph.
12239 If the next paragraph has another style, the separations are not simply
12240 added, but the maximum is taken.
12243 \begin_layout Description
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12263 ] The category for this style.
12264 This is used to group related styles in the style combobox on the toolbar.
12265 Any string can be used, but you may want to use existing categories with
12270 \begin_layout Description
12271 \begin_inset Flex Code
12274 \begin_layout Plain Layout
12280 Depth of XML command.
12281 Used only with XML-type formats.
12284 \begin_layout Description
12285 \begin_inset Flex Code
12288 \begin_layout Plain Layout
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12304 ] Copies all the features of an existing style into the current one.
12308 \begin_layout Description
12309 \begin_inset Flex Code
12312 \begin_layout Plain Layout
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12328 ] The name of a style whose preamble should be output
12333 This allows to ensure some ordering of the preamble snippets when macros
12334 definitions depend on one another.
12338 \begin_layout Plain Layout
12339 Note that, besides that functionality, there is no way to ensure any ordering
12341 The ordering that you see in a given version of \SpecialChar LyX
12342 may change without warning
12351 \begin_layout Description
12352 \begin_inset Flex Code
12355 \begin_layout Plain Layout
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12370 , Box, Filled_Box, Static
12375 ] The type of label that stands at the end of the paragraph (or sequence
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12387 \begin_inset Newline newline
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12401 \begin_inset Flex Code
12404 \begin_layout Plain Layout
12411 \begin_inset Flex Code
12414 \begin_layout Plain Layout
12422 \begin_inset Flex Code
12425 \begin_layout Plain Layout
12432 \begin_inset Quotes eld
12436 \begin_inset Quotes erd
12440 \begin_inset Flex Code
12443 \begin_layout Plain Layout
12450 \begin_inset space \space{}
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12463 ) is a white (resp.
12464 \begin_inset space ~
12467 black) square suitable for end of proof markers,
12468 \begin_inset Flex Code
12471 \begin_layout Plain Layout
12477 is an explicit text string.
12480 \begin_layout Description
12481 \begin_inset Flex Code
12484 \begin_layout Plain Layout
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12500 ] The string used for a label with a
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12511 \begin_inset Newline newline
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12528 \begin_layout Description
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12538 The font used for both the text body
12544 \begin_inset CommandInset ref
12546 reference "subsec:Font-description"
12551 Note that defining this font automatically defines the
12552 \begin_inset Flex Code
12555 \begin_layout Plain Layout
12562 So you should define this one first if you also want to define
12563 \begin_inset Flex Code
12566 \begin_layout Plain Layout
12575 \begin_layout Description
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12586 \begin_inset Flex Code
12589 \begin_layout Plain Layout
12595 ] Used for backporting new styles to stable \SpecialChar LyX
12597 The first stable version that supports this tag is \SpecialChar LyX
12599 The argument is a number which may either be 0, -1 or any value greater
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12611 flag of a style is greater than zero, it will always be written to the
12613 If a .lyx file is read, the style definitions from the document header are
12614 added to the document class.
12615 Therefore even older \SpecialChar LyX
12616 versions can handle the style.
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12627 is a version number: if the style is read, and the version number is less
12628 than the version number of the already existing style in the document class,
12629 the new style is ignored.
12630 If the version number is greater, the new style replaces the existing style.
12631 A value of -1 means an infinite version number, i.
12632 \begin_inset space \thinspace{}
12636 \begin_inset space \space{}
12639 the style is always used.
12642 \begin_layout Description
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12665 \begin_inset space \thinspace{}
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12678 ] Usually \SpecialChar LyX
12679 does not allow you to insert more than one space between words,
12680 since a space is considered as the separation between two words, not a
12681 character or symbol of its own.
12682 This is a very fine thing but sometimes annoying, for example, when typing
12683 program code or plain \SpecialChar LaTeX
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12696 Note that \SpecialChar LyX
12697 will create protected blanks for the additional blanks when
12698 in another mode than \SpecialChar LaTeX
12702 \begin_layout Description
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12712 These tags are used with XHTML output.
12714 \begin_inset CommandInset ref
12716 reference "subsec:Paragraph-Style-XHTML"
12723 \begin_layout Description
12724 \begin_inset Flex Code
12727 \begin_layout Plain Layout
12733 [FIXME] (Used only with XML-type formats.)
12736 \begin_layout Description
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset space \thinspace{}
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12773 \begin_inset Flex Code
12776 \begin_layout Plain Layout
12782 , marks the style as to be included in the document preamble and not in
12784 This is useful for document classes that want such information as the title
12785 and author to appear in the preamble.
12786 Note that this works only for styles for which the
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12807 \begin_inset Flex Code
12810 \begin_layout Plain Layout
12819 \begin_layout Description
12820 \begin_inset Flex Code
12823 \begin_layout Plain Layout
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12842 \begin_inset space \thinspace{}
12846 \begin_inset Flex Code
12849 \begin_layout Plain Layout
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 , marks the style as being part of a title block (see also the
12866 \begin_inset Flex Code
12869 \begin_layout Plain Layout
12876 \begin_inset Flex Code
12879 \begin_layout Plain Layout
12888 \begin_layout Description
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12899 \begin_inset Flex Code
12902 \begin_layout Plain Layout
12911 \begin_inset space \thinspace{}
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12924 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12925 of its contents in its item in the table of contents.
12926 Otherwise, only the label, if it exists, appears.
12929 \begin_layout Description
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12949 ] The \SpecialChar LaTeX
12950 command sequence declaring an item in a list.
12951 The command is to be defined without the preceding backslash (the default
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Flex Code
12964 \begin_layout Plain Layout
12972 in the \SpecialChar LaTeX
12976 \begin_layout Description
12977 \begin_inset Flex Code
12980 \begin_layout Plain Layout
12987 \begin_inset Flex Code
12990 \begin_layout Plain Layout
12996 ] This provides extra space between paragraphs that have the same style.
12997 If you put other styles into an environment, each is separated with the
12999 \begin_inset Flex Code
13002 \begin_layout Plain Layout
13009 But the whole items of the environment are additionally separated with
13011 \begin_inset Flex Code
13014 \begin_layout Plain Layout
13021 Note that this is a
13026 \begin_layout Description
13027 \begin_inset Flex Code
13030 \begin_layout Plain Layout
13036 [FIXME] (Used only with XML-type formats.)
13039 \begin_layout Description
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13062 \begin_inset space \thinspace{}
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13075 ] Usually \SpecialChar LyX
13076 does not allow you to leave a paragraph empty, since it would
13077 lead to empty \SpecialChar LaTeX
13079 There are some cases where this could be desirable however: in a letter
13080 template, the required fields can be provided as empty fields, so that
13081 people do not forget them; in some special classes, a style can be used
13082 as some kind of break, which does not contain actual text.
13085 \begin_layout Description
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13096 \begin_inset Flex Code
13099 \begin_layout Plain Layout
13105 ] The vertical space between the label and the text body.
13106 Only used for labels that are above the text body (
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13117 \begin_inset Newline newline
13121 \begin_inset Flex Code
13124 \begin_layout Plain Layout
13125 Centered_Top_Environment
13133 \begin_layout Description
13134 \begin_inset Flex Code
13137 \begin_layout Plain Layout
13144 \begin_inset Flex Code
13147 \begin_layout Plain Layout
13153 ] The name of the counter for automatic numbering.
13154 In order to have the counter appear with your label, you will need to reference
13156 \begin_inset Flex Code
13159 \begin_layout Plain Layout
13168 This will work with
13169 \begin_inset Flex Code
13172 \begin_layout Plain Layout
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 \begin_inset Newline newline
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13227 \begin_inset Flex Code
13230 \begin_layout Plain Layout
13236 , though this case is a bit complicated.
13237 Suppose you declare
13238 \begin_inset Quotes eld
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13246 LabelCounter myenum
13252 \begin_inset Quotes erd
13256 Then the actual counters used are
13257 \begin_inset Flex Code
13260 \begin_layout Plain Layout
13267 \begin_inset Flex Code
13270 \begin_layout Plain Layout
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13287 \begin_inset Flex Code
13290 \begin_layout Plain Layout
13296 , much as in \SpecialChar LaTeX
13298 These counters must all be declared separately.
13299 \begin_inset Newline newline
13303 \begin_inset CommandInset ref
13305 reference "subsec:Counters"
13309 for details on counters.
13312 \begin_layout Description
13313 \begin_inset Flex Code
13316 \begin_layout Plain Layout
13322 The font used for the label.
13324 \begin_inset CommandInset ref
13326 reference "subsec:Font-description"
13333 \begin_layout Description
13334 \begin_inset Flex Code
13337 \begin_layout Plain Layout
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13353 ] Text that indicates how far a label should be indented.
13356 \begin_layout Description
13357 \begin_inset Flex Code
13360 \begin_layout Plain Layout
13367 \begin_inset Flex Code
13370 \begin_layout Plain Layout
13376 ] Text that indicates the amount of horizontal space between the label and
13378 Only used for labels that are not above the text body.
13381 \begin_layout Description
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13401 ] The string used for the label.
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13412 is set, this string can be contain the special formatting commands described
13414 \begin_inset CommandInset ref
13416 reference "subsec:Counters"
13423 \begin_layout Description
13424 \begin_inset Flex Code
13427 \begin_layout Plain Layout
13428 LabelStringAppendix
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13443 ] This is used inside the appendix instead of
13444 \begin_inset Newline newline
13448 \begin_inset Flex Code
13451 \begin_layout Plain Layout
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13469 \begin_inset Newline newline
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13477 LabelStringAppendix
13485 \begin_layout Description
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13495 [FIXME] (Used only with XML-type formats.)
13498 \begin_layout Description
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13517 , Manual, Static, Above,
13518 \begin_inset Newline newline
13521 Centered, Sensitive, Enumerate,
13522 \begin_inset Newline newline
13525 Itemize, Bibliography
13534 \begin_layout Description
13535 \begin_inset Flex Code
13538 \begin_layout Plain Layout
13544 means the label is the very first word (up to the first real blank).
13545 Use protected spaces if you want more than one word as the label.
13549 \begin_layout Description
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13559 means the label is simply what is declared as
13560 \begin_inset Flex Code
13563 \begin_layout Plain Layout
13570 This will be displayed
13571 \begin_inset Quotes eld
13575 \begin_inset Quotes erd
13578 , at the beginning of the paragraph.
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13599 , then it will be displayed only in the first paragraph of any sequence
13600 of paragraphs with the same
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13613 \begin_layout Description
13614 \begin_inset Flex Code
13617 \begin_layout Plain Layout
13624 \begin_inset space ~
13628 \begin_inset space ~
13632 \begin_inset Flex Code
13635 \begin_layout Plain Layout
13641 are special cases of
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13652 The label will be printed above the paragraph either at the beginning of
13653 the line or centered.
13656 \begin_layout Description
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13666 is a special case for the caption-labels
13667 \begin_inset Quotes eld
13671 \begin_inset Quotes erd
13675 \begin_inset Quotes eld
13679 \begin_inset Quotes erd
13683 \begin_inset Newline newline
13687 \begin_inset Flex Code
13690 \begin_layout Plain Layout
13696 means the (hardcoded) label string depends on the kind of float: It is
13697 hardcoded to be `FloatType N', where N is the value of the counter associated
13699 For the case that a caption is inserted outside of a float the
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13710 \begin_inset Quotes eld
13714 \begin_inset Quotes erd
13720 \begin_layout Description
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13730 produces the usual sort of enumeration labels.
13731 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13732 small Roman numerals, and uppercase letters for the four possible depths.
13735 \begin_layout Description
13736 \begin_inset Flex Code
13739 \begin_layout Plain Layout
13745 produces various bullets at the different levels.
13746 It is also hardcoded.
13749 \begin_layout Description
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13759 should be used only with
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13764 LatexType BibEnvironment
13773 \begin_layout Description
13774 \begin_inset Flex Code
13777 \begin_layout Plain Layout
13783 Note that this will completely override any prior
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13793 declaration for this style.
13795 \begin_inset Quotes eld
13799 \begin_inset Flex Code
13802 \begin_layout Plain Layout
13809 \begin_inset Quotes erd
13814 \begin_inset CommandInset ref
13816 reference "subsec:I18n"
13820 for details on its use.
13823 \begin_layout Description
13824 \begin_inset Flex Code
13827 \begin_layout Plain Layout
13834 \begin_inset Flex Code
13837 \begin_layout Plain Layout
13843 ] The name of the corresponding \SpecialChar LaTeX
13845 Either the environment or command name.
13848 \begin_layout Description
13849 \begin_inset Flex Code
13852 \begin_layout Plain Layout
13859 \begin_inset Flex Code
13862 \begin_layout Plain Layout
13868 ] An optional parameter for the corresponding
13869 \begin_inset Flex Code
13872 \begin_layout Plain Layout
13879 This parameter cannot be changed from within \SpecialChar LyX
13881 \begin_inset Flex Code
13884 \begin_layout Plain Layout
13890 for customizable parameters).
13891 This will be output as is after all \SpecialChar LaTeX
13893 \begin_inset Flex Code
13896 \begin_layout Plain Layout
13905 \begin_layout Description
13906 \begin_inset Flex Code
13909 \begin_layout Plain Layout
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13924 , Command, Environment, Item_Environment,
13925 \begin_inset Newline newline
13928 List_Environment, Bib_Environment
13933 ] How the style should be translated into \SpecialChar LaTeX
13938 \begin_layout Plain Layout
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13948 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13949 Visit the SGML class files for specific examples.
13958 \begin_layout Description
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13968 means nothing special.
13971 \begin_layout Description
13972 \begin_inset Flex Code
13975 \begin_layout Plain Layout
13982 \begin_inset Flex Code
13985 \begin_layout Plain Layout
13992 {\SpecialChar ldots
14001 \begin_layout Description
14002 \begin_inset Flex Code
14005 \begin_layout Plain Layout
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14022 }\SpecialChar ldots
14038 \begin_layout Description
14039 \begin_inset Flex Code
14042 \begin_layout Plain Layout
14049 \begin_inset Flex Code
14052 \begin_layout Plain Layout
14059 \begin_inset Flex Code
14062 \begin_layout Plain Layout
14070 is generated for each paragraph of this environment.
14074 \begin_layout Description
14075 \begin_inset Flex Code
14078 \begin_layout Plain Layout
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14095 \begin_inset Newline newline
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14108 is passed as an argument to the environment.
14109 \begin_inset Newline newline
14113 \begin_inset Flex Code
14116 \begin_layout Plain Layout
14122 can be defined in the
14123 \begin_inset Flex Noun
14126 \begin_layout Plain Layout
14127 Edit\SpecialChar menuseparator
14129 \begin_inset space ~
14140 \begin_layout Description
14141 \begin_inset Flex Code
14144 \begin_layout Plain Layout
14151 \begin_inset Flex Code
14154 \begin_layout Plain Layout
14160 but adds the necessary mandatory argument (the longest label) to the begin
14161 statement of the bibliography environment:
14162 \begin_inset Newline newline
14166 \begin_inset Flex Code
14169 \begin_layout Plain Layout
14172 begin{thebibliography}{99}
14178 It is therefore only useful for bibliography environments.
14179 The default longest label
14180 \begin_inset Quotes eld
14184 \begin_inset Quotes erd
14187 can be changed by the user in the paragraph settings of a bibliography
14191 \begin_layout Standard
14192 Putting the last few things together, the \SpecialChar LaTeX
14193 output will be either:
14196 \begin_layout LyX-Code
14199 LatexName[LatexParam]{\SpecialChar ldots
14203 \begin_layout Standard
14207 \begin_layout LyX-Code
14210 begin{LatexName}[LatexParam] \SpecialChar ldots
14216 \begin_layout Standard
14217 depending upon the \SpecialChar LaTeX
14222 \begin_layout Description
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14242 ] A string that is put at the beginning of the style content.
14243 A line break in the output can be indicated by
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14256 \begin_layout Description
14257 \begin_inset Flex Code
14260 \begin_layout Plain Layout
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14276 ] If you put styles into environments, the different
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14286 are not simply added, but added with a factor
14287 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14291 Note that this parameter is also used when
14292 \begin_inset Flex Code
14295 \begin_layout Plain Layout
14302 \begin_inset Flex Code
14305 \begin_layout Plain Layout
14312 \begin_inset Flex Code
14315 \begin_layout Plain Layout
14322 Then it is added to the manual or dynamic margin.
14323 \begin_inset Newline newline
14327 \begin_inset Quotes eld
14331 \begin_inset Flex Code
14334 \begin_layout Plain Layout
14341 \begin_inset Quotes erd
14344 means that the paragraph is indented with the width of
14345 \begin_inset Quotes eld
14349 \begin_inset Flex Code
14352 \begin_layout Plain Layout
14359 \begin_inset Quotes erd
14362 in the normal font.
14363 You can get a negative width by prefixing the string with
14364 \begin_inset Quotes eld
14368 \begin_inset Flex Code
14371 \begin_layout Plain Layout
14378 \begin_inset Quotes erd
14382 This way was chosen so that the look is the same with each used screen
14386 \begin_layout Description
14387 \begin_inset Flex Code
14390 \begin_layout Plain Layout
14397 \begin_inset Flex Code
14400 \begin_layout Plain Layout
14405 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14411 \begin_inset Newline newline
14414 The kind of margin that the style has on the left side.
14418 \begin_layout Description
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14428 just means a fixed margin.
14431 \begin_layout Description
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14441 means that the left margin depends on the string entered in the
14442 \begin_inset Flex Noun
14445 \begin_layout Plain Layout
14446 Edit\SpecialChar menuseparator
14448 \begin_inset space ~
14457 This is used to typeset nice lists without tabulators.
14460 \begin_layout Description
14461 \begin_inset Flex Code
14464 \begin_layout Plain Layout
14470 means that the margin depends on the size of the label.
14471 This is used for automatic enumerated headlines.
14472 It is obvious that the headline
14473 \begin_inset Quotes eld
14476 5.4.3.2.1 Very long headline
14477 \begin_inset Quotes erd
14480 must have a wider left margin (as wide as
14481 \begin_inset Quotes eld
14485 \begin_inset Quotes erd
14488 plus the space) than
14489 \begin_inset Quotes eld
14492 3.2 Very long headline
14493 \begin_inset Quotes erd
14497 \begin_inset Quotes eld
14501 \begin_inset Quotes erd
14504 are not able to do this.
14507 \begin_layout Description
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14517 is similar, but only the very first row of the paragraph is dynamic, while
14518 the others are static; this is used, for example, for descriptions.
14521 \begin_layout Description
14522 \begin_inset Flex Code
14525 \begin_layout Plain Layout
14531 means the margin is chosen in a way that the longest row of this paragraph
14532 fits to the right margin.
14533 This is used to typeset an address on the right edge of the page.
14537 \begin_layout Description
14538 \begin_inset Flex Code
14541 \begin_layout Plain Layout
14548 \begin_inset Flex Code
14551 \begin_layout Plain Layout
14560 \begin_inset space \thinspace{}
14564 \begin_inset Flex Code
14567 \begin_layout Plain Layout
14573 ] Whether fragile commands in this style should be
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14590 whether this command should itself be protected.)
14593 \begin_layout Description
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14614 \begin_inset space \thinspace{}
14618 \begin_inset Flex Code
14621 \begin_layout Plain Layout
14629 ] Whether newlines are translated into \SpecialChar LaTeX
14631 \begin_inset Flex Code
14634 \begin_layout Plain Layout
14645 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14647 inside \SpecialChar LyX
14651 \begin_layout Description
14652 \begin_inset Flex Code
14655 \begin_layout Plain Layout
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14674 \begin_inset space \thinspace{}
14678 \begin_inset Flex Code
14681 \begin_layout Plain Layout
14687 ] If set to true, and if
14688 \begin_inset Flex Code
14691 \begin_layout Plain Layout
14698 \begin_inset Flex Code
14701 \begin_layout Plain Layout
14707 ) paragraphs are being indented, then the indentation of such a paragraph
14708 following one of this type will be suppressed.
14709 (So this will not affect the display of non-default paragraphs.)
14712 \begin_layout Description
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14732 ] Name of a style that has replaced this style.
14733 This is used to rename a style, while keeping backward compatibility.
14736 \begin_layout Description
14737 \begin_inset Flex Code
14740 \begin_layout Plain Layout
14747 \begin_inset Flex Code
14750 \begin_layout Plain Layout
14757 \begin_inset space \thinspace{}
14761 \begin_inset Flex Code
14764 \begin_layout Plain Layout
14770 ] Determines whether consecutive pragraphs of the same type are treated
14771 as belonging together.
14772 This has the effect that the
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14782 is only printed once before such a group.
14783 By default, this is true for
14784 \begin_inset Flex Code
14787 \begin_layout Plain Layout
14794 \begin_inset Flex Code
14797 \begin_layout Plain Layout
14804 \begin_inset Flex Code
14807 \begin_layout Plain Layout
14813 and false for all other types.
14816 \begin_layout Description
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14827 \begin_inset Flex Code
14830 \begin_layout Plain Layout
14839 \begin_inset space \thinspace{}
14843 \begin_inset Flex Code
14846 \begin_layout Plain Layout
14852 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14854 but only by a line break; together with
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14864 , this allows to emulate a plain text editor (like the ERT inset).
14867 \begin_layout Description
14868 \begin_inset Flex Code
14871 \begin_layout Plain Layout
14878 \begin_inset Flex Code
14881 \begin_layout Plain Layout
14887 ] The indent of the very first line of a paragraph.
14889 \begin_inset Newline newline
14893 \begin_inset Flex Code
14896 \begin_layout Plain Layout
14902 will be fixed for a certain style.
14903 The exception is the default style, since the indentation for these paragraphs
14904 can be prohibited with
14905 \begin_inset Flex Code
14908 \begin_layout Plain Layout
14916 \begin_inset Flex Code
14919 \begin_layout Plain Layout
14925 style paragraphs inside environments use the
14926 \begin_inset Flex Code
14929 \begin_layout Plain Layout
14935 of the environment, not their native one.
14937 \begin_inset Flex Code
14940 \begin_layout Plain Layout
14946 paragraphs inside an enumeration are not indented.
14949 \begin_layout Description
14950 \begin_inset Flex Code
14953 \begin_layout Plain Layout
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14969 ] The vertical space between two paragraphs of this style.
14972 \begin_layout Description
14973 \begin_inset Flex Code
14976 \begin_layout Plain Layout
14983 \begin_inset Flex Code
14986 \begin_layout Plain Layout
14993 allows the user to choose either
14994 \begin_inset Quotes eld
14998 \begin_inset Quotes erd
15002 \begin_inset Quotes eld
15006 \begin_inset Quotes erd
15009 to separate paragraphs.
15011 \begin_inset Quotes eld
15015 \begin_inset Quotes erd
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15030 \begin_inset Quotes eld
15034 \begin_inset Quotes erd
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15047 is ignored and all paragraphs are separated by the
15048 \begin_inset Flex Code
15051 \begin_layout Plain Layout
15058 The vertical space is calculated with
15059 \begin_inset Flex Code
15062 \begin_layout Plain Layout
15064 \begin_inset space ~
15073 \begin_inset Flex Code
15076 \begin_layout Plain Layout
15082 is the height of a row with the normal font.
15083 This way, the look stays the same with different screen fonts.
15086 \begin_layout Description
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15097 \begin_inset Flex Code
15100 \begin_layout Plain Layout
15109 \begin_inset space \thinspace{}
15113 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15122 ] Whether the contents of this paragraph should be output in raw form, meaning
15123 without special translations that \SpecialChar LaTeX
15127 \begin_layout Description
15128 \begin_inset Flex Code
15131 \begin_layout Plain Layout
15138 \begin_inset Flex Code
15141 \begin_layout Plain Layout
15151 Defines individual characters that should be output in raw form, meaning
15152 without special translations that \SpecialChar LaTeX
15156 \begin_layout Description
15157 \begin_inset Flex Code
15160 \begin_layout Plain Layout
15166 Information to be included in the \SpecialChar LaTeX
15167 preamble when this style is used.
15168 Used to define macros, load packages, etc., required by this particular
15171 \begin_inset Quotes eld
15175 \begin_inset Flex Code
15178 \begin_layout Plain Layout
15185 \begin_inset Quotes erd
15191 \begin_layout Description
15192 \begin_inset Flex Code
15195 \begin_layout Plain Layout
15202 \begin_inset Flex Code
15205 \begin_layout Plain Layout
15211 ] The prefix to use when creating labels referring to paragraphs of this
15213 This allows the use of formatted references.
15216 \begin_layout Description
15217 \begin_inset Flex Code
15220 \begin_layout Plain Layout
15227 \begin_inset Flex Code
15230 \begin_layout Plain Layout
15236 ] Whether the style requires the feature
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15247 \begin_inset CommandInset ref
15249 reference "chap:List-of-functions"
15253 for the list of features).
15254 If you require a package with specific options, you can additionally use
15256 \begin_inset Flex Code
15259 \begin_layout Plain Layout
15265 as a general text class parameter (see
15266 \begin_inset CommandInset ref
15268 reference "subsec:General-text-class"
15275 \begin_layout Description
15276 \begin_inset Flex Code
15279 \begin_layout Plain Layout
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15298 \begin_inset Flex Code
15301 \begin_layout Plain Layout
15307 ] Resets the \SpecialChar LaTeX
15308 arguments of this style (as defined via the
15309 \begin_inset Flex Code
15312 \begin_layout Plain Layout
15319 This is useful if you have copied a style via
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15329 , but you do not want to inherit its (required and optional) arguments.
15332 \begin_layout Description
15333 \begin_inset Flex Code
15336 \begin_layout Plain Layout
15343 \begin_inset Flex Code
15346 \begin_layout Plain Layout
15355 \begin_inset Flex Code
15358 \begin_layout Plain Layout
15364 ] Resumes a counter that is usually reset at each new sequence of layouts.
15365 This is currently only useful when
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15388 \begin_layout Description
15389 \begin_inset Flex Code
15392 \begin_layout Plain Layout
15399 \begin_inset Flex Code
15402 \begin_layout Plain Layout
15408 ] A string that is put at the end of the layout content.
15409 A line break in the output can be indicated by
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15422 \begin_layout Description
15423 \begin_inset Flex Code
15426 \begin_layout Plain Layout
15433 \begin_inset Flex Code
15436 \begin_layout Plain Layout
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15455 \begin_layout Description
15456 \begin_inset Flex Code
15459 \begin_layout Plain Layout
15466 \begin_inset Flex Code
15469 \begin_layout Plain Layout
15478 \begin_inset Flex Code
15481 \begin_layout Plain Layout
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15498 \begin_inset Flex Code
15501 \begin_layout Plain Layout
15503 \begin_inset space ~
15511 ] This defines what the default spacing should be in the style.
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15523 \begin_inset Flex Code
15526 \begin_layout Plain Layout
15533 \begin_inset Flex Code
15536 \begin_layout Plain Layout
15542 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15543 If you specify the argument
15544 \begin_inset Flex Code
15547 \begin_layout Plain Layout
15553 , then you must also provide a value argument which will be the actual multiplie
15555 Note that, contrary to other parameters,
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15565 implies the generation of specific \SpecialChar LaTeX
15566 code, using the \SpecialChar LaTeX
15570 \begin_inset Flex Code
15573 \begin_layout Plain Layout
15582 \begin_layout Description
15583 \begin_inset Flex Code
15586 \begin_layout Plain Layout
15593 \begin_inset Flex Code
15596 \begin_layout Plain Layout
15603 \begin_inset space \thinspace{}
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15618 ] Allow spell-checking paragraphs of this style.
15622 \begin_layout Description
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15633 \begin_inset Flex Code
15636 \begin_layout Plain Layout
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15654 ] Steps the master counter of a given counter at the beginning of a new
15655 sequence of layouts.
15656 This is currently only useful when
15657 \begin_inset Flex Code
15660 \begin_layout Plain Layout
15667 \begin_inset Flex Code
15670 \begin_layout Plain Layout
15679 \begin_layout Description
15680 \begin_inset Flex Code
15683 \begin_layout Plain Layout
15689 The font used for the text body .
15691 \begin_inset CommandInset ref
15693 reference "subsec:Font-description"
15700 \begin_layout Description
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15726 The level of the style in the table of contents.
15727 This is used for automatic numbering of section headings.
15730 \begin_layout Description
15731 \begin_inset Flex Code
15734 \begin_layout Plain Layout
15743 \begin_inset Flex Code
15746 \begin_layout Plain Layout
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15776 ] This tag determines whether the first line indentation of this paragraph
15777 can be toggled via the Paragraph settings dialog.
15781 \begin_inset Flex Code
15784 \begin_layout Plain Layout
15794 is set, indentation can be toggled if the document settings use
15795 \begin_inset Quotes eld
15799 \begin_inset Quotes erd
15802 paragraph style, with
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15812 , indentation can always be toggled, notwithstanding the document settings,
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15823 , indentation can never be toggled.
15826 \begin_layout Description
15827 \begin_inset Flex Code
15830 \begin_layout Plain Layout
15837 \begin_inset Flex Code
15840 \begin_layout Plain Layout
15846 ] The vertical space with which the very first of a chain of paragraphs
15847 with this style is separated from the previous paragraph.
15848 If the previous paragraph has another style, the separations are not simply
15849 added, but the maximum is taken.
15852 \begin_layout Subsection
15853 \begin_inset CommandInset label
15859 Internationalization of Paragraph Styles
15862 \begin_layout Standard
15864 has long supported internationalization of layout information, but, until
15865 version 2.0, this applied only to the user interface and not to, say, PDF
15867 Thus, French authors were forced to resort to ugly hacks if they wanted
15872 1' instead of `Theorem 1'.
15873 Thanks to Georg Baum, that is no longer the case.
15876 \begin_layout Standard
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15887 defines text that is to appear in the typeset document, it may use
15888 \begin_inset Flex Code
15891 \begin_layout Plain Layout
15898 \begin_inset Flex Code
15901 \begin_layout Plain Layout
15907 to support non-English and even multi-language documents correctly.
15908 The following excerpt (from the
15909 \begin_inset Flex Code
15912 \begin_layout Plain Layout
15918 file) shows how this works:
15921 \begin_layout LyX-Code
15926 \begin_layout LyX-Code
15929 theoremstyle{remark}
15932 \begin_layout LyX-Code
15935 newtheorem{claim}[thm]{
15942 \begin_layout LyX-Code
15946 \begin_layout LyX-Code
15950 \begin_layout LyX-Code
15955 claimname}{_(Claim)}
15958 \begin_layout LyX-Code
15962 \begin_layout LyX-Code
15966 \begin_layout LyX-Code
15975 claimname}{_(Claim)}}
15978 \begin_layout LyX-Code
15983 \begin_layout Standard
15984 In principle, any legal \SpecialChar LaTeX
15986 \begin_inset Flex Code
15989 \begin_layout Plain Layout
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16005 tags, but in practice they will typically look as they do here.
16006 The key to correct translation of the typeset text is the definition of
16007 the \SpecialChar LaTeX
16009 \begin_inset Flex Code
16012 \begin_layout Plain Layout
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16036 \begin_layout Standard
16038 \begin_inset Flex Code
16041 \begin_layout Plain Layout
16047 tag provides for internationalization based upon the overall language of
16049 The contents of the tag will be included in the preamble, just as with
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16061 What makes it special is the use of the
16062 \begin_inset Quotes eld
16066 \begin_inset Quotes erd
16070 \begin_inset Flex Code
16073 \begin_layout Plain Layout
16079 , which will be replaced, when \SpecialChar LyX
16080 produces \SpecialChar LaTeX
16081 output, with the translation of
16082 its argument into the document language.
16085 \begin_layout Standard
16087 \begin_inset Flex Code
16090 \begin_layout Plain Layout
16096 tag is more complex, since it is meant to provide support for multi-language
16097 documents and so offers an interface to the
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16108 Its contents will be added to the preamble once for each language that
16109 appears in the document.
16110 In this case, the argument to
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16120 will be replaced with its translation into the language in question; the
16122 \begin_inset Flex Code
16125 \begin_layout Plain Layout
16131 is replaced by the language name (as used by the babel package).
16134 \begin_layout Standard
16135 A German document that also included a French section would thus have the
16136 following in the preamble:
16139 \begin_layout LyX-Code
16148 claimname}{Affirmation}}
16149 \begin_inset Newline newline
16160 claimname}{Behauptung}}
16161 \begin_inset Newline newline
16168 claimname}{Behauptung}
16171 \begin_layout Standard
16174 \begin_inset Flex Code
16177 \begin_layout Plain Layout
16183 will then conspire to produce the correct text in the output.
16186 \begin_layout Standard
16187 One important point to note here is that the translations are provided by
16189 itself, through the file
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16200 This means, in effect, that
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16220 are really only of use in layout files that are provided with \SpecialChar LyX
16222 entered in user-created layout files will not be seen by \SpecialChar LyX
16223 's internationalizatio
16224 n routines unless the
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16234 file is modified accordingly.
16235 That said, however, any layout created with the intention that it will
16236 be included with \SpecialChar LyX
16237 should use these tags where appropriate.
16238 Please note that the paragraph style translations provided by \SpecialChar LyX
16240 change with a minor update (e.
16241 \begin_inset space \thinspace{}
16245 \begin_inset space \space{}
16248 from version 2.1.x to 2.1.y).
16249 It is however quite likely that a major update (e.
16250 \begin_inset space \thinspace{}
16254 \begin_inset space \space{}
16257 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16260 \begin_layout Subsection
16262 \begin_inset CommandInset label
16264 name "subsec:Floats"
16271 \begin_layout Standard
16272 It is necessary to define the floats (
16273 \begin_inset Flex Noun
16276 \begin_layout Plain Layout
16283 \begin_inset Flex Noun
16286 \begin_layout Plain Layout
16292 , \SpecialChar ldots
16293 ) in the text class itself.
16294 Standard floats are included in the file
16295 \begin_inset Flex Code
16298 \begin_layout Plain Layout
16304 , so you may have to do no more than add
16307 \begin_layout LyX-Code
16308 Input stdfloats.inc
16311 \begin_layout Standard
16312 to your layout file.
16313 If you want to implement a text class that proposes some other float types
16314 (like the AGU class bundled with \SpecialChar LyX
16315 ), the information below will hopefully
16319 \begin_layout Description
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16330 \begin_inset Flex Code
16333 \begin_layout Plain Layout
16339 =!htbpH] Allowed placement options for this float type.
16340 The value is a string of placement characters.
16341 Possible characters include:
16346 \begin_inset Quotes eld
16350 \begin_inset Quotes erd
16358 \begin_inset Quotes eld
16362 \begin_inset Quotes erd
16370 \begin_inset Quotes eld
16374 \begin_inset Quotes erd
16382 \begin_inset Quotes eld
16386 \begin_inset Quotes erd
16394 \begin_inset Quotes eld
16398 \begin_inset Quotes erd
16406 \begin_inset Quotes eld
16410 \begin_inset Quotes erd
16414 The order of the characters in the string does not matter.
16415 If no placement options are allowed, use the string
16422 \begin_layout Description
16423 \begin_inset Flex Code
16426 \begin_layout Plain Layout
16433 \begin_inset Flex Code
16436 \begin_layout Plain Layout
16445 \begin_inset space \thinspace{}
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16464 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16471 \begin_inset Flex Code
16474 \begin_layout Plain Layout
16480 if the float does not support this feature.
16483 \begin_layout Description
16484 \begin_inset Flex Code
16487 \begin_layout Plain Layout
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16506 \begin_inset space \thinspace{}
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16525 ] Defines whether the float has a starred variant that spans columns in
16526 a two column paragraph.
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16537 if the float does not support this feature.
16540 \begin_layout Description
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16551 \begin_inset Flex Code
16554 \begin_layout Plain Layout
16561 \begin_inset Quotes erd
16565 \begin_inset Quotes erd
16568 ] The file name extension of an auxiliary file for the list of figures (or
16571 writes the captions to this file.
16574 \begin_layout Description
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16585 \begin_inset Flex Code
16588 \begin_layout Plain Layout
16595 \begin_inset Quotes erd
16599 \begin_inset Quotes erd
16602 ] The string that will be used in the menus and also for the caption.
16603 This is translated to the current language if babel is used.
16606 \begin_layout Description
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16616 These tags control the XHTML output.
16618 \begin_inset CommandInset ref
16620 reference "sec:Tags-for-XHTML"
16627 \begin_layout Description
16628 \begin_inset Flex Code
16631 \begin_layout Plain Layout
16640 \begin_inset Flex Code
16643 \begin_layout Plain Layout
16652 \begin_inset space \thinspace{}
16656 \begin_inset Flex Code
16659 \begin_layout Plain Layout
16665 ] Indicates whether the float is already defined in the document class or
16666 if instead the \SpecialChar LaTeX
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16677 needs to be loaded to define it on-the-fly.
16679 \begin_inset Flex Code
16682 \begin_layout Plain Layout
16689 \begin_inset Flex Code
16692 \begin_layout Plain Layout
16699 It should be set to
16700 \begin_inset Flex Code
16703 \begin_layout Plain Layout
16709 if the float is already defined by the \SpecialChar LaTeX
16713 \begin_layout Description
16714 \begin_inset Flex Code
16717 \begin_layout Plain Layout
16724 \begin_inset Flex Code
16727 \begin_layout Plain Layout
16734 \begin_inset Quotes erd
16738 \begin_inset Quotes erd
16741 ] The command used to generate a list of floats of this type; the leading
16750 \begin_inset Flex Code
16753 \begin_layout Plain Layout
16759 is false, since there is no standard way to generate this command.
16761 \begin_inset Flex Code
16764 \begin_layout Plain Layout
16770 is true, since in that case there is a standard way to define the command.
16773 \begin_layout Description
16774 \begin_inset Flex Code
16777 \begin_layout Plain Layout
16784 \begin_inset Flex Code
16787 \begin_layout Plain Layout
16794 \begin_inset Quotes erd
16798 \begin_inset Quotes erd
16801 ] A title for a list of floats of this kind (list of figures, tables, or
16803 It is used for the screen label within \SpecialChar LyX
16804 , it is used by \SpecialChar LaTeX
16806 it is used as the title in the XHTML output.
16807 It will be translated to the document language.
16810 \begin_layout Description
16811 \begin_inset Flex Code
16814 \begin_layout Plain Layout
16821 \begin_inset Flex Code
16824 \begin_layout Plain Layout
16831 \begin_inset Quotes erd
16835 \begin_inset Quotes erd
16838 ] This (optional) argument determines whether floats of this class will
16839 be numbered within some sectional unit of the document.
16841 \begin_inset Flex Code
16844 \begin_layout Plain Layout
16851 \begin_inset Quotes eld
16855 \begin_inset Flex Code
16858 \begin_layout Plain Layout
16865 \begin_inset Quotes erd
16868 , the floats will be numbered within chapters.
16872 \begin_layout Description
16873 \begin_inset Flex Code
16876 \begin_layout Plain Layout
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 \begin_inset Quotes erd
16897 \begin_inset Quotes erd
16900 ] The default placement for the given class of floats.
16901 The string should be as in standard \SpecialChar LaTeX
16903 \begin_inset Flex Code
16906 \begin_layout Plain Layout
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16923 \begin_inset Flex Code
16926 \begin_layout Plain Layout
16933 \begin_inset Flex Code
16936 \begin_layout Plain Layout
16942 for top, bottom, page, and here, respectively.
16946 \begin_layout Plain Layout
16947 Note that the order of these letters in the string is irrelevant, like in
16954 On top of that there is a new type,
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 , which does not really correspond to a float, since it means: put it
16965 \begin_inset Quotes eld
16969 \begin_inset Quotes erd
16973 Note however that the
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16983 specifier is special and, because of implementation details, cannot be
16984 used in non-built in float types.
16985 If you do not understand what this means, just use
16986 \begin_inset Quotes eld
16990 \begin_inset Flex Code
16993 \begin_layout Plain Layout
17000 \begin_inset Quotes erd
17006 \begin_layout Description
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17026 ] The prefix to use when creating labels referring to floats of this type.
17027 This allows the use of formatted references.
17028 Note that you can remove any
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17038 set by a copied style by using the special value
17039 \begin_inset Quotes eld
17043 \begin_inset Quotes erd
17046 , which must be all caps.
17049 \begin_layout Description
17050 \begin_inset Flex Code
17053 \begin_layout Plain Layout
17060 \begin_inset Flex Code
17063 \begin_layout Plain Layout
17070 \begin_inset Quotes erd
17074 \begin_inset Quotes erd
17077 ] The style used when defining the float using
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17092 \begin_layout Description
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17113 \begin_inset Quotes erd
17117 \begin_inset Quotes erd
17121 \begin_inset Quotes eld
17125 \begin_inset Quotes erd
17128 of the new class of floats, like program or algorithm.
17129 After the appropriate
17130 \begin_inset Flex Code
17133 \begin_layout Plain Layout
17142 \begin_inset Flex Code
17145 \begin_layout Plain Layout
17154 \begin_inset Flex Code
17157 \begin_layout Plain Layout
17168 \begin_layout Description
17169 \begin_inset Flex Code
17172 \begin_layout Plain Layout
17179 \begin_inset Flex Code
17182 \begin_layout Plain Layout
17189 \begin_inset space \thinspace{}
17193 \begin_inset Flex Code
17196 \begin_layout Plain Layout
17204 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17206 \begin_inset Flex Code
17209 \begin_layout Plain Layout
17215 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17219 \begin_layout Standard
17220 Note that defining a float with type
17221 \begin_inset Flex Code
17224 \begin_layout Plain Layout
17232 automatically defines the corresponding counter with name
17233 \begin_inset Flex Code
17236 \begin_layout Plain Layout
17247 \begin_layout Subsection
17248 Flex insets and InsetLayout
17249 \begin_inset CommandInset label
17251 name "subsec:Flex-insets-and"
17258 \begin_layout Standard
17259 Flex insets come in three different kinds:
17262 \begin_layout Itemize
17264 \begin_inset Flex Code
17267 \begin_layout Plain Layout
17273 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17275 \begin_inset Flex Code
17278 \begin_layout Plain Layout
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17301 \begin_layout Itemize
17303 \begin_inset Flex Code
17306 \begin_layout Plain Layout
17312 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17314 footnote, and the like.
17315 An obvious example is an endnote inset, which is defined in the
17316 \begin_inset Flex Code
17319 \begin_layout Plain Layout
17328 \begin_layout Itemize
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17339 ): For use with DocBook classes.
17342 \begin_layout Standard
17343 Flex insets are defined using the
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17353 tag, which shall be explained in a moment.
17356 \begin_layout Standard
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 tag also serves another function: It can be used to customize the general
17368 layout of many different types of insets.
17370 \begin_inset Flex Code
17373 \begin_layout Plain Layout
17379 can be used to customize the layout parameters for footnotes, marginal
17380 notes, note insets, \SpecialChar TeX
17381 code (ERT) insets, branches, listings, indexes, boxes,
17382 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17385 \begin_layout Standard
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17396 definition must begin with a line of the form:
17399 \begin_layout LyX-Code
17403 \begin_layout Standard
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17414 indicates the inset whose layout is being defined, and here there are four
17418 \begin_layout Enumerate
17419 The layout for a pre-existing inset is being modified.
17420 In this case, can be
17421 \begin_inset Flex Code
17424 \begin_layout Plain Layout
17430 any one of the following:
17431 \begin_inset Flex Code
17434 \begin_layout Plain Layout
17441 \begin_inset Flex Code
17444 \begin_layout Plain Layout
17451 \begin_inset Flex Code
17454 \begin_layout Plain Layout
17461 \begin_inset Flex Code
17464 \begin_layout Plain Layout
17471 \begin_inset Flex Code
17474 \begin_layout Plain Layout
17481 \begin_inset Flex Code
17484 \begin_layout Plain Layout
17491 \begin_inset Flex Code
17494 \begin_layout Plain Layout
17501 \begin_inset Flex Code
17504 \begin_layout Plain Layout
17511 \begin_inset Flex Code
17514 \begin_layout Plain Layout
17521 \begin_inset Flex Code
17524 \begin_layout Plain Layout
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17551 \begin_inset Flex Code
17554 \begin_layout Plain Layout
17561 \begin_inset Flex Code
17564 \begin_layout Plain Layout
17571 \begin_inset Flex Code
17574 \begin_layout Plain Layout
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17591 \begin_inset Flex Code
17594 \begin_layout Plain Layout
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17633 \begin_layout Enumerate
17634 The layout for a Flex inset is being defined.
17636 \begin_inset Flex Code
17639 \begin_layout Plain Layout
17645 must be of the form
17646 \begin_inset Quotes eld
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17660 \begin_inset Quotes erd
17664 \begin_inset Flex Code
17667 \begin_layout Plain Layout
17673 may be be any valid identifier not used by a pre-existing Flex inset.
17674 The identifier may include spaces, but in that case the whole thing must
17675 be wrapped in quotes.
17676 Note that the definition of a flex inset
17681 \begin_inset Flex Code
17684 \begin_layout Plain Layout
17690 entry, declaring which type of inset it defines.
17693 \begin_layout Enumerate
17694 The layout for user specific branch is being defined.
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17705 must be of the form
17706 \begin_inset Quotes eld
17710 \begin_inset Flex Code
17713 \begin_layout Plain Layout
17720 \begin_inset Quotes erd
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17733 may be be any valid identifier of branch defined in user's document.
17734 The identifier may include spaces, but in that case the whole thing must
17735 be wrapped in quotes.
17736 The main purpose of this feature is to allow \SpecialChar LaTeX
17737 wrapping around specific
17738 branches as user needs.
17741 \begin_layout Enumerate
17742 The layout of a user (or class) specific caption is being defined.
17744 \begin_inset Flex Code
17747 \begin_layout Plain Layout
17753 must be of the form
17754 \begin_inset Quotes eld
17758 \begin_inset Flex Code
17761 \begin_layout Plain Layout
17768 \begin_inset Quotes erd
17772 \begin_inset Flex Code
17775 \begin_layout Plain Layout
17781 specifies the name of the caption as it appears in the menu.
17782 Have a look at the standard caption (
17783 \begin_inset Flex Code
17786 \begin_layout Plain Layout
17792 ), the specific captions of the KOMA-Script classes (
17793 \begin_inset Flex Code
17796 \begin_layout Plain Layout
17803 \begin_inset Flex Code
17806 \begin_layout Plain Layout
17815 \begin_inset space ~
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17830 ) for applications.
17833 \begin_layout Standard
17835 \begin_inset Flex Code
17838 \begin_layout Plain Layout
17844 definition can contain the following entries:
17847 \begin_layout Description
17848 \begin_inset Flex Code
17851 \begin_layout Plain Layout
17858 \begin_inset Flex Code
17861 \begin_layout Plain Layout
17867 =""] This inset will appear in the table of contents of the given type.
17868 An empty string disables.
17869 See also the OutlinerName and the IsTocCaption commands.
17870 This is only implemented for Flex insets.
17874 \begin_layout Description
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17885 \begin_inset Flex Code
17888 \begin_layout Plain Layout
17894 ] Defines argument number of a command\SpecialChar breakableslash
17895 environment associated with the current
17897 The definition must end with
17898 \begin_inset Flex Code
17901 \begin_layout Plain Layout
17909 \begin_inset CommandInset ref
17911 reference "subsec:Paragraph-Styles"
17918 \begin_layout Description
17919 \begin_inset Flex Code
17922 \begin_layout Plain Layout
17928 Preamble for changing language commands; see
17929 \begin_inset CommandInset ref
17931 reference "subsec:I18n"
17938 \begin_layout Description
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17949 \begin_inset Flex Code
17952 \begin_layout Plain Layout
17958 ] The color for the inset's background.
17960 \begin_inset CommandInset ref
17962 reference "chap:Names-of-colors"
17966 for a list of the available color names.
17969 \begin_layout Description
17970 \begin_inset Flex Code
17973 \begin_layout Plain Layout
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17992 \begin_inset space \thinspace{}
17996 \begin_inset Flex Code
17999 \begin_layout Plain Layout
18005 ] Whether to use the content of the inset as the label, when the inset is
18010 \begin_layout Description
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18030 ] As with paragraph styles, see
18031 \begin_inset CommandInset ref
18033 reference "subsec:Paragraph-Styles"
18038 Note that you need to specify the complete type, e.
18039 \begin_inset space \thinspace{}
18043 \begin_inset space ~
18047 \begin_inset Flex Code
18050 \begin_layout Plain Layout
18051 CopyStyle Flex:<name>
18059 \begin_layout Description
18060 \begin_inset Flex Code
18063 \begin_layout Plain Layout
18070 \begin_inset Flex Code
18073 \begin_layout Plain Layout
18082 \begin_inset space \thinspace{}
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18095 ] Indicates whether the user may employ the Paragraph Settings dialog to
18096 customize the paragraph.
18099 \begin_layout Description
18100 \begin_inset Flex Code
18103 \begin_layout Plain Layout
18110 \begin_inset Flex Code
18113 \begin_layout Plain Layout
18120 \begin_inset Flex Code
18123 \begin_layout Plain Layout
18130 \begin_inset Flex Code
18133 \begin_layout Plain Layout
18139 , describing the rendering style used for the inset's frame and buttons.
18140 Footnotes generally use
18141 \begin_inset Flex Code
18144 \begin_layout Plain Layout
18150 , ERT insets generally
18151 \begin_inset Flex Code
18154 \begin_layout Plain Layout
18160 , and character styles
18161 \begin_inset Flex Code
18164 \begin_layout Plain Layout
18173 \begin_layout Description
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18184 \begin_inset Flex Code
18187 \begin_layout Plain Layout
18196 \begin_inset space \thinspace{}
18202 \begin_inset Flex Code
18205 \begin_layout Plain Layout
18214 \begin_inset Flex Code
18217 \begin_layout Plain Layout
18224 \begin_inset Flex Code
18227 \begin_layout Plain Layout
18234 Indicates whether the environment will stand on its own in the output or
18235 will appear inline with the surrounding text.
18236 If set to false, it is supposed that the \SpecialChar LaTeX
18237 environment ignores white space
18238 (including one newline character) after the
18239 \begin_inset Flex Code
18242 \begin_layout Plain Layout
18255 \begin_inset Flex Code
18258 \begin_layout Plain Layout
18274 \begin_layout Description
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18284 Required at the end of the
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18297 \begin_layout Description
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18307 The font used for both the text body
18313 \begin_inset CommandInset ref
18315 reference "subsec:Font-description"
18320 Note that defining this font automatically defines the
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18330 to the same value, so define this first and define
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18340 later if you want them to be different.
18343 \begin_layout Description
18344 \begin_inset Flex Code
18347 \begin_layout Plain Layout
18348 FixedWidthPreambleEncoding
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18366 \begin_inset space \thinspace{}
18370 \begin_inset Flex Code
18373 \begin_layout Plain Layout
18379 ] Force a fixed width encoding for the translated contents of
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18390 \begin_inset Flex Code
18393 \begin_layout Plain Layout
18399 code generated by this layout.
18400 This is needed for special \SpecialChar LaTeX
18405 that do not work with variable width encodings such as
18410 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18411 backends such as Xe\SpecialChar TeX
18413 Lua\SpecialChar TeX
18417 \begin_layout Description
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18422 ForceLocalFontSwitch
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18440 \begin_inset space \thinspace{}
18444 \begin_inset Flex Code
18447 \begin_layout Plain Layout
18453 ] When using babel, always use a local font switch (
18454 \begin_inset Flex Code
18457 \begin_layout Plain Layout
18465 ), never a global one (such as
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18480 \begin_layout Description
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18491 \begin_inset Flex Code
18494 \begin_layout Plain Layout
18503 \begin_inset space \thinspace{}
18507 \begin_inset Flex Code
18510 \begin_layout Plain Layout
18517 \begin_inset Quotes eld
18521 \begin_inset Quotes erd
18524 language, leading to Left-to-Right (Latin) output, e.
18525 \begin_inset space \thinspace{}
18529 \begin_inset space \space{}
18532 in \SpecialChar TeX
18537 \begin_layout Description
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18560 \begin_inset space \thinspace{}
18564 \begin_inset Flex Code
18567 \begin_layout Plain Layout
18573 ] Force a a line break in the \SpecialChar LaTeX
18574 output before the inset starts and after
18576 This assures the inset itself is output on its own lines, for parsing purposes.
18579 \begin_layout Description
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18590 \begin_inset Flex Code
18593 \begin_layout Plain Layout
18602 \begin_inset space \thinspace{}
18606 \begin_inset Flex Code
18609 \begin_layout Plain Layout
18615 ] Indicates whether the
18616 \begin_inset Flex Code
18619 \begin_layout Plain Layout
18625 should be used or, instead, the user can change the paragraph style used
18630 \begin_layout Description
18631 \begin_inset Flex Code
18634 \begin_layout Plain Layout
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18653 \begin_inset space \thinspace{}
18657 \begin_inset Flex Code
18660 \begin_layout Plain Layout
18666 ] As with paragraph styles, see
18667 \begin_inset CommandInset ref
18669 reference "subsec:Paragraph-Styles"
18676 \begin_layout Description
18677 \begin_inset Flex Code
18680 \begin_layout Plain Layout
18686 These tags control the XHTML output.
18688 \begin_inset CommandInset ref
18690 reference "sec:Tags-for-XHTML"
18697 \begin_layout Description
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18720 \begin_inset space \thinspace{}
18724 \begin_inset Flex Code
18727 \begin_layout Plain Layout
18733 ] Whether to include the contents of this inset in the strings generated
18734 for the `Outline' pane for all table of contents, regardless of the AddToToc
18736 One would not, for example, want the content of a footnote in a section
18737 header to be included in the TOC displayed in the outline, but one would
18738 normally want the content of a character style displayed.
18739 Default is false: not to include.
18742 \begin_layout Description
18743 \begin_inset Flex Code
18746 \begin_layout Plain Layout
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18765 \begin_inset space \thinspace{}
18769 \begin_inset Flex Code
18772 \begin_layout Plain Layout
18778 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18779 of its contents in its item in the table of contents.
18780 Otherwise, only the label appears.
18783 \begin_layout Description
18784 \begin_inset Flex Code
18787 \begin_layout Plain Layout
18796 \begin_inset Flex Code
18799 \begin_layout Plain Layout
18808 \begin_inset space \thinspace{}
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18821 ] As with paragraph styles, see
18822 \begin_inset CommandInset ref
18824 reference "subsec:Paragraph-Styles"
18831 \begin_layout Description
18832 \begin_inset Flex Code
18835 \begin_layout Plain Layout
18841 The font used for the label.
18843 \begin_inset CommandInset ref
18845 reference "subsec:Font-description"
18850 Note that this definition can never appear before
18851 \begin_inset Flex Code
18854 \begin_layout Plain Layout
18860 , lest it be ineffective.
18863 \begin_layout Description
18864 \begin_inset Flex Code
18867 \begin_layout Plain Layout
18874 \begin_inset Flex Code
18877 \begin_layout Plain Layout
18884 \begin_inset Quotes erd
18888 \begin_inset Quotes erd
18891 ] What will be displayed on the button or elsewhere as the inset label.
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18904 \begin_inset Flex Code
18907 \begin_layout Plain Layout
18913 ) modify this label on the fly.
18916 \begin_layout Description
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18926 Language dependent preamble; see
18927 \begin_inset CommandInset ref
18929 reference "subsec:I18n"
18936 \begin_layout Description
18937 \begin_inset Flex Code
18940 \begin_layout Plain Layout
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18956 ] The name of the corresponding \SpecialChar LaTeX
18958 Either the environment or command name.
18961 \begin_layout Description
18962 \begin_inset Flex Code
18965 \begin_layout Plain Layout
18972 \begin_inset Flex Code
18975 \begin_layout Plain Layout
18981 ] The optional parameter for the corresponding
18982 \begin_inset Flex Code
18985 \begin_layout Plain Layout
18991 stuff, including possible bracket pairs like
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19002 This parameter cannot be changed from within \SpecialChar LyX
19004 \begin_inset Flex Code
19007 \begin_layout Plain Layout
19013 for customizable parameters).
19014 It will be output as is after all \SpecialChar LaTeX
19016 \begin_inset Flex Code
19019 \begin_layout Plain Layout
19028 \begin_layout Description
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19039 \begin_inset Flex Code
19042 \begin_layout Plain Layout
19043 Command, Environment, None
19048 ] How the style should be translated into \SpecialChar LaTeX
19053 \begin_layout Plain Layout
19054 \begin_inset Flex Code
19057 \begin_layout Plain Layout
19063 is perhaps a bit misleading, since these rules apply to SGML classes too.
19064 Visit the SGML class files for specific examples.
19073 \begin_layout Description
19074 \begin_inset Flex Code
19077 \begin_layout Plain Layout
19083 means nothing special
19086 \begin_layout Description
19087 \begin_inset Flex Code
19090 \begin_layout Plain Layout
19097 \begin_inset Flex Code
19100 \begin_layout Plain Layout
19107 {\SpecialChar ldots
19116 \begin_layout Description
19117 \begin_inset Flex Code
19120 \begin_layout Plain Layout
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19137 }\SpecialChar ldots
19152 \begin_layout Standard
19153 Putting the last few things together, the \SpecialChar LaTeX
19154 output will be either:
19157 \begin_layout LyX-Code
19160 LatexName[LatexParam]{\SpecialChar ldots
19164 \begin_layout Standard
19168 \begin_layout LyX-Code
19171 begin{LatexName}[LatexParam] \SpecialChar ldots
19177 \begin_layout Standard
19178 depending upon the \SpecialChar LaTeX
19183 \begin_layout Description
19184 \begin_inset Flex Code
19187 \begin_layout Plain Layout
19194 \begin_inset Flex Code
19197 \begin_layout Plain Layout
19203 ] A string that is put at the beginning of the layout content.
19204 A line break in the output can be indicated by
19205 \begin_inset Flex Code
19208 \begin_layout Plain Layout
19217 \begin_layout Description
19218 \begin_inset Flex Code
19221 \begin_layout Plain Layout
19228 \begin_inset Flex Code
19231 \begin_layout Plain Layout
19238 \begin_inset Flex Code
19241 \begin_layout Plain Layout
19248 \begin_inset Flex Code
19251 \begin_layout Plain Layout
19258 \begin_inset Flex Code
19261 \begin_layout Plain Layout
19267 (indicating a dummy definition ending definitions of charstyles, etc).
19268 This entry is required in and is only meaningful for Flex insets.
19269 Among other things, it determines on which menu this inset will appear.
19271 \begin_inset Flex Code
19274 \begin_layout Plain Layout
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19290 will automatically set
19291 \begin_inset Flex Code
19294 \begin_layout Plain Layout
19301 \begin_inset Flex Code
19304 \begin_layout Plain Layout
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19321 can be set to true, or
19322 \begin_inset Flex Code
19325 \begin_layout Plain Layout
19332 \begin_inset Flex Code
19335 \begin_layout Plain Layout
19341 insets by setting it
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19358 \begin_layout Description
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19369 \begin_inset Flex Code
19372 \begin_layout Plain Layout
19381 \begin_inset space \thinspace{}
19385 \begin_inset Flex Code
19388 \begin_layout Plain Layout
19394 ] Whether multiple paragraphs are permitted in this inset.
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19405 to the same value and
19406 \begin_inset Flex Code
19409 \begin_layout Plain Layout
19415 to the opposite value.
19416 These can be reset to other values, if they are used
19421 \begin_inset Flex Code
19424 \begin_layout Plain Layout
19434 \begin_layout Description
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19457 \begin_inset space \thinspace{}
19461 \begin_inset Flex Code
19464 \begin_layout Plain Layout
19470 ] Whether fragile commands in this inset should be
19471 \begin_inset Flex Code
19474 \begin_layout Plain Layout
19487 whether the command should itself be protected.) Default is false.
19490 \begin_layout Description
19491 \begin_inset Flex Code
19494 \begin_layout Plain Layout
19501 \begin_inset Flex Code
19504 \begin_layout Plain Layout
19510 ] Deletes an existing
19511 \begin_inset Flex Code
19514 \begin_layout Plain Layout
19523 \begin_layout Description
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19534 \begin_inset Flex Code
19537 \begin_layout Plain Layout
19544 \begin_inset Flex Code
19547 \begin_layout Plain Layout
19553 that has replaced this
19554 \begin_inset Flex Code
19557 \begin_layout Plain Layout
19564 This is used to rename an
19565 \begin_inset Flex Code
19568 \begin_layout Plain Layout
19574 , while keeping backward compatibility.
19577 \begin_layout Description
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19588 \begin_inset Flex Code
19591 \begin_layout Plain Layout
19600 \begin_inset space \thinspace{}
19604 \begin_inset Flex Code
19607 \begin_layout Plain Layout
19613 ] As with paragraph styles, see
19614 \begin_inset CommandInset ref
19616 reference "subsec:Paragraph-Styles"
19624 \begin_layout Description
19625 \begin_inset Flex Code
19628 \begin_layout Plain Layout
19635 \begin_inset Flex Code
19638 \begin_layout Plain Layout
19647 \begin_inset space \thinspace{}
19651 \begin_inset Flex Code
19654 \begin_layout Plain Layout
19660 ] As with paragraph styles, see
19661 \begin_inset CommandInset ref
19663 reference "subsec:Paragraph-Styles"
19671 \begin_layout Description
19672 \begin_inset Flex Code
19675 \begin_layout Plain Layout
19681 As with paragraph styles, see
19682 \begin_inset CommandInset ref
19684 reference "subsec:Paragraph-Styles"
19691 \begin_layout Description
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19711 ] The prefix to use when creating labels referring to insets of this type.
19712 This allows the use of formatted references.
19715 \begin_layout Description
19716 \begin_inset Flex Code
19719 \begin_layout Plain Layout
19726 \begin_inset Flex Code
19729 \begin_layout Plain Layout
19735 ] As with paragraph styles, see
19736 \begin_inset CommandInset ref
19738 reference "subsec:Paragraph-Styles"
19745 \begin_layout Description
19746 \begin_inset Flex Code
19749 \begin_layout Plain Layout
19756 \begin_inset Flex Code
19759 \begin_layout Plain Layout
19768 \begin_inset space \thinspace{}
19772 \begin_inset Flex Code
19775 \begin_layout Plain Layout
19781 ] Resets the \SpecialChar LaTeX
19782 arguments of this layout (as defined via the
19783 \begin_inset Flex Code
19786 \begin_layout Plain Layout
19793 This is useful if you have copied a style via
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19803 , but you do not want to inherit its (required and optional) arguments.
19806 \begin_layout Description
19807 \begin_inset Flex Code
19810 \begin_layout Plain Layout
19817 \begin_inset Flex Code
19820 \begin_layout Plain Layout
19827 \begin_inset space \thinspace{}
19831 \begin_inset Flex Code
19834 \begin_layout Plain Layout
19842 ] Whether this inset should use the font of its surrounding environment
19844 Default is false: use the font of the surrounding environment.
19847 \begin_layout Description
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19867 ] A string that is put at the end of the layout content.
19868 A line break in the output can be indicated by
19869 \begin_inset Flex Code
19872 \begin_layout Plain Layout
19881 \begin_layout Description
19882 \begin_inset Flex Code
19885 \begin_layout Plain Layout
19892 \begin_inset Flex Code
19895 \begin_layout Plain Layout
19902 \begin_inset space \thinspace{}
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19917 ] Allow spell-checking the contents of this inset.
19921 \begin_layout Subsection
19923 \begin_inset CommandInset label
19925 name "subsec:Counters"
19932 \begin_layout Standard
19933 It is necessary to define the counters (
19934 \begin_inset Flex Noun
19937 \begin_layout Plain Layout
19944 \begin_inset Flex Noun
19947 \begin_layout Plain Layout
19953 , \SpecialChar ldots
19954 ) in the text class itself.
19955 The standard counters are defined in the file
19956 \begin_inset Flex Code
19959 \begin_layout Plain Layout
19965 , so you may have to do no more than add
19968 \begin_layout LyX-Code
19969 Input stdcounters.inc
19972 \begin_layout Standard
19973 to your layout file to get them to work.
19974 But if you want to define custom counters, then you can do so.
19975 The counter declaration must begin with:
19978 \begin_layout LyX-Code
19979 Counter CounterName
19982 \begin_layout Standard
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19993 ' is replaced by the name of the counter.
19994 And it must end with
19995 \begin_inset Quotes eld
19999 \begin_inset Flex Code
20002 \begin_layout Plain Layout
20009 \begin_inset Quotes erd
20013 The following parameters can also be used:
20016 \begin_layout Description
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20036 ] Sets the initial value for the counter, to which it will be reset whenever
20038 Normally, one will want the default, 1.
20041 \begin_layout Description
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20052 \begin_inset Flex Code
20055 \begin_layout Plain Layout
20062 \begin_inset Quotes erd
20066 \begin_inset Quotes erd
20069 ] When defined, this string defines how the counter is displayed.
20070 Setting this value sets
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20075 LabelStringAppendix
20081 The following special constructs can be used in the string:
20085 \begin_layout Itemize
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20097 will be replaced by the expansion of the
20098 \begin_inset Flex Code
20101 \begin_layout Plain Layout
20108 \begin_inset Flex Code
20111 \begin_layout Plain Layout
20112 LabelStringAppendix
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20131 \begin_layout Itemize
20132 counter values can be expressed using \SpecialChar LaTeX
20134 \begin_inset Newline newline
20138 \begin_inset Flex Code
20141 \begin_layout Plain Layout
20158 \begin_inset Flex Code
20161 \begin_layout Plain Layout
20173 \begin_layout Plain Layout
20183 Actually, the situation is a bit more complicated: any
20202 other than those described below will produce arabic numerals.
20203 It would not be surprising to see this change in the future.
20209 \begin_inset Flex Code
20212 \begin_layout Plain Layout
20218 : 1, 2, 3,\SpecialChar ldots
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20229 for lower-case letters: a, b, c, \SpecialChar ldots
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20240 for upper-case letters: A, B, C, \SpecialChar ldots
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20251 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20262 for upper-case roman numerals: I, II, III\SpecialChar ldots
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20273 for hebrew numerals.
20277 \begin_layout Standard
20278 If LabelString is not defined, a default value is constructed as follows:
20279 if the counter has a master counter
20280 \begin_inset Flex Code
20283 \begin_layout Plain Layout
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20300 \begin_inset Newline newline
20304 \begin_inset Flex Code
20307 \begin_layout Plain Layout
20317 is used; otherwise the string
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20332 \begin_layout Description
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20337 LabelStringAppendix
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20353 \begin_inset Quotes erd
20357 \begin_inset Quotes erd
20361 \begin_inset Flex Code
20364 \begin_layout Plain Layout
20370 , but for use in the Appendix.
20373 \begin_layout Description
20374 \begin_inset Flex Code
20377 \begin_layout Plain Layout
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20394 \begin_inset Quotes erd
20398 \begin_inset Quotes erd
20401 ] A format for use with formatted references to this counter.
20402 For example, one might want to have references to section numbers appear
20404 \begin_inset Quotes eld
20408 \begin_inset Quotes erd
20412 The string should contain
20413 \begin_inset Quotes eld
20417 \begin_inset Quotes erd
20421 This will be replaced by the counter number itself.
20422 So, for sections, it would be: Section ##.
20425 \begin_layout Description
20426 \begin_inset Flex Code
20429 \begin_layout Plain Layout
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20446 \begin_inset Quotes erd
20450 \begin_inset Quotes erd
20453 ] If this is set to the name of another counter, the present counter will
20454 be reset every time the other one is increased.
20456 \begin_inset Flex Code
20459 \begin_layout Plain Layout
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20478 \begin_layout Subsection
20480 \begin_inset CommandInset label
20482 name "subsec:Font-description"
20489 \begin_layout Standard
20490 A font description looks like this:
20493 \begin_layout LyX-Code
20510 \begin_layout LyX-Code
20514 \begin_layout LyX-Code
20518 \begin_layout Standard
20519 The following commands are available:
20522 \begin_layout Description
20523 \begin_inset Flex Code
20526 \begin_layout Plain Layout
20533 \begin_inset Flex Code
20536 \begin_layout Plain Layout
20545 \begin_inset Flex Code
20548 \begin_layout Plain Layout
20555 \begin_inset Flex Code
20558 \begin_layout Plain Layout
20565 \begin_inset Flex Code
20568 \begin_layout Plain Layout
20575 \begin_inset Flex Code
20578 \begin_layout Plain Layout
20585 \begin_inset Flex Code
20588 \begin_layout Plain Layout
20595 \begin_inset Flex Code
20598 \begin_layout Plain Layout
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20615 \begin_inset Flex Code
20618 \begin_layout Plain Layout
20625 \begin_inset Flex Code
20628 \begin_layout Plain Layout
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20645 \begin_inset Flex Code
20648 \begin_layout Plain Layout
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20665 \begin_inset Flex Code
20668 \begin_layout Plain Layout
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20725 \begin_inset Flex Code
20728 \begin_layout Plain Layout
20737 \begin_layout Description
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20760 \begin_inset Flex Code
20763 \begin_layout Plain Layout
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20782 \begin_layout Description
20783 \begin_inset Flex Code
20786 \begin_layout Plain Layout
20793 \begin_inset Flex Code
20796 \begin_layout Plain Layout
20802 ] Valid arguments are:
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20823 \begin_inset Flex Code
20826 \begin_layout Plain Layout
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20843 \begin_inset Flex Code
20846 \begin_layout Plain Layout
20853 \begin_inset Flex Code
20856 \begin_layout Plain Layout
20863 \begin_inset Flex Code
20866 \begin_layout Plain Layout
20873 \begin_inset Flex Code
20876 \begin_layout Plain Layout
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20903 \begin_inset Flex Code
20906 \begin_layout Plain Layout
20913 \begin_inset Flex Code
20916 \begin_layout Plain Layout
20923 Each of these turns on or off the corresponding attribute.
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20934 turns on emphasis, and
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20946 \begin_inset Newline newline
20949 If the latter seems puzzling, remember that the font settings for the present
20950 context are generally inherited from the surrounding context.
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20961 would turn off the emphasis that was anyway in effect, say, in a theorem
20965 \begin_layout Description
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
21000 \begin_layout Description
21001 \begin_inset Flex Code
21004 \begin_layout Plain Layout
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21043 \begin_inset Flex Code
21046 \begin_layout Plain Layout
21055 \begin_layout Description
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21076 \begin_inset Flex Code
21079 \begin_layout Plain Layout
21086 \begin_inset Flex Code
21089 \begin_layout Plain Layout
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21150 \begin_layout Subsection
21151 \begin_inset CommandInset label
21153 name "subsec:Citation-engine-description"
21157 Cite engine description
21160 \begin_layout Standard
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21171 blocks, as used mainly in cite engine files (see
21172 \begin_inset CommandInset ref
21174 reference "subsec:Cite-Engine-Files"
21181 ), define the citation commands provided by a specific
21182 \begin_inset Quotes eld
21186 \begin_inset Quotes erd
21190 A cite engine, in \SpecialChar LyX
21191 terms, is way specific way to format citations, using
21192 numbers, author names and/or years.
21193 Currently, \SpecialChar LyX
21194 supports three such engine types, namely:
21197 \begin_layout Enumerate
21198 \begin_inset Flex Code
21201 \begin_layout Plain Layout
21207 : the default Bib\SpecialChar TeX
21208 way to format citations, a simple numeric style (e.
21209 \begin_inset space \thinspace{}
21213 \begin_inset Quotes eld
21217 \begin_inset Quotes erd
21223 \begin_layout Enumerate
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21233 : Harvard-styled citations using author names and publication year (e.
21234 \begin_inset space \thinspace{}
21238 \begin_inset Quotes eld
21241 Smith and Miller (2017b)
21242 \begin_inset Quotes erd
21248 \begin_layout Enumerate
21249 \begin_inset Flex Code
21252 \begin_layout Plain Layout
21258 : extended numerical citations that also allow for author or title next
21260 \begin_inset space \thinspace{}
21264 \begin_inset Quotes eld
21267 Smith and Miller [1]
21268 \begin_inset Quotes erd
21274 \begin_layout Standard
21275 \begin_inset Flex Code
21278 \begin_layout Plain Layout
21284 blocks look like this:
21287 \begin_layout LyX-Code
21291 \begin_layout LyX-Code
21295 \begin_layout LyX-Code
21299 \begin_layout LyX-Code
21300 citeyearpar[][]=parencite*
21303 \begin_layout LyX-Code
21307 \begin_layout LyX-Code
21311 \begin_layout Standard
21313 \begin_inset Flex Code
21316 \begin_layout Plain Layout
21322 denotes the engine.
21323 The individual lines respectively define a cite command or cite command
21324 paradigm supported by this engine.
21325 The line can be as simple as a cite command that is used both to name the
21326 respective \SpecialChar LyX
21327 command and the \SpecialChar LaTeX
21328 output or more complex in order to differentiate
21330 The full syntax is:
21333 \begin_layout LyX-Code
21334 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21337 \begin_layout Itemize
21338 \begin_inset Flex Code
21341 \begin_layout Plain Layout
21347 : The name as used in the
21348 \begin_inset Flex Code
21351 \begin_layout Plain Layout
21361 \begin_layout Standard
21362 For portability reasons, we try to use the same name for same-formatted
21363 commands in different cite packages (thus many names stem from natbib,
21364 and thus we need to differentiate a
21365 \begin_inset Flex Code
21368 \begin_layout Plain Layout
21374 sometimes, if the \SpecialChar LaTeX
21375 command names differ).
21379 \begin_layout Itemize
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21389 : a (comma-separated) list of commands that fall back to the given
21390 \begin_inset Flex Code
21393 \begin_layout Plain Layout
21399 in the current engine.
21400 This eases the switch of citation packages and engines.
21402 \begin_inset Flex Code
21405 \begin_layout Plain Layout
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21421 in layout definitions.
21424 \begin_layout Itemize
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21434 : The actual \SpecialChar LaTeX
21435 command that is output.
21439 \begin_layout Standard
21440 \begin_inset Flex Code
21443 \begin_layout Plain Layout
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21471 \begin_inset Flex Code
21474 \begin_layout Plain Layout
21480 will be output to \SpecialChar LaTeX
21484 \begin_layout Standard
21488 \begin_layout Itemize
21489 Capitalization indicates that the command also has a capitalized form (
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21515 These usually enforce up-casing of name prefixes (
21520 \begin_inset Formula $\Rightarrow$
21530 \begin_layout Itemize
21532 \begin_inset Flex Code
21535 \begin_layout Plain Layout
21541 indicate the number of optional arguments (there can be 0–2).
21544 \begin_layout Itemize
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21555 indicates there is a starred version of the command (
21556 \begin_inset Flex Code
21559 \begin_layout Plain Layout
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21585 \begin_layout Standard
21586 By default, the starred version means: Output all authors even if it should
21588 \begin_inset Quotes eld
21592 \begin_inset Quotes erd
21596 \begin_inset Flex Code
21599 \begin_layout Plain Layout
21608 \begin_layout Standard
21609 If the star has a different meaning for a given command, it can be specified
21611 \begin_inset Flex Code
21614 \begin_layout Plain Layout
21615 <!_stardesc!_stardesctooltip>
21621 Maximal two translatable macro keywords, marked by the prefix
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21632 The first points to the string that replaces the
21633 \begin_inset Quotes eld
21637 \begin_inset Quotes erd
21640 checkbox label in the citation dialog, the second one to an optional tool
21641 tip for this checkbox.
21645 \begin_layout Standard
21646 Note that these two macros have to be defined in a
21647 \begin_inset Flex Code
21650 \begin_layout Plain Layout
21656 (see next section), dropping the
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21666 from the prefix, like this:
21669 \begin_layout LyX-Code
21670 _stardesc Sta&rred command label
21673 \begin_layout LyX-Code
21674 _stardesctooltip Tooltip for the starred command checkbox.
21678 \begin_layout Itemize
21680 \begin_inset Flex Code
21683 \begin_layout Plain Layout
21689 indicates that this command features
21690 \begin_inset Quotes eld
21693 qualified citation lists
21694 \begin_inset Quotes erd
21702 -specific feature for multi-reference citations where an individual pre-
21703 and postnote can be given to each reference in the list.
21704 Please refer to the
21708 manual for details.
21711 \begin_layout Subsection
21712 \begin_inset CommandInset label
21714 name "subsec:Citation-format-description"
21718 Cite format description
21721 \begin_layout Standard
21723 \begin_inset Flex Code
21726 \begin_layout Plain Layout
21732 blocks are used to describe how bibliographic information should be displayed,
21733 both within \SpecialChar LyX
21734 itself (in the citation dialog and in tooltips, for example)
21735 and in XHTML output.
21736 Such a block might look like this:
21739 \begin_layout LyX-Code
21743 \begin_layout LyX-Code
21747 \begin_layout LyX-Code
21751 \begin_layout LyX-Code
21755 \begin_layout Standard
21759 \begin_layout LyX-Code
21763 \begin_layout LyX-Code
21767 \begin_layout LyX-Code
21771 \begin_layout LyX-Code
21775 \begin_layout Standard
21776 In the first case, the individual lines define how the bibliographic information
21777 associated with an article or book, respectively, is to be displayed, and
21778 such a definition can be given for any
21779 \begin_inset Quotes els
21783 \begin_inset Quotes ers
21786 that might be present in a Bib\SpecialChar TeX
21789 defines a default format in the source code that will be used if no specific
21790 definition has been given.
21792 predefines several formats in the file
21793 \begin_inset Flex Code
21796 \begin_layout Plain Layout
21802 , which is included in most of \SpecialChar LyX
21803 's document classes.
21806 \begin_layout Standard
21807 In the second case, the lines define how a specific citation command (in
21809 \begin_inset Flex Code
21812 \begin_layout Plain Layout
21821 \begin_inset Flex Code
21824 \begin_layout Plain Layout
21832 ) is to be displayed on the citation inset label, in the citation dialog,
21833 menu or XHTML output.
21835 defines such formats for the citation style variants it supports via
21837 Document\SpecialChar menuseparator
21838 Setting\SpecialChar menuseparator
21839 Bibliography\SpecialChar ldots
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21852 files that are shipped with \SpecialChar LyX
21854 \begin_inset CommandInset ref
21856 reference "subsec:Cite-Engine-Files"
21866 \begin_layout Standard
21867 The definitions use a simple language that allows Bib\SpecialChar TeX
21868 keys to be replaced
21870 Keys should be enclosed in
21871 \begin_inset Flex Code
21874 \begin_layout Plain Layout
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21891 So a simple definition might look like this:
21894 \begin_layout LyX-Code
21896 \begin_inset Quotes eld
21900 \begin_inset Quotes erd
21906 \begin_layout Standard
21907 This would print the author, followed by a comma, followed by the title,
21908 in quotes, followed by a period.
21911 \begin_layout Standard
21912 Of course, sometimes you may want to print a key only if it exists.
21913 This can be done by using a conditional construction, such as:
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21919 \begin_inset space ~
21929 \begin_inset Flex Code
21932 \begin_layout Plain Layout
21938 key exists, then print
21939 \begin_inset Quotes eld
21943 \begin_inset space ~
21947 \begin_inset Quotes erd
21950 followed by the volume key.
21951 It is also possible to have an else clause in the conditional, such as:
21952 \begin_inset Newline newline
21956 \begin_inset Flex Code
21959 \begin_layout Plain Layout
21960 {%author%[[%author%]][[%editor%, ed.]]}
21966 \begin_inset Newline newline
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21979 key is printed if it exists; otherwise, the editor key is printed, followed
21981 \begin_inset Quotes eld
21985 \begin_inset space ~
21989 \begin_inset Quotes erd
21992 Note that the key is again enclosed in
21993 \begin_inset Flex Code
21996 \begin_layout Plain Layout
22002 signs; the entire conditional is enclosed in braces; and the if and else
22003 clauses are enclosed in double brackets,
22004 \begin_inset Quotes eld
22008 \begin_inset Flex Code
22011 \begin_layout Plain Layout
22018 \begin_inset Quotes eld
22022 \begin_inset Quotes eld
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22036 \begin_inset Quotes erd
22040 There must be no space between any of these.
22043 \begin_layout Standard
22044 Next to the entry keys, there are some special keys that can be used for
22045 these conditionals:
22048 \begin_layout Itemize
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22053 {%dialog%[[true]][[false]]}
22059 \begin_inset Quotes eld
22063 \begin_inset Quotes erd
22066 part for dialogs and menus, the
22067 \begin_inset Quotes eld
22071 \begin_inset Quotes erd
22074 part for other contexts (workarea, export)
22077 \begin_layout Itemize
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22082 {%export%[[true]][[false]]}
22088 \begin_inset Quotes eld
22092 \begin_inset Quotes erd
22095 part for export and menus, the
22096 \begin_inset Quotes eld
22100 \begin_inset Quotes erd
22103 part for other contexts (workarea, dialog)
22106 \begin_layout Itemize
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22117 \begin_inset Quotes eld
22121 \begin_inset Quotes erd
22124 part if another item follows (e.
22125 \begin_inset space \thinspace{}
22128 g., in a citation with multiple keys)
22131 \begin_layout Itemize
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22136 {%second%[[true]][[false]]}
22142 \begin_inset Quotes eld
22146 \begin_inset Quotes erd
22149 if this is the second of multiple items, else the
22150 \begin_inset Quotes eld
22154 \begin_inset Quotes erd
22160 \begin_layout Itemize
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22165 {%ifstar%[[true]][[false]]}
22171 \begin_inset Quotes eld
22175 \begin_inset Quotes erd
22178 part for starred citation commands (such as
22179 \begin_inset Flex Code
22182 \begin_layout Plain Layout
22190 ), the false part for unstarred
22193 \begin_layout Itemize
22194 \begin_inset Flex Code
22197 \begin_layout Plain Layout
22198 {%ifentrytype:<type>%[[true]][[false]]}
22204 \begin_inset Quotes eld
22208 \begin_inset Quotes erd
22211 if the current entry type matches
22212 \begin_inset Flex Code
22215 \begin_layout Plain Layout
22221 , else the false part (e.g., in a citation definition:
22222 \begin_inset Flex Code
22225 \begin_layout Plain Layout
22226 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22234 \begin_layout Itemize
22235 \begin_inset Flex Code
22238 \begin_layout Plain Layout
22239 {%ifmultiple:<authortype>%[[true]][[false]]}
22245 \begin_inset Quotes eld
22249 \begin_inset Quotes erd
22252 if the current author type (author, editor etc.) has multiple authors, else
22253 the false part (e.g., in a bibliography definition:
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22258 {%ifmultiple:editor%[[eds.]][[ed.]]}
22266 \begin_layout Itemize
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22271 {%ifqualified%[[true]][[false]]}
22277 \begin_inset Quotes eld
22281 \begin_inset Quotes erd
22284 part if the current citation is a qualified citation list (a specific
22288 format for multi-reference citations), the false part if this is not the
22292 \begin_layout Standard
22294 \begin_inset Flex Code
22297 \begin_layout Plain Layout
22303 prints the author key as it is recorded in the bibliography file.
22304 This might not be what you want, since it will result in a string such
22306 \begin_inset Quotes eld
22309 Miller, Peter and Smith, Mary and White, Jane
22310 \begin_inset Quotes erd
22314 \begin_inset Quotes eld
22318 \begin_inset Quotes erd
22321 is used by Bib\SpecialChar TeX
22322 to delimit authors).
22324 therefore provides some methods to get properly formatted name lists (which
22325 will also get translated).
22326 The following keys are provided:
22329 \begin_layout Enumerate
22330 For name lists with pre- and surname, suitable for the main authors/editors
22331 of a bibliography item.
22333 \begin_inset Flex Code
22336 \begin_layout Plain Layout
22342 part denotes the kind of list that is requested (e.g.
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22357 \begin_layout Itemize
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22362 %abbrvnames:<nametype>%
22367 : Provides a name list which is abbreviated (with
22368 \begin_inset Quotes eld
22372 \begin_inset Quotes erd
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22388 \begin_layout Itemize
22389 \begin_inset Flex Code
22392 \begin_layout Plain Layout
22393 %fullnames:<nametype>%
22398 : Provides a full name list (never abbreviated with
22399 \begin_inset Quotes eld
22403 \begin_inset Quotes erd
22409 \begin_layout Itemize
22410 \begin_inset Flex Code
22413 \begin_layout Plain Layout
22414 %forceabbrvnames:<nametype>%
22419 : Provides a name list which is always abbreviated (with
22420 \begin_inset Quotes eld
22424 \begin_inset Quotes erd
22428 \begin_inset Flex Code
22431 \begin_layout Plain Layout
22441 \begin_layout Enumerate
22442 Alternative name lists with pre- and surname, if the order of pre- and surname
22443 inside the bibliography item differs (as in:
22444 \begin_inset Quotes eld
22447 Miller, John: Some text, in: Mary Smith, ed.: A volume
22448 \begin_inset Quotes erd
22455 \begin_layout Itemize
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22460 %abbrvbynames:<nametype>%
22465 : Provides a name list which is abbreviated (with
22466 \begin_inset Quotes eld
22470 \begin_inset Quotes erd
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22486 \begin_layout Itemize
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22491 %fullbynames:<nametype>%
22496 : Provides a full name list (never abbreviated with
22497 \begin_inset Quotes eld
22501 \begin_inset Quotes erd
22507 \begin_layout Itemize
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22512 %forceabbrvbynames:<nametype>%
22517 : Provides a name list which is always abbreviated (with
22518 \begin_inset Quotes eld
22522 \begin_inset Quotes erd
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22539 \begin_layout Enumerate
22540 And finally name lists which consist of family names only, as used in author-yea
22542 These do not take a
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22552 part, but always return either an author list or, if this does not exist,
22553 an editor list (as common in author-year labels):
22557 \begin_layout Itemize
22558 \begin_inset Flex Code
22561 \begin_layout Plain Layout
22567 : Provides a name list which is abbreviated (with
22568 \begin_inset Quotes eld
22572 \begin_inset Quotes erd
22576 \begin_inset Flex Code
22579 \begin_layout Plain Layout
22588 \begin_layout Itemize
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22598 : Provides a full name list (never abbreviated with
22599 \begin_inset Quotes eld
22603 \begin_inset Quotes erd
22609 \begin_layout Itemize
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22614 %forceabbrvciteauthor%
22619 : Provides a name list which is always abbreviated (with
22620 \begin_inset Quotes eld
22624 \begin_inset Quotes erd
22628 \begin_inset Flex Code
22631 \begin_layout Plain Layout
22641 \begin_layout Standard
22642 The order of pre- and surname in the former two lists can be adjusted by
22646 \begin_layout Itemize
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22651 !firstnameform %surname%, %prename%
22656 (first author in lists of type 1)
22659 \begin_layout Itemize
22660 \begin_inset Flex Code
22663 \begin_layout Plain Layout
22664 !othernameform %surname%, %prename%
22669 (other authors in lists of type 1)
22672 \begin_layout Itemize
22673 \begin_inset Flex Code
22676 \begin_layout Plain Layout
22677 !firstbynameform %prename% %surname%
22682 (first author in lists of type 2)
22685 \begin_layout Itemize
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22690 !otherbynameform %prename% %surname%
22695 (other authors in lists of type 2)
22698 \begin_layout Standard
22699 This allows you to configure namings like
22700 \begin_inset Quotes eld
22703 Miller, Peter and Mary Smith: \SpecialChar ldots
22704 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22706 \begin_inset Quotes erd
22712 \begin_layout Standard
22713 There is one other piece of syntax available in definitions, which looks
22715 \begin_inset Flex Code
22718 \begin_layout Plain Layout
22725 This defines a piece of formatting information that is to be used when
22727 \begin_inset Quotes eld
22731 \begin_inset Quotes erd
22735 Obviously, we do not want to output HTML tags when writing plain text,
22736 so they should be wrapped in
22737 \begin_inset Quotes eld
22741 \begin_inset Quotes erd
22745 \begin_inset Quotes eld
22749 \begin_inset Quotes erd
22755 \begin_layout Standard
22756 Two special sorts of definitions are also possible in a
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22767 An example of the first would be:
22770 \begin_layout LyX-Code
22772 \begin_inset Quotes eld
22776 \begin_inset Quotes erd
22782 \begin_layout Standard
22783 This is an abbreviation, or macro, and it can be used by treating it as
22785 \begin_inset Flex Code
22788 \begin_layout Plain Layout
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22806 exactly as it would treat its definition.
22807 So, let us issue the obvious
22815 \begin_layout LyX-Code
22819 \begin_layout Standard
22820 or anything like it.
22822 shouldn't go into an infinite loop, but it may go into a long one before
22826 \begin_layout Standard
22827 The second sort of special definition might look like this:
22830 \begin_layout LyX-Code
22834 \begin_layout Standard
22835 This defines a translatable piece of text, which allows relevant parts of
22836 the bibliography or citation to be translated.
22837 It can be included in a definition by treating it as a key:
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22848 Several of these are predefined in
22849 \begin_inset Flex Code
22852 \begin_layout Plain Layout
22859 \begin_inset Flex Code
22862 \begin_layout Plain Layout
22869 Note that these are not macros, in the sense just defined.
22870 They will not be expanded.
22873 \begin_layout Standard
22874 So here then is an example that use all these features:
22875 \begin_inset VSpace defskip
22881 \begin_layout Standard
22885 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22888 \begin_layout Standard
22889 \begin_inset VSpace defskip
22892 This defines a macro that prints the author, followed by a comma, if the
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22903 key is defined, or else prints the name of the editor, followed by the
22905 \begin_inset Flex Code
22908 \begin_layout Plain Layout
22914 or its translation (it is by default
22915 \begin_inset Quotes eld
22919 \begin_inset Quotes erd
22923 \begin_inset Flex Code
22926 \begin_layout Plain Layout
22933 Note that this is in fact defined in
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22943 , so you can use it in your own definitions, or re-definitions, if you load
22947 \begin_layout Section
22948 \begin_inset CommandInset label
22950 name "sec:Tags-for-XHTML"
22954 Tags for XHTML output
22957 \begin_layout Standard
22958 As with \SpecialChar LaTeX
22959 or DocBook, the format of \SpecialChar LyX
22960 's XHTML output is also controlled by
22961 layout information.
22962 In general, \SpecialChar LyX
22963 provides sensible defaults and, as mentioned earlier, it will
22964 even construct default CSS style rules from the other layout tags.
22965 For example, \SpecialChar LyX
22966 will attempt to use the information provided in the
22967 \begin_inset Flex Code
22970 \begin_layout Plain Layout
22976 declaration for the Chapter style to write CSS that will appropriately
22977 format chapter headings.
22980 \begin_layout Standard
22981 In many cases, then, you may not have to do anything at all to get acceptable
22982 XHTML output for your own environments, custom insets, and so forth.
22983 But in some cases you will, and so \SpecialChar LyX
22984 provides a number of layout tags that
22985 can be used to customize the XHTML and CSS that are generated.
22988 \begin_layout Standard
22989 Note that there are two tags,
22990 \begin_inset Flex Code
22993 \begin_layout Plain Layout
23000 \begin_inset Flex Code
23003 \begin_layout Plain Layout
23009 that may appear outside style and inset declarations.
23011 \begin_inset CommandInset ref
23013 reference "subsec:General-text-class"
23017 for details on these.
23020 \begin_layout Subsection
23021 \begin_inset CommandInset label
23023 name "subsec:Paragraph-Style-XHTML"
23030 \begin_layout Standard
23031 The sort of XHTML \SpecialChar LyX
23032 outputs for a paragraph depends upon whether we are dealing
23033 with a normal paragraph, a command, or an environment, where this is itself
23034 determined by the contents of the corresponding
23035 \begin_inset Flex Code
23038 \begin_layout Plain Layout
23049 \begin_layout Standard
23050 For a command or normal paragraph, the output XHTML has the following form:
23053 \begin_layout LyX-Code
23055 \begin_inset Quotes erd
23059 \begin_inset Quotes erd
23065 \begin_layout LyX-Code
23067 \begin_inset Quotes erd
23071 \begin_inset Quotes erd
23077 \begin_layout LyX-Code
23078 Contents of the paragraph.
23081 \begin_layout LyX-Code
23085 \begin_layout Standard
23086 The label tags are of course omitted if the paragraph does not have a label.
23089 \begin_layout Standard
23090 For an environment that is not some sort of list, the XHTML takes this form:
23093 \begin_layout LyX-Code
23095 \begin_inset Quotes erd
23099 \begin_inset Quotes erd
23105 \begin_layout LyX-Code
23107 \begin_inset Quotes erd
23111 \begin_inset Quotes erd
23115 \begin_inset Quotes erd
23119 \begin_inset Quotes erd
23122 >Environment Label</labeltag>First paragraph.</itemtag>
23125 \begin_layout LyX-Code
23126 <itemtag>Second paragraph.</itemtag>
23129 \begin_layout LyX-Code
23133 \begin_layout Standard
23134 Note that the label is output only for the first paragraph, as it should
23135 be for a theorem, for example.
23139 \begin_layout Standard
23140 For a list, we have one of these forms:
23143 \begin_layout LyX-Code
23145 \begin_inset Quotes erd
23149 \begin_inset Quotes erd
23155 \begin_layout LyX-Code
23157 \begin_inset Quotes erd
23161 \begin_inset Quotes erd
23165 \begin_inset Quotes erd
23169 \begin_inset Quotes erd
23172 >List Label</labeltag>First item.</itemtag>
23175 \begin_layout LyX-Code
23177 \begin_inset Quotes erd
23181 \begin_inset Quotes erd
23185 \begin_inset Quotes erd
23189 \begin_inset Quotes erd
23192 >List Label</labeltag>Second item.</itemtag>
23195 \begin_layout LyX-Code
23199 \begin_layout LyX-Code
23203 \begin_layout LyX-Code
23205 \begin_inset Quotes erd
23209 \begin_inset Quotes erd
23215 \begin_layout LyX-Code
23217 \begin_inset Quotes erd
23221 \begin_inset Quotes erd
23224 >List Label</labeltag><itemtag attr=
23225 \begin_inset Quotes erd
23229 \begin_inset Quotes erd
23232 >First item.</itemtag>
23235 \begin_layout LyX-Code
23237 \begin_inset Quotes erd
23241 \begin_inset Quotes erd
23244 >List Label</labeltag><itemtag attr=
23245 \begin_inset Quotes erd
23249 \begin_inset Quotes erd
23252 >Second item.</itemtag>
23255 \begin_layout LyX-Code
23259 \begin_layout Standard
23260 Note the different orders of
23261 \begin_inset Flex Code
23264 \begin_layout Plain Layout
23271 \begin_inset Flex Code
23274 \begin_layout Plain Layout
23281 Which order we get depends upon the setting of
23282 \begin_inset Flex Code
23285 \begin_layout Plain Layout
23292 \begin_inset Flex Code
23295 \begin_layout Plain Layout
23301 is false (the default), you get the first of these, with the label within
23302 the item; if true, you get the second, with the label outside the item.
23305 \begin_layout Standard
23306 The specific tags and attributes output for each paragraph type can be controlle
23307 d by means of the layout tags we are about to describe.
23308 As mentioned earlier, however, \SpecialChar LyX
23309 uses sensible defaults for many of these,
23310 so you often may not need to do very much to get good XHTML output.
23311 Think of the available tags as there so you can tweak things to your liking.
23314 \begin_layout Description
23315 \begin_inset Flex Code
23318 \begin_layout Plain Layout
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23334 ] Specifies attribute information to be output with the main tag.
23336 \begin_inset Quotes eld
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23350 \begin_inset Quotes erd
23354 By default, \SpecialChar LyX
23356 \begin_inset Quotes eld
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23370 \begin_inset Quotes erd
23374 \begin_inset Flex Code
23377 \begin_layout Plain Layout
23383 is the \SpecialChar LyX
23384 name of the layout, made lowercase, for example: chapter.
23389 contain any style information.
23391 \begin_inset Flex Code
23394 \begin_layout Plain Layout
23403 \begin_layout Description
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23414 \begin_inset Flex Code
23417 \begin_layout Plain Layout
23427 ] Whether to output the default CSS information \SpecialChar LyX
23428 generates for this layout,
23429 even if additional information is explicitly provided via
23430 \begin_inset Flex Code
23433 \begin_layout Plain Layout
23441 \begin_inset Flex Code
23444 \begin_layout Plain Layout
23450 allows you to alter or augment the generated CSS, rather than to override
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23465 \begin_layout Description
23466 \begin_inset Flex Code
23469 \begin_layout Plain Layout
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23485 ] The tag to be used for individual paragraphs of environments, replacing
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23496 in the examples above.
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23510 \begin_layout Description
23511 \begin_inset Flex Code
23514 \begin_layout Plain Layout
23521 \begin_inset Flex Code
23524 \begin_layout Plain Layout
23530 ] Attributes for the item tag.
23532 \begin_inset Quotes eld
23536 \begin_inset Flex Code
23539 \begin_layout Plain Layout
23540 class=`layoutname_item'
23546 \begin_inset Quotes erd
23554 contain any style information.
23556 \begin_inset Flex Code
23559 \begin_layout Plain Layout
23568 \begin_layout Description
23569 \begin_inset Flex Code
23572 \begin_layout Plain Layout
23579 \begin_inset Flex Code
23582 \begin_layout Plain Layout
23588 ] The tag to be used for paragraph and item labels, replacing
23589 \begin_inset Flex Code
23592 \begin_layout Plain Layout
23598 in the examples above.
23600 \begin_inset Flex Code
23603 \begin_layout Plain Layout
23610 \begin_inset Flex Code
23613 \begin_layout Plain Layout
23620 \begin_inset Flex Code
23623 \begin_layout Plain Layout
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23634 Centered_Top_Environment
23639 , in which case it defaults to
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23652 \begin_layout Description
23653 \begin_inset Flex Code
23656 \begin_layout Plain Layout
23663 \begin_inset Flex Code
23666 \begin_layout Plain Layout
23672 ] Attributes for the label tag.
23674 \begin_inset Quotes eld
23678 \begin_inset Flex Code
23681 \begin_layout Plain Layout
23682 class=`layoutname_label'
23688 \begin_inset Quotes erd
23696 contain any style information.
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23710 \begin_layout Description
23711 \begin_inset Flex Code
23714 \begin_layout Plain Layout
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23734 ] Meaningful only for list-like environments, this tag controls whether
23735 the label tag is output before or inside the item tag.
23736 This is used, for example, in the description environment, where we want
23738 \begin_inset Flex Code
23741 \begin_layout Plain Layout
23742 <dt>\SpecialChar ldots
23743 </dt><dd>\SpecialChar ldots
23751 \begin_inset Flex Code
23754 \begin_layout Plain Layout
23760 : The label tag is output inside the item tag.
23763 \begin_layout Description
23764 \begin_inset Flex Code
23767 \begin_layout Plain Layout
23773 Information to be output in the
23774 \begin_inset Flex Code
23777 \begin_layout Plain Layout
23783 section when this style is used.
23784 This might, for example, be used to include a
23785 \begin_inset Flex Code
23788 \begin_layout Plain Layout
23795 \begin_inset Flex Code
23798 \begin_layout Plain Layout
23807 \begin_layout Description
23808 \begin_inset Flex Code
23811 \begin_layout Plain Layout
23817 CSS style information to be included when this style is used.
23818 Note that this will automatically be wrapped in a layout-generated
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23828 block, so only the CSS itself need be included.
23830 \begin_inset Flex Code
23833 \begin_layout Plain Layout
23842 \begin_layout Description
23843 \begin_inset Flex Code
23846 \begin_layout Plain Layout
23853 \begin_inset Flex Code
23856 \begin_layout Plain Layout
23862 ] The tag to be used for the main label, replacing
23863 \begin_inset Flex Code
23866 \begin_layout Plain Layout
23872 in the examples above.
23874 \begin_inset Flex Code
23877 \begin_layout Plain Layout
23886 \begin_layout Description
23887 \begin_inset Flex Code
23890 \begin_layout Plain Layout
23897 \begin_inset Flex Code
23900 \begin_layout Plain Layout
23910 ] Marks this style as the one to be used to generate the
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23920 tag for the XHTML file.
23921 By default, it is false.
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23932 file sets it to true for the
23933 \begin_inset Flex Code
23936 \begin_layout Plain Layout
23946 \begin_layout Subsection
23950 \begin_layout Standard
23951 The XHTML output of insets can also be controlled by information in layout
23956 \begin_layout Plain Layout
23957 At present, this is true only for
23958 \begin_inset Quotes eld
23962 \begin_inset Quotes erd
23965 insets (insets you can type into) and is not true for
23966 \begin_inset Quotes eld
23970 \begin_inset Quotes erd
23973 insets (insets that are associated with dialog boxes).
23978 Here, too, \SpecialChar LyX
23979 tries to provide sensible defaults, and it constructs default
23981 But everything can be customized.
23984 \begin_layout Standard
23985 The XHTML \SpecialChar LyX
23986 outputs for an inset has the following form:
23989 \begin_layout LyX-Code
23991 \begin_inset Quotes erd
23995 \begin_inset Quotes erd
24001 \begin_layout LyX-Code
24002 <labeltag>Label</labeltag>
24005 \begin_layout LyX-Code
24007 \begin_inset Quotes erd
24011 \begin_inset Quotes erd
24014 >Contents of the inset.</innertag>
24017 \begin_layout LyX-Code
24021 \begin_layout Standard
24022 If the inset permits multiple paragraphs—that is, if
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24032 is true—then the contents of the inset will itself be output as paragraphs
24033 formatted according to the styles used for those paragraphs (standard,
24034 quote, and the like).
24035 The label tag is of course omitted if the paragraph does not have a label
24036 and, at present, is always
24037 \begin_inset Flex Code
24040 \begin_layout Plain Layout
24047 The inner tag is optional and, by default, does not appear.
24050 \begin_layout Standard
24051 The specific tags and attributes output for each inset can be controlled
24052 by means of the following layout tags.
24055 \begin_layout Description
24056 \begin_inset Flex Code
24059 \begin_layout Plain Layout
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24075 ] Specifies attribute information to be output with the main tag.
24077 \begin_inset Quotes eld
24081 \begin_inset Flex Code
24084 \begin_layout Plain Layout
24085 class=`myinset' onclick=`\SpecialChar ldots
24092 \begin_inset Quotes erd
24096 By default, \SpecialChar LyX
24098 \begin_inset Quotes eld
24102 \begin_inset Flex Code
24105 \begin_layout Plain Layout
24112 \begin_inset Quotes erd
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24125 is the \SpecialChar LyX
24126 name of the inset, made lowercase and with non-alphanumeric characters
24127 converted to underscores, for example: footnote.
24130 \begin_layout Description
24131 \begin_inset Flex Code
24134 \begin_layout Plain Layout
24141 \begin_inset Flex Code
24144 \begin_layout Plain Layout
24154 ] Whether to output the default CSS information \SpecialChar LyX
24155 generates for this layout,
24156 even if additional information is explicitly provided via
24157 \begin_inset Flex Code
24160 \begin_layout Plain Layout
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24177 allows you to alter or augment the generated CSS, rather than to override
24182 \begin_layout Description
24183 \begin_inset Flex Code
24186 \begin_layout Plain Layout
24193 \begin_inset Flex Code
24196 \begin_layout Plain Layout
24202 ] Attributes for the inner tag.
24204 \begin_inset Quotes eld
24208 \begin_inset Flex Code
24211 \begin_layout Plain Layout
24212 class=`insetname_inner'
24218 \begin_inset Quotes erd
24224 \begin_layout Description
24225 \begin_inset Flex Code
24228 \begin_layout Plain Layout
24235 \begin_inset Flex Code
24238 \begin_layout Plain Layout
24244 ] The inner tag, replacing
24245 \begin_inset Flex Code
24248 \begin_layout Plain Layout
24254 in the examples above.
24255 By default, there is none.
24258 \begin_layout Description
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24269 \begin_inset Flex Code
24272 \begin_layout Plain Layout
24280 ] Whether this inset represents a standalone block of text (such as a footnote)
24281 or instead represents material that is included in the surrounding text
24282 (such as a branch).
24286 \begin_layout Description
24287 \begin_inset Flex Code
24290 \begin_layout Plain Layout
24297 \begin_inset Flex Code
24300 \begin_layout Plain Layout
24306 ] A label for this inset, possibly including a reference to a counter.
24307 For example, for footnote, it might be:
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24320 This is optional, and there is no default.
24323 \begin_layout Description
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24333 Information to be output in the
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24343 section when this style is used.
24344 This might, for example, be used to include a
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24355 \begin_inset Flex Code
24358 \begin_layout Plain Layout
24367 \begin_layout Description
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24377 CSS style information to be included when this style is used.
24378 Note that this will automatically be wrapped in a layout-generated
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24388 block, so only the CSS itself need be included.
24391 \begin_layout Description
24392 \begin_inset Flex Code
24395 \begin_layout Plain Layout
24402 \begin_inset Flex Code
24405 \begin_layout Plain Layout
24411 ] The tag to be used for the main label, replacing
24412 \begin_inset Flex Code
24415 \begin_layout Plain Layout
24421 in the examples above.
24422 The default depends upon the setting of
24423 \begin_inset Flex Code
24426 \begin_layout Plain Layout
24433 \begin_inset Flex Code
24436 \begin_layout Plain Layout
24442 is true, the default is
24443 \begin_inset Flex Code
24446 \begin_layout Plain Layout
24452 ; if it is false, the default is
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24465 \begin_layout Subsection
24469 \begin_layout Standard
24470 The XHTML output for floats too can be controlled by layout information.
24471 The output has the following form:
24474 \begin_layout LyX-Code
24476 \begin_inset Quotes erd
24480 \begin_inset Quotes erd
24486 \begin_layout LyX-Code
24487 Contents of the float.
24490 \begin_layout LyX-Code
24494 \begin_layout Standard
24495 The caption, if there is one, is a separate inset and will be output as
24497 Its appearance can be controlled via the InsetLayout for caption insets.
24501 \begin_layout Description
24502 \begin_inset Flex Code
24505 \begin_layout Plain Layout
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24521 ] Specifies attribute information to be output with the main tag.
24523 \begin_inset Quotes eld
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24531 class=`myfloat' onclick=`\SpecialChar ldots
24538 \begin_inset Quotes erd
24542 By default, \SpecialChar LyX
24544 \begin_inset Quotes eld
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24552 class=`float float-floattype'
24558 \begin_inset Quotes erd
24562 \begin_inset Flex Code
24565 \begin_layout Plain Layout
24571 is \SpecialChar LyX
24572 's name for this type of float, as determined by the float declaration
24574 \begin_inset CommandInset ref
24576 reference "subsec:Floats"
24580 ), though made lowercase and with non-alphanumeric characters converted
24581 to underscores, for example: float-table.
24584 \begin_layout Description
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24594 CSS style information to be included when this float is used.
24595 Note that this will automatically be wrapped in a layout-generated
24596 \begin_inset Flex Code
24599 \begin_layout Plain Layout
24605 block, so only the CSS itself need be included.
24608 \begin_layout Description
24609 \begin_inset Flex Code
24612 \begin_layout Plain Layout
24619 \begin_inset Flex Code
24622 \begin_layout Plain Layout
24628 ] The tag to be used for this float, replacing
24629 \begin_inset Quotes eld
24633 \begin_inset Flex Code
24636 \begin_layout Plain Layout
24643 \begin_inset Quotes erd
24646 in the example above.
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24657 and will rarely need changing.
24660 \begin_layout Subsection
24661 Bibliography formatting
24664 \begin_layout Standard
24665 The bibliography can be formatted using
24666 \begin_inset Flex Code
24669 \begin_layout Plain Layout
24677 \begin_inset CommandInset ref
24679 reference "subsec:Citation-format-description"
24686 \begin_layout Subsection
24691 \begin_layout Standard
24692 We have several times mentioned that \SpecialChar LyX
24693 will generate default CSS style rules
24694 for both insets and paragraph styles, based upon the other layout information
24696 In this section, we shall say a word about which layout information \SpecialChar LyX
24701 \begin_layout Standard
24702 At present, \SpecialChar LyX
24703 auto-generates CSS only for font information, making use of
24705 \begin_inset Flex Code
24708 \begin_layout Plain Layout
24715 \begin_inset Flex Code
24718 \begin_layout Plain Layout
24725 \begin_inset Flex Code
24728 \begin_layout Plain Layout
24735 \begin_inset Flex Code
24738 \begin_layout Plain Layout
24745 \begin_inset Flex Code
24748 \begin_layout Plain Layout
24755 \begin_inset CommandInset ref
24757 reference "subsec:Font-description"
24762 The translation is mostly straightforward and obvious.
24764 \begin_inset Quotes eld
24768 \begin_inset Flex Code
24771 \begin_layout Plain Layout
24778 \begin_inset Quotes erd
24782 \begin_inset Quotes eld
24786 \begin_inset Flex Code
24789 \begin_layout Plain Layout
24790 font-family: sans-serif;
24796 \begin_inset Quotes erd
24800 The correspondence of \SpecialChar LyX
24801 sizes and CSS sizes is a little less obvious but
24802 nonetheless intuitive.
24804 \begin_inset Flex Code
24807 \begin_layout Plain Layout
24814 \begin_inset Flex URL
24817 \begin_layout Plain Layout
24827 \begin_layout Chapter
24828 Including External Material
24829 \begin_inset CommandInset label
24831 name "chap:Including-External-Material"
24838 \begin_layout Standard
24839 \begin_inset Box Shadowbox
24849 height_special "totalheight"
24854 backgroundcolor "none"
24857 \begin_layout Plain Layout
24858 WARNING: This portion of the documentation has not been updated for some
24860 We certainly hope that it is still accurate, but there are no guarantees.
24868 \begin_layout Standard
24869 The use of material from sources external to \SpecialChar LyX
24870 is covered in detail in the
24876 This part of the manual covers what needs to happen behind the scenes for
24877 new sorts of material to be included.
24880 \begin_layout Section
24884 \begin_layout Standard
24885 The external material feature is based on the concept of a
24890 A template is a specification of how \SpecialChar LyX
24891 should interface with a certain kind
24893 As bundled, \SpecialChar LyX
24894 comes with predefined templates for Xfig figures, various
24895 raster format images, chess diagrams, and LilyPond music notation.
24896 You can check the actual list by using the menu
24897 \begin_inset Flex Noun
24900 \begin_layout Plain Layout
24901 Insert\SpecialChar menuseparator
24902 File\SpecialChar menuseparator
24909 Furthermore, it is possible to roll your own template to support a specific
24911 Later we'll describe in more detail what is involved, and hopefully you
24912 will submit all the templates you create so we can include them in a later
24917 \begin_layout Standard
24918 Another basic idea of the external material feature is to distinguish between
24919 the original file that serves as a base for final material and the produced
24920 file that is included in your exported or printed document.
24921 For example, consider the case of a figure produced with
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24932 The Xfig application itself works on an original file with the
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24943 Within Xfig, you create and change your figure, and when you are done,
24945 \begin_inset Flex Code
24948 \begin_layout Plain Layout
24955 When you want to include the figure in your document, you invoke
24956 \begin_inset Flex Code
24959 \begin_layout Plain Layout
24965 in order to create a PostScript file that can readily be included in your
24969 \begin_inset Flex Code
24972 \begin_layout Plain Layout
24978 file is the original file, and the PostScript file is the produced file.
24981 \begin_layout Standard
24982 This distinction is important in order to allow updating of the material
24983 while you are in the process of writing the document.
24984 Furthermore, it provides us with the flexibility that is needed to support
24985 multiple export formats.
24986 For instance, in the case of a plain text file, it is not exactly an award-winn
24987 ing idea to include the figure as raw PostScript.
24988 Instead, you would either prefer to just include a reference to the figure
24989 or try to invoke some graphics to ASCII converter to make the final result
24990 look similar to the real graphics.
24991 The external material management allows you to do this, because it is parametri
24992 zed on the different export formats that \SpecialChar LyX
24996 \begin_layout Standard
24997 Besides supporting the production of different products according to the
24998 exported format, it supports tight integration with editing and viewing
25000 In the case of an Xfig figure, you are able to invoke Xfig on the original
25001 file with a single click from within the external material dialog in \SpecialChar LyX
25003 and also preview the produced PostScript file with Ghostview with another
25005 No more fiddling around with the command line and/or file browsers to locate
25006 and manipulate the original or produced files.
25007 In this way, you are finally able to take full advantage of the many different
25008 applications that are relevant to use when you write your documents, and
25009 ultimately be more productive.
25012 \begin_layout Section
25013 The external template configuration files
25016 \begin_layout Standard
25017 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25019 However, be aware that doing this in an careless manner most probably
25023 introduce an easily exploitable security hole.
25024 So before you do this, please read the discussion about security in
25025 \begin_inset CommandInset ref
25027 reference "sec:Security-discussion"
25034 \begin_layout Standard
25035 Having said that, we encourage you to submit any interesting templates that
25040 \begin_layout Standard
25041 The external templates are defined in the
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25051 files that are stored in the
25052 \begin_inset Flex Code
25055 \begin_layout Plain Layout
25056 LyXDir/lib/xtemplates/
25062 Each template is defined in a file of its own.
25063 You can place your own templates in
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25068 UserDir/xtemplates/
25073 or copy existing templates to that directory in order to modify them.
25076 \begin_layout Standard
25077 A typical template looks like this:
25080 \begin_layout LyX-Code
25084 \begin_layout LyX-Code
25085 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25088 \begin_layout LyX-Code
25092 \begin_layout LyX-Code
25096 \begin_layout LyX-Code
25100 \begin_layout LyX-Code
25104 \begin_layout LyX-Code
25108 \begin_layout LyX-Code
25109 AutomaticProduction true
25112 \begin_layout LyX-Code
25116 \begin_layout LyX-Code
25120 \begin_layout LyX-Code
25124 \begin_layout LyX-Code
25125 TransformCommand Rotate RotationLatexCommand
25128 \begin_layout LyX-Code
25129 TransformCommand Resize ResizeLatexCommand
25132 \begin_layout LyX-Code
25133 Product "$$RotateFront$$ResizeFront
25136 \begin_layout LyX-Code
25141 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25144 \begin_layout LyX-Code
25145 $$ResizeBack$$RotateBack"
25148 \begin_layout LyX-Code
25152 \begin_layout LyX-Code
25153 UpdateResult "$$AbsPath$$Basename.pstex_t"
25156 \begin_layout LyX-Code
25157 Requirement "graphicx"
25160 \begin_layout LyX-Code
25161 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25164 \begin_layout LyX-Code
25165 ReferencedFile latex "$$AbsPath$$Basename.eps"
25168 \begin_layout LyX-Code
25169 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25172 \begin_layout LyX-Code
25176 \begin_layout LyX-Code
25180 \begin_layout LyX-Code
25181 TransformCommand Rotate RotationLatexCommand
25184 \begin_layout LyX-Code
25185 TransformCommand Resize ResizeLatexCommand
25188 \begin_layout LyX-Code
25189 Product "$$RotateFront$$ResizeFront
25192 \begin_layout LyX-Code
25197 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25200 \begin_layout LyX-Code
25201 $$ResizeBack$$RotateBack"
25204 \begin_layout LyX-Code
25205 UpdateFormat pdftex
25208 \begin_layout LyX-Code
25209 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25212 \begin_layout LyX-Code
25213 Requirement "graphicx"
25216 \begin_layout LyX-Code
25217 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25220 \begin_layout LyX-Code
25221 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25224 \begin_layout LyX-Code
25228 \begin_layout LyX-Code
25232 \begin_layout LyX-Code
25233 Product "[XFig: $$FName]"
25236 \begin_layout LyX-Code
25240 \begin_layout LyX-Code
25244 \begin_layout LyX-Code
25245 Product "<graphic fileref=
25247 "$$AbsOrRelPathMaster$$Basename.eps
25252 \begin_layout LyX-Code
25256 \begin_layout LyX-Code
25260 \begin_layout LyX-Code
25261 UpdateResult "$$AbsPath$$Basename.eps"
25264 \begin_layout LyX-Code
25265 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25268 \begin_layout LyX-Code
25269 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25272 \begin_layout LyX-Code
25276 \begin_layout LyX-Code
25280 \begin_layout Standard
25281 As you can see, the template is enclosed in
25282 \begin_inset Flex Code
25285 \begin_layout Plain Layout
25293 \begin_inset Flex Code
25296 \begin_layout Plain Layout
25303 It contains a header specifying some general settings and, for each supported
25304 primary document file format, a section
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25316 \begin_inset Flex Code
25319 \begin_layout Plain Layout
25328 \begin_layout Subsection
25329 The template header
25332 \begin_layout Description
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25337 AutomaticProduction
25338 \begin_inset space ~
25346 Whether the file represented by the template must be generated by \SpecialChar LyX
25348 This command must occur exactly once.
25351 \begin_layout Description
25352 \begin_inset Flex Code
25355 \begin_layout Plain Layout
25357 \begin_inset space ~
25365 A glob pattern that is used in the file dialog to filter out the desired
25367 If there is more than one possible file extension (e.
25368 \begin_inset space \thinspace{}
25372 \begin_inset space \space{}
25376 \begin_inset Flex Code
25379 \begin_layout Plain Layout
25386 \begin_inset Flex Code
25389 \begin_layout Plain Layout
25395 ), use something like
25396 \begin_inset Flex Code
25399 \begin_layout Plain Layout
25406 This command must occur exactly once.
25409 \begin_layout Description
25410 \begin_inset Flex Code
25413 \begin_layout Plain Layout
25415 \begin_inset space ~
25423 The text that is displayed on the button.
25424 This command must occur exactly once.
25427 \begin_layout Description
25428 \begin_inset Flex Code
25431 \begin_layout Plain Layout
25433 \begin_inset space ~
25437 \begin_inset space ~
25445 The help text that is used in the External dialog.
25446 Provide enough information to explain to the user just what the template
25447 can provide him with.
25448 This command must occur exactly once.
25451 \begin_layout Description
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25457 \begin_inset space ~
25465 The file format of the original file.
25466 This must be the name of a format that is known to \SpecialChar LyX
25468 \begin_inset CommandInset ref
25470 reference "sec:Formats"
25476 \begin_inset Quotes eld
25480 \begin_inset Flex Code
25483 \begin_layout Plain Layout
25490 \begin_inset Quotes erd
25493 if the template can handle original files of more than one format.
25495 will attempt to interrogate the file itself in order to deduce its format
25497 This command must occur exactly once.
25500 \begin_layout Description
25501 \begin_inset Flex Code
25504 \begin_layout Plain Layout
25506 \begin_inset space ~
25514 A unique name for the template.
25515 It must not contain substitution macros (see below).
25518 \begin_layout Description
25519 \begin_inset Flex Code
25522 \begin_layout Plain Layout
25524 \begin_inset space ~
25527 Rotate|Resize|Clip|Extra
25532 This command specifies which transformations are supported by this template.
25533 It may occur zero or more times.
25534 This command enables the corresponding tabs in the external dialog.
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25545 command must have either a corresponding
25546 \begin_inset Flex Code
25549 \begin_layout Plain Layout
25556 \begin_inset Flex Code
25559 \begin_layout Plain Layout
25566 \begin_inset Flex Code
25569 \begin_layout Plain Layout
25576 Otherwise the transformation will not be supported by that format.
25579 \begin_layout Subsection
25583 \begin_layout Description
25584 \begin_inset Flex Code
25587 \begin_layout Plain Layout
25589 \begin_inset space ~
25592 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25597 The primary document file format that this format definition is for.
25598 Not every template has a sensible representation in all document file formats.
25599 Please define nevertheless a
25600 \begin_inset Flex Code
25603 \begin_layout Plain Layout
25609 section for all templates.
25610 Use a dummy text when no representation is available.
25611 Then you can at least see a reference to the external material in the exported
25615 \begin_layout Description
25616 \begin_inset Flex Code
25619 \begin_layout Plain Layout
25621 \begin_inset space ~
25625 \begin_inset space ~
25633 This command defines an additional macro
25634 \begin_inset Flex Code
25637 \begin_layout Plain Layout
25643 for substitution in
25644 \begin_inset Flex Code
25647 \begin_layout Plain Layout
25655 \begin_inset Flex Code
25658 \begin_layout Plain Layout
25664 itself may contain substitution macros.
25665 The advantage over using
25666 \begin_inset Flex Code
25669 \begin_layout Plain Layout
25676 \begin_inset Flex Code
25679 \begin_layout Plain Layout
25685 is that the substituted value of
25686 \begin_inset Flex Code
25689 \begin_layout Plain Layout
25695 is sanitized so that it is a valid optional argument in the document format.
25696 This command may occur zero or more times.
25699 \begin_layout Description
25700 \begin_inset Flex Code
25703 \begin_layout Plain Layout
25705 \begin_inset space ~
25713 The text that is inserted in the exported document.
25714 This is actually the most important command and can be quite complex.
25715 This command must occur exactly once.
25718 \begin_layout Description
25719 \begin_inset Flex Code
25722 \begin_layout Plain Layout
25724 \begin_inset space ~
25732 This command specifies a preamble snippet that will be included in the
25735 It has to be defined using
25736 \begin_inset Flex Code
25739 \begin_layout Plain Layout
25747 \begin_inset Flex Code
25750 \begin_layout Plain Layout
25757 This command may occur zero or more times.
25760 \begin_layout Description
25761 \begin_inset Flex Code
25764 \begin_layout Plain Layout
25766 \begin_inset space ~
25770 \begin_inset space ~
25778 This command denotes files that are created by the conversion process and
25779 are needed for a particular export format.
25780 If the filename is relative, it is interpreted relative to the master document.
25781 This command may be given zero or more times.
25784 \begin_layout Description
25785 \begin_inset Flex Code
25788 \begin_layout Plain Layout
25790 \begin_inset space ~
25798 The name of a required \SpecialChar LaTeX
25800 The package is included via
25801 \begin_inset Flex Code
25804 \begin_layout Plain Layout
25812 in the \SpecialChar LaTeX
25814 This command may occur zero or more times.
25817 \begin_layout Description
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25823 \begin_inset space ~
25827 \begin_inset space ~
25830 RotationLatexCommand
25835 This command specifies that the built in \SpecialChar LaTeX
25836 command should be used for rotation.
25837 This command may occur once or not at all.
25840 \begin_layout Description
25841 \begin_inset Flex Code
25844 \begin_layout Plain Layout
25846 \begin_inset space ~
25850 \begin_inset space ~
25858 This command specifies that the built in \SpecialChar LaTeX
25859 command should be used for resizing.
25860 This command may occur once or not at all.
25863 \begin_layout Description
25864 \begin_inset Flex Code
25867 \begin_layout Plain Layout
25869 \begin_inset space ~
25873 \begin_inset space ~
25876 RotationLatexOption
25881 This command specifies that rotation is done via an optional argument.
25882 This command may occur once or not at all.
25885 \begin_layout Description
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25891 \begin_inset space ~
25895 \begin_inset space ~
25903 This command specifies that resizing is done via an optional argument.
25904 This command may occur once or not at all.
25907 \begin_layout Description
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25913 \begin_inset space ~
25917 \begin_inset space ~
25925 This command specifies that clipping is done via an optional argument.
25926 This command may occur once or not at all.
25929 \begin_layout Description
25930 \begin_inset Flex Code
25933 \begin_layout Plain Layout
25935 \begin_inset space ~
25939 \begin_inset space ~
25947 This command specifies that an extra optional argument is used.
25948 This command may occur once or not at all.
25951 \begin_layout Description
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25957 \begin_inset space ~
25965 The file format of the converted file.
25966 This must be the name of a format that is known to \SpecialChar LyX
25968 \begin_inset Flex Noun
25971 \begin_layout Plain Layout
25972 Tools\SpecialChar menuseparator
25973 Preferences\SpecialChar menuseparator
25974 File Handling\SpecialChar menuseparator
25981 This command must occur exactly once.
25982 If the resulting file format is PDF, you need to specify the format
25983 \begin_inset Flex Code
25986 \begin_layout Plain Layout
25993 This is the PDF format used for including graphics.
25994 The other defined PDF formats are for document export.
25997 \begin_layout Description
25998 \begin_inset Flex Code
26001 \begin_layout Plain Layout
26003 \begin_inset space ~
26011 The file name of the converted file.
26012 The file name must be absolute.
26013 This command must occur exactly once.
26016 \begin_layout Subsection
26017 Preamble definitions
26020 \begin_layout Standard
26021 The external template configuration file may contain additional preamble
26022 definitions enclosed by
26023 \begin_inset Flex Code
26026 \begin_layout Plain Layout
26034 \begin_inset Flex Code
26037 \begin_layout Plain Layout
26044 They can be used by the templates in the
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26057 \begin_layout Section
26058 The substitution mechanism
26061 \begin_layout Standard
26062 When the external material facility invokes an external program, it is done
26063 on the basis of a command defined in the template configuration file.
26064 These commands can contain various macros that are expanded before execution.
26065 Execution always take place in the directory of the containing document.
26068 \begin_layout Standard
26069 Also, whenever external material is to be displayed, the name will be produced
26070 by the substitution mechanism, and most other commands in the template
26071 definition support substitution as well.
26074 \begin_layout Standard
26075 The available macros are the following:
26078 \begin_layout Description
26079 \begin_inset Flex Code
26082 \begin_layout Plain Layout
26083 $$AbsOrRelPathMaster
26088 The file path, absolute or relative to the master \SpecialChar LyX
26092 \begin_layout Description
26093 \begin_inset Flex Code
26096 \begin_layout Plain Layout
26097 $$AbsOrRelPathParent
26102 The file path, absolute or relative to the \SpecialChar LyX
26106 \begin_layout Description
26107 \begin_inset Flex Code
26110 \begin_layout Plain Layout
26116 The absolute file path.
26119 \begin_layout Description
26120 \begin_inset Flex Code
26123 \begin_layout Plain Layout
26129 The filename without path and without the extension.
26132 \begin_layout Description
26133 \begin_inset Flex Code
26136 \begin_layout Plain Layout
26138 \begin_inset Quotes eld
26142 \begin_inset Quotes erd
26150 This macro will expand to the contents of the file with the name
26151 \begin_inset Flex Code
26154 \begin_layout Plain Layout
26163 \begin_layout Description
26164 \begin_inset Flex Code
26167 \begin_layout Plain Layout
26173 The file extension (including the dot).
26176 \begin_layout Description
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26186 This will be the string
26187 \begin_inset Quotes eld
26191 \begin_inset Quotes erd
26194 if the file is in JPEG format, otherwise it will be the string
26195 \begin_inset Quotes eld
26199 \begin_inset Quotes erd
26203 This is useful to avoid uneeded conversions for output formats that support
26204 both PNG and JPEG fomats.
26205 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26210 \begin_layout Description
26211 \begin_inset Flex Code
26214 \begin_layout Plain Layout
26220 The filename of the file specified in the external material dialog.
26221 This is either an absolute name, or it is relative to the \SpecialChar LyX
26225 \begin_layout Description
26226 \begin_inset Flex Code
26229 \begin_layout Plain Layout
26236 \begin_inset Flex Code
26239 \begin_layout Plain Layout
26245 (absolute name or relative to the \SpecialChar LyX
26249 \begin_layout Description
26250 \begin_inset Flex Code
26253 \begin_layout Plain Layout
26259 The file path, relative to the master \SpecialChar LyX
26263 \begin_layout Description
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26273 The file path, relative to the \SpecialChar LyX
26277 \begin_layout Description
26278 \begin_inset Flex Code
26281 \begin_layout Plain Layout
26287 This macro will expand to the absolute path of the system directory.
26288 This is typically used to point to the various helper scripts that are
26289 bundled with \SpecialChar LyX
26293 \begin_layout Description
26294 \begin_inset Flex Code
26297 \begin_layout Plain Layout
26303 A name and full path to a temporary file which will be automatically deleted
26304 whenever the containing document is closed, or the external material insertion
26308 \begin_layout Standard
26309 All path macros contain a trailing directory separator, so you can construct
26311 \begin_inset space \thinspace{}
26315 \begin_inset space \space{}
26318 the absolute filename with
26319 \begin_inset Flex Code
26322 \begin_layout Plain Layout
26323 $$AbsPath$$Basename$$Extension
26331 \begin_layout Standard
26332 The macros above are substituted in all commands unless otherwise noted.
26334 \begin_inset Flex Code
26337 \begin_layout Plain Layout
26343 supports additionally the following substitutions if they are enabled by
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26355 \begin_inset Flex Code
26358 \begin_layout Plain Layout
26367 \begin_layout Description
26368 \begin_inset Flex Code
26371 \begin_layout Plain Layout
26377 The front part of the resize command.
26380 \begin_layout Description
26381 \begin_inset Flex Code
26384 \begin_layout Plain Layout
26390 The back part of the resize command.
26393 \begin_layout Description
26394 \begin_inset Flex Code
26397 \begin_layout Plain Layout
26403 The front part of the rotation command.
26406 \begin_layout Description
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26416 The back part of the rotation command.
26419 \begin_layout Standard
26420 The value string of the
26421 \begin_inset Flex Code
26424 \begin_layout Plain Layout
26430 command supports additionally the following substitutions if they are enabled
26432 \begin_inset Flex Code
26435 \begin_layout Plain Layout
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26454 \begin_layout Description
26455 \begin_inset Flex Code
26458 \begin_layout Plain Layout
26467 \begin_layout Description
26468 \begin_inset Flex Code
26471 \begin_layout Plain Layout
26480 \begin_layout Description
26481 \begin_inset Flex Code
26484 \begin_layout Plain Layout
26493 \begin_layout Description
26494 \begin_inset Flex Code
26497 \begin_layout Plain Layout
26503 The rotation option.
26506 \begin_layout Standard
26507 You may ask why there are so many path macros.
26508 There are mainly two reasons:
26511 \begin_layout Enumerate
26512 Relative and absolute file names should remain relative or absolute, respectivel
26514 Users may have reasons to prefer either form.
26515 Relative names are useful for portable documents that should work on different
26516 machines, for example.
26517 Absolute names may be required by some programs.
26520 \begin_layout Enumerate
26522 treats relative file names differently than \SpecialChar LyX
26523 and other programs in nested
26525 For \SpecialChar LyX
26526 , a relative file name is always relative to the document that contains
26528 For \SpecialChar LaTeX
26529 , it is always relative to the master document.
26530 These two definitions are identical if you have only one document, but
26531 differ if you have a master document that includes part documents.
26532 That means that relative filenames must be transformed when presented to
26535 Fortunately \SpecialChar LyX
26536 does this automatically for you if you choose the right macros.
26539 \begin_layout Standard
26540 So which path macro should be used in new template definitions? The rule
26544 \begin_layout Itemize
26546 \begin_inset Flex Code
26549 \begin_layout Plain Layout
26555 if an absolute path is required.
26558 \begin_layout Itemize
26560 \begin_inset Flex Code
26563 \begin_layout Plain Layout
26564 $$AbsOrRelPathMaster
26569 if the substituted string is some kind of \SpecialChar LaTeX
26573 \begin_layout Itemize
26575 \begin_inset Flex Code
26578 \begin_layout Plain Layout
26579 $$AbsOrRelPathParent
26584 in order to preserve the user's choice.
26587 \begin_layout Standard
26588 There are special cases where this rule does not work and e.
26589 \begin_inset space \thinspace{}
26593 \begin_inset space \space{}
26596 relative names are needed, but normally it will work just fine.
26597 One example for such a case is the command
26598 \begin_inset Flex Code
26601 \begin_layout Plain Layout
26602 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26607 in the XFig template above: We can't use the absolute name because the
26609 \begin_inset Flex Code
26612 \begin_layout Plain Layout
26618 files needs the relative name in order to rewrite the file content.
26621 \begin_layout Section
26622 Security discussion
26623 \begin_inset CommandInset label
26625 name "sec:Security-discussion"
26632 \begin_layout Standard
26633 The external material feature interfaces with a lot of external programs
26634 and does so automatically, so we have to consider the security implications
26636 In particular, since you have the option of including your own filenames
26637 and/or parameter strings and those are expanded into a command, it seems
26638 that it would be possible to create a malicious document which executes
26639 arbitrary commands when a user views or prints the document.
26640 This is something we definitely want to avoid.
26643 \begin_layout Standard
26644 However, since the external program commands are specified in the template
26645 configuration file only, there are no security issues if \SpecialChar LyX
26646 is properly configure
26647 d with safe templates only.
26648 This is so because the external programs are invoked with the
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26658 -system call rather than the
26659 \begin_inset Flex Code
26662 \begin_layout Plain Layout
26668 system-call, so it's not possible to execute arbitrary commands from the
26669 filename or parameter section via the shell.
26672 \begin_layout Standard
26673 This also implies that you are restricted in what command strings you can
26674 use in the external material templates.
26675 In particular, pipes and redirection are not readily available.
26676 This has to be so if \SpecialChar LyX
26677 should remain safe.
26678 If you want to use some of the shell features, you should write a safe
26679 script to do this in a controlled manner, and then invoke the script from
26680 the command string.
26684 \begin_layout Standard
26685 It is possible to design a template that interacts directly with the shell,
26686 but since this would allow a malicious user to execute arbitrary commands
26687 by writing clever filenames and/or parameters, we generally recommend that
26688 you only use safe scripts that work with the
26689 \begin_inset Flex Code
26692 \begin_layout Plain Layout
26698 system call in a controlled manner.
26699 Of course, for use in a controlled environment, it can be tempting to just
26700 fall back to use ordinary shell scripts.
26701 If you do so, be aware that you
26705 provide an easily exploitable security hole in your system.
26706 Of course it stands to reason that such unsafe templates will never be
26707 included in the standard \SpecialChar LyX
26708 distribution, although we do encourage people
26709 to submit new templates in the open source tradition.
26710 But \SpecialChar LyX
26711 as shipped from the official distribution channels will never have
26715 \begin_layout Standard
26716 Including external material provides a lot of power, and you have to be
26717 careful not to introduce security hazards with this power.
26718 A subtle error in a single line in an innocent looking script can open
26719 the door to huge security problems.
26720 So if you do not fully understand the issues, we recommend that you consult
26721 a knowledgeable security professional or the \SpecialChar LyX
26722 development team if you have
26723 any questions about whether a given template is safe or not.
26724 And do this before you use it in an uncontrolled environment.
26727 \begin_layout Chapter
26729 List of supported \SpecialChar LyX
26730 functions to be used in layouts
26731 \begin_inset CommandInset label
26733 name "chap:List-of-functions"
26740 \begin_layout Standard
26742 \begin_inset Tabular
26743 <lyxtabular version="3" rows="11" columns="8">
26744 <features tabularvalignment="middle">
26745 <column alignment="left" valignment="top">
26746 <column alignment="left" valignment="top">
26747 <column alignment="left" valignment="top">
26748 <column alignment="left" valignment="top">
26749 <column alignment="left" valignment="top">
26750 <column alignment="left" valignment="top">
26751 <column alignment="left" valignment="top">
26752 <column alignment="left" valignment="top">
26754 <cell alignment="left" valignment="top" usebox="none">
26757 \begin_layout Plain Layout
26763 <cell alignment="left" valignment="top" usebox="none">
26766 \begin_layout Plain Layout
26772 <cell alignment="left" valignment="top" usebox="none">
26775 \begin_layout Plain Layout
26781 <cell alignment="left" valignment="top" usebox="none">
26784 \begin_layout Plain Layout
26790 <cell alignment="center" valignment="top" usebox="none">
26793 \begin_layout Plain Layout
26799 <cell alignment="center" valignment="top" usebox="none">
26802 \begin_layout Plain Layout
26808 <cell alignment="center" valignment="top" usebox="none">
26811 \begin_layout Plain Layout
26817 <cell alignment="center" valignment="top" usebox="none">
26820 \begin_layout Plain Layout
26828 <cell alignment="left" valignment="top" usebox="none">
26831 \begin_layout Plain Layout
26837 <cell alignment="left" valignment="top" usebox="none">
26840 \begin_layout Plain Layout
26846 <cell alignment="left" valignment="top" usebox="none">
26849 \begin_layout Plain Layout
26855 <cell alignment="left" valignment="top" usebox="none">
26858 \begin_layout Plain Layout
26864 <cell alignment="center" valignment="top" usebox="none">
26867 \begin_layout Plain Layout
26873 <cell alignment="center" valignment="top" usebox="none">
26876 \begin_layout Plain Layout
26882 <cell alignment="center" valignment="top" usebox="none">
26885 \begin_layout Plain Layout
26891 <cell alignment="center" valignment="top" usebox="none">
26894 \begin_layout Plain Layout
26902 <cell alignment="left" valignment="top" usebox="none">
26905 \begin_layout Plain Layout
26911 <cell alignment="left" valignment="top" usebox="none">
26914 \begin_layout Plain Layout
26920 <cell alignment="left" valignment="top" usebox="none">
26923 \begin_layout Plain Layout
26929 <cell alignment="left" valignment="top" usebox="none">
26932 \begin_layout Plain Layout
26938 <cell alignment="center" valignment="top" usebox="none">
26941 \begin_layout Plain Layout
26947 <cell alignment="center" valignment="top" usebox="none">
26950 \begin_layout Plain Layout
26956 <cell alignment="center" valignment="top" usebox="none">
26959 \begin_layout Plain Layout
26965 <cell alignment="center" valignment="top" usebox="none">
26968 \begin_layout Plain Layout
26976 <cell alignment="left" valignment="top" usebox="none">
26979 \begin_layout Plain Layout
26985 <cell alignment="left" valignment="top" usebox="none">
26988 \begin_layout Plain Layout
26994 <cell alignment="left" valignment="top" usebox="none">
26997 \begin_layout Plain Layout
27003 <cell alignment="left" valignment="top" usebox="none">
27006 \begin_layout Plain Layout
27012 <cell alignment="center" valignment="top" usebox="none">
27015 \begin_layout Plain Layout
27021 <cell alignment="center" valignment="top" usebox="none">
27024 \begin_layout Plain Layout
27030 <cell alignment="center" valignment="top" usebox="none">
27033 \begin_layout Plain Layout
27039 <cell alignment="center" valignment="top" usebox="none">
27042 \begin_layout Plain Layout
27050 <cell alignment="left" valignment="top" usebox="none">
27053 \begin_layout Plain Layout
27059 <cell alignment="left" valignment="top" usebox="none">
27062 \begin_layout Plain Layout
27068 <cell alignment="left" valignment="top" usebox="none">
27071 \begin_layout Plain Layout
27077 <cell alignment="left" valignment="top" usebox="none">
27080 \begin_layout Plain Layout
27086 <cell alignment="center" valignment="top" usebox="none">
27089 \begin_layout Plain Layout
27095 <cell alignment="center" valignment="top" usebox="none">
27098 \begin_layout Plain Layout
27104 <cell alignment="center" valignment="top" usebox="none">
27107 \begin_layout Plain Layout
27113 <cell alignment="center" valignment="top" usebox="none">
27116 \begin_layout Plain Layout
27124 <cell alignment="left" valignment="top" usebox="none">
27127 \begin_layout Plain Layout
27133 <cell alignment="left" valignment="top" usebox="none">
27136 \begin_layout Plain Layout
27142 <cell alignment="left" valignment="top" usebox="none">
27145 \begin_layout Plain Layout
27151 <cell alignment="left" valignment="top" usebox="none">
27154 \begin_layout Plain Layout
27160 <cell alignment="center" valignment="top" usebox="none">
27163 \begin_layout Plain Layout
27169 <cell alignment="center" valignment="top" usebox="none">
27172 \begin_layout Plain Layout
27178 <cell alignment="center" valignment="top" usebox="none">
27181 \begin_layout Plain Layout
27187 <cell alignment="center" valignment="top" usebox="none">
27190 \begin_layout Plain Layout
27198 <cell alignment="left" valignment="top" usebox="none">
27201 \begin_layout Plain Layout
27207 <cell alignment="left" valignment="top" usebox="none">
27210 \begin_layout Plain Layout
27216 <cell alignment="left" valignment="top" usebox="none">
27219 \begin_layout Plain Layout
27225 <cell alignment="left" valignment="top" usebox="none">
27228 \begin_layout Plain Layout
27234 <cell alignment="center" valignment="top" usebox="none">
27237 \begin_layout Plain Layout
27243 <cell alignment="center" valignment="top" usebox="none">
27246 \begin_layout Plain Layout
27252 <cell alignment="center" valignment="top" usebox="none">
27255 \begin_layout Plain Layout
27261 <cell alignment="center" valignment="top" usebox="none">
27264 \begin_layout Plain Layout
27272 <cell alignment="left" valignment="top" usebox="none">
27275 \begin_layout Plain Layout
27281 <cell alignment="left" valignment="top" usebox="none">
27284 \begin_layout Plain Layout
27290 <cell alignment="left" valignment="top" usebox="none">
27293 \begin_layout Plain Layout
27299 <cell alignment="left" valignment="top" usebox="none">
27302 \begin_layout Plain Layout
27308 <cell alignment="center" valignment="top" usebox="none">
27311 \begin_layout Plain Layout
27317 <cell alignment="center" valignment="top" usebox="none">
27320 \begin_layout Plain Layout
27326 <cell alignment="center" valignment="top" usebox="none">
27329 \begin_layout Plain Layout
27335 <cell alignment="center" valignment="top" usebox="none">
27338 \begin_layout Plain Layout
27346 <cell alignment="left" valignment="top" usebox="none">
27349 \begin_layout Plain Layout
27355 <cell alignment="left" valignment="top" usebox="none">
27358 \begin_layout Plain Layout
27364 <cell alignment="left" valignment="top" usebox="none">
27367 \begin_layout Plain Layout
27373 <cell alignment="left" valignment="top" usebox="none">
27376 \begin_layout Plain Layout
27382 <cell alignment="center" valignment="top" usebox="none">
27385 \begin_layout Plain Layout
27391 <cell alignment="center" valignment="top" usebox="none">
27394 \begin_layout Plain Layout
27400 <cell alignment="center" valignment="top" usebox="none">
27403 \begin_layout Plain Layout
27409 <cell alignment="center" valignment="top" usebox="none">
27412 \begin_layout Plain Layout
27420 <cell alignment="left" valignment="top" usebox="none">
27423 \begin_layout Plain Layout
27429 <cell alignment="left" valignment="top" usebox="none">
27432 \begin_layout Plain Layout
27438 <cell alignment="left" valignment="top" usebox="none">
27441 \begin_layout Plain Layout
27447 <cell alignment="left" valignment="top" usebox="none">
27450 \begin_layout Plain Layout
27456 <cell alignment="center" valignment="top" usebox="none">
27459 \begin_layout Plain Layout
27465 <cell alignment="center" valignment="top" usebox="none">
27468 \begin_layout Plain Layout
27474 <cell alignment="center" valignment="top" usebox="none">
27477 \begin_layout Plain Layout
27483 <cell alignment="center" valignment="top" usebox="none">
27486 \begin_layout Plain Layout
27494 <cell alignment="center" valignment="top" usebox="none">
27497 \begin_layout Plain Layout
27503 <cell alignment="center" valignment="top" usebox="none">
27506 \begin_layout Plain Layout
27512 <cell alignment="center" valignment="top" usebox="none">
27515 \begin_layout Plain Layout
27521 <cell alignment="center" valignment="top" usebox="none">
27524 \begin_layout Plain Layout
27530 <cell alignment="center" valignment="top" usebox="none">
27533 \begin_layout Plain Layout
27539 <cell alignment="center" valignment="top" usebox="none">
27542 \begin_layout Plain Layout
27548 <cell alignment="center" valignment="top" usebox="none">
27551 \begin_layout Plain Layout
27557 <cell alignment="center" valignment="top" usebox="none">
27560 \begin_layout Plain Layout
27574 \begin_layout Chapter
27575 Names of available colors to be used in layouts
27576 \begin_inset CommandInset label
27578 name "chap:Names-of-colors"
27585 \begin_layout Standard
27586 The colors listed here are the standard colors and the those that you can
27587 adjust in the \SpecialChar LyX
27591 \begin_layout Description
27604 No particular color – clear or default
27607 \begin_layout Description
27611 \begin_layout Description
27615 \begin_layout Description
27619 \begin_layout Description
27623 \begin_layout Description
27627 \begin_layout Description
27631 \begin_layout Description
27635 \begin_layout Description
27639 \begin_layout Description
27640 added_space Added space marker color
27643 \begin_layout Description
27644 addedtext Added text color
27647 \begin_layout Description
27648 appendix Appendix marker color
27651 \begin_layout Description
27652 background Background color
27655 \begin_layout Description
27656 bottomarea Bottom area color
27659 \begin_layout Description
27660 branchlabel Label color for branches
27663 \begin_layout Description
27664 buttonbg Color used for button background
27667 \begin_layout Description
27668 buttonhoverbg Color used for button background under focus
27671 \begin_layout Description
27672 buttonframe Color for inset button frames
27675 \begin_layout Description
27676 changebar Changebar color
27679 \begin_layout Description
27680 changedtextauthor1 Changed text color author 1
27683 \begin_layout Description
27684 changedtextauthor2 Changed text color author 2
27687 \begin_layout Description
27688 changedtextauthor3 Changed text color author 3
27691 \begin_layout Description
27692 changedtextauthor4 Changed text color author 4
27695 \begin_layout Description
27696 changedtextauthor5 Changed text color author 5
27699 \begin_layout Description
27700 collapsable_inset_frame Collapsable insets framecolor
27703 \begin_layout Description
27704 collapsable_inset_text Collapsable insets text color
27707 \begin_layout Description
27708 command Text color for command insets
27711 \begin_layout Description
27712 commandbg Background color for command insets
27715 \begin_layout Description
27716 commandframe Frame color for command insets
27719 \begin_layout Description
27720 comment color for comments
27723 \begin_layout Description
27724 commentbg Background color of comments
27727 \begin_layout Description
27728 cursor Cursor color
27731 \begin_layout Description
27732 deletedtext Deleted text color
27735 \begin_layout Description
27736 deletedtextmodifier Deleted text modifying color
27739 \begin_layout Description
27740 depthbar Color for the depth bars in the margin
27743 \begin_layout Description
27744 eolmarker End of line marker color
27747 \begin_layout Description
27748 error Color of the \SpecialChar LaTeX
27752 \begin_layout Description
27753 footlabel Label color for footnotes
27756 \begin_layout Description
27757 graphicsbg Graphics inset background color
27760 \begin_layout Description
27761 greyedout Label color for greyedout insets
27764 \begin_layout Description
27765 greyedoutbg Background color of greyedout inset
27768 \begin_layout Description
27769 greyedouttext Color for greyedout inset text
27772 \begin_layout Description
27773 indexlabel Label color for index insets
27776 \begin_layout Description
27777 ignore The color is ignored
27780 \begin_layout Description
27781 inherit The color is inherited
27784 \begin_layout Description
27785 inlinecompletion Inline completion color
27788 \begin_layout Description
27789 insetbg Inset marker background color
27792 \begin_layout Description
27793 insetframe Inset marker frame color
27796 \begin_layout Description
27797 language Color for marking foreign language words
27800 \begin_layout Description
27801 latex Text color in \SpecialChar LaTeX
27805 \begin_layout Description
27806 listingsbg Background color of listings inset
27809 \begin_layout Description
27810 marginlabel Label color for margin notes
27813 \begin_layout Description
27814 math Math inset text color
27817 \begin_layout Description
27818 mathbg Math inset background color
27821 \begin_layout Description
27822 mathcorners Math inset frame color not under focus
27825 \begin_layout Description
27826 mathframe Math inset frame color under focus
27829 \begin_layout Description
27830 mathline Math line color
27833 \begin_layout Description
27834 mathmacrobg Macro math inset background color
27837 \begin_layout Description
27838 mathmacroblend Macro math blended color
27841 \begin_layout Description
27842 mathmacroframe Macro math frame color
27845 \begin_layout Description
27846 mathmacrohoverbg Macro math inset background color hovered
27849 \begin_layout Description
27850 mathmacrolabel Macro math label color
27853 \begin_layout Description
27854 mathmacronewarg Macro template color for new parameters
27857 \begin_layout Description
27858 mathmacrooldarg Macro template color for old parameters
27861 \begin_layout Description
27862 newpage New page color
27865 \begin_layout Description
27866 nonunique_inlinecompletion Inline completion color for the non-unique part
27869 \begin_layout Description
27870 notebg Background color of notes
27873 \begin_layout Description
27874 notelabel Label color for notes
27877 \begin_layout Description
27878 pagebreak Page break/line break color
27881 \begin_layout Description
27882 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
27885 \begin_layout Description
27886 phantomtext Text color for phantom insets
27889 \begin_layout Description
27890 preview The color used for previews
27893 \begin_layout Description
27894 previewframe Preview frame color
27897 \begin_layout Description
27898 regexpframe Color for regexp frame
27901 \begin_layout Description
27902 selection Background color of selected text
27905 \begin_layout Description
27906 selectiontext Foreground color of selected text
27909 \begin_layout Description
27910 shadedbg Background color of shaded box
27913 \begin_layout Description
27914 special Special chars text color
27917 \begin_layout Description
27918 tabularline Table line color
27921 \begin_layout Description
27922 tabularonoffline Table line color
27925 \begin_layout Description
27926 urllabel Label color for URL insets
27929 \begin_layout Description
27930 urltext Color for URL inset text