1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 1
86 \use_package amssymb 1
89 \use_package mathdots 1
90 \use_package mathtools 1
92 \use_package stackrel 1
93 \use_package stmaryrd 1
94 \use_package undertilde 1
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes false
128 \output_changes false
137 Customizing \SpecialChar LyX
138 : Features for the Advanced User
142 by the \SpecialChar LyX
147 \begin_layout Plain Layout
149 If you have comments or error corrections, please send them to the \SpecialChar LyX
152 \begin_inset CommandInset href
154 target "lyx-docs@lists.lyx.org"
162 \begin_inset Quotes eld
166 \begin_inset Quotes erd
169 in the subject header, and please cc the current maintainer of this file,
170 Richard Heck <rgheck@comcast.net>.
176 \begin_inset Newline newline
180 \begin_inset Newline newline
186 \begin_layout Standard
187 \begin_inset CommandInset toc
188 LatexCommand tableofcontents
195 \begin_layout Standard
196 \begin_inset Note Note
199 \begin_layout Plain Layout
200 Please use change tracking when modifying this document.
201 This makes it easier for our translators to recognize things that have
202 been changed, and it helps the maintainer keep up-to-date with what's been
211 \begin_layout Chapter
215 \begin_layout Standard
216 This manual covers the customization features present in \SpecialChar LyX
218 In it, we discuss issues like keyboard shortcuts, screen previewing options,
219 printer options, sending commands to \SpecialChar LyX
220 via the \SpecialChar LyX
221 Server, internationalization,
222 installing new \SpecialChar LaTeX
223 classes and \SpecialChar LyX
225 We can't possibly hope to touch on everything you can change—our developers
226 add new features faster than we can document them—but we will explain the
227 most common customizations and hopefully point you in the right direction
228 for some of the more obscure ones.
231 \begin_layout Standard
232 \begin_inset Branch OutDated
236 \begin_layout Standard
237 Information from previous versions of this document that now seems to be
238 outdated is contained in the OutDated branch of this document.
239 By default, this information will not appear in the \SpecialChar LaTeX
248 \begin_layout Chapter
253 \begin_layout Standard
254 This chapter aims to help you to find your way through the \SpecialChar LyX
257 Before continuing to read this chapter, you should find out where your
259 library and user directories are by using
260 \begin_inset Flex Noun
263 \begin_layout Plain Layout
264 Help\SpecialChar menuseparator
275 The library directory is the place where \SpecialChar LyX
276 places its system-wide configuration
277 files; the user directory is where you can place your modified versions.
278 We will call the former
279 \begin_inset Flex Code
282 \begin_layout Plain Layout
289 \begin_inset Flex Noun
292 \begin_layout Plain Layout
298 in the remainder of this document.
302 \begin_layout Section
304 \begin_inset Flex Code
307 \begin_layout Plain Layout
316 \begin_layout Standard
317 \begin_inset Flex Code
320 \begin_layout Plain Layout
326 and its sub-directories contain a number of files and that can be used
327 to customize \SpecialChar LyX
329 You can change many of these files from within \SpecialChar LyX
331 \begin_inset Flex Noun
334 \begin_layout Plain Layout
335 Tools\SpecialChar menuseparator
342 Most customization that you will want to do in \SpecialChar LyX
343 is possible through this
345 However, many other inner aspects of \SpecialChar LyX
346 can be customized by modifying the
348 \begin_inset Flex Code
351 \begin_layout Plain Layout
358 These files fall in different categories, described in the following subsection
362 \begin_layout Subsection
363 Automatically generated files
366 \begin_layout Standard
367 The files, which are to be found in
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
377 , are generated when you configure \SpecialChar LyX
379 They contain various default values that are guessed by inspection.
380 In general, it is not a good idea to modify them, since they might be overwritt
384 \begin_layout Labeling
385 \labelwidthstring 00.00.0000
386 \begin_inset Flex Code
389 \begin_layout Plain Layout
395 contains defaults for various commands.
398 \begin_layout Labeling
399 \labelwidthstring 00.00.0000
400 \begin_inset Flex Code
403 \begin_layout Plain Layout
409 contains the list of packages that have been recognized by \SpecialChar LyX
411 It is currently unused by the \SpecialChar LyX
412 program itself, but the information extracted,
413 and more, is made available with
414 \begin_inset Flex Noun
417 \begin_layout Plain Layout
418 Help\SpecialChar menuseparator
432 \begin_layout Labeling
433 \labelwidthstring 00.00.0000
434 \begin_inset Flex Code
437 \begin_layout Plain Layout
443 the list of text classes that have been found in your
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
453 directories, along with the associated \SpecialChar LaTeX
454 document class and their description.
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 the list of layout modules found in your
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
481 \begin_layout Labeling
482 \labelwidthstring 00.00.0000
483 \begin_inset Flex Code
486 \begin_layout Plain Layout
492 lists of various sorts of \SpecialChar LaTeX
493 -related files found on your system
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
502 doc/\SpecialChar LaTeX
508 is automatically generated during configuration from the file
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
520 It contains information on your \SpecialChar LaTeX
524 \begin_layout Subsection
528 \begin_layout Standard
529 These directories are duplicated between
530 \begin_inset Flex Code
533 \begin_layout Plain Layout
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 If a particular files exists in both places, the one in
551 \begin_inset Flex Code
554 \begin_layout Plain Layout
563 \begin_layout Labeling
564 \labelwidthstring 00.00.0000
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 this directory contains files with the extension
575 \begin_inset Flex Code
578 \begin_layout Plain Layout
584 that define the keybindings used in \SpecialChar LyX
586 If there exists an internationalized version of the bind file named
587 \begin_inset Flex Code
590 \begin_layout Plain Layout
596 , that will be used first.
599 \begin_layout Labeling
600 \labelwidthstring 00.00.0000
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
610 contains files with the extension
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
620 which define the diverse citation possibilities (natbib, biblatex etc.).
622 \begin_inset CommandInset ref
624 reference "subsec:Cite-Engine-Files"
634 \begin_layout Labeling
635 \labelwidthstring 00.00.0000
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
645 contains graphics files that can be included in documents.
649 \begin_layout Labeling
650 \labelwidthstring 00.00.0000
651 \begin_inset Flex Code
654 \begin_layout Plain Layout
660 contains \SpecialChar LyX
661 documentation files (including the one you are currently reading).
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
673 deserves special attention, as noted above.
674 The internationalized help docs are in subdirectories
675 \begin_inset Flex Code
678 \begin_layout Plain Layout
685 \begin_inset Quotes eld
689 \begin_inset Quotes erd
692 is the ISO language code.
694 \begin_inset CommandInset ref
696 reference "cha:Internationalizing-LyX"
703 \begin_layout Labeling
704 \labelwidthstring 00.00.0000
705 \begin_inset Flex Code
708 \begin_layout Plain Layout
714 contains example files that explain how to use some features.
715 In the file browser, press the
716 \begin_inset Flex Noun
719 \begin_layout Plain Layout
728 \begin_layout Labeling
729 \labelwidthstring 00.00.0000
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
739 contains image files that are used by the
740 \begin_inset Flex Noun
743 \begin_layout Plain Layout
750 In addition, it also contains the individual icons used in the toolbar
751 and the banners that can be shown when \SpecialChar LyX
755 \begin_layout Labeling
756 \labelwidthstring 00.00.0000
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
766 contains keyboard keymapping files.
768 \begin_inset CommandInset ref
770 reference "sec:International-Keymap-Stuff"
777 \begin_layout Labeling
778 \labelwidthstring 00.00.0000
779 \begin_inset Flex Code
782 \begin_layout Plain Layout
788 contains the text class and module files described in
789 \begin_inset CommandInset ref
791 reference "cha:Installing-New-Document"
798 \begin_layout Labeling
799 \labelwidthstring 00.00.0000
800 \begin_inset Flex Code
803 \begin_layout Plain Layout
810 \begin_inset Flex Code
813 \begin_layout Plain Layout
819 Python scripts used to convert between \SpecialChar LyX
821 These can be run from the command line if, say, you want to batch-convert
825 \begin_layout Labeling
826 \labelwidthstring 00.00.0000
827 \begin_inset Flex Code
830 \begin_layout Plain Layout
836 contains some files that demonstrate the capabilities of the
837 \begin_inset Flex Noun
840 \begin_layout Plain Layout
851 Also contains some scripts used by \SpecialChar LyX
855 \begin_layout Labeling
856 \labelwidthstring 00.00.0000
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
866 contains the standard \SpecialChar LyX
867 template files described in
868 \begin_inset CommandInset ref
870 reference "subsec:Creating-Templates"
877 \begin_layout Labeling
878 \labelwidthstring 00.00.0000
879 \begin_inset Flex Code
882 \begin_layout Plain Layout
888 contains files with the extension
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
898 that define the user interface to \SpecialChar LyX
900 That is, the files define which items appear in which menus and the items
901 appearing on the toolbar.
904 \begin_layout Labeling
905 \labelwidthstring 00.00.0000
906 \begin_inset Flex Code
909 \begin_layout Plain Layout
915 contains files with the extension
916 \begin_inset Flex Code
919 \begin_layout Plain Layout
925 which define the templates for the insertion of external material to a
928 \begin_inset CommandInset ref
930 reference "chap:Including-External-Material"
937 \begin_layout Subsection
938 Files you don't want to modify
941 \begin_layout Standard
942 These files are used internally by \SpecialChar LyX
943 and you generally do not need to modify
944 them unless you are a developer.
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
958 this file contains the list of \SpecialChar LyX
960 The contents are displayed with the menu entry
961 \begin_inset Flex Noun
964 \begin_layout Plain Layout
965 Help\SpecialChar menuseparator
978 \begin_layout Labeling
979 \labelwidthstring 00.00.0000
980 \begin_inset Flex Code
983 \begin_layout Plain Layout
989 this is a \SpecialChar LaTeX
990 script used during the configuration process.
994 \begin_layout Labeling
995 \labelwidthstring 00.00.0000
996 \begin_inset Flex Code
999 \begin_layout Plain Layout
1005 this is a Python script that is used to re-configure \SpecialChar LyX
1007 It creates configuration files in the directory it was run from.
1010 \begin_layout Subsection
1011 Other files needing a line or two
1014 \begin_layout Labeling
1015 \labelwidthstring 00.00.0000
1016 \begin_inset Flex Code
1019 \begin_layout Plain Layout
1025 this contains tables describing how different character encodings can be
1029 \begin_layout Labeling
1030 \labelwidthstring 00.00.0000
1031 \begin_inset Flex Code
1034 \begin_layout Plain Layout
1040 this file contains a list of all the languages currently supported by \SpecialChar LyX
1044 \begin_layout Labeling
1045 \labelwidthstring 00.00.0000
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1055 contains information about the supported fonts.
1058 \begin_layout Labeling
1059 \labelwidthstring 00.00.0000
1060 \begin_inset Flex Code
1063 \begin_layout Plain Layout
1069 this file contains translations for internationalized paragraph styles
1071 \begin_inset CommandInset ref
1073 reference "subsec:I18n"
1080 \begin_layout Labeling
1081 \labelwidthstring 00.00.0000
1082 \begin_inset Flex Code
1085 \begin_layout Plain Layout
1091 this file contains information about Unicode-encoded glyphs and the way
1092 they are supported by \SpecialChar LyX
1093 via \SpecialChar LaTeX
1097 \begin_layout Section
1098 Your local configuration directory
1101 \begin_layout Standard
1102 Even if you are using \SpecialChar LyX
1103 as an unprivileged user, you might want to change
1105 configuration for your own use.
1107 \begin_inset Flex Code
1110 \begin_layout Plain Layout
1116 directory contains all your personal configuration files.
1117 This is the directory described as
1118 \begin_inset Quotes eld
1122 \begin_inset Quotes erd
1126 \begin_inset Flex Noun
1129 \begin_layout Plain Layout
1130 Help\SpecialChar menuseparator
1132 \begin_inset space ~
1141 This directory is used as a mirror of
1142 \begin_inset Flex Code
1145 \begin_layout Plain Layout
1151 , which means that every file in
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1161 is a replacement for the corresponding file in
1162 \begin_inset Flex Code
1165 \begin_layout Plain Layout
1172 Any configuration file described in the above sections can be placed either
1173 in the system-wide directory, in which case it will affect all users, or
1174 in your local directory for your own use.
1177 \begin_layout Standard
1178 To make things clearer, let's provide a few examples:
1181 \begin_layout Itemize
1182 The preferences set in the
1183 \begin_inset Flex Noun
1186 \begin_layout Plain Layout
1187 Tools\SpecialChar menuseparator
1193 dialog are saved to a file
1194 \begin_inset Flex Code
1197 \begin_layout Plain Layout
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1216 \begin_layout Itemize
1217 When you reconfigure using
1218 \begin_inset Flex Noun
1221 \begin_layout Plain Layout
1222 Tools\SpecialChar menuseparator
1230 \begin_inset Flex Code
1233 \begin_layout Plain Layout
1239 script, and the resulting files are written in your local configuration
1241 This means that any additional text class file that you might have added
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1252 will be added to the list of classes in the
1253 \begin_inset Flex Noun
1256 \begin_layout Plain Layout
1257 Document\SpecialChar menuseparator
1266 \begin_layout Itemize
1267 If you get some updated documentation from \SpecialChar LyX
1268 ftp site and cannot install
1269 it because you do not have sysadmin rights on your system, you can just
1271 \begin_inset Flex Code
1274 \begin_layout Plain Layout
1280 and the items in the
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1290 menu will open them!
1293 \begin_layout Section
1294 Running \SpecialChar LyX
1295 with multiple configurations
1298 \begin_layout Standard
1299 The configuration freedom of the local configuration directory may not suffice
1300 if you want to have more than one configuration at your disposal.
1301 For example, you may want to be use different key bindings or printer settings
1303 You can achieve this by having several such directories.
1304 You then specify which directory to use at run-time.
1307 \begin_layout Standard
1308 Invoking \SpecialChar LyX
1309 with the command line switch
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1323 instructs the program to read the configuration from that directory, and
1324 not from the default directory.
1325 (You can determine the default directory by running \SpecialChar LyX
1327 \begin_inset Flex Code
1330 \begin_layout Plain Layout
1336 switch.) If the specified directory does not exist, \SpecialChar LyX
1338 for you, just like it does for the default directory on the first time
1339 you run the program.
1340 You can modify the configuration options in this additional user directory
1341 exactly as you would for the default directory.
1342 These directories are completely independent (but read on).
1343 Note that setting the environment variable
1344 \begin_inset Flex Code
1347 \begin_layout Plain Layout
1353 to some value has exactly the same effect.
1356 \begin_layout Standard
1357 Having several configurations also requires more maintenance: if you want
1358 to add a new layout to
1359 \begin_inset Flex Code
1362 \begin_layout Plain Layout
1368 which you want available from all your configurations, you must add it
1369 to each directory separately.
1370 You can avoid this with the following trick: after \SpecialChar LyX
1371 creates the additional
1372 directory, most of the subdirectories (see above) are empty.
1373 If you want the new configuration to mirror an existing one, replace the
1374 empty subdirectory with a symbolic link to the matching subdirectory in
1375 the existing configuration.
1377 \begin_inset Flex Code
1380 \begin_layout Plain Layout
1386 subdirectory, however, since it contains a file written by the configuration
1387 script (also accessible through
1388 \begin_inset Flex Noun
1391 \begin_layout Plain Layout
1392 Tools\SpecialChar menuseparator
1398 ) which is configuration-specific.
1401 \begin_layout Chapter
1402 The Preferences dialog
1405 \begin_layout Standard
1406 All options of the preferences dialog are described in the Appendix
1408 The Preferences Dialog
1415 For some options you might find here more details.
1418 \begin_layout Section
1420 \begin_inset CommandInset label
1429 \begin_layout Standard
1430 The first step is to define your file formats if they are not already defined.
1432 \begin_inset Flex Noun
1435 \begin_layout Plain Layout
1436 Tools\SpecialChar menuseparator
1444 \begin_inset Flex Noun
1447 \begin_layout Plain Layout
1448 File Handling\SpecialChar menuseparator
1455 \begin_inset Flex Noun
1458 \begin_layout Plain Layout
1464 button to define your new format.
1466 \begin_inset Flex Noun
1469 \begin_layout Plain Layout
1475 field contains the name used to identify the format in the GUI.
1477 \begin_inset Flex Noun
1480 \begin_layout Plain Layout
1486 is used to identify the format internally.
1487 You will also need to enter a file extension.
1488 These are all required.
1490 \begin_inset Flex Noun
1493 \begin_layout Plain Layout
1499 field is used to provide a keyboard shortcut on the menus.
1500 (For example, pressing
1501 \begin_inset Flex Noun
1504 \begin_layout Plain Layout
1511 \begin_inset Flex Noun
1514 \begin_layout Plain Layout
1515 Document\SpecialChar menuseparator
1516 View (Other Formats)\SpecialChar menuseparator
1525 \begin_layout Standard
1527 \begin_inset Flex Noun
1530 \begin_layout Plain Layout
1537 \begin_inset Flex Noun
1540 \begin_layout Plain Layout
1547 For example, you might want to use
1548 \begin_inset Flex Noun
1551 \begin_layout Plain Layout
1557 to view PostScript files.
1558 You can enter the command needed to start the program in the corresponding
1560 In defining this command, you can use the four variables listed in the
1562 The viewer is launched when you view an image in \SpecialChar LyX
1564 \begin_inset Flex Noun
1567 \begin_layout Plain Layout
1568 Document\SpecialChar menuseparator
1575 The editor is for example launched when you right-click on an image and
1577 \begin_inset Flex Noun
1580 \begin_layout Plain Layout
1586 in the appearing context menu.
1589 \begin_layout Standard
1591 \begin_inset Flex Noun
1594 \begin_layout Plain Layout
1600 type of a format is optional, but if it is specified, it must be unique
1602 It is used to detect files of this format from the file contents.
1603 For some important file formats there is no MIME type officially registered
1605 \begin_inset CommandInset href
1608 target "http://www.iana.org/assignments/media-types/"
1614 Therefore \SpecialChar LyX
1615 uses the extended list of MIME types as specified by
1616 \begin_inset CommandInset href
1618 name "freedesktop.org"
1619 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1627 \begin_layout Standard
1629 \begin_inset Flex Noun
1632 \begin_layout Plain Layout
1638 option tells \SpecialChar LyX
1639 that a format is suitable for document export.
1640 If this is set and if a suitable conversion route exists (see
1641 \begin_inset CommandInset ref
1643 reference "sec:Converters"
1647 ), the format will appear in the
1648 \begin_inset Flex Noun
1651 \begin_layout Plain Layout
1652 File\SpecialChar menuseparator
1659 The format will also appear in the
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1664 Document\SpecialChar menuseparator
1670 menu if a viewer is specified for the format.
1671 Pure image formats, such as
1672 \begin_inset Flex Code
1675 \begin_layout Plain Layout
1681 , should not use this option.
1682 Formats that can both represent vector graphics and documents like
1683 \begin_inset Flex Code
1686 \begin_layout Plain Layout
1695 \begin_layout Standard
1697 \begin_inset Flex Noun
1700 \begin_layout Plain Layout
1701 Vector graphics format
1706 tells \SpecialChar LyX
1707 that a format can contain vector graphics.
1708 This information is used to determine the target format of included graphics
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1720 Included graphics may need to be converted to either
1721 \begin_inset Flex Noun
1724 \begin_layout Plain Layout
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1751 \begin_inset Flex Noun
1754 \begin_layout Plain Layout
1760 cannot handle other image formats.
1761 If an included graphic is not already in
1762 \begin_inset Flex Noun
1765 \begin_layout Plain Layout
1772 \begin_inset Flex Noun
1775 \begin_layout Plain Layout
1782 \begin_inset Flex Noun
1785 \begin_layout Plain Layout
1791 format, it is converted to
1792 \begin_inset Flex Noun
1795 \begin_layout Plain Layout
1801 if the vector format option is set, and otherwise to
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1814 \begin_layout Section
1818 \begin_layout Standard
1819 Since all conversions from one format to another take place in \SpecialChar LyX
1821 directory, it is sometimes necessary to modify a file before copying it
1822 to the temporary directory in order that the conversion may be performed.
1826 \begin_layout Plain Layout
1827 For example, the file may refer to other files—images, for example—using
1828 relative file names, and these may become invalid when the file is copied
1829 to the temporary directory.
1834 This is done by a Copier: It copies a file to (or from) the temporary directory
1835 and may modify it in the process.
1838 \begin_layout Standard
1839 The definitions of the copiers may use eight variables:
1842 \begin_layout Labeling
1843 \labelwidthstring 00.00.0000
1844 \begin_inset Flex Code
1847 \begin_layout Plain Layout
1853 The \SpecialChar LyX
1854 system directory (e.
1855 \begin_inset space \thinspace{}
1859 \begin_inset space \space{}
1863 \begin_inset Flex Noun
1866 \begin_layout Plain Layout
1875 \begin_layout Labeling
1876 \labelwidthstring 00.00.0000
1877 \begin_inset Flex Code
1880 \begin_layout Plain Layout
1889 \begin_layout Labeling
1890 \labelwidthstring 00.00.0000
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1903 \begin_layout Labeling
1904 \labelwidthstring 00.00.0000
1905 \begin_inset Flex Code
1908 \begin_layout Plain Layout
1914 The base name (without filename extension) in the \SpecialChar LyX
1918 \begin_layout Labeling
1919 \labelwidthstring 00.00.0000
1920 \begin_inset Flex Code
1923 \begin_layout Plain Layout
1929 The full directory path of the \SpecialChar LyX
1933 \begin_layout Labeling
1934 \labelwidthstring 00.00.0000
1935 \begin_inset Flex Code
1938 \begin_layout Plain Layout
1944 The full pathname to the original \SpecialChar LyX
1945 file being processed
1948 \begin_layout Labeling
1949 \labelwidthstring 00.00.0000
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1959 The filename (without any directory path) of the \SpecialChar LyX
1963 \begin_layout Labeling
1964 \labelwidthstring 00.00.0000
1965 \begin_inset Flex Code
1968 \begin_layout Plain Layout
1974 The `\SpecialChar LaTeX
1978 \begin_layout Standard
1979 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1987 It is relevant only when exporting files suitable for such inclusion.
1990 \begin_layout Standard
1991 Copiers can be used to do almost anything with output files.
1992 For example, suppose you want generated pdf files to be copied to a special
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
2004 Then you could write a shell script such as this one:
2007 \begin_layout Standard
2008 \begin_inset listings
2012 \begin_layout Plain Layout
2017 \begin_layout Plain Layout
2022 \begin_layout Plain Layout
2024 TOFILE=`basename $2`
2027 \begin_layout Plain Layout
2029 cp $FROMFILE /home/you/pdf/$TOFILE
2034 Save it in your local \SpecialChar LyX
2036 \begin_inset Flex Code
2039 \begin_layout Plain Layout
2040 /home/you/.lyx/scripts/pdfcopier.sh
2045 —and make it executable, if you need to do so on your platform.
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2051 Tools\SpecialChar menuseparator
2057 dialog, select under
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 File Handling\SpecialChar menuseparator
2069 \begin_inset Flex Noun
2072 \begin_layout Plain Layout
2078 format—or one of the other pdf formats—and enter
2079 \begin_inset Flex Code
2082 \begin_layout Plain Layout
2083 pdfcopier.sh $$i $$o
2089 \begin_inset Flex Noun
2092 \begin_layout Plain Layout
2102 \begin_layout Standard
2103 Copiers are used by \SpecialChar LyX
2104 in various of its own conversions.
2105 For example, if appropriate programs are found, \SpecialChar LyX
2106 will automatically install
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2118 \begin_inset Flex Noun
2121 \begin_layout Plain Layout
2123 \begin_inset space ~
2132 When these formats are exported, the copier sees that not just the main
2133 HTML file but various associated files (style files, images, etc.) are also
2135 All these files are written to a subdirectory of the directory in which
2136 the original \SpecialChar LyX
2141 \begin_layout Plain Layout
2142 This copier can be customized.
2144 \begin_inset Quotes eld
2148 \begin_inset Quotes erd
2151 argument takes a comma-separated list of extensions to be copied; if it
2152 is omitted, all files will be copied.
2154 \begin_inset Quotes eld
2158 \begin_inset Quotes erd
2161 argument determines the extension added to the generated directory.
2163 \begin_inset Quotes eld
2167 \begin_inset Flex Noun
2170 \begin_layout Plain Layout
2177 \begin_inset Quotes erd
2180 , so HTML generated from
2181 \begin_inset Flex Noun
2184 \begin_layout Plain Layout
2185 /path/to/filename.lyx
2191 \begin_inset Flex Noun
2194 \begin_layout Plain Layout
2195 /path/to/filename.html.LyXconv
2209 \begin_layout Section
2211 \begin_inset CommandInset label
2213 name "sec:Converters"
2220 \begin_layout Standard
2221 You can define your own Converters to convert files between different formats.
2223 \begin_inset Flex Noun
2226 \begin_layout Plain Layout
2227 Tools\SpecialChar menuseparator
2228 Preferences\SpecialChar menuseparator
2229 File Handling\SpecialChar menuseparator
2238 \begin_layout Standard
2239 To define a new converter, select the
2240 \begin_inset Flex Noun
2243 \begin_layout Plain Layout
2245 \begin_inset space ~
2254 \begin_inset Flex Noun
2257 \begin_layout Plain Layout
2259 \begin_inset space ~
2267 from the drop-down lists, enter the command needed for the conversion,
2269 \begin_inset Flex Noun
2272 \begin_layout Plain Layout
2279 Several variables can be used in the definition of converters:
2282 \begin_layout Labeling
2283 \labelwidthstring 00.00.0000
2284 \begin_inset Flex Code
2287 \begin_layout Plain Layout
2293 The \SpecialChar LyX
2297 \begin_layout Labeling
2298 \labelwidthstring 00.00.0000
2299 \begin_inset Flex Code
2302 \begin_layout Plain Layout
2311 \begin_layout Labeling
2312 \labelwidthstring 00.00.0000
2313 \begin_inset Flex Code
2316 \begin_layout Plain Layout
2325 \begin_layout Labeling
2326 \labelwidthstring 00.00.0000
2327 \begin_inset Flex Code
2330 \begin_layout Plain Layout
2336 The base filename of the input file (i.
2337 \begin_inset space \thinspace{}
2340 g., without the extension)
2343 \begin_layout Labeling
2344 \labelwidthstring 00.00.0000
2345 \begin_inset Flex Code
2348 \begin_layout Plain Layout
2354 The path to the input file
2357 \begin_layout Labeling
2358 \labelwidthstring 00.00.0000
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2368 The path to the original input file (this is different from $$p when a
2369 chain of converters is called)
2372 \begin_layout Labeling
2373 \labelwidthstring 00.00.0000
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2383 The iconv name for the encoding of the document.
2386 \begin_layout Standard
2388 \begin_inset Flex Noun
2391 \begin_layout Plain Layout
2393 \begin_inset space ~
2401 field you can enter the following flags, separated by commas:
2404 \begin_layout Labeling
2405 \labelwidthstring 00.00.0000
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2415 This converter runs some form of \SpecialChar LaTeX
2417 This will make \SpecialChar LyX
2418 's \SpecialChar LaTeX
2419 error logs available.
2422 \begin_layout Labeling
2423 \labelwidthstring 00.00.0000
2424 \begin_inset Flex Code
2427 \begin_layout Plain Layout
2433 Needs the \SpecialChar LaTeX
2435 \begin_inset Flex Noun
2438 \begin_layout Plain Layout
2444 file for the conversion.
2447 \begin_layout Labeling
2448 \labelwidthstring 00.00.0000
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2459 \begin_inset Quotes eld
2463 \begin_inset Quotes erd
2466 file from the backend, which in practice means a \SpecialChar LaTeX
2467 file like the one we
2468 would export, without
2469 \begin_inset Flex Code
2472 \begin_layout Plain Layout
2481 \begin_layout Labeling
2482 \labelwidthstring 00.00.0000
2483 \begin_inset Flex Code
2486 \begin_layout Plain Layout
2495 \begin_layout Standard
2496 The following three flags are not really flags at all because they take
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2503 \begin_inset space ~
2507 \begin_inset space ~
2518 \begin_layout Labeling
2519 \labelwidthstring 00.00.0000
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2529 If set, the converter's standard error will be redirected to a file
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2539 , and the script given as argument will be run as:
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2544 script < infile.out > infile.log
2550 The argument may contain
2551 \begin_inset Flex Code
2554 \begin_layout Plain Layout
2563 \begin_layout Labeling
2564 \labelwidthstring 00.00.0000
2565 \begin_inset Flex Code
2568 \begin_layout Plain Layout
2574 The name of the directory in which the converter will dump the generated
2577 will not create this directory, and it does not copy anything into it,
2578 though it will copy this directory to the destination.
2579 The argument may contain
2580 \begin_inset Flex Code
2583 \begin_layout Plain Layout
2589 , which will be replaced by the base name of the input and output files,
2590 respectively, when the directory is copied.
2591 \begin_inset Newline newline
2594 Note that resultdir and usetempdir make no sense together.
2595 The latter will be ignored if the former is given.
2598 \begin_layout Labeling
2599 \labelwidthstring 00.00.0000
2600 \begin_inset Flex Code
2603 \begin_layout Plain Layout
2609 Determines the output file name and may, contain
2610 \begin_inset Flex Code
2613 \begin_layout Plain Layout
2620 Sensible only with resultdir and optional even then; if not given, it defaults
2624 \begin_layout Standard
2625 None of these last three are presently used in any of the converters that
2626 are installed with \SpecialChar LyX
2631 \begin_layout Standard
2632 You do not have to define converters for all formats between which you want
2634 For example, you will note that there is no `\SpecialChar LyX
2635 to PostScript' converter,
2636 but \SpecialChar LyX
2637 will export PostScript.
2638 It does so by first creating a \SpecialChar LaTeX
2639 file (no converter needs to be defined
2640 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2642 and finally converting the resulting DVI file to PostScript.
2644 finds such `chains' of converters automatically, and it will always choose
2645 the shortest possible chain.
2646 You can, though, still define multiple conversion methods between file
2648 For example, the standard \SpecialChar LyX
2649 configuration provides five ways to convert
2654 \begin_layout Enumerate
2656 \begin_inset Flex Noun
2659 \begin_layout Plain Layout
2668 \begin_layout Enumerate
2669 via (DVI and) PostScript, using
2670 \begin_inset Flex Noun
2673 \begin_layout Plain Layout
2682 \begin_layout Enumerate
2684 \begin_inset Flex Noun
2687 \begin_layout Plain Layout
2696 \begin_layout Enumerate
2698 \begin_inset Flex Noun
2701 \begin_layout Plain Layout
2711 \begin_layout Enumerate
2713 \begin_inset Flex Noun
2716 \begin_layout Plain Layout
2726 \begin_layout Standard
2727 To define such alternate chains, you must define multiple target `file formats',
2729 \begin_inset CommandInset ref
2731 reference "sec:Formats"
2736 For example, in the standard configuration, the formats named
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2757 \begin_inset Flex Noun
2760 \begin_layout Plain Layout
2767 \begin_inset Flex Noun
2770 \begin_layout Plain Layout
2777 \begin_inset Flex Noun
2780 \begin_layout Plain Layout
2787 \begin_inset Flex Noun
2790 \begin_layout Plain Layout
2797 \begin_inset Flex Noun
2800 \begin_layout Plain Layout
2807 \begin_inset Flex Noun
2810 \begin_layout Plain Layout
2818 \begin_inset Flex Noun
2821 \begin_layout Plain Layout
2828 \begin_inset Flex Noun
2831 \begin_layout Plain Layout
2838 ) are defined, all of which share the extension
2839 \begin_inset Flex Noun
2842 \begin_layout Plain Layout
2848 , and which correspond to the conversion methods just mentioned.
2851 \begin_layout Chapter
2852 Internationalizing \SpecialChar LyX
2854 \begin_inset CommandInset label
2856 name "cha:Internationalizing-LyX"
2863 \begin_layout Standard
2865 supports using a translated interface.
2866 Last time we checked, \SpecialChar LyX
2867 provided text in thirty languages.
2868 The language of choice is called your
2873 (For further reading on locale settings, see also the documentation for
2874 locale that comes with your operating system.
2875 For Linux, the manual page for
2876 \begin_inset Flex Code
2879 \begin_layout Plain Layout
2885 could be a good place to start).
2888 \begin_layout Standard
2889 Notice that these translations will work, but do contain a few flaws.
2890 In particular, all dialogs have been designed with the English text in
2891 mind, which means that some of the translated text will be too large to
2892 fit within the space allocated.
2893 This is only a display problem and will not cause any harm.
2894 Also, you will find that some of the translations do not define shortcut
2895 keys for everything.
2896 Sometimes, there are simply not enough free letters to do it.
2897 Other times, the translator just hasn't got around to doing it yet.
2898 Our localization team, which you may wish to join,
2902 \begin_layout Plain Layout
2903 If you are a fluent speaker of a language other than English, joining these
2904 teams is a great way to give back to the \SpecialChar LyX
2910 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2914 \begin_layout Section
2915 Translating \SpecialChar LyX
2919 \begin_layout Subsection
2920 Translating the graphical user interface (text messages).
2923 \begin_layout Standard
2926 \begin_inset Flex Code
2929 \begin_layout Plain Layout
2935 library to handle the internationalization of the interface.
2936 To have \SpecialChar LyX
2937 speak your favorite language in all menus and dialogs, you need
2939 \begin_inset Flex Code
2942 \begin_layout Plain Layout
2948 -file for that language.
2949 When this is available, you'll have to generate a
2950 \begin_inset Flex Code
2953 \begin_layout Plain Layout
2959 -file from it and install the
2960 \begin_inset Flex Code
2963 \begin_layout Plain Layout
2970 The process of doing all of this is explained in the documentation for
2972 \begin_inset Flex Code
2975 \begin_layout Plain Layout
2982 It is possible to do this just for yourself, but if you're going to do
2983 it, you might as well share the results of your labors with the rest of
2984 the \SpecialChar LyX
2986 Send a message to the \SpecialChar LyX
2987 developers' list for more information about how
2991 \begin_layout Standard
2992 In short, this is what you should do (xx denotes the language code):
2995 \begin_layout Itemize
2996 Check out the \SpecialChar LyX
2999 \begin_inset CommandInset href
3001 name "information on the web"
3002 target "http://www.lyx.org/HowToUseGIT"
3010 \begin_layout Itemize
3012 \begin_inset Flex Code
3015 \begin_layout Plain Layout
3021 to the folder of the
3022 \begin_inset Flex Code
3025 \begin_layout Plain Layout
3033 \begin_inset Flex Code
3036 \begin_layout Plain Layout
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3053 doesn't exist anywhere, it can be remade with the console command
3054 \begin_inset Flex Code
3057 \begin_layout Plain Layout
3063 in that directory, or you can use an existing po-file for some other language
3067 \begin_layout Itemize
3069 \begin_inset Flex Code
3072 \begin_layout Plain Layout
3082 \begin_layout Plain Layout
3083 This is just a text file, so it can be edited in any text editor.
3084 But there are also specialized programs that support such editing, such
3089 (for all platforms) or
3098 contains a `mode' for editing
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3109 \begin_inset Flex URL
3112 \begin_layout Plain Layout
3114 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3126 For some menu- and widget-labels, there are also shortcut keys that should
3128 Those keys are marked after a `|', and should be translated according to
3129 the words and phrases of the language.
3130 You should also fill also out the information at the beginning of the new
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3141 -file with your email-address, etc., so people know where to reach you with
3142 suggestions and entertaining flames.
3145 \begin_layout Standard
3146 If you are just doing this on your own, then:
3149 \begin_layout Itemize
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3161 This can be done with
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3166 msgfmt -o xx.mo < xx.po
3174 \begin_layout Itemize
3176 \begin_inset Flex Code
3179 \begin_layout Plain Layout
3185 -file to your locale-tree, at the correct directory for application messages
3190 xx, and under the name
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3201 \begin_inset space \thinspace{}
3205 \begin_inset space \space{}
3209 \begin_inset Flex Code
3212 \begin_layout Plain Layout
3213 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3223 \begin_layout Standard
3224 As said, however, it would be best if the new
3225 \begin_inset Flex Code
3228 \begin_layout Plain Layout
3234 file could be added to the \SpecialChar LyX
3235 distribution, so others can use it.
3236 Adding it involves making additional changes to \SpecialChar LyX
3238 So send an email to the developers' mailing list if you're interested in
3242 \begin_layout Subsubsection
3246 \begin_layout Standard
3247 Sometimes it turns out that one English message needs to be translated into
3248 different messages in the target language.
3249 One example is the message
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3259 which has the German translation
3267 , depending upon exactly what the English
3268 \begin_inset Quotes eld
3272 \begin_inset Quotes erd
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3286 does not handle such ambiguous translations.
3287 Therefore you have to add some context information to the message: Instead
3289 \begin_inset Flex Code
3292 \begin_layout Plain Layout
3299 \begin_inset Flex Code
3302 \begin_layout Plain Layout
3303 To[[as in 'From format x to format y']]
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3313 To[[as in 'From page x to page y']].
3318 Now the two occurrences of
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3338 and can be translated correctly to
3349 \begin_layout Standard
3350 Of course the context information needs to be stripped off the original
3351 message when no translation is used.
3352 Therefore you have to put it in double square brackets at the end of the
3353 message (see the example above).
3354 The translation mechanism of \SpecialChar LyX
3355 ensures that everything in double square
3356 brackets at the end of messages is removed before displaying the message.
3359 \begin_layout Subsection
3360 Translating the documentation.
3363 \begin_layout Standard
3364 The online documentation (in the
3365 \begin_inset Flex Noun
3368 \begin_layout Plain Layout
3374 -menu) can (and should!) be translated.
3375 If there are translated versions of the documentation available
3379 \begin_layout Plain Layout
3380 As of March 2008, at least some of the documents have been translated into
3381 fourteen languages, with the Tutorial available in a few more.
3386 and the locale is set accordingly, these will be used automagically by
3390 looks for translated versions as
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3395 LyXDir/doc/xx/DocName.lyx
3401 \begin_inset Flex Code
3404 \begin_layout Plain Layout
3410 is the code for the language currently in use.
3411 If there are no translated documents, the default English versions will
3413 Note that the translated versions must have the same filenames (
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3423 above) as the original.
3424 If you feel up to translating the documentation (an excellent way to proof-read
3425 the original documentation by the way!), there are a few things you should
3429 \begin_layout Itemize
3430 Check out the documentation translation web page at
3431 \begin_inset CommandInset href
3433 name "http://www.lyx.org/Translation"
3434 target "http://www.lyx.org/Translation"
3440 That way, you can find out which (if any) documents have already been translate
3441 d into your language.
3442 You can also find out who (if anyone) is organizing the effort to translate
3443 the documentation into your language.
3444 If no one is organizing the effort, please let us know that you're interested.
3447 \begin_layout Standard
3448 Once you get to actually translating, here's a few hints for you that may
3452 \begin_layout Itemize
3453 Join the documentation team! There is information on how to do that in
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3464 \begin_inset Flex Noun
3467 \begin_layout Plain Layout
3468 Help\SpecialChar menuseparator
3474 ), which by the way is the first document you should translate.
3477 \begin_layout Itemize
3478 Learn the typographic conventions for the language you are translating to.
3479 Typography is an ancient art and over the centuries, a great variety of
3480 conventions have developed throughout different parts of the world.
3481 Also study the professional terminology amongst typographers in your country.
3482 Inventing your own terminology will only confuse the users.
3485 (Warning! Typography is addictive!)
3488 \begin_layout Itemize
3489 Make a copy of the document.
3490 This will be your working copy.
3491 You can use this as your personal translated help-file by placing it in
3493 \begin_inset Flex Code
3496 \begin_layout Plain Layout
3503 \begin_inset Note Greyedout
3506 \begin_layout Plain Layout
3511 For a complex document with external material (images, etc.), if you make
3513 \begin_inset space \thinspace{}
3517 \begin_inset space \space{}
3520 in a temp dir, beware that the links to external material may be broken
3521 when the document is moved to a different place.
3522 The best way is to retrieve the \SpecialChar LyX
3524 \begin_inset Flex URL
3527 \begin_layout Plain Layout
3529 http://www.lyx.org/HowToUseGIT
3534 ) and to edit the doc file in place.
3542 \begin_layout Itemize
3543 Sometimes the original document (from the \SpecialChar LyX
3544 team) will be updated.
3545 Use the source viewer at
3546 \begin_inset CommandInset href
3548 name "http://www.lyx.org/trac/timeline"
3549 target "http://www.lyx.org/trac/timeline"
3554 to see what has been changed.
3555 That way you can easily see which parts of the translated document need
3559 \begin_layout Standard
3560 If you ever find an error in the original document, fix it and notify the
3561 rest of the documentation team of the changes! (You didn't forget to join
3562 the documentation team, did you?)
3565 \begin_layout Standard
3566 \begin_inset Branch OutDated
3570 \begin_layout Section
3571 International Keyboard Support
3574 \begin_layout Standard
3577 [Editor's Note: The following section is by
3585 It needs to be fixed to conform to the new Documentation Style sheet and
3586 to make use of the new v1.0 features.
3587 The whole thing also needs to be merged with the section following it.-jw
3588 It may also be badly out of date.-rh (2008)]
3591 \begin_layout Subsection
3592 Defining Own Keymaps: Keymap File Format
3595 \begin_layout Standard
3596 Let's look at a keyboard definition file a little closer.
3597 It is a plain text file defining
3600 \begin_layout Itemize
3601 key-to-key or key-to-string translations
3604 \begin_layout Itemize
3608 \begin_layout Itemize
3609 dead keys exceptions
3612 \begin_layout Standard
3613 To define key-to-key or key-to-string translation, use this command:
3616 \begin_layout Quotation
3617 \begin_inset Flex Code
3620 \begin_layout Plain Layout
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3641 \begin_layout Standard
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3652 is the key to be translated and
3653 \begin_inset Flex Code
3656 \begin_layout Plain Layout
3662 is the string to be inserted into the document.
3663 To define dead keys, use:
3666 \begin_layout Quotation
3667 \begin_inset Flex Code
3670 \begin_layout Plain Layout
3679 \begin_inset Flex Code
3682 \begin_layout Plain Layout
3691 \begin_layout Standard
3693 \begin_inset Flex Code
3696 \begin_layout Plain Layout
3702 is a keyboard key and
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3713 The following dead keys are supported (shortcut name is in parentheses):
3716 \begin_layout Quotation
3720 \begin_inset space \hfill{}
3726 \begin_layout Quotation
3728 \begin_inset space \hfill{}
3734 \begin_layout Quotation
3736 \begin_inset space \hfill{}
3742 \begin_layout Quotation
3744 \begin_inset space \hfill{}
3750 \begin_layout Quotation
3752 \begin_inset space \hfill{}
3758 \begin_layout Quotation
3760 \begin_inset space \hfill{}
3767 \begin_layout Plain Layout
3779 \begin_layout Quotation
3781 \begin_inset space \hfill{}
3787 \begin_layout Quotation
3789 \begin_inset space \hfill{}
3796 \begin_layout Plain Layout
3808 \begin_layout Quotation
3810 \begin_inset space \hfill{}
3816 \begin_layout Quotation
3818 \begin_inset space \hfill{}
3824 \begin_layout Quotation
3826 \begin_inset space \hfill{}
3833 \begin_layout Plain Layout
3845 \begin_layout Quotation
3847 \begin_inset space \hfill{}
3854 \begin_layout Plain Layout
3866 \begin_layout Quotation
3868 \begin_inset space \hfill{}
3874 \begin_layout Quotation
3875 hungarian umlaut (hug)
3876 \begin_inset space \hfill{}
3882 \begin_layout Quotation
3884 \begin_inset space \hfill{}
3890 \begin_layout Quotation
3892 \begin_inset space \hfill{}
3899 \begin_layout Plain Layout
3911 \begin_layout Standard
3912 Since in many international keyboards there are exceptions to what some
3913 dead keys should do, you can define them using
3916 \begin_layout Quotation
3917 \begin_inset Flex Code
3920 \begin_layout Plain Layout
3928 deadkey key outstring
3931 \begin_layout Standard
3932 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3936 \begin_layout Quotation
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3953 \begin_layout Standard
3954 to make it work correctly.
3955 Also, you have to define as exceptions dead keys over i and j, to remove
3956 the dot from them before inserting an accent mark.
3957 I will change this when the time comes, but so far I haven't had time.
3960 \begin_layout Standard
3961 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3964 \begin_inset Flex Code
3967 \begin_layout Plain Layout
3973 have different meaning.
3975 \begin_inset Flex Code
3978 \begin_layout Plain Layout
3984 marks comments, quotes start and end \SpecialChar LaTeX
3986 To enter quote, you'll need to use
3987 \begin_inset Flex Code
3990 \begin_layout Plain Layout
3999 \begin_inset Flex Code
4002 \begin_layout Plain Layout
4009 \begin_inset Flex Code
4012 \begin_layout Plain Layout
4023 \begin_layout Standard
4024 If you make a keyboard description file that works for your language, please
4025 mail it to me, so I can include it in the next keymap distribution.
4028 \begin_layout Standard
4029 More keywords will be supported in keymap configuration file in future,
4033 \begin_layout Itemize
4034 \begin_inset Flex Code
4037 \begin_layout Plain Layout
4048 \begin_inset space \hfill{}
4052 \begin_inset Flex Code
4055 \begin_layout Plain Layout
4064 \begin_layout Itemize
4065 \begin_inset Flex Code
4068 \begin_layout Plain Layout
4079 \begin_inset space \hfill{}
4083 \begin_inset Flex Code
4086 \begin_layout Plain Layout
4092 an external keymap translation program
4095 \begin_layout Standard
4096 Also, it should look into
4097 \begin_inset Flex Code
4100 \begin_layout Plain Layout
4106 file for defaults, too (for example, a
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4118 option to include default keyboard).
4126 \begin_layout Section
4127 International Keymap Stuff
4128 \begin_inset CommandInset label
4130 name "sec:International-Keymap-Stuff"
4137 \begin_layout Standard
4138 \begin_inset Note Note
4141 \begin_layout Plain Layout
4142 In doing the revisions on this document in March 2008, I did not look over
4143 this stuff, as I do not understand it.
4144 It would be good if someone else could do so.
4153 \begin_layout Standard
4154 The next two sections describe the
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4178 file syntax in detail.
4179 These sections should help you design your own key map if the ones provided
4180 do not meet your needs.
4183 \begin_layout Subsection
4187 \begin_layout Standard
4191 \begin_inset Flex Code
4194 \begin_layout Plain Layout
4200 file maps keystrokes to characters or strings.
4201 As the name suggests, it sets a keyboard mapping.
4203 \begin_inset Flex Code
4206 \begin_layout Plain Layout
4217 \begin_inset Flex Code
4220 \begin_layout Plain Layout
4235 \begin_inset Flex Code
4238 \begin_layout Plain Layout
4251 \begin_inset Flex Code
4254 \begin_layout Plain Layout
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4274 are described in this section.
4277 \begin_layout Labeling
4278 \labelwidthstring 00.00.0000
4279 \begin_inset Flex Code
4282 \begin_layout Plain Layout
4290 Map a character to a string
4293 \begin_layout LyX-Code
4308 \begin_layout Standard
4341 the double-quote (")
4358 must be escaped with a preceding backslash (
4369 \begin_layout Standard
4371 \begin_inset Flex Noun
4374 \begin_layout Plain Layout
4382 statement to cause the symbol
4383 \begin_inset Flex Noun
4386 \begin_layout Plain Layout
4394 to be output for the keystroke
4395 \begin_inset Flex Noun
4398 \begin_layout Plain Layout
4409 \begin_layout LyX-Code
4415 \begin_layout Labeling
4416 \labelwidthstring 00.00.0000
4417 \begin_inset Flex Code
4420 \begin_layout Plain Layout
4428 Specify an accent character
4431 \begin_layout LyX-Code
4440 \begin_layout Standard
4441 This will make the cha
4479 This is the dead key
4483 \begin_layout Plain Layout
4490 refers to a key that does not produce a character by itself, but when followed
4491 with another key, produces the desired accent character.
4492 For example, a German characte
4494 r with an umlaut like
4504 can be produced in this manner.
4513 \begin_layout Standard
4526 and then another key not in
4543 followed by the other, not allowed key, as output.
4547 \begin_inset Flex Noun
4550 \begin_layout Plain Layout
4558 cancels a dead key, so if
4569 \begin_inset Flex Noun
4572 \begin_layout Plain Layout
4581 , the cursor will not go one position backwards but will instead cancel
4597 might have had on the next keystroke.
4601 \begin_layout Standard
4602 The following example specifies that the character ' is to be an acute accent,
4603 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4606 \begin_layout LyX-Code
4609 kmod ' acute aeiouAEIOU
4612 \begin_layout Labeling
4613 \labelwidthstring 00.00.0000
4614 \begin_inset Flex Code
4617 \begin_layout Plain Layout
4623 Specify an exception to the accent character
4626 \begin_layout LyX-Code
4635 \begin_layout Standard
4636 This defines an exce
4677 have been assigned a keystroke with a previous
4680 \begin_inset Flex Code
4683 \begin_layout Plain Layout
4707 must not belong in the
4754 If such a declaration does not exist in
4762 \begin_inset Flex Code
4765 \begin_layout Plain Layout
4799 \begin_inset Flex Code
4802 \begin_layout Plain Layout
4816 \begin_layout Standard
4817 The following command produces causes äi to be produced when you enter acute-i
4821 \begin_layout LyX-Code
4835 \begin_layout Labeling
4836 \labelwidthstring 00.00.0000
4837 \begin_inset Flex Code
4840 \begin_layout Plain Layout
4846 Combine two accent characters
4849 \begin_layout LyX-Code
4855 accent1 accent2 allowed
4858 \begin_layout Standard
4859 This one is getting pretty esoteric.
4860 It allows you to combine the effect
4916 \begin_inset Flex Code
4919 \begin_layout Plain Layout
4947 \begin_layout Standard
4948 Consider this example from the
4949 \begin_inset Flex Code
4952 \begin_layout Plain Layout
4963 \begin_layout LyX-Code
4966 kmod ; acute aeioyvhAEIOYVH
4970 kcomb acute umlaut iyIY
4973 \begin_layout Standard
4974 This allows you to press
4975 \begin_inset Flex Noun
4978 \begin_layout Plain Layout
4986 and get the effect of
4987 \begin_inset Flex Code
4990 \begin_layout Plain Layout
5009 in this case cancels the last dead key, so if you press
5010 \begin_inset Flex Noun
5013 \begin_layout Plain Layout
5022 \begin_inset Flex Code
5025 \begin_layout Plain Layout
5038 \begin_layout Subsection
5042 \begin_layout Standard
5044 \begin_inset Flex Code
5047 \begin_layout Plain Layout
5055 mapping is performed, a
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5069 file maps the strings that the symbols generate to characters in the current
5071 The \SpecialChar LyX
5072 distribution currently includes at least the
5073 \begin_inset Flex Code
5076 \begin_layout Plain Layout
5085 \begin_inset Flex Code
5088 \begin_layout Plain Layout
5099 \begin_layout Standard
5101 \begin_inset Flex Code
5104 \begin_layout Plain Layout
5112 file is a sequence of declarations of the form
5115 \begin_layout LyX-Code
5128 \begin_layout Standard
5129 For example, in order to map
5130 \begin_inset Flex Noun
5133 \begin_layout Plain Layout
5143 to the corresponding character in the iso-8859-1 set (233), the following
5147 \begin_layout LyX-Code
5155 \begin_layout Standard
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5169 \begin_inset Flex Code
5172 \begin_layout Plain Layout
5190 the same character can apply to more than one string.
5192 \begin_inset Flex Code
5195 \begin_layout Plain Layout
5206 \begin_layout LyX-Code
5218 \begin_inset Newline newline
5234 \begin_layout Standard
5236 cannot find a mapping for the string produced by the keystroke or a
5237 deadkey sequence, it will check if it looks like an accented char and try
5238 to draw an accent over the character on screen.
5241 \begin_layout Subsection
5245 \begin_layout Standard
5246 There is a second way to add support for international characters through
5247 so-called dead-keys.
5248 A dead-key works in combination with a letter to produce an accented character.
5249 Here, we'll explain how to create a really simple dead-key to illustrate
5253 \begin_layout Standard
5254 Suppose you happen to need the circumflex character,
5255 \begin_inset Quotes eld
5259 \begin_inset Quotes erd
5264 \begin_inset Flex Noun
5267 \begin_layout Plain Layout
5274 \begin_inset space ~
5278 \begin_inset Flex Noun
5281 \begin_layout Plain Layout
5287 ] to the \SpecialChar LyX
5289 \begin_inset Flex Code
5292 \begin_layout Plain Layout
5299 \begin_inset Flex Code
5302 \begin_layout Plain Layout
5309 Now, whenever you type the
5310 \begin_inset Flex Noun
5313 \begin_layout Plain Layout
5319 -key followed by a letter, that letter will have a circumflex accent on
5321 For example, the sequence
5322 \begin_inset Quotes eld
5326 \begin_inset Flex Noun
5329 \begin_layout Plain Layout
5336 \begin_inset Quotes erd
5339 produces the letter:
5340 \begin_inset Quotes eld
5344 \begin_inset Quotes erd
5348 If you tried to type
5349 \begin_inset Quotes eld
5353 \begin_inset Flex Noun
5356 \begin_layout Plain Layout
5363 \begin_inset Quotes erd
5366 , however, \SpecialChar LyX
5367 will complain with a beep, since a
5368 \begin_inset Quotes eld
5372 \begin_inset Flex Noun
5375 \begin_layout Plain Layout
5382 \begin_inset Quotes erd
5385 never takes a circumflex accent.
5387 \begin_inset Flex Noun
5390 \begin_layout Plain Layout
5396 after a dead-key produces the bare-accent.
5397 Please note this last point! If you bind a key to a dead-key, you'll need
5398 to rebind the character on that key to yet another key.
5400 \begin_inset Flex Noun
5403 \begin_layout Plain Layout
5409 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5412 \begin_layout Standard
5413 One common way to bind dead-keys is to use
5414 \begin_inset Flex Noun
5417 \begin_layout Plain Layout
5424 \begin_inset Flex Noun
5427 \begin_layout Plain Layout
5434 \begin_inset Flex Noun
5437 \begin_layout Plain Layout
5443 in combination with an accent, like
5444 \begin_inset Quotes eld
5448 \begin_inset Flex Noun
5451 \begin_layout Plain Layout
5458 \begin_inset Quotes erd
5462 \begin_inset Quotes eld
5466 \begin_inset Flex Noun
5469 \begin_layout Plain Layout
5476 \begin_inset Quotes erd
5480 \begin_inset Quotes eld
5484 \begin_inset Flex Noun
5487 \begin_layout Plain Layout
5494 \begin_inset Quotes erd
5498 Another way involves using
5499 \begin_inset Flex Code
5502 \begin_layout Plain Layout
5509 \begin_inset Flex Code
5512 \begin_layout Plain Layout
5518 to set up the special
5519 \begin_inset Flex Code
5522 \begin_layout Plain Layout
5530 \begin_inset Flex Code
5533 \begin_layout Plain Layout
5539 acts in some ways just like
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5549 and permits you to bind keys to accented characters.
5550 You can also turn keys into dead-keys by binding them to something like
5552 \begin_inset Flex Code
5555 \begin_layout Plain Layout
5561 and then binding this symbolic key to the corresponding \SpecialChar LyX
5566 \begin_layout Plain Layout
5571 : This is exactly what I do in my
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5582 \begin_inset Flex Code
5585 \begin_layout Plain Layout
5593 \begin_inset Flex Noun
5596 \begin_layout Plain Layout
5598 \begin_inset space ~
5607 \begin_inset Flex Code
5610 \begin_layout Plain Layout
5616 and a bunch of these
5617 \begin_inset Quotes eld
5621 \begin_inset Flex Code
5624 \begin_layout Plain Layout
5631 \begin_inset Quotes erd
5634 symbolic keys bound such things as
5635 \begin_inset Flex Noun
5638 \begin_layout Plain Layout
5640 \begin_inset space ~
5649 \begin_inset Flex Noun
5652 \begin_layout Plain Layout
5654 \begin_inset space ~
5663 This is how I produce my accented characters.
5668 You can make just about anything into the
5669 \begin_inset Flex Code
5672 \begin_layout Plain Layout
5679 \begin_inset Flex Noun
5682 \begin_layout Plain Layout
5688 keys, a spare function key, etc.
5689 As for the \SpecialChar LyX
5690 commands that produce accents, check the entry for
5691 \begin_inset Flex Code
5694 \begin_layout Plain Layout
5705 You'll find the complete list there.
5708 \begin_layout Subsection
5709 Saving your Language Configuration
5712 \begin_layout Standard
5713 You can edit your preferences so that your desired language environment
5714 is automatically configured when \SpecialChar LyX
5716 \begin_inset Flex Noun
5719 \begin_layout Plain Layout
5720 Edit\SpecialChar menuseparator
5729 \begin_layout Chapter
5730 Installing New Document Classes, Layouts, and Templates
5731 \begin_inset CommandInset label
5733 name "cha:Installing-New-Document"
5738 \begin_inset Argument 1
5741 \begin_layout Plain Layout
5742 Installing New Document Classes
5750 \begin_layout Standard
5751 In this chapter, we describe the procedures for creating and installing
5752 new \SpecialChar LyX
5753 layout and template files, as well as offer a refresher on correctly
5754 installing new \SpecialChar LaTeX
5759 \begin_layout Standard
5760 First, let us a say a few words about how one ought to think about the relation
5761 between \SpecialChar LyX
5762 and \SpecialChar LaTeX
5764 The thing to understand is that, in a certain sense, \SpecialChar LyX
5765 doesn't know anything
5766 about \SpecialChar LaTeX
5768 Indeed, from \SpecialChar LyX
5769 's point of view, \SpecialChar LaTeX
5770 is just one of several
5771 \begin_inset Quotes eld
5775 \begin_inset Quotes erd
5778 in which it is capable of producing output.
5779 Other such formats are DocBook, plaintext, and XHTML.
5781 is, of course, a particularly important format, but very little of the
5782 information \SpecialChar LyX
5783 has about \SpecialChar LaTeX
5784 is actually contained in the program itself.
5788 \begin_layout Plain Layout
5789 Some commands are sufficiently complex that they are
5790 \begin_inset Quotes eld
5794 \begin_inset Quotes erd
5797 into \SpecialChar LyX
5799 But the developers generally regard this as a Bad Thing.
5804 Rather, that information, even for the standard classes like
5805 \begin_inset Flex Code
5808 \begin_layout Plain Layout
5814 , is contained in `layout files'.
5815 Similarly, \SpecialChar LyX
5816 itself does not know much about DocBook or XHTML.
5817 What it knows is contained in layout files.
5820 \begin_layout Standard
5821 You can think of the layout file for a given document class as a translation
5822 manual between \SpecialChar LyX
5823 constructs—paragraphs with their corresponding styles,
5824 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5827 Almost everything \SpecialChar LyX
5829 \begin_inset Flex Code
5832 \begin_layout Plain Layout
5838 , for example, is contained in the file
5839 \begin_inset Flex Code
5842 \begin_layout Plain Layout
5848 and in various other files it includes.
5849 For this reason, anyone intending to write layout files should plan to
5850 study the existing files.
5851 A good place to start is with
5852 \begin_inset Flex Code
5855 \begin_layout Plain Layout
5861 , which is included in
5862 \begin_inset Flex Code
5865 \begin_layout Plain Layout
5872 \begin_inset Flex Code
5875 \begin_layout Plain Layout
5881 , and many of the other layout files for document classes.
5882 This file is where sections and the like are defined:
5883 \begin_inset Flex Code
5886 \begin_layout Plain Layout
5892 tells \SpecialChar LyX
5893 how paragraphs that are marked with the Section, Subsection, etc,
5894 styles can be translated into corresponding \SpecialChar LaTeX
5895 , DocBook, and XHTML commands
5898 \begin_inset Flex Code
5901 \begin_layout Plain Layout
5907 file basically just includes several of these
5908 \begin_inset Flex Code
5911 \begin_layout Plain Layout
5920 \begin_layout Standard
5921 Defining the \SpecialChar LyX
5923 correspondence is not the only thing layout files do, though.
5924 Their other job is to define how the \SpecialChar LyX
5925 constructs themselves will appear
5927 The fact that layout files have these two jobs is often a source of confusion,
5928 because they are completely separate.
5929 Telling \SpecialChar LyX
5930 how to translate a certain paragraph style into \SpecialChar LaTeX
5933 how to display it; conversely, telling \SpecialChar LyX
5934 how to display a certain paragraph
5935 style does not tell \SpecialChar LyX
5936 how to translate it into \SpecialChar LaTeX
5937 (let alone tell \SpecialChar LaTeX
5940 So, in general, when you define a new \SpecialChar LyX
5941 construct, you must always do two
5942 quite separate things: (i)
5943 \begin_inset space ~
5946 tell \SpecialChar LyX
5947 how to translate it into \SpecialChar LaTeX
5949 \begin_inset space ~
5952 tell \SpecialChar LyX
5956 \begin_layout Standard
5957 Much the same is true, of course, as regards \SpecialChar LyX
5958 's other backend formats, though
5959 XHTML is in some ways different, because in that case \SpecialChar LyX
5964 able, to some extent, to use information about how it should display a
5965 paragraph on the screen to output information (in the form of CSS) about
5966 how the paragraph should be displayed in a browser.
5967 Even in this case, however, the distinction between what \SpecialChar LyX
5969 and how things are rendered externally remains in force, and the two can
5970 be controlled separately.
5972 \begin_inset CommandInset ref
5974 reference "sec:Tags-for-XHTML"
5981 \begin_layout Section
5982 Installing new \SpecialChar LaTeX
5986 \begin_layout Standard
5987 Some installations may not include a \SpecialChar LaTeX
5988 package or class file that you would
5989 like to use within \SpecialChar LyX
5991 For example, you might need Foil\SpecialChar TeX
5992 , a package for preparing slides for overhead
5994 Modern \SpecialChar LaTeX
5995 distributions like \SpecialChar TeX
5996 Live (2008 or newer) or MiK\SpecialChar TeX
5997 provide a user interface
5998 for installing such packages.
5999 For example, with MiK\SpecialChar TeX
6000 , you start the program
6001 \begin_inset Quotes eld
6005 \begin_inset space ~
6009 \begin_inset Quotes erd
6012 to get a list of available packages.
6013 To install one of them, right click on it or use the corresponding toolbar
6017 \begin_layout Standard
6018 If your \SpecialChar LaTeX
6019 distribution does not provide such a `package manager', or if the
6020 package is not available from your distribution, then follow these steps
6021 to install it manually:
6024 \begin_layout Enumerate
6025 Get the package from
6026 \begin_inset CommandInset href
6029 target "http://www.ctan.org/"
6037 \begin_layout Enumerate
6038 If the package contains a file with the ending
6039 \begin_inset Quotes eld
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6053 \begin_inset Quotes erd
6056 (is the case for Foil\SpecialChar TeX
6057 ) then open a console, change to the folder of this
6058 file and execute the command
6059 \begin_inset Flex Code
6062 \begin_layout Plain Layout
6069 You have now unpacked the package and have all files to install it.
6070 Most \SpecialChar LaTeX
6071 -packages are not packed and you can skip this step.
6074 \begin_layout Enumerate
6075 Now you need to decide if the package should be available for all users
6080 \begin_layout Enumerate
6081 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6082 for all users on your system, then install it in your `local' \SpecialChar TeX
6084 install it in your own `user' \SpecialChar TeX
6086 Where these trees should be created, if they do not already exist, depends
6088 To find this out, look in the file
6089 \begin_inset Flex Code
6092 \begin_layout Plain Layout
6102 \begin_layout Plain Layout
6103 This is usually in the directory
6104 \begin_inset Flex Code
6107 \begin_layout Plain Layout
6113 , though you can execute the command
6114 \begin_inset Flex Code
6117 \begin_layout Plain Layout
6128 The location of the `local' \SpecialChar TeX
6129 tree is defined by the
6130 \begin_inset Flex Code
6133 \begin_layout Plain Layout
6139 variable; this is usually somewhere like
6140 \begin_inset Flex Code
6143 \begin_layout Plain Layout
6144 /usr/local/share/texmf
6149 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6152 The location of the `user' \SpecialChar TeX
6154 \begin_inset Flex Code
6157 \begin_layout Plain Layout
6164 \begin_inset Flex Code
6167 \begin_layout Plain Layout
6174 \begin_inset Flex Code
6177 \begin_layout Plain Layout
6186 (If these variables are not predefined, you have to define them.) You'll
6187 probably need root permissions to create or modify the `local' tree, but
6188 not for your `user' tree.
6189 \begin_inset Newline newline
6192 In general, it is recommended to install in the user tree because your user
6193 will not be modified or even overwritten when you upgrade your system.
6194 It will typically also be backed up together with everything else when
6195 you backup your home directory (which, of course, you do on a regular basis).
6198 \begin_layout Enumerate
6199 On Windows, if you want the new package to be available for all users on
6200 your system, change to the folder where \SpecialChar LaTeX
6201 is installed and then change to
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6217 (For MiK\SpecialChar TeX
6218 , this would be by default the folder
6219 \begin_inset Flex Code
6222 \begin_layout Plain Layout
6240 \begin_layout Plain Layout
6241 Note that this will be the correct path only on English installations.
6242 On a German one, it would be
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6260 , and similarly for other languages.
6265 Create there a new folder
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6275 and copy all files of the package into it.
6277 \begin_inset Newline newline
6280 If the package should only available for you or you don't have admin permissions
6281 , do the same, but in the local \SpecialChar LaTeX
6284 \begin_inset space \thinspace{}
6287 g., for MiK\SpecialChar TeX
6289 \begin_inset space ~
6292 2.8 under Windows XP, this would be the folder:
6293 \begin_inset Newline newline
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6305 Documents and Settings
6317 \begin_inset Newline newline
6323 \begin_inset Phantom HPhantom
6326 \begin_layout Plain Layout
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6353 \begin_inset Newline newline
6356 On Vista, it would be:
6357 \begin_inset Newline newline
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6390 \begin_layout Enumerate
6391 Now one only need to tell \SpecialChar LaTeX
6392 that there are new files.
6393 This depends on the used \SpecialChar LaTeX
6398 \begin_layout Enumerate
6399 For \SpecialChar TeX
6400 Live execute the command
6401 \begin_inset Flex Code
6404 \begin_layout Plain Layout
6411 If you installed the package for all users, then you will probably need
6412 to have root permissions for that.
6415 \begin_layout Enumerate
6416 For MiK\SpecialChar TeX
6417 , if you have installed the package for all users, start the program
6419 \begin_inset Quotes eld
6423 \begin_inset space ~
6427 \begin_inset Quotes erd
6430 and press the button marked
6431 \begin_inset Quotes eld
6435 \begin_inset Quotes erd
6439 Otherwise start the program
6440 \begin_inset Quotes eld
6444 \begin_inset Quotes erd
6451 \begin_layout Enumerate
6452 Finally, you need to tell \SpecialChar LyX
6453 that there are new packages available.
6454 So, in \SpecialChar LyX
6456 \begin_inset Flex Noun
6459 \begin_layout Plain Layout
6462 \SpecialChar menuseparator
6468 and then restart \SpecialChar LyX
6472 \begin_layout Standard
6473 Now the package is installed.
6474 In our example, the document class
6475 \begin_inset Flex Code
6478 \begin_layout Plain Layout
6484 will now be available under
6485 \begin_inset Flex Noun
6488 \begin_layout Plain Layout
6489 Document\SpecialChar menuseparator
6490 Settings\SpecialChar menuseparator
6497 \begin_inset Quotes eld
6501 \begin_inset Quotes erd
6508 \begin_layout Standard
6509 If you would like to use a \SpecialChar LaTeX
6510 document class that is not even listed in the
6512 \begin_inset Flex Noun
6515 \begin_layout Plain Layout
6516 Document\SpecialChar menuseparator
6517 Settings\SpecialChar menuseparator
6523 , then you need to create a `layout' file for it.
6524 That is the topic of the next section.
6527 \begin_layout Section
6528 Types of layout files
6531 \begin_layout Standard
6532 This section describes the various sorts of \SpecialChar LyX
6533 files that contain layout informati
6535 These files describe various paragraph and character styles, determining
6536 how \SpecialChar LyX
6537 should display them and how they should be translated into \SpecialChar LaTeX
6539 XHTML, or whatever output format is being used.
6543 \begin_layout Standard
6544 We shall try to provide a thorough description of the process of writing
6546 However, there are so many different types of documents supported even
6547 by just \SpecialChar LaTeX
6548 that we can't hope to cover every different possibility or problem
6549 you might encounter.
6550 The \SpecialChar LyX
6551 users' list is frequented by people with lots of experience with layout
6552 design who are willing to share what they've learned, so please feel free
6553 to ask questions there.
6556 \begin_layout Standard
6557 As you prepare to write a new layout, it is extremely helpful to look at
6558 the layouts distributed with \SpecialChar LyX
6560 If you write a \SpecialChar LyX
6561 layout for a \SpecialChar LaTeX
6562 document class that might also be used by
6563 others, or write a module that might be useful to others, then you should
6564 consider posting your layout to the
6565 \begin_inset CommandInset href
6567 name "layout section on the LyX wiki"
6568 target "http://wiki.lyx.org/Layouts/Layouts"
6573 or even to the \SpecialChar LyX
6574 developers' list, so that it might be included in \SpecialChar LyX
6579 \begin_layout Plain Layout
6580 Note that \SpecialChar LyX
6581 is licensed under the General Public License, so any material
6582 that is contributed to \SpecialChar LyX
6583 must be similarly licensed.
6591 \begin_layout Subsection
6593 \begin_inset CommandInset label
6595 name "subsec:Layout-modules"
6602 \begin_layout Standard
6603 We have spoken to this point about `layout files'.
6604 But there are different sorts of files that contain layout information.
6605 Layout files, strictly so called, have the
6606 \begin_inset Flex Code
6609 \begin_layout Plain Layout
6615 extension and provide \SpecialChar LyX
6616 with information about document classes.
6617 Since \SpecialChar LyX
6618 1.6 layout information can also be contained in layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6633 Modules are to \SpecialChar LaTeX
6634 packages much as layouts are to \SpecialChar LaTeX
6635 classes, and some modules—such
6637 \begin_inset Flex Code
6640 \begin_layout Plain Layout
6646 module—specifically provide support for one package.
6647 In a sense, layout modules are similar to included
6651 \begin_layout Plain Layout
6652 These can have any extension, but by convention have the
6653 \begin_inset Flex Code
6656 \begin_layout Plain Layout
6668 \begin_inset Flex Code
6671 \begin_layout Plain Layout
6677 —in that modules are not specific to a given document class but may be used
6678 with many different classes.
6679 The difference is that using an included file with
6680 \begin_inset Flex Code
6683 \begin_layout Plain Layout
6689 requires editing that file.
6690 Modules, by contrast, are selected in the
6691 \begin_inset Flex Noun
6694 \begin_layout Plain Layout
6695 Document\SpecialChar menuseparator
6704 \begin_layout Standard
6705 Building modules is the easiest way to get started with layout editing,
6706 since it can be as simple as adding a single new paragraph style or flex
6708 But modules may, in principle, contain anything a layout file can contain.
6711 \begin_layout Standard
6712 After creating a new module and copying it to the
6713 \begin_inset Flex Code
6716 \begin_layout Plain Layout
6722 folder, you will need to reconfigure and then restart \SpecialChar LyX
6725 However, changes you make to the module will be seen immediately, if you
6727 \begin_inset Flex Noun
6730 \begin_layout Plain Layout
6731 Document\SpecialChar menuseparator
6737 , highlight something, and then hit
6738 \begin_inset Quotes eld
6742 \begin_inset Quotes erd
6748 It is strongly recommended that you save your work before doing this
6753 it is strongly recommended that you not attempt to edit modules while simultaneo
6754 usly working on actual documents
6757 Though of course the developers strive to keep \SpecialChar LyX
6758 stable in such situations,
6759 syntax errors and the like in your module file could cause strange behavior.
6762 \begin_layout Subsubsection
6766 \begin_layout Standard
6767 Modules are to \SpecialChar LyX
6768 as packages are to \SpecialChar LaTeX
6770 Sometimes, however, you find yourself wanting a specific inset or character
6771 style just for one document and writing a module that will also be available
6772 to other documents makes little sense.
6773 What you need is \SpecialChar LyX
6775 \begin_inset Quotes eld
6779 \begin_inset Quotes erd
6785 \begin_layout Standard
6786 You will find it under
6788 Document\SpecialChar menuseparator
6789 Settings\SpecialChar menuseparator
6793 The large text box allows you to enter anything that you might enter in
6794 a layout file or module.
6795 You can think of a document's local layout, in fact, as a module that belongs
6797 So, in particular, you must enter a
6798 \begin_inset Flex Code
6801 \begin_layout Plain Layout
6808 Any format is acceptable, but one would normally use the format current
6810 (In \SpecialChar LyX
6811 2.3, the current layout format is 63.)
6814 \begin_layout Standard
6815 When you have entered something in the
6816 \begin_inset Flex Code
6819 \begin_layout Plain Layout
6825 pane, \SpecialChar LyX
6827 \begin_inset Quotes eld
6831 \begin_inset Quotes erd
6834 button at the bottom.
6835 Clicking this button will cause \SpecialChar LyX
6836 to determine whether what you have entered
6837 is valid layout information for the chosen format.
6839 will report the result but, unfortunately, will not tell you what errors
6840 there might have been.
6841 These will be written to the terminal, however, if \SpecialChar LyX
6842 is started from a terminal.
6843 You will not be permitted to save your local layout until you have entered
6847 \begin_layout Standard
6848 The warnings at the end of the previous section apply here, too.
6849 Do not play with local layout while you are actually working, especially
6850 if you have not saved your document.
6851 That said, using local layout with a test document can be a very convenient
6852 way to try out layout ideas, or even to start developing a module.
6855 \begin_layout Subsection
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6869 \begin_layout Standard
6870 There are two situations you are likely to encounter when wanting to support
6871 a new \SpecialChar LaTeX
6872 document class, involving style (
6873 \begin_inset Flex Code
6876 \begin_layout Plain Layout
6882 ) files and \SpecialChar LaTeX2e
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6894 Supporting a style file is usually fairly easy.
6895 Supporting a new class file is a bit harder.
6896 We'll discuss the former in this section and the latter in the next.
6897 Similar remarks apply, of course, if you want to support a new DocBook
6901 \begin_layout Standard
6902 The easier case is the one in which your new document class is provided
6903 as a style file that is to be used in conjunction with an already supported
6905 For the sake of the example, we'll assume that the style file is called
6907 \begin_inset Flex Noun
6910 \begin_layout Plain Layout
6916 and that it is meant to be used with
6917 \begin_inset Flex Noun
6920 \begin_layout Plain Layout
6926 , which is a standard class.
6930 \begin_layout Standard
6931 Start by copying the existing class's layout file into your local directory:
6935 \begin_layout Plain Layout
6936 Of course, which directory is your local directory will vary by platform,
6937 and \SpecialChar LyX
6938 allows you to specify your local directory on startup, too, using
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6957 \begin_layout LyX-Code
6958 cp report.layout ~/.lyx/layouts/myclass.layout
6961 \begin_layout Standard
6963 \begin_inset Flex Code
6966 \begin_layout Plain Layout
6972 and change the line:
6975 \begin_layout LyX-Code
6978 DeclareLaTeXClass{Report (Standard Class)}
6981 \begin_layout Standard
6985 \begin_layout LyX-Code
6988 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6991 \begin_layout Standard
6995 \begin_layout LyX-Code
6997 \begin_inset Newline newline
7003 \begin_inset Newline newline
7009 \begin_layout Standard
7010 near the top of the file.
7013 \begin_layout Standard
7014 Start \SpecialChar LyX
7016 \begin_inset Flex Noun
7019 \begin_layout Plain Layout
7020 Tools\SpecialChar menuseparator
7027 Then restart \SpecialChar LyX
7028 and try creating a new document.
7030 \begin_inset Flex Noun
7033 \begin_layout Plain Layout
7039 " as a document class option in the
7040 \begin_inset Flex Noun
7043 \begin_layout Plain Layout
7044 Document\SpecialChar menuseparator
7051 It is likely that some of the sectioning commands and such in your new
7052 class will work differently from how they worked in the base class—
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7062 in this example—so you can fiddle around with the settings for the different
7063 sections if you wish.
7064 The layout information for sections is contained in
7065 \begin_inset Flex Code
7068 \begin_layout Plain Layout
7074 , but you do not need to copy and change this file.
7075 Instead, you can simply add your changes to your layout file, after the
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7086 , which itself includes
7087 \begin_inset Flex Code
7090 \begin_layout Plain Layout
7097 For example, you might add these lines:
7100 \begin_layout LyX-Code
7104 \begin_layout LyX-Code
7108 \begin_layout LyX-Code
7112 \begin_layout LyX-Code
7116 \begin_layout LyX-Code
7120 \begin_layout Standard
7121 to change the font for chapter headings to sans-serif.
7122 This will override (or, in this case, add to) the existing declaration
7123 for the Chapter style.
7127 \begin_layout Standard
7128 Your new package may also provide commands or environments not present in
7130 In this case, you will want to add these to the layout file.
7132 \begin_inset CommandInset ref
7134 reference "sec:TextClass"
7138 for information on how to do so.
7141 \begin_layout Standard
7143 \begin_inset Flex Noun
7146 \begin_layout Plain Layout
7152 can be used with several different document classes, and even if it cannot,
7153 you might find it easiest just to write a module that you can load with
7155 The simplest possible such module would be:
7158 \begin_layout LyX-Code
7161 DeclareLyXModule{My Class}
7164 \begin_layout LyX-Code
7168 \begin_layout LyX-Code
7169 #Support for myclass.sty.
7172 \begin_layout LyX-Code
7174 \begin_inset Newline newline
7180 \begin_layout LyX-Code
7182 \begin_inset Newline newline
7188 \begin_layout LyX-Code
7190 \begin_inset Newline newline
7196 \begin_inset Newline newline
7202 \begin_layout Standard
7203 A more complex module might modify the behavior of some existing constructs
7204 or define some new ones.
7206 \begin_inset CommandInset ref
7208 reference "sec:TextClass"
7215 \begin_layout Subsection
7217 \begin_inset Flex Noun
7220 \begin_layout Plain Layout
7229 \begin_layout Standard
7230 There are two possibilities here.
7231 One is that the class file is itself based upon an existing document class.
7232 For example, many thesis classes are based upon
7233 \begin_inset Flex Noun
7236 \begin_layout Plain Layout
7243 To see whether yours is, look for a line like
7246 \begin_layout LyX-Code
7252 \begin_layout Standard
7254 If so, then you may proceed largely as in the previous section, though
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7260 Declare\SpecialChar LaTeX
7266 line will be different.
7267 If your new class is
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 and it is based upon
7278 \begin_inset Flex Code
7281 \begin_layout Plain Layout
7287 , then the line should read:
7291 \begin_layout Plain Layout
7292 And it will be easiest if you save the file to
7293 \begin_inset Flex Code
7296 \begin_layout Plain Layout
7303 assumes that the document class has the same name as the layout file.
7312 \begin_layout LyX-Code
7315 DeclareLaTeXClass[thesis,book]{thesis}
7318 \begin_layout Standard
7319 If, on the other hand, the new class is not based upon an existing class,
7320 you will probably have to
7321 \begin_inset Quotes eld
7325 \begin_inset Quotes erd
7329 We strongly suggest copying an existing layout file which uses a similar
7331 class and then modifying it, if you can do so.
7332 At least use an existing file as a starting point so you can find out what
7333 items you need to worry about.
7334 Again, the specifics are covered below.
7337 \begin_layout Subsection
7339 \begin_inset CommandInset label
7341 name "subsec:Creating-Templates"
7348 \begin_layout Standard
7349 Once you have written a layout file for a new document class, you might
7350 want to consider writing a
7355 A template acts as a kind of tutorial for your layout, showing how it might
7356 be used, though containing dummy content.
7357 You can of course look at the various templates included with \SpecialChar LyX
7361 \begin_layout Standard
7362 Templates are created just like usual documents: using \SpecialChar LyX
7364 The only difference is that usual documents contain all possible settings,
7365 including the font scheme and the paper size.
7366 Usually a user doesn't want a template to overwrite his preferred settings
7367 for such parameters.
7368 For that reason, the designer of a template should remove the corresponding
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7393 from the template \SpecialChar LyX
7395 This can be done with any simple text-editor, for example
7396 \begin_inset Flex Code
7399 \begin_layout Plain Layout
7406 \begin_inset Flex Code
7409 \begin_layout Plain Layout
7418 \begin_layout Standard
7419 Put the edited template files you create in
7420 \begin_inset Flex Code
7423 \begin_layout Plain Layout
7429 , copy the ones you use from the global template directory in
7430 \begin_inset Flex Code
7433 \begin_layout Plain Layout
7439 to the same place, and redefine the template path in the
7440 \begin_inset Flex Noun
7443 \begin_layout Plain Layout
7444 Tools\SpecialChar menuseparator
7445 Preferences\SpecialChar menuseparator
7454 \begin_layout Standard
7455 Note, by the way, that there is a template which has a particular meaning:
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 menuseparator
7651 Bibliography\SpecialChar menuseparator
7657 \begin_layout Standard
7658 Even though a cite engine file is essentially a normal layout file that
7659 could theoretically include any layout information, it usually primarily
7660 includes some specific parameters such as
7661 \begin_inset Flex Code
7664 \begin_layout Plain Layout
7671 \begin_inset Flex Code
7674 \begin_layout Plain Layout
7681 \begin_inset Flex Code
7684 \begin_layout Plain Layout
7691 \begin_inset Flex Code
7694 \begin_layout Plain Layout
7701 The syntax of the latter two is described in
7702 \begin_inset CommandInset ref
7704 reference "subsec:Citation-engine-description"
7712 \begin_inset CommandInset ref
7714 reference "subsec:Citation-format-description"
7718 , as well as in the files themselves.
7721 \begin_layout Section
7722 \begin_inset CommandInset label
7724 name "sec:TextClass"
7728 The layout file format
7731 \begin_layout Standard
7732 The following sections describe how layout files are structured and written.
7733 Our advice is to go slowly, save and test often.
7734 It is really not that hard, except that the multitude of options can become
7735 overwhelming, especially if you try to check out too many at once.
7736 It becomes easier if you use existing layouts of \SpecialChar LyX
7737 as examples/reference
7738 or if you modify an existing layout to your needs.
7741 \begin_layout Standard
7742 Note that all the tags used in layout files are case-insensitive.
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7754 \begin_inset Flex Code
7757 \begin_layout Plain Layout
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7773 are really the same tag.
7774 The possible arguments are printed in brackets after the tag's name.
7775 The default argument is typeset
7776 \begin_inset Flex Code
7779 \begin_layout Plain Layout
7788 If the argument has a data type like
7789 \begin_inset Quotes eld
7793 \begin_inset Quotes erd
7797 \begin_inset Quotes eld
7801 \begin_inset Quotes erd
7804 , the default is shown like this:
7805 \begin_inset Flex Code
7808 \begin_layout Plain Layout
7819 \begin_layout Subsection
7820 The document class declaration and classification
7823 \begin_layout Standard
7824 Lines in a layout file which begin with
7825 \begin_inset Flex Code
7828 \begin_layout Plain Layout
7835 There is one exception to this rule.
7837 \begin_inset Flex Code
7840 \begin_layout Plain Layout
7846 files should begin with lines like:
7849 \begin_layout LyX-Code
7852 #% Do not delete the line below; configure depends on this
7855 \begin_layout LyX-Code
7860 DeclareLaTeXClass{Article (Standard Class)}
7863 \begin_layout LyX-Code
7868 DeclareCategory{Articles}
7871 \begin_layout Standard
7872 The second and third lines are used when you (re)configure \SpecialChar LyX
7874 The layout file is read by the \SpecialChar LaTeX
7876 \begin_inset Flex Code
7879 \begin_layout Plain Layout
7885 , in a special mode where
7886 \begin_inset Flex Code
7889 \begin_layout Plain Layout
7896 The first line is just a \SpecialChar LaTeX
7897 comment, the second one contains the mandatory
7898 declaration of the text class and the third line contains the optional
7899 classification of the class.
7900 If these lines appear in a file named
7901 \begin_inset Flex Code
7904 \begin_layout Plain Layout
7910 , then they define a text class of name
7911 \begin_inset Flex Code
7914 \begin_layout Plain Layout
7920 (the name of the layout file) which uses the \SpecialChar LaTeX
7922 \begin_inset Flex Code
7925 \begin_layout Plain Layout
7931 (the default is to use the same name as the layout).
7933 \begin_inset Quotes eld
7936 Article (Standard Class)
7937 \begin_inset Quotes erd
7940 that appears above is used as a description of the text class in the
7941 \begin_inset Flex Noun
7944 \begin_layout Plain Layout
7945 Document\SpecialChar menuseparator
7953 \begin_inset Quotes eld
7957 \begin_inset Quotes erd
7960 in the example) is also used in the
7961 \begin_inset Flex Noun
7964 \begin_layout Plain Layout
7965 Document\SpecialChar menuseparator
7971 dialog: the text classes are grouped by these categories (which are usually
7972 genres, so typical categories are
7973 \begin_inset Quotes eld
7977 \begin_inset Quotes erd
7981 \begin_inset Quotes eld
7985 \begin_inset Quotes erd
7989 \begin_inset Quotes eld
7993 \begin_inset Quotes erd
7997 \begin_inset Quotes eld
8001 \begin_inset Quotes erd
8005 \begin_inset Quotes eld
8009 \begin_inset Quotes erd
8013 \begin_inset Quotes eld
8017 \begin_inset Quotes erd
8021 If no category has been declared, the class will be put in the
8022 \begin_inset Quotes eld
8026 \begin_inset Quotes erd
8032 \begin_layout Standard
8033 Let's assume that you wrote your own text class that uses the
8034 \begin_inset Flex Code
8037 \begin_layout Plain Layout
8043 document class, but where you changed the appearance of the section headings.
8044 If you put it in a file
8045 \begin_inset Flex Code
8048 \begin_layout Plain Layout
8054 , the header of this file should be:
8057 \begin_layout LyX-Code
8060 #% Do not delete the line below; configure depends on this
8063 \begin_layout LyX-Code
8068 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8071 \begin_layout LyX-Code
8076 DeclareCategory{Articles}
8079 \begin_layout Standard
8080 This declares a text class
8081 \begin_inset Flex Code
8084 \begin_layout Plain Layout
8090 , associated with the \SpecialChar LaTeX
8092 \begin_inset Flex Code
8095 \begin_layout Plain Layout
8102 \begin_inset Quotes eld
8105 Article (with My Own Headings)
8106 \begin_inset Quotes erd
8110 If your text class depends on several packages, you can declare it as:
8113 \begin_layout LyX-Code
8116 #% Do not delete the line below; configure depends on this
8119 \begin_layout LyX-Code
8124 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8127 \begin_layout LyX-Code
8132 DeclareCategory{Articles}
8135 \begin_layout Standard
8136 This indicates that your text class uses the
8137 \begin_inset Flex Code
8140 \begin_layout Plain Layout
8147 Finally, it is also possible to declare classes for DocBook code.
8148 Typical declarations will look like:
8151 \begin_layout LyX-Code
8154 #% Do not delete the line below; configure depends on this
8157 \begin_layout LyX-Code
8162 DeclareDocBookClass[article]{SGML (DocBook Article)}
8165 \begin_layout LyX-Code
8170 DeclareCategory{Articles (DocBook)}
8173 \begin_layout Standard
8174 Note that these declarations can also be given an optional parameter declaring
8175 the name of the document class (but not a list).
8178 \begin_layout Standard
8179 So, to be as explicit as possible, the form of the layout declaration is:
8182 \begin_layout LyX-Code
8187 DeclareLaTeXClass[class,package.sty]{layout description}
8190 \begin_layout LyX-Code
8195 DeclareCategory{category}
8198 \begin_layout Standard
8199 The class need only be specified if the name of the \SpecialChar LaTeX
8201 name of the layout file are different or if there are packages to load.
8202 If the name of the class file is not specified, then \SpecialChar LyX
8204 that it is the same as the name of the layout file.
8207 \begin_layout Standard
8208 When the text class has been modified to your taste, all you have to do
8209 is to copy it either to
8210 \begin_inset Flex Code
8213 \begin_layout Plain Layout
8220 \begin_inset Flex Code
8223 \begin_layout Plain Layout
8230 \begin_inset Flex Noun
8233 \begin_layout Plain Layout
8234 Tools\SpecialChar menuseparator
8240 , exit \SpecialChar LyX
8242 Then your new text class should be available along with the others.
8245 \begin_layout Standard
8246 Once the layout file is installed, you can edit it and see your changes
8247 without having to reconfigure or to restart \SpecialChar LyX
8252 \begin_layout Plain Layout
8253 In versions of \SpecialChar LyX
8254 prior to 1.6, this was not true.
8255 As a result, editing layout files was very time consuming, since you had
8256 constantly to restart \SpecialChar LyX
8262 You can force a reload of the current layout by using the \SpecialChar LyX
8264 \begin_inset Flex Noun
8267 \begin_layout Plain Layout
8274 There is no default binding for this function—though, of course, you can
8275 bind it to a key yourself.
8276 But you will normally use this function simply by entering it in the mini-buffe
8281 \begin_layout Standard
8287 \begin_inset Flex Noun
8290 \begin_layout Plain Layout
8296 is very much an `advanced feature'.
8301 recommended that you save your work before using this function.
8306 recommended that you not attempt to edit layout information while simultaneousl
8307 y working on a document that you care about.
8308 Use a test document.
8309 Syntax errors and the like in your layout file could cause peculiar behavior.
8310 In particular, such errors could cause \SpecialChar LyX
8311 to regard the current layout as
8312 invalid and to attempt to switch to some other layout.
8316 \begin_layout Plain Layout
8317 Really bad syntax errors may even caused \SpecialChar LyX
8319 This is because certain sorts of errors may make \SpecialChar LyX
8330 The \SpecialChar LyX
8331 team strives to keep \SpecialChar LyX
8332 stable in such situations, but safe is better
8337 \begin_layout Plain Layout
8338 While we're giving advice: make regular backups.
8339 And be nice to your mother.
8347 \begin_layout Subsection
8348 The Module declaration
8351 \begin_layout Standard
8352 A module must begin with a line like the following:
8355 \begin_layout LyX-Code
8358 DeclareLyXModule[endnotes.sty]{Endnotes}
8361 \begin_layout Standard
8362 The mandatory argument, in curly brackets, is the name of the module, as
8364 \begin_inset Flex Noun
8367 \begin_layout Plain Layout
8368 Document\SpecialChar menuseparator
8369 Settings\SpecialChar menuseparator
8376 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8378 on which the module depends.
8379 It is also possible to use the form
8380 \begin_inset Flex Noun
8383 \begin_layout Plain Layout
8389 as an optional argument, which declares that the module can only be used
8390 when there exists a conversion chain between the formats `
8391 \begin_inset Flex Code
8394 \begin_layout Plain Layout
8401 \begin_inset Flex Code
8404 \begin_layout Plain Layout
8413 \begin_layout Standard
8414 The module declaration should then be followed by lines like the following:
8418 \begin_layout Plain Layout
8419 Preferably in English if the module should be published with \SpecialChar LyX
8421 This description will appear in the list of messages to be translated and
8422 will be thus translated with the next interface update.
8430 \begin_layout LyX-Code
8434 \begin_layout LyX-Code
8435 #Adds an endnote command, in addition to footnotes.
8439 \begin_layout LyX-Code
8440 #You will need to add
8442 theendnotes in TeX code where you
8445 \begin_layout LyX-Code
8446 #want the endnotes to appear.
8450 \begin_layout LyX-Code
8454 \begin_layout LyX-Code
8455 #Requires: somemodule | othermodule
8458 \begin_layout LyX-Code
8459 #Excludes: badmodule
8462 \begin_layout Standard
8463 The description is used in
8464 \begin_inset Flex Noun
8467 \begin_layout Plain Layout
8468 Document\SpecialChar menuseparator
8469 Settings\SpecialChar menuseparator
8475 to provide the user with information about what the module does.
8477 \begin_inset Flex Code
8480 \begin_layout Plain Layout
8486 line is used to identify other modules with which this one must be used;
8488 \begin_inset Flex Code
8491 \begin_layout Plain Layout
8497 line is used to identify modules with which this one may not be used.
8498 Both are optional, and, as shown, multiple modules should be separated
8499 with the pipe symbol: |.
8500 Note that the required modules are treated disjunctively:
8504 of the required modules must be used.
8509 excluded module may be used.
8510 Note that modules are identified here by their filenames without the
8511 \begin_inset Flex Code
8514 \begin_layout Plain Layout
8522 \begin_inset Flex Code
8525 \begin_layout Plain Layout
8532 \begin_inset Flex Code
8535 \begin_layout Plain Layout
8544 \begin_layout Subsection
8545 The CiteEngine file declaration
8548 \begin_layout Standard
8549 A cite engine file must begin with a line like the following:
8552 \begin_layout LyX-Code
8555 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8558 \begin_layout Standard
8559 The mandatory argument, in curly brackets, is the name of the cite style,
8560 as it should appear in
8561 \begin_inset Flex Noun
8564 \begin_layout Plain Layout
8565 Document\SpecialChar menuseparator
8566 Settings\SpecialChar menuseparator
8573 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8575 on which the cite engine depends.
8578 \begin_layout Standard
8579 The cite engine declaration should then be followed by lines like the following:
8583 \begin_layout Plain Layout
8584 Preferably in English if the module should be published with \SpecialChar LyX
8586 This description will appear in the list of messages to be translated and
8587 will be thus translated with the next interface update.
8595 \begin_layout LyX-Code
8599 \begin_layout LyX-Code
8600 # Biblatex supports many author-year and numerical styles.
8603 \begin_layout LyX-Code
8604 # It is mainly aimed at the Humanities.
8608 \begin_layout LyX-Code
8609 # customizable, fully localized and provides many features
8612 \begin_layout LyX-Code
8613 # that are not possible with BibTeX.
8614 The use of 'biber' as
8617 \begin_layout LyX-Code
8618 # bibliography processor is advised.
8621 \begin_layout LyX-Code
8625 \begin_layout Standard
8626 The description is used in
8627 \begin_inset Flex Noun
8630 \begin_layout Plain Layout
8631 Document\SpecialChar menuseparator
8632 Settings\SpecialChar menuseparator
8638 to provide the user with information about the cite engine.
8641 \begin_layout Subsection
8645 \begin_layout Standard
8646 The first non-comment line of any layout file, included file, or module
8651 contain the file format number:
8654 \begin_layout Description
8655 \begin_inset Flex Code
8658 \begin_layout Plain Layout
8665 \begin_inset Flex Code
8668 \begin_layout Plain Layout
8674 ] The format number of the layout file.
8677 \begin_layout Standard
8678 This tag was introduced with \SpecialChar LyX
8680 \begin_inset space ~
8684 Layout files from older \SpecialChar LyX
8685 versions do not have an explicit file format and
8686 are considered to have
8687 \begin_inset Flex Code
8690 \begin_layout Plain Layout
8692 \begin_inset space ~
8701 The format for the present version of \SpecialChar LyX
8703 But each version of \SpecialChar LyX
8704 is capable of reading earlier versions' layout files,
8705 just as they are capable of reading files produced by earlier versions
8708 There is, however, no provision for converting to earlier formats.
8711 \begin_layout Subsection
8712 \begin_inset CommandInset label
8714 name "subsec:General-text-class"
8718 General text class parameters
8721 \begin_layout Standard
8722 These are general parameters that govern the behavior of an entire document
8728 mean that they must appear in
8729 \begin_inset Flex Code
8732 \begin_layout Plain Layout
8738 files rather than in modules.
8739 A module can contain any layout tag.)
8742 \begin_layout Description
8743 \begin_inset Flex Code
8746 \begin_layout Plain Layout
8752 Adds information that will be output in the
8753 \begin_inset Flex Code
8756 \begin_layout Plain Layout
8762 block when the document is output to XHTML.
8763 Typically, this would be used to output CSS style information, but it can
8764 be used for anything that can appear in
8765 \begin_inset Flex Code
8768 \begin_layout Plain Layout
8776 \begin_inset Quotes eld
8780 \begin_inset Flex Code
8783 \begin_layout Plain Layout
8790 \begin_inset Quotes erd
8796 \begin_layout Description
8797 \begin_inset Flex Code
8800 \begin_layout Plain Layout
8806 Adds information to the document preamble.
8808 \begin_inset Newline newline
8812 \begin_inset Quotes eld
8816 \begin_inset Flex Code
8819 \begin_layout Plain Layout
8826 \begin_inset Quotes erd
8832 \begin_layout Description
8833 \begin_inset Flex Code
8836 \begin_layout Plain Layout
8842 Defines the possibilities for displaying citation references.
8844 \begin_inset CommandInset ref
8846 reference "subsec:Citation-engine-description"
8855 \begin_inset Quotes eld
8859 \begin_inset Flex Code
8862 \begin_layout Plain Layout
8869 \begin_inset Quotes erd
8873 Primarily used in cite engine files (see
8874 \begin_inset CommandInset ref
8876 reference "subsec:Cite-Engine-Files"
8886 \begin_layout Description
8887 \begin_inset Flex Code
8890 \begin_layout Plain Layout
8896 Defines formats for use in the display of bibliographic information.
8898 \begin_inset CommandInset ref
8900 reference "subsec:Citation-format-description"
8906 \begin_inset Quotes eld
8910 \begin_inset Flex Code
8913 \begin_layout Plain Layout
8920 \begin_inset Quotes erd
8924 Primarily used in cite engine files (see
8925 \begin_inset CommandInset ref
8927 reference "subsec:Cite-Engine-Files"
8937 \begin_layout Description
8938 \begin_inset Flex Code
8941 \begin_layout Plain Layout
8948 \begin_inset Flex Code
8951 \begin_layout Plain Layout
8960 \begin_inset Flex Code
8963 \begin_layout Plain Layout
8969 ] Determines whether
8973 or Bib\SpecialChar TeX
8974 is used to generate a Bibliography.
8975 Primarily used in cite engine files (see
8976 \begin_inset CommandInset ref
8978 reference "subsec:Cite-Engine-Files"
8988 \begin_layout Description
8989 \begin_inset Flex Code
8992 \begin_layout Plain Layout
8998 Describes various global options supported by the document class.
9000 \begin_inset CommandInset ref
9002 reference "subsec:ClassOptions"
9008 \begin_inset Quotes eld
9012 \begin_inset Flex Code
9015 \begin_layout Plain Layout
9022 \begin_inset Quotes erd
9028 \begin_layout Description
9029 \begin_inset Flex Code
9032 \begin_layout Plain Layout
9039 \begin_inset Flex Code
9042 \begin_layout Plain Layout
9051 \begin_inset space \thinspace{}
9055 \begin_inset Flex Code
9058 \begin_layout Plain Layout
9064 ] Whether the class should
9068 to having one or two columns.
9069 Can be changed in the
9070 \begin_inset Flex Noun
9073 \begin_layout Plain Layout
9074 Document\SpecialChar menuseparator
9083 \begin_layout Description
9084 \begin_inset Flex Code
9087 \begin_layout Plain Layout
9094 \begin_inset Flex Code
9097 \begin_layout Plain Layout
9103 ] This sequence defines the properties for a counter.
9104 If the counter does not yet exist, it is created; if it does exist, it
9107 \begin_inset Quotes eld
9111 \begin_inset Flex Code
9114 \begin_layout Plain Layout
9121 \begin_inset Quotes erd
9125 \begin_inset Newline newline
9129 \begin_inset CommandInset ref
9131 reference "subsec:Counters"
9135 for details on counters.
9138 \begin_layout Description
9139 \begin_inset Flex Code
9142 \begin_layout Plain Layout
9148 Sets the default font used to display the document.
9150 \begin_inset CommandInset ref
9152 reference "subsec:Font-description"
9156 for how to declare fonts.
9158 \begin_inset Quotes eld
9162 \begin_inset Flex Code
9165 \begin_layout Plain Layout
9172 \begin_inset Quotes erd
9178 \begin_layout Description
9179 \begin_inset Flex Code
9182 \begin_layout Plain Layout
9189 \begin_inset Flex Code
9192 \begin_layout Plain Layout
9198 ] Specifies a module to be included by default with this document class.
9199 The module is specified as filename without the
9200 \begin_inset Flex Code
9203 \begin_layout Plain Layout
9210 The user can still remove the module, but it will be active at the outset.
9211 (This applies only when new files are created, or when this class is chosen
9212 for an existing document.)
9215 \begin_layout Description
9216 \begin_inset Flex Code
9219 \begin_layout Plain Layout
9226 \begin_inset Flex Code
9229 \begin_layout Plain Layout
9235 ] This is the style that will be assigned to new paragraphs, usually
9236 \begin_inset Flex Noun
9239 \begin_layout Plain Layout
9246 This will default to the first defined style if not given, but you are
9247 encouraged to use this directive.
9250 \begin_layout Description
9251 \begin_inset Flex Code
9254 \begin_layout Plain Layout
9261 \begin_inset Flex Code
9264 \begin_layout Plain Layout
9270 ] This tag indicates that the module (which is specified by filename without
9272 \begin_inset Flex Code
9275 \begin_layout Plain Layout
9281 extension) cannot be used with this document class.
9282 This might be used in a journal-specific layout file to prevent, say, the
9284 \begin_inset Flex Code
9287 \begin_layout Plain Layout
9293 module that numbers theorems by section.
9298 be used in a module.
9299 Modules have their own way of excluding other modules (see
9300 \begin_inset CommandInset ref
9302 reference "subsec:Layout-modules"
9309 \begin_layout Description
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9319 Defines a new float.
9321 \begin_inset CommandInset ref
9323 reference "subsec:Floats"
9329 \begin_inset Quotes eld
9333 \begin_inset Flex Code
9336 \begin_layout Plain Layout
9343 \begin_inset Quotes erd
9349 \begin_layout Description
9350 \begin_inset Flex Code
9353 \begin_layout Plain Layout
9359 Sets the information that will be output in the
9360 \begin_inset Flex Code
9363 \begin_layout Plain Layout
9369 block when this document class is output to XHTML.
9370 Note that this will completely override any prior
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9381 \begin_inset Flex Code
9384 \begin_layout Plain Layout
9392 \begin_inset Newline newline
9396 \begin_inset Flex Code
9399 \begin_layout Plain Layout
9405 if you just want to add material to the preamble.) Must end with
9406 \begin_inset Quotes eld
9410 \begin_inset Flex Code
9413 \begin_layout Plain Layout
9420 \begin_inset Quotes erd
9426 \begin_layout Description
9427 \begin_inset Flex Code
9430 \begin_layout Plain Layout
9437 \begin_inset Flex Code
9440 \begin_layout Plain Layout
9446 ] The style to use for the table of contents, bibliography, and so forth,
9447 when the document is output to HTML.
9448 For articles, this should normally be
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9459 \begin_inset Flex Code
9462 \begin_layout Plain Layout
9469 If it is not given, then \SpecialChar LyX
9470 will attempt to figure out which layout to use.
9473 \begin_layout Description
9474 \begin_inset Flex Code
9477 \begin_layout Plain Layout
9484 \begin_inset Flex Code
9487 \begin_layout Plain Layout
9493 ] Modifies the properties of the given counter.
9494 If the counter does not exist, the statement is ignored.
9496 \begin_inset Quotes eld
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9510 \begin_inset Quotes erd
9514 \begin_inset Newline newline
9518 \begin_inset CommandInset ref
9520 reference "subsec:Counters"
9524 for details on counters.
9527 \begin_layout Description
9528 \begin_inset Flex Code
9531 \begin_layout Plain Layout
9538 \begin_inset Flex Code
9541 \begin_layout Plain Layout
9547 ] This allows you to include another layout definition file within yours
9548 to avoid duplicating commands.
9549 Common examples are the standard layout files, for example,
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9559 , which contains most of the basic layouts.
9562 \begin_layout Description
9563 \begin_inset Flex Code
9566 \begin_layout Plain Layout
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9582 ] This section (re-)defines the layout of an inset.
9583 It can be applied to an existing inset or to a new, user-defined inset,
9584 e.g., a new character style.
9586 \begin_inset Quotes eld
9590 \begin_inset Flex Code
9593 \begin_layout Plain Layout
9600 \begin_inset Quotes erd
9604 \begin_inset Newline newline
9608 \begin_inset CommandInset ref
9610 reference "subsec:Flex-insets-and"
9614 for more information.
9618 \begin_layout Description
9619 \begin_inset Flex Code
9622 \begin_layout Plain Layout
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9638 ] A string that indicates the width of the left margin on the screen, for
9640 \begin_inset Quotes eld
9644 \begin_inset Flex Code
9647 \begin_layout Plain Layout
9654 \begin_inset Quotes erd
9658 (Note that this is not a `length', like
9659 \begin_inset Quotes eld
9663 \begin_inset Quotes erd
9669 \begin_layout Description
9670 \begin_inset Flex Code
9673 \begin_layout Plain Layout
9680 \begin_inset Flex Code
9683 \begin_layout Plain Layout
9689 ] An integer that determines the maximal number of names displayed in an
9690 author-year citation before the citation switches to
9691 \begin_inset Quotes eld
9695 \begin_inset Quotes erd
9699 Primarily used in cite engine files (see
9700 \begin_inset CommandInset ref
9702 reference "subsec:Cite-Engine-Files"
9712 \begin_layout Description
9713 \begin_inset Flex Code
9716 \begin_layout Plain Layout
9723 \begin_inset Flex Code
9726 \begin_layout Plain Layout
9732 ] Modifies the properties of the given paragraph style.
9733 If the style does not exist, this section is ignored.
9735 \begin_inset Quotes eld
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9749 \begin_inset Quotes erd
9755 \begin_layout Description
9756 \begin_inset Flex Code
9759 \begin_layout Plain Layout
9766 \begin_inset Flex Code
9769 \begin_layout Plain Layout
9775 ] Deletes an existing counter, usually one defined in an included file.
9778 \begin_layout Description
9779 \begin_inset Flex Code
9782 \begin_layout Plain Layout
9789 \begin_inset Flex Code
9792 \begin_layout Plain Layout
9798 ] Deletes an existing float.
9799 This is particularly useful when you want to suppress a float that has
9800 been defined in an input file.
9803 \begin_layout Description
9804 \begin_inset Flex Code
9807 \begin_layout Plain Layout
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9823 ] Deletes an existing style.
9826 \begin_layout Description
9827 \begin_inset Flex Code
9830 \begin_layout Plain Layout
9837 \begin_inset Flex Code
9840 \begin_layout Plain Layout
9847 \begin_inset Flex Code
9850 \begin_layout Plain Layout
9856 ] Define a new table of contents with type
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9877 See also the AddToToc commands.
9880 \begin_layout Description
9881 \begin_inset Flex Code
9884 \begin_layout Plain Layout
9891 \begin_inset Flex Code
9894 \begin_layout Plain Layout
9900 ] The file format (as defined in the \SpecialChar LyX
9901 preferences) produced by this document
9903 It is mainly useful when
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9914 \begin_inset Flex Code
9917 \begin_layout Plain Layout
9923 and one wants to define a new type of literate document.
9924 The format is reset to
9925 \begin_inset Quotes eld
9929 \begin_inset Flex Code
9932 \begin_layout Plain Layout
9939 \begin_inset Quotes erd
9943 \begin_inset Quotes eld
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9957 \begin_inset Quotes erd
9960 when the corresponding
9961 \begin_inset Flex Code
9964 \begin_layout Plain Layout
9970 parameter is encountered.
9973 \begin_layout Description
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9984 \begin_inset Flex Code
9987 \begin_layout Plain Layout
9998 \begin_inset Flex Code
10001 \begin_layout Plain Layout
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10017 ] Specifies what sort of output documents using this class will produce.
10020 \begin_layout Description
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10031 \begin_inset Flex Code
10034 \begin_layout Plain Layout
10041 \begin_inset Flex Code
10044 \begin_layout Plain Layout
10050 ] Specifies options, given in the second string, for the package named by
10053 \begin_inset Quotes eld
10057 \begin_inset Flex Code
10060 \begin_layout Plain Layout
10061 PackageOptions natbib square
10067 \begin_inset Quotes erd
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10080 to be loaded with the
10081 \begin_inset Flex Code
10084 \begin_layout Plain Layout
10091 (For \SpecialChar TeX
10092 perts, this causes \SpecialChar LyX
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10100 PassOptionsToPackage{natbib}{square}
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10118 \begin_layout Description
10119 \begin_inset Flex Code
10122 \begin_layout Plain Layout
10129 \begin_inset Flex Code
10132 \begin_layout Plain Layout
10141 \begin_inset Flex Code
10144 \begin_layout Plain Layout
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10160 ] The default pagestyle.
10161 Can be changed in the
10162 \begin_inset Flex Noun
10165 \begin_layout Plain Layout
10166 Document\SpecialChar menuseparator
10175 \begin_layout Description
10176 \begin_inset Flex Code
10179 \begin_layout Plain Layout
10185 Sets the preamble for the \SpecialChar LaTeX
10187 Note that this will completely override any prior
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10198 \begin_inset Flex Code
10201 \begin_layout Plain Layout
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 if you just want to add material to the preamble.) Must end with
10219 \begin_inset Quotes eld
10223 \begin_inset Flex Code
10226 \begin_layout Plain Layout
10233 \begin_inset Quotes erd
10239 \begin_layout Description
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10272 \begin_inset space \thinspace{}
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10285 ] Whether the class already provides the feature
10286 \begin_inset Flex Code
10289 \begin_layout Plain Layout
10296 A feature is in general the name of a package (e.
10297 \begin_inset space \thinspace{}
10301 \begin_inset space \space{}
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10315 \begin_inset Flex Code
10318 \begin_layout Plain Layout
10325 \begin_inset space \thinspace{}
10329 \begin_inset space \space{}
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10343 \begin_inset Flex Code
10346 \begin_layout Plain Layout
10354 \begin_inset CommandInset ref
10356 reference "chap:List-of-functions"
10360 for the list of features.
10363 \begin_layout Description
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10374 \begin_inset Flex Code
10377 \begin_layout Plain Layout
10383 ] Indicates that this layout provides the functionality of the module mentioned,
10384 which should be specified by the filename without the
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10395 This will typically be used if the layout includes the module directly,
10396 rather than using the
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10406 tag to indicate that it ought to be used.
10407 It could also be used in a module that provided an alternate implementation
10408 of the same functionality.
10411 \begin_layout Description
10412 \begin_inset Flex Code
10415 \begin_layout Plain Layout
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10431 ] Creates a new paragraph style if it does not already exist.
10432 If the style does exist, this section is ignored.
10434 \begin_inset Quotes eld
10438 \begin_inset Flex Code
10441 \begin_layout Plain Layout
10448 \begin_inset Quotes erd
10454 \begin_layout Description
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10465 \begin_inset Flex Code
10468 \begin_layout Plain Layout
10474 ] Whether the class requires the feature
10475 \begin_inset Flex Code
10478 \begin_layout Plain Layout
10485 Multiple features must be separated by commas.
10486 Note that you can only request supported features.
10488 \begin_inset CommandInset ref
10490 reference "chap:List-of-functions"
10494 for the list of features.).
10495 If you require a package with specific options, you can additionally use
10497 \begin_inset Flex Code
10500 \begin_layout Plain Layout
10509 \begin_layout Description
10510 \begin_inset Flex Code
10513 \begin_layout Plain Layout
10520 \begin_inset Flex Code
10523 \begin_layout Plain Layout
10529 ] A string that indicates the width of the right margin on the screen, for
10531 \begin_inset Quotes eld
10535 \begin_inset Flex Code
10538 \begin_layout Plain Layout
10545 \begin_inset Quotes erd
10551 \begin_layout Description
10552 \begin_inset Flex Code
10555 \begin_layout Plain Layout
10562 \begin_inset Flex Code
10565 \begin_layout Plain Layout
10571 ] Sets which divisions get numbered.
10573 \begin_inset Newline newline
10577 \begin_inset Flex Code
10580 \begin_layout Plain Layout
10586 counter in \SpecialChar LaTeX
10590 \begin_layout Description
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10613 \begin_inset space \thinspace{}
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10626 ] Whether the class-default should be printing on one or both sides of the
10628 Can be changed in the
10629 \begin_inset Flex Noun
10632 \begin_layout Plain Layout
10633 Document\SpecialChar menuseparator
10642 \begin_layout Description
10643 \begin_inset Flex Code
10646 \begin_layout Plain Layout
10653 \begin_inset Flex Code
10656 \begin_layout Plain Layout
10662 ] This sequence defines a paragraph style.
10663 If the style does not yet exist, it is created; if it does exist, its parameter
10666 \begin_inset Quotes eld
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 \begin_inset Quotes erd
10684 \begin_inset Newline newline
10688 \begin_inset CommandInset ref
10690 reference "subsec:Paragraph-Styles"
10694 for details on paragraph styles.
10697 \begin_layout Description
10698 \begin_inset Flex Code
10701 \begin_layout Plain Layout
10708 \begin_inset Flex Code
10711 \begin_layout Plain Layout
10717 ] The name of the command or environment to be used with
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10730 \begin_layout Description
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10741 \begin_inset Flex Code
10744 \begin_layout Plain Layout
10753 \begin_inset Flex Code
10756 \begin_layout Plain Layout
10762 ] Indicates what kind of markup is used to define the title of a document.
10764 \begin_inset Flex Code
10767 \begin_layout Plain Layout
10773 means that the macro with name
10774 \begin_inset Flex Code
10777 \begin_layout Plain Layout
10783 will be inserted after the last layout which has
10784 \begin_inset Quotes eld
10788 \begin_inset Flex Code
10791 \begin_layout Plain Layout
10793 \begin_inset space ~
10802 \begin_inset Quotes erd
10807 \begin_inset Flex Code
10810 \begin_layout Plain Layout
10816 corresponds to the case where all layouts which have
10817 \begin_inset Quotes eld
10821 \begin_inset Flex Code
10824 \begin_layout Plain Layout
10826 \begin_inset space ~
10835 \begin_inset Quotes erd
10838 should be enclosed into the
10839 \begin_inset Flex Code
10842 \begin_layout Plain Layout
10851 \begin_layout Description
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10862 \begin_inset Flex Code
10865 \begin_layout Plain Layout
10871 ] Sets which divisions are included in the table of contents.
10873 \begin_inset Flex Code
10876 \begin_layout Plain Layout
10882 counter in \SpecialChar LaTeX
10886 \begin_layout Subsection
10887 \begin_inset Flex Code
10890 \begin_layout Plain Layout
10897 \begin_inset CommandInset label
10899 name "subsec:ClassOptions"
10906 \begin_layout Standard
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10917 section can contain the following entries:
10920 \begin_layout Description
10921 \begin_inset Flex Code
10924 \begin_layout Plain Layout
10931 \begin_inset Flex Code
10934 \begin_layout Plain Layout
10940 ] The list of available font sizes for the document's main font, separated
10942 \begin_inset Quotes eld
10946 \begin_inset Flex Code
10949 \begin_layout Plain Layout
10956 \begin_inset Quotes erd
10962 \begin_layout Description
10963 \begin_inset Flex Code
10966 \begin_layout Plain Layout
10972 Used to set the DTD line with XML-based output classes.
10974 \begin_inset space \thinspace{}
10978 \begin_inset Quotes eld
10981 -//OASIS//DTD DocBook V4.2//EN
10982 \begin_inset Quotes erd
10988 \begin_layout Description
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
10999 \begin_inset Flex Code
11002 \begin_layout Plain Layout
11003 string="empty|plain|headings|fancy"
11008 ] The list of available page sty\SpecialChar softhyphen
11010 \begin_inset Quotes eld
11014 \begin_inset Flex Code
11017 \begin_layout Plain Layout
11024 \begin_inset Quotes erd
11030 \begin_layout Description
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11050 ] Some document class options, separated by a comma, that will be added
11051 to the optional part of the
11052 \begin_inset Flex Code
11055 \begin_layout Plain Layout
11066 \begin_layout Standard
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11077 section must end with
11078 \begin_inset Quotes eld
11082 \begin_inset Flex Code
11085 \begin_layout Plain Layout
11092 \begin_inset Quotes erd
11098 \begin_layout Subsection
11100 \begin_inset CommandInset label
11102 name "subsec:Paragraph-Styles"
11109 \begin_layout Standard
11110 A paragraph style description looks like this:
11114 \begin_layout Plain Layout
11115 Note that this will either define a new style or modify an existing one.
11123 \begin_layout LyX-Code
11130 \begin_layout LyX-Code
11134 \begin_layout LyX-Code
11138 \begin_layout Standard
11139 where the following commands are allowed:
11142 \begin_layout Description
11143 \begin_inset Flex Code
11146 \begin_layout Plain Layout
11153 \begin_inset Flex Code
11156 \begin_layout Plain Layout
11162 =""] This paragraph will appear in the table of contents of the given type.
11163 An empty string disables.
11164 See also the OutlinerName and the IsTocCaption commands.
11168 \begin_layout Description
11169 \begin_inset Flex Code
11172 \begin_layout Plain Layout
11179 \begin_inset Flex Code
11182 \begin_layout Plain Layout
11187 , left, right, center
11192 ] Paragraph alignment.
11195 \begin_layout Description
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11206 \begin_inset Flex Code
11209 \begin_layout Plain Layout
11214 , left, right, center
11219 ] A comma separated list of permitted alignments.
11220 (Some \SpecialChar LaTeX
11221 styles prohibit certain alignments, since those wouldn't make sense.
11222 For example a right-aligned or centered enumeration isn't possible.)
11225 \begin_layout Description
11226 \begin_inset Flex Code
11229 \begin_layout Plain Layout
11236 \begin_inset Flex Code
11239 \begin_layout Plain Layout
11245 ] Defines argument number <int> of a command\SpecialChar breakableslash
11246 environment associated with
11248 This is useful for things like section headings, and only makes sense with
11251 Every (optional or required) argument of a command or environment – except
11252 for the required argument that is associated with the content of the paragraph
11253 itself – has a separate definition, where the number specifies the order
11255 The definition must end with
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11266 So a command with two optional arguments has:
11270 \begin_layout Quote
11276 \begin_layout Quote
11282 \begin_layout Quote
11288 \begin_layout Quote
11294 \begin_layout Quote
11300 \begin_layout Quote
11306 \begin_layout Standard
11308 \begin_inset Flex Code
11311 \begin_layout Plain Layout
11317 definition, the following specifications are possible:
11320 \begin_layout Itemize
11321 \begin_inset Flex Code
11324 \begin_layout Plain Layout
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11340 The string that will appear both in the menu (to insert this argument)
11341 and on the argument inset button (unless you also specify a separate
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11352 For the menu, you can define an accelerator by appending the respective
11353 character to the string, divided by
11354 \begin_inset Quotes eld
11358 \begin_inset Quotes erd
11362 \begin_inset space \thinspace{}
11366 \begin_inset space \space{}
11370 \begin_inset Quotes eld
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11384 \begin_inset Quotes erd
11390 \begin_layout Itemize
11391 \begin_inset Flex Code
11394 \begin_layout Plain Layout
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11410 A separate string for the menu.
11411 You can define an accelerator by appending the respective character to
11412 the string, divided by
11413 \begin_inset Quotes eld
11417 \begin_inset Quotes erd
11421 \begin_inset space \thinspace{}
11425 \begin_inset space \space{}
11429 \begin_inset Quotes eld
11433 \begin_inset Flex Code
11436 \begin_layout Plain Layout
11443 \begin_inset Quotes erd
11447 This specification is optional.
11448 If it is not given the
11449 \begin_inset Flex Code
11452 \begin_layout Plain Layout
11458 will be used instead for the menu.
11461 \begin_layout Itemize
11462 \begin_inset Flex Code
11465 \begin_layout Plain Layout
11472 \begin_inset Flex Code
11475 \begin_layout Plain Layout
11481 A longer explanatory text that appears in the tooltip when hovering over
11482 the argument inset.
11485 \begin_layout Itemize
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11496 \begin_inset Flex Code
11499 \begin_layout Plain Layout
11508 \begin_inset space \thinspace{}
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11521 ] Declare if this is a mandatory (1) or an optional (0) argument.
11522 Mandatory arguments will be output empty if not given, while optional arguments
11523 will not be output at all.
11524 By default, mandatory arguments are delimited by
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11534 , while optional arguments are delimited by
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11547 \begin_layout Itemize
11548 \begin_inset Flex Code
11551 \begin_layout Plain Layout
11558 \begin_inset Flex Code
11561 \begin_layout Plain Layout
11567 defines another argument (by its number) which this argument requires to
11568 be output if it is itself output.
11570 \begin_inset space \thinspace{}
11573 g., in \SpecialChar LaTeX
11574 commands, optional arguments often require previous optional arguments
11575 to be output (at least empty), as in
11576 \begin_inset Flex Code
11579 \begin_layout Plain Layout
11582 command[][argument]{text}
11588 This can be achieved by the statement
11589 \begin_inset Flex Code
11592 \begin_layout Plain Layout
11599 \begin_inset Flex Code
11602 \begin_layout Plain Layout
11611 \begin_layout Itemize
11612 \begin_inset Flex Code
11615 \begin_layout Plain Layout
11622 \begin_inset Flex Code
11625 \begin_layout Plain Layout
11631 defines a custom left delimiter (instead of
11632 \begin_inset Flex Code
11635 \begin_layout Plain Layout
11642 \begin_inset Flex Code
11645 \begin_layout Plain Layout
11652 A line break in the output can be indicated by
11653 \begin_inset Flex Code
11656 \begin_layout Plain Layout
11665 \begin_layout Itemize
11666 \begin_inset Flex Code
11669 \begin_layout Plain Layout
11676 \begin_inset Flex Code
11679 \begin_layout Plain Layout
11685 defines a custom right delimiter (instead of
11686 \begin_inset Flex Code
11689 \begin_layout Plain Layout
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11706 A line break in the output can be indicated by
11707 \begin_inset Flex Code
11710 \begin_layout Plain Layout
11719 \begin_layout Itemize
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11739 defines an argument that is inserted if and only if no user-specified arguments
11741 \begin_inset space \thinspace{}
11745 \begin_inset space \space{}
11748 if no argument inset has been inserted (note that also an empty argument
11749 inset omits the DefaultArg).
11750 Multiple arguments need to be separated by comma.
11753 \begin_layout Itemize
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11764 \begin_inset Flex Code
11767 \begin_layout Plain Layout
11773 defines an argument that is inserted in any case (alone or in addition
11774 to user-specified arguments).
11775 Multiple arguments need to be separated by comma.
11778 \begin_layout Itemize
11779 \begin_inset Flex Code
11782 \begin_layout Plain Layout
11788 The font used for the argument content, see
11789 \begin_inset CommandInset ref
11791 reference "subsec:Font-description"
11798 \begin_layout Itemize
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11808 The font used for the label; see
11809 \begin_inset CommandInset ref
11811 reference "subsec:Font-description"
11818 \begin_layout Itemize
11819 \begin_inset Flex Code
11822 \begin_layout Plain Layout
11829 \begin_inset Flex Code
11832 \begin_layout Plain Layout
11837 , Minimalistic, Conglomerate
11842 ] describes the rendering style used for the inset's frame and buttons.
11845 \begin_layout Itemize
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11866 \begin_inset Flex Code
11869 \begin_layout Plain Layout
11875 , this argument is automatically inserted when the respective style is selected.
11876 Currently, only one argument per style\SpecialChar breakableslash
11877 layout can be automatically inserted.
11880 \begin_layout Itemize
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11891 \begin_inset Flex Code
11894 \begin_layout Plain Layout
11901 \begin_inset Flex Code
11904 \begin_layout Plain Layout
11910 , this argument will be inserted with a copy of the co-text (either selected
11911 text or the whole paragraph) as content.
11914 \begin_layout Itemize
11915 \begin_inset Flex Code
11918 \begin_layout Plain Layout
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11938 ] Whether the contents of this argument should be output in raw form, meaning
11939 without special translations that \SpecialChar LaTeX
11942 \begin_inset Flex Code
11945 \begin_layout Plain Layout
11951 status is inherited by the inset or paragraph layout the argument belongs
11952 to, true and false change the status for the given argument only.
11955 \begin_layout Itemize
11956 \begin_inset Flex Code
11959 \begin_layout Plain Layout
11966 \begin_inset Flex Code
11969 \begin_layout Plain Layout
11970 string of characters
11979 Defines individual characters that should be output in raw form, meaning
11980 without special translations that \SpecialChar LaTeX
11982 Note that, contrary to PassThru, this needs to be explicitly defined for
11984 That is, arguments do not inherit PassThruChars from their parent inset
11988 \begin_layout Itemize
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11999 \begin_inset Flex Code
12002 \begin_layout Plain Layout
12011 \begin_inset space \thinspace{}
12015 \begin_inset Flex Code
12018 \begin_layout Plain Layout
12024 ] If this is set to 1, the argument will output its content in the corresponding
12025 item in the table of contents.
12029 \begin_layout Standard
12030 By default, the text entered in the \SpecialChar LyX
12031 workarea in the respective layout is
12032 the last (mandatory) argument of a command if the
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 However, arguments with the prefix
12054 \begin_inset Flex Code
12057 \begin_layout Plain Layout
12063 are output after this workarea argument.
12064 Note that post-argument numbering restarts at 1, so the first argument
12065 following the workarea argument is
12066 \begin_inset Flex Code
12069 \begin_layout Plain Layout
12076 Post-arguments are ignored in any other
12077 \begin_inset Flex Code
12080 \begin_layout Plain Layout
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12099 \begin_layout Standard
12101 \begin_inset Flex Code
12104 \begin_layout Plain Layout
12113 \begin_inset Flex Code
12116 \begin_layout Plain Layout
12125 \begin_inset Flex Code
12128 \begin_layout Plain Layout
12134 followed by the number (e.
12135 \begin_inset space \thinspace{}
12139 \begin_inset space \space{}
12143 \begin_inset Flex Code
12146 \begin_layout Plain Layout
12156 \begin_layout Description
12157 \begin_inset Flex Code
12160 \begin_layout Plain Layout
12166 Note that this will completely override any prior
12167 \begin_inset Flex Code
12170 \begin_layout Plain Layout
12176 declaration for this style.
12178 \begin_inset Quotes eld
12182 \begin_inset Flex Code
12185 \begin_layout Plain Layout
12192 \begin_inset Quotes erd
12197 \begin_inset CommandInset ref
12199 reference "subsec:I18n"
12203 for details on its use.
12206 \begin_layout Description
12207 \begin_inset Flex Code
12210 \begin_layout Plain Layout
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12230 \begin_layout Plain Layout
12231 Note that a `float' here is a real number, such as: 1.5.
12236 The vertical space with which the last of a chain of paragraphs with this
12237 style is separated from the following paragraph.
12238 If the next paragraph has another style, the separations are not simply
12239 added, but the maximum is taken.
12242 \begin_layout Description
12243 \begin_inset Flex Code
12246 \begin_layout Plain Layout
12253 \begin_inset Flex Code
12256 \begin_layout Plain Layout
12262 ] The category for this style.
12263 This is used to group related styles in the style combobox on the toolbar.
12264 Any string can be used, but you may want to use existing categories with
12269 \begin_layout Description
12270 \begin_inset Flex Code
12273 \begin_layout Plain Layout
12279 Depth of XML command.
12280 Used only with XML-type formats.
12283 \begin_layout Description
12284 \begin_inset Flex Code
12287 \begin_layout Plain Layout
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12303 ] Copies all the features of an existing style into the current one.
12307 \begin_layout Description
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12318 \begin_inset Flex Code
12321 \begin_layout Plain Layout
12327 ] The name of a style whose preamble should be output
12332 This allows to ensure some ordering of the preamble snippets when macros
12333 definitions depend on one another.
12337 \begin_layout Plain Layout
12338 Note that, besides that functionality, there is no way to ensure any ordering
12340 The ordering that you see in a given version of \SpecialChar LyX
12341 may change without warning
12350 \begin_layout Description
12351 \begin_inset Flex Code
12354 \begin_layout Plain Layout
12361 \begin_inset Flex Code
12364 \begin_layout Plain Layout
12369 , Box, Filled_Box, Static
12374 ] The type of label that stands at the end of the paragraph (or sequence
12376 \begin_inset Flex Code
12379 \begin_layout Plain Layout
12386 \begin_inset Newline newline
12390 \begin_inset Flex Code
12393 \begin_layout Plain Layout
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12410 \begin_inset Flex Code
12413 \begin_layout Plain Layout
12421 \begin_inset Flex Code
12424 \begin_layout Plain Layout
12431 \begin_inset Quotes eld
12435 \begin_inset Quotes erd
12439 \begin_inset Flex Code
12442 \begin_layout Plain Layout
12449 \begin_inset space \space{}
12453 \begin_inset Flex Code
12456 \begin_layout Plain Layout
12462 ) is a white (resp.
12463 \begin_inset space ~
12466 black) square suitable for end of proof markers,
12467 \begin_inset Flex Code
12470 \begin_layout Plain Layout
12476 is an explicit text string.
12479 \begin_layout Description
12480 \begin_inset Flex Code
12483 \begin_layout Plain Layout
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12499 ] The string used for a label with a
12500 \begin_inset Flex Code
12503 \begin_layout Plain Layout
12510 \begin_inset Newline newline
12514 \begin_inset Flex Code
12517 \begin_layout Plain Layout
12527 \begin_layout Description
12528 \begin_inset Flex Code
12531 \begin_layout Plain Layout
12537 The font used for both the text body
12543 \begin_inset CommandInset ref
12545 reference "subsec:Font-description"
12550 Note that defining this font automatically defines the
12551 \begin_inset Flex Code
12554 \begin_layout Plain Layout
12561 So you should define this one first if you also want to define
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12574 \begin_layout Description
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12585 \begin_inset Flex Code
12588 \begin_layout Plain Layout
12594 ] Used for backporting new styles to stable \SpecialChar LyX
12596 The first stable version that supports this tag is \SpecialChar LyX
12598 The argument is a number which may either be 0, -1 or any value greater
12601 \begin_inset Flex Code
12604 \begin_layout Plain Layout
12610 flag of a style is greater than zero, it will always be written to the
12612 If a .lyx file is read, the style definitions from the document header are
12613 added to the document class.
12614 Therefore even older \SpecialChar LyX
12615 versions can handle the style.
12617 \begin_inset Flex Code
12620 \begin_layout Plain Layout
12626 is a version number: if the style is read, and the version number is less
12627 than the version number of the already existing style in the document class,
12628 the new style is ignored.
12629 If the version number is greater, the new style replaces the existing style.
12630 A value of -1 means an infinite version number, i.
12631 \begin_inset space \thinspace{}
12635 \begin_inset space \space{}
12638 the style is always used.
12641 \begin_layout Description
12642 \begin_inset Flex Code
12645 \begin_layout Plain Layout
12652 \begin_inset Flex Code
12655 \begin_layout Plain Layout
12664 \begin_inset space \thinspace{}
12668 \begin_inset Flex Code
12671 \begin_layout Plain Layout
12677 ] Usually \SpecialChar LyX
12678 does not allow you to insert more than one space between words,
12679 since a space is considered as the separation between two words, not a
12680 character or symbol of its own.
12681 This is a very fine thing but sometimes annoying, for example, when typing
12682 program code or plain \SpecialChar LaTeX
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12695 Note that \SpecialChar LyX
12696 will create protected blanks for the additional blanks when
12697 in another mode than \SpecialChar LaTeX
12701 \begin_layout Description
12702 \begin_inset Flex Code
12705 \begin_layout Plain Layout
12711 These tags are used with XHTML output.
12713 \begin_inset CommandInset ref
12715 reference "subsec:Paragraph-Style-XHTML"
12722 \begin_layout Description
12723 \begin_inset Flex Code
12726 \begin_layout Plain Layout
12732 [FIXME] (Used only with XML-type formats.)
12735 \begin_layout Description
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12746 \begin_inset Flex Code
12749 \begin_layout Plain Layout
12758 \begin_inset space \thinspace{}
12762 \begin_inset Flex Code
12765 \begin_layout Plain Layout
12772 \begin_inset Flex Code
12775 \begin_layout Plain Layout
12781 , marks the style as to be included in the document preamble and not in
12783 This is useful for document classes that want such information as the title
12784 and author to appear in the preamble.
12785 Note that this works only for styles for which the
12786 \begin_inset Flex Code
12789 \begin_layout Plain Layout
12796 \begin_inset Flex Code
12799 \begin_layout Plain Layout
12806 \begin_inset Flex Code
12809 \begin_layout Plain Layout
12818 \begin_layout Description
12819 \begin_inset Flex Code
12822 \begin_layout Plain Layout
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12841 \begin_inset space \thinspace{}
12845 \begin_inset Flex Code
12848 \begin_layout Plain Layout
12855 \begin_inset Flex Code
12858 \begin_layout Plain Layout
12864 , marks the style as being part of a title block (see also the
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12875 \begin_inset Flex Code
12878 \begin_layout Plain Layout
12887 \begin_layout Description
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12898 \begin_inset Flex Code
12901 \begin_layout Plain Layout
12910 \begin_inset space \thinspace{}
12914 \begin_inset Flex Code
12917 \begin_layout Plain Layout
12923 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12924 of its contents in its item in the table of contents.
12925 Otherwise, only the label, if it exists, appears.
12928 \begin_layout Description
12929 \begin_inset Flex Code
12932 \begin_layout Plain Layout
12939 \begin_inset Flex Code
12942 \begin_layout Plain Layout
12948 ] The \SpecialChar LaTeX
12949 command sequence declaring an item in a list.
12950 The command is to be defined without the preceding backslash (the default
12952 \begin_inset Quotes eld
12956 \begin_inset Quotes erd
12960 \begin_inset Flex Code
12963 \begin_layout Plain Layout
12971 in the \SpecialChar LaTeX
12975 \begin_layout Description
12976 \begin_inset Flex Code
12979 \begin_layout Plain Layout
12986 \begin_inset Flex Code
12989 \begin_layout Plain Layout
12995 ] This provides extra space between paragraphs that have the same style.
12996 If you put other styles into an environment, each is separated with the
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13008 But the whole items of the environment are additionally separated with
13010 \begin_inset Flex Code
13013 \begin_layout Plain Layout
13020 Note that this is a
13025 \begin_layout Description
13026 \begin_inset Flex Code
13029 \begin_layout Plain Layout
13035 [FIXME] (Used only with XML-type formats.)
13038 \begin_layout Description
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13061 \begin_inset space \thinspace{}
13065 \begin_inset Flex Code
13068 \begin_layout Plain Layout
13074 ] Usually \SpecialChar LyX
13075 does not allow you to leave a paragraph empty, since it would
13076 lead to empty \SpecialChar LaTeX
13078 There are some cases where this could be desirable however: in a letter
13079 template, the required fields can be provided as empty fields, so that
13080 people do not forget them; in some special classes, a style can be used
13081 as some kind of break, which does not contain actual text.
13084 \begin_layout Description
13085 \begin_inset Flex Code
13088 \begin_layout Plain Layout
13095 \begin_inset Flex Code
13098 \begin_layout Plain Layout
13104 ] The vertical space between the label and the text body.
13105 Only used for labels that are above the text body (
13106 \begin_inset Flex Code
13109 \begin_layout Plain Layout
13116 \begin_inset Newline newline
13120 \begin_inset Flex Code
13123 \begin_layout Plain Layout
13124 Centered_Top_Environment
13132 \begin_layout Description
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13143 \begin_inset Flex Code
13146 \begin_layout Plain Layout
13152 ] The name of the counter for automatic numbering.
13153 In order to have the counter appear with your label, you will need to reference
13155 \begin_inset Flex Code
13158 \begin_layout Plain Layout
13167 This will work with
13168 \begin_inset Flex Code
13171 \begin_layout Plain Layout
13178 \begin_inset Flex Code
13181 \begin_layout Plain Layout
13188 \begin_inset Flex Code
13191 \begin_layout Plain Layout
13198 \begin_inset Flex Code
13201 \begin_layout Plain Layout
13208 \begin_inset Newline newline
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13226 \begin_inset Flex Code
13229 \begin_layout Plain Layout
13235 , though this case is a bit complicated.
13236 Suppose you declare
13237 \begin_inset Quotes eld
13241 \begin_inset Flex Code
13244 \begin_layout Plain Layout
13245 LabelCounter myenum
13251 \begin_inset Quotes erd
13255 Then the actual counters used are
13256 \begin_inset Flex Code
13259 \begin_layout Plain Layout
13266 \begin_inset Flex Code
13269 \begin_layout Plain Layout
13276 \begin_inset Flex Code
13279 \begin_layout Plain Layout
13286 \begin_inset Flex Code
13289 \begin_layout Plain Layout
13295 , much as in \SpecialChar LaTeX
13297 These counters must all be declared separately.
13298 \begin_inset Newline newline
13302 \begin_inset CommandInset ref
13304 reference "subsec:Counters"
13308 for details on counters.
13311 \begin_layout Description
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13321 The font used for the label.
13323 \begin_inset CommandInset ref
13325 reference "subsec:Font-description"
13332 \begin_layout Description
13333 \begin_inset Flex Code
13336 \begin_layout Plain Layout
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13352 ] Text that indicates how far a label should be indented.
13355 \begin_layout Description
13356 \begin_inset Flex Code
13359 \begin_layout Plain Layout
13366 \begin_inset Flex Code
13369 \begin_layout Plain Layout
13375 ] Text that indicates the amount of horizontal space between the label and
13377 Only used for labels that are not above the text body.
13380 \begin_layout Description
13381 \begin_inset Flex Code
13384 \begin_layout Plain Layout
13391 \begin_inset Flex Code
13394 \begin_layout Plain Layout
13400 ] The string used for the label.
13402 \begin_inset Flex Code
13405 \begin_layout Plain Layout
13411 is set, this string can be contain the special formatting commands described
13413 \begin_inset CommandInset ref
13415 reference "subsec:Counters"
13422 \begin_layout Description
13423 \begin_inset Flex Code
13426 \begin_layout Plain Layout
13427 LabelStringAppendix
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13442 ] This is used inside the appendix instead of
13443 \begin_inset Newline newline
13447 \begin_inset Flex Code
13450 \begin_layout Plain Layout
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13468 \begin_inset Newline newline
13472 \begin_inset Flex Code
13475 \begin_layout Plain Layout
13476 LabelStringAppendix
13484 \begin_layout Description
13485 \begin_inset Flex Code
13488 \begin_layout Plain Layout
13494 [FIXME] (Used only with XML-type formats.)
13497 \begin_layout Description
13498 \begin_inset Flex Code
13501 \begin_layout Plain Layout
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13516 , Manual, Static, Above,
13517 \begin_inset Newline newline
13520 Centered, Sensitive, Enumerate,
13521 \begin_inset Newline newline
13524 Itemize, Bibliography
13533 \begin_layout Description
13534 \begin_inset Flex Code
13537 \begin_layout Plain Layout
13543 means the label is the very first word (up to the first real blank).
13544 Use protected spaces if you want more than one word as the label.
13548 \begin_layout Description
13549 \begin_inset Flex Code
13552 \begin_layout Plain Layout
13558 means the label is simply what is declared as
13559 \begin_inset Flex Code
13562 \begin_layout Plain Layout
13569 This will be displayed
13570 \begin_inset Quotes eld
13574 \begin_inset Quotes erd
13577 , at the beginning of the paragraph.
13579 \begin_inset Flex Code
13582 \begin_layout Plain Layout
13589 \begin_inset Flex Code
13592 \begin_layout Plain Layout
13598 , then it will be displayed only in the first paragraph of any sequence
13599 of paragraphs with the same
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13612 \begin_layout Description
13613 \begin_inset Flex Code
13616 \begin_layout Plain Layout
13623 \begin_inset space ~
13627 \begin_inset space ~
13631 \begin_inset Flex Code
13634 \begin_layout Plain Layout
13640 are special cases of
13641 \begin_inset Flex Code
13644 \begin_layout Plain Layout
13651 The label will be printed above the paragraph either at the beginning of
13652 the line or centered.
13655 \begin_layout Description
13656 \begin_inset Flex Code
13659 \begin_layout Plain Layout
13665 is a special case for the caption-labels
13666 \begin_inset Quotes eld
13670 \begin_inset Quotes erd
13674 \begin_inset Quotes eld
13678 \begin_inset Quotes erd
13682 \begin_inset Newline newline
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13695 means the (hardcoded) label string depends on the kind of float: It is
13696 hardcoded to be `FloatType N', where N is the value of the counter associated
13698 For the case that a caption is inserted outside of a float the
13699 \begin_inset Flex Code
13702 \begin_layout Plain Layout
13709 \begin_inset Quotes eld
13713 \begin_inset Quotes erd
13719 \begin_layout Description
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13729 produces the usual sort of enumeration labels.
13730 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13731 small Roman numerals, and uppercase letters for the four possible depths.
13734 \begin_layout Description
13735 \begin_inset Flex Code
13738 \begin_layout Plain Layout
13744 produces various bullets at the different levels.
13745 It is also hardcoded.
13748 \begin_layout Description
13749 \begin_inset Flex Code
13752 \begin_layout Plain Layout
13758 should be used only with
13759 \begin_inset Flex Code
13762 \begin_layout Plain Layout
13763 LatexType BibEnvironment
13772 \begin_layout Description
13773 \begin_inset Flex Code
13776 \begin_layout Plain Layout
13782 Note that this will completely override any prior
13783 \begin_inset Flex Code
13786 \begin_layout Plain Layout
13792 declaration for this style.
13794 \begin_inset Quotes eld
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13808 \begin_inset Quotes erd
13813 \begin_inset CommandInset ref
13815 reference "subsec:I18n"
13819 for details on its use.
13822 \begin_layout Description
13823 \begin_inset Flex Code
13826 \begin_layout Plain Layout
13833 \begin_inset Flex Code
13836 \begin_layout Plain Layout
13842 ] The name of the corresponding \SpecialChar LaTeX
13844 Either the environment or command name.
13847 \begin_layout Description
13848 \begin_inset Flex Code
13851 \begin_layout Plain Layout
13858 \begin_inset Flex Code
13861 \begin_layout Plain Layout
13867 ] An optional parameter for the corresponding
13868 \begin_inset Flex Code
13871 \begin_layout Plain Layout
13878 This parameter cannot be changed from within \SpecialChar LyX
13880 \begin_inset Flex Code
13883 \begin_layout Plain Layout
13889 for customizable parameters).
13890 This will be output as is after all \SpecialChar LaTeX
13892 \begin_inset Flex Code
13895 \begin_layout Plain Layout
13904 \begin_layout Description
13905 \begin_inset Flex Code
13908 \begin_layout Plain Layout
13915 \begin_inset Flex Code
13918 \begin_layout Plain Layout
13923 , Command, Environment, Item_Environment,
13924 \begin_inset Newline newline
13927 List_Environment, Bib_Environment
13932 ] How the style should be translated into \SpecialChar LaTeX
13937 \begin_layout Plain Layout
13938 \begin_inset Flex Code
13941 \begin_layout Plain Layout
13947 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13948 Visit the SGML class files for specific examples.
13957 \begin_layout Description
13958 \begin_inset Flex Code
13961 \begin_layout Plain Layout
13967 means nothing special.
13970 \begin_layout Description
13971 \begin_inset Flex Code
13974 \begin_layout Plain Layout
13981 \begin_inset Flex Code
13984 \begin_layout Plain Layout
13991 {\SpecialChar ldots
14000 \begin_layout Description
14001 \begin_inset Flex Code
14004 \begin_layout Plain Layout
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 }\SpecialChar ldots
14037 \begin_layout Description
14038 \begin_inset Flex Code
14041 \begin_layout Plain Layout
14048 \begin_inset Flex Code
14051 \begin_layout Plain Layout
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14069 is generated for each paragraph of this environment.
14073 \begin_layout Description
14074 \begin_inset Flex Code
14077 \begin_layout Plain Layout
14084 \begin_inset Flex Code
14087 \begin_layout Plain Layout
14094 \begin_inset Newline newline
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14107 is passed as an argument to the environment.
14108 \begin_inset Newline newline
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14121 can be defined in the
14122 \begin_inset Flex Noun
14125 \begin_layout Plain Layout
14126 Edit\SpecialChar menuseparator
14128 \begin_inset space ~
14139 \begin_layout Description
14140 \begin_inset Flex Code
14143 \begin_layout Plain Layout
14150 \begin_inset Flex Code
14153 \begin_layout Plain Layout
14159 but adds the necessary mandatory argument (the longest label) to the begin
14160 statement of the bibliography environment:
14161 \begin_inset Newline newline
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14171 begin{thebibliography}{99}
14177 It is therefore only useful for bibliography environments.
14178 The default longest label
14179 \begin_inset Quotes eld
14183 \begin_inset Quotes erd
14186 can be changed by the user in the paragraph settings of a bibliography
14190 \begin_layout Standard
14191 Putting the last few things together, the \SpecialChar LaTeX
14192 output will be either:
14195 \begin_layout LyX-Code
14198 LatexName[LatexParam]{\SpecialChar ldots
14202 \begin_layout Standard
14206 \begin_layout LyX-Code
14209 begin{LatexName}[LatexParam] \SpecialChar ldots
14215 \begin_layout Standard
14216 depending upon the \SpecialChar LaTeX
14221 \begin_layout Description
14222 \begin_inset Flex Code
14225 \begin_layout Plain Layout
14232 \begin_inset Flex Code
14235 \begin_layout Plain Layout
14241 ] A string that is put at the beginning of the style content.
14242 A line break in the output can be indicated by
14243 \begin_inset Flex Code
14246 \begin_layout Plain Layout
14255 \begin_layout Description
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14275 ] If you put styles into environments, the different
14276 \begin_inset Flex Code
14279 \begin_layout Plain Layout
14285 are not simply added, but added with a factor
14286 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14290 Note that this parameter is also used when
14291 \begin_inset Flex Code
14294 \begin_layout Plain Layout
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14321 Then it is added to the manual or dynamic margin.
14322 \begin_inset Newline newline
14326 \begin_inset Quotes eld
14330 \begin_inset Flex Code
14333 \begin_layout Plain Layout
14340 \begin_inset Quotes erd
14343 means that the paragraph is indented with the width of
14344 \begin_inset Quotes eld
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14358 \begin_inset Quotes erd
14361 in the normal font.
14362 You can get a negative width by prefixing the string with
14363 \begin_inset Quotes eld
14367 \begin_inset Flex Code
14370 \begin_layout Plain Layout
14377 \begin_inset Quotes erd
14381 This way was chosen so that the look is the same with each used screen
14385 \begin_layout Description
14386 \begin_inset Flex Code
14389 \begin_layout Plain Layout
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14404 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14410 \begin_inset Newline newline
14413 The kind of margin that the style has on the left side.
14417 \begin_layout Description
14418 \begin_inset Flex Code
14421 \begin_layout Plain Layout
14427 just means a fixed margin.
14430 \begin_layout Description
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14440 means that the left margin depends on the string entered in the
14441 \begin_inset Flex Noun
14444 \begin_layout Plain Layout
14445 Edit\SpecialChar menuseparator
14447 \begin_inset space ~
14456 This is used to typeset nice lists without tabulators.
14459 \begin_layout Description
14460 \begin_inset Flex Code
14463 \begin_layout Plain Layout
14469 means that the margin depends on the size of the label.
14470 This is used for automatic enumerated headlines.
14471 It is obvious that the headline
14472 \begin_inset Quotes eld
14475 5.4.3.2.1 Very long headline
14476 \begin_inset Quotes erd
14479 must have a wider left margin (as wide as
14480 \begin_inset Quotes eld
14484 \begin_inset Quotes erd
14487 plus the space) than
14488 \begin_inset Quotes eld
14491 3.2 Very long headline
14492 \begin_inset Quotes erd
14496 \begin_inset Quotes eld
14500 \begin_inset Quotes erd
14503 are not able to do this.
14506 \begin_layout Description
14507 \begin_inset Flex Code
14510 \begin_layout Plain Layout
14516 is similar, but only the very first row of the paragraph is dynamic, while
14517 the others are static; this is used, for example, for descriptions.
14520 \begin_layout Description
14521 \begin_inset Flex Code
14524 \begin_layout Plain Layout
14530 means the margin is chosen in a way that the longest row of this paragraph
14531 fits to the right margin.
14532 This is used to typeset an address on the right edge of the page.
14536 \begin_layout Description
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14547 \begin_inset Flex Code
14550 \begin_layout Plain Layout
14559 \begin_inset space \thinspace{}
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14572 ] Whether fragile commands in this style should be
14573 \begin_inset Flex Code
14576 \begin_layout Plain Layout
14589 whether this command should itself be protected.)
14592 \begin_layout Description
14593 \begin_inset Flex Code
14596 \begin_layout Plain Layout
14603 \begin_inset Flex Code
14606 \begin_layout Plain Layout
14613 \begin_inset space \thinspace{}
14617 \begin_inset Flex Code
14620 \begin_layout Plain Layout
14628 ] Whether newlines are translated into \SpecialChar LaTeX
14630 \begin_inset Flex Code
14633 \begin_layout Plain Layout
14644 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14646 inside \SpecialChar LyX
14650 \begin_layout Description
14651 \begin_inset Flex Code
14654 \begin_layout Plain Layout
14661 \begin_inset Flex Code
14664 \begin_layout Plain Layout
14673 \begin_inset space \thinspace{}
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14686 ] If set to true, and if
14687 \begin_inset Flex Code
14690 \begin_layout Plain Layout
14697 \begin_inset Flex Code
14700 \begin_layout Plain Layout
14706 ) paragraphs are being indented, then the indentation of such a paragraph
14707 following one of this type will be suppressed.
14708 (So this will not affect the display of non-default paragraphs.)
14711 \begin_layout Description
14712 \begin_inset Flex Code
14715 \begin_layout Plain Layout
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14731 ] Name of a style that has replaced this style.
14732 This is used to rename a style, while keeping backward compatibility.
14735 \begin_layout Description
14736 \begin_inset Flex Code
14739 \begin_layout Plain Layout
14746 \begin_inset Flex Code
14749 \begin_layout Plain Layout
14756 \begin_inset space \thinspace{}
14760 \begin_inset Flex Code
14763 \begin_layout Plain Layout
14769 ] Determines whether consecutive paragraphs of the same type are treated
14770 as belonging together.
14771 This has the effect that the
14772 \begin_inset Flex Code
14775 \begin_layout Plain Layout
14781 is only printed once before such a group.
14782 By default, this is true for
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14812 and false for all other types.
14815 \begin_layout Description
14816 \begin_inset Flex Code
14819 \begin_layout Plain Layout
14826 \begin_inset Flex Code
14829 \begin_layout Plain Layout
14838 \begin_inset space \thinspace{}
14842 \begin_inset Flex Code
14845 \begin_layout Plain Layout
14851 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14853 but only by a line break; together with
14854 \begin_inset Flex Code
14857 \begin_layout Plain Layout
14863 , this allows to emulate a plain text editor (like the ERT inset).
14866 \begin_layout Description
14867 \begin_inset Flex Code
14870 \begin_layout Plain Layout
14877 \begin_inset Flex Code
14880 \begin_layout Plain Layout
14886 ] The indent of the very first line of a paragraph.
14888 \begin_inset Newline newline
14892 \begin_inset Flex Code
14895 \begin_layout Plain Layout
14901 will be fixed for a certain style.
14902 The exception is the default style, since the indentation for these paragraphs
14903 can be prohibited with
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14915 \begin_inset Flex Code
14918 \begin_layout Plain Layout
14924 style paragraphs inside environments use the
14925 \begin_inset Flex Code
14928 \begin_layout Plain Layout
14934 of the environment, not their native one.
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14945 paragraphs inside an enumeration are not indented.
14948 \begin_layout Description
14949 \begin_inset Flex Code
14952 \begin_layout Plain Layout
14959 \begin_inset Flex Code
14962 \begin_layout Plain Layout
14968 ] The vertical space between two paragraphs of this style.
14971 \begin_layout Description
14972 \begin_inset Flex Code
14975 \begin_layout Plain Layout
14982 \begin_inset Flex Code
14985 \begin_layout Plain Layout
14992 allows the user to choose either
14993 \begin_inset Quotes eld
14997 \begin_inset Quotes erd
15001 \begin_inset Quotes eld
15005 \begin_inset Quotes erd
15008 to separate paragraphs.
15010 \begin_inset Quotes eld
15014 \begin_inset Quotes erd
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15029 \begin_inset Quotes eld
15033 \begin_inset Quotes erd
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15046 is ignored and all paragraphs are separated by the
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15057 The vertical space is calculated with
15058 \begin_inset Flex Code
15061 \begin_layout Plain Layout
15063 \begin_inset space ~
15072 \begin_inset Flex Code
15075 \begin_layout Plain Layout
15081 is the height of a row with the normal font.
15082 This way, the look stays the same with different screen fonts.
15085 \begin_layout Description
15086 \begin_inset Flex Code
15089 \begin_layout Plain Layout
15096 \begin_inset Flex Code
15099 \begin_layout Plain Layout
15108 \begin_inset space \thinspace{}
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15121 ] Whether the contents of this paragraph should be output in raw form, meaning
15122 without special translations that \SpecialChar LaTeX
15126 \begin_layout Description
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15137 \begin_inset Flex Code
15140 \begin_layout Plain Layout
15150 Defines individual characters that should be output in raw form, meaning
15151 without special translations that \SpecialChar LaTeX
15155 \begin_layout Description
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15165 Information to be included in the \SpecialChar LaTeX
15166 preamble when this style is used.
15167 Used to define macros, load packages, etc., required by this particular
15170 \begin_inset Quotes eld
15174 \begin_inset Flex Code
15177 \begin_layout Plain Layout
15184 \begin_inset Quotes erd
15190 \begin_layout Description
15191 \begin_inset Flex Code
15194 \begin_layout Plain Layout
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15210 ] The prefix to use when creating labels referring to paragraphs of this
15212 This allows the use of formatted references.
15215 \begin_layout Description
15216 \begin_inset Flex Code
15219 \begin_layout Plain Layout
15226 \begin_inset Flex Code
15229 \begin_layout Plain Layout
15235 ] Whether the style requires the feature
15236 \begin_inset Flex Code
15239 \begin_layout Plain Layout
15246 \begin_inset CommandInset ref
15248 reference "chap:List-of-functions"
15252 for the list of features).
15253 If you require a package with specific options, you can additionally use
15255 \begin_inset Flex Code
15258 \begin_layout Plain Layout
15264 as a general text class parameter (see
15265 \begin_inset CommandInset ref
15267 reference "subsec:General-text-class"
15274 \begin_layout Description
15275 \begin_inset Flex Code
15278 \begin_layout Plain Layout
15285 \begin_inset Flex Code
15288 \begin_layout Plain Layout
15297 \begin_inset Flex Code
15300 \begin_layout Plain Layout
15306 ] Resets the \SpecialChar LaTeX
15307 arguments of this style (as defined via the
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15318 This is useful if you have copied a style via
15319 \begin_inset Flex Code
15322 \begin_layout Plain Layout
15328 , but you do not want to inherit its (required and optional) arguments.
15331 \begin_layout Description
15332 \begin_inset Flex Code
15335 \begin_layout Plain Layout
15342 \begin_inset Flex Code
15345 \begin_layout Plain Layout
15354 \begin_inset Flex Code
15357 \begin_layout Plain Layout
15363 ] Resumes a counter that is usually reset at each new sequence of layouts.
15364 This is currently only useful when
15365 \begin_inset Flex Code
15368 \begin_layout Plain Layout
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15387 \begin_layout Description
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15398 \begin_inset Flex Code
15401 \begin_layout Plain Layout
15407 ] A string that is put at the end of the layout content.
15408 A line break in the output can be indicated by
15409 \begin_inset Flex Code
15412 \begin_layout Plain Layout
15421 \begin_layout Description
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15432 \begin_inset Flex Code
15435 \begin_layout Plain Layout
15442 \begin_inset Flex Code
15445 \begin_layout Plain Layout
15454 \begin_layout Description
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15487 \begin_inset Flex Code
15490 \begin_layout Plain Layout
15497 \begin_inset Flex Code
15500 \begin_layout Plain Layout
15502 \begin_inset space ~
15510 ] This defines what the default spacing should be in the style.
15512 \begin_inset Flex Code
15515 \begin_layout Plain Layout
15522 \begin_inset Flex Code
15525 \begin_layout Plain Layout
15532 \begin_inset Flex Code
15535 \begin_layout Plain Layout
15541 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15542 If you specify the argument
15543 \begin_inset Flex Code
15546 \begin_layout Plain Layout
15552 , then you must also provide a value argument which will be the actual multiplie
15554 Note that, contrary to other parameters,
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15564 implies the generation of specific \SpecialChar LaTeX
15565 code, using the \SpecialChar LaTeX
15569 \begin_inset Flex Code
15572 \begin_layout Plain Layout
15581 \begin_layout Description
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15602 \begin_inset space \thinspace{}
15606 \begin_inset Flex Code
15609 \begin_layout Plain Layout
15617 ] Allow spell-checking paragraphs of this style.
15621 \begin_layout Description
15622 \begin_inset Flex Code
15625 \begin_layout Plain Layout
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15644 \begin_inset Flex Code
15647 \begin_layout Plain Layout
15653 ] Steps the master counter of a given counter at the beginning of a new
15654 sequence of layouts.
15655 This is currently only useful when
15656 \begin_inset Flex Code
15659 \begin_layout Plain Layout
15666 \begin_inset Flex Code
15669 \begin_layout Plain Layout
15678 \begin_layout Description
15679 \begin_inset Flex Code
15682 \begin_layout Plain Layout
15688 The font used for the text body .
15690 \begin_inset CommandInset ref
15692 reference "subsec:Font-description"
15699 \begin_layout Description
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15725 The level of the style in the table of contents.
15726 This is used for automatic numbering of section headings.
15729 \begin_layout Description
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15742 \begin_inset Flex Code
15745 \begin_layout Plain Layout
15756 \begin_inset Flex Code
15759 \begin_layout Plain Layout
15766 \begin_inset Flex Code
15769 \begin_layout Plain Layout
15775 ] This tag determines whether the first line indentation of this paragraph
15776 can be toggled via the Paragraph settings dialog.
15780 \begin_inset Flex Code
15783 \begin_layout Plain Layout
15793 is set, indentation can be toggled if the document settings use
15794 \begin_inset Quotes eld
15798 \begin_inset Quotes erd
15801 paragraph style, with
15802 \begin_inset Flex Code
15805 \begin_layout Plain Layout
15811 , indentation can always be toggled, notwithstanding the document settings,
15813 \begin_inset Flex Code
15816 \begin_layout Plain Layout
15822 , indentation can never be toggled.
15825 \begin_layout Description
15826 \begin_inset Flex Code
15829 \begin_layout Plain Layout
15836 \begin_inset Flex Code
15839 \begin_layout Plain Layout
15845 ] The vertical space with which the very first of a chain of paragraphs
15846 with this style is separated from the previous paragraph.
15847 If the previous paragraph has another style, the separations are not simply
15848 added, but the maximum is taken.
15851 \begin_layout Subsection
15852 \begin_inset CommandInset label
15858 Internationalization of Paragraph Styles
15861 \begin_layout Standard
15863 has long supported internationalization of layout information, but, until
15864 version 2.0, this applied only to the user interface and not to, say, PDF
15866 Thus, French authors were forced to resort to ugly hacks if they wanted
15871 1' instead of `Theorem 1'.
15872 Thanks to Georg Baum, that is no longer the case.
15875 \begin_layout Standard
15877 \begin_inset Flex Code
15880 \begin_layout Plain Layout
15886 defines text that is to appear in the typeset document, it may use
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15897 \begin_inset Flex Code
15900 \begin_layout Plain Layout
15906 to support non-English and even multi-language documents correctly.
15907 The following excerpt (from the
15908 \begin_inset Flex Code
15911 \begin_layout Plain Layout
15917 file) shows how this works:
15920 \begin_layout LyX-Code
15925 \begin_layout LyX-Code
15928 theoremstyle{remark}
15931 \begin_layout LyX-Code
15934 newtheorem{claim}[thm]{
15941 \begin_layout LyX-Code
15945 \begin_layout LyX-Code
15949 \begin_layout LyX-Code
15954 claimname}{_(Claim)}
15957 \begin_layout LyX-Code
15961 \begin_layout LyX-Code
15965 \begin_layout LyX-Code
15974 claimname}{_(Claim)}}
15977 \begin_layout LyX-Code
15982 \begin_layout Standard
15983 In principle, any legal \SpecialChar LaTeX
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15995 \begin_inset Flex Code
15998 \begin_layout Plain Layout
16004 tags, but in practice they will typically look as they do here.
16005 The key to correct translation of the typeset text is the definition of
16006 the \SpecialChar LaTeX
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16020 \begin_inset Flex Code
16023 \begin_layout Plain Layout
16035 \begin_layout Standard
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16046 tag provides for internationalization based upon the overall language of
16048 The contents of the tag will be included in the preamble, just as with
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16060 What makes it special is the use of the
16061 \begin_inset Quotes eld
16065 \begin_inset Quotes erd
16069 \begin_inset Flex Code
16072 \begin_layout Plain Layout
16078 , which will be replaced, when \SpecialChar LyX
16079 produces \SpecialChar LaTeX
16080 output, with the translation of
16081 its argument into the document language.
16084 \begin_layout Standard
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16095 tag is more complex, since it is meant to provide support for multi-language
16096 documents and so offers an interface to the
16097 \begin_inset Flex Code
16100 \begin_layout Plain Layout
16107 Its contents will be added to the preamble once for each language that
16108 appears in the document.
16109 In this case, the argument to
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16119 will be replaced with its translation into the language in question; the
16121 \begin_inset Flex Code
16124 \begin_layout Plain Layout
16130 is replaced by the language name (as used by the babel package).
16133 \begin_layout Standard
16134 A German document that also included a French section would thus have the
16135 following in the preamble:
16138 \begin_layout LyX-Code
16147 claimname}{Affirmation}}
16148 \begin_inset Newline newline
16159 claimname}{Behauptung}}
16160 \begin_inset Newline newline
16167 claimname}{Behauptung}
16170 \begin_layout Standard
16173 \begin_inset Flex Code
16176 \begin_layout Plain Layout
16182 will then conspire to produce the correct text in the output.
16185 \begin_layout Standard
16186 One important point to note here is that the translations are provided by
16188 itself, through the file
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16199 This means, in effect, that
16200 \begin_inset Flex Code
16203 \begin_layout Plain Layout
16210 \begin_inset Flex Code
16213 \begin_layout Plain Layout
16219 are really only of use in layout files that are provided with \SpecialChar LyX
16221 entered in user-created layout files will not be seen by \SpecialChar LyX
16222 's internationalizatio
16223 n routines unless the
16224 \begin_inset Flex Code
16227 \begin_layout Plain Layout
16233 file is modified accordingly.
16234 That said, however, any layout created with the intention that it will
16235 be included with \SpecialChar LyX
16236 should use these tags where appropriate.
16237 Please note that the paragraph style translations provided by \SpecialChar LyX
16239 change with a minor update (e.
16240 \begin_inset space \thinspace{}
16244 \begin_inset space \space{}
16247 from version 2.1.x to 2.1.y).
16248 It is however quite likely that a major update (e.
16249 \begin_inset space \thinspace{}
16253 \begin_inset space \space{}
16256 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16259 \begin_layout Subsection
16261 \begin_inset CommandInset label
16263 name "subsec:Floats"
16270 \begin_layout Standard
16271 It is necessary to define the floats (
16272 \begin_inset Flex Noun
16275 \begin_layout Plain Layout
16282 \begin_inset Flex Noun
16285 \begin_layout Plain Layout
16291 , \SpecialChar ldots
16292 ) in the text class itself.
16293 Standard floats are included in the file
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16303 , so you may have to do no more than add
16306 \begin_layout LyX-Code
16307 Input stdfloats.inc
16310 \begin_layout Standard
16311 to your layout file.
16312 If you want to implement a text class that proposes some other float types
16313 (like the AGU class bundled with \SpecialChar LyX
16314 ), the information below will hopefully
16318 \begin_layout Description
16319 \begin_inset Flex Code
16322 \begin_layout Plain Layout
16329 \begin_inset Flex Code
16332 \begin_layout Plain Layout
16338 =!htbpH] Allowed placement options for this float type.
16339 The value is a string of placement characters.
16340 Possible characters include:
16345 \begin_inset Quotes eld
16349 \begin_inset Quotes erd
16357 \begin_inset Quotes eld
16361 \begin_inset Quotes erd
16369 \begin_inset Quotes eld
16373 \begin_inset Quotes erd
16381 \begin_inset Quotes eld
16385 \begin_inset Quotes erd
16393 \begin_inset Quotes eld
16397 \begin_inset Quotes erd
16405 \begin_inset Quotes eld
16409 \begin_inset Quotes erd
16413 The order of the characters in the string does not matter.
16414 If no placement options are allowed, use the string
16421 \begin_layout Description
16422 \begin_inset Flex Code
16425 \begin_layout Plain Layout
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16444 \begin_inset space \thinspace{}
16450 \begin_inset Flex Code
16453 \begin_layout Plain Layout
16463 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16470 \begin_inset Flex Code
16473 \begin_layout Plain Layout
16479 if the float does not support this feature.
16482 \begin_layout Description
16483 \begin_inset Flex Code
16486 \begin_layout Plain Layout
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16505 \begin_inset space \thinspace{}
16511 \begin_inset Flex Code
16514 \begin_layout Plain Layout
16524 ] Defines whether the float has a starred variant that spans columns in
16525 a two column paragraph.
16527 \begin_inset Flex Code
16530 \begin_layout Plain Layout
16536 if the float does not support this feature.
16539 \begin_layout Description
16540 \begin_inset Flex Code
16543 \begin_layout Plain Layout
16550 \begin_inset Flex Code
16553 \begin_layout Plain Layout
16560 \begin_inset Quotes erd
16564 \begin_inset Quotes erd
16567 ] The file name extension of an auxiliary file for the list of figures (or
16570 writes the captions to this file.
16573 \begin_layout Description
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16594 \begin_inset Quotes erd
16598 \begin_inset Quotes erd
16601 ] The string that will be used in the menus and also for the caption.
16602 This is translated to the current language if babel is used.
16605 \begin_layout Description
16606 \begin_inset Flex Code
16609 \begin_layout Plain Layout
16615 These tags control the XHTML output.
16617 \begin_inset CommandInset ref
16619 reference "sec:Tags-for-XHTML"
16626 \begin_layout Description
16627 \begin_inset Flex Code
16630 \begin_layout Plain Layout
16639 \begin_inset Flex Code
16642 \begin_layout Plain Layout
16651 \begin_inset space \thinspace{}
16655 \begin_inset Flex Code
16658 \begin_layout Plain Layout
16664 ] Indicates whether the float is already defined in the document class or
16665 if instead the \SpecialChar LaTeX
16667 \begin_inset Flex Code
16670 \begin_layout Plain Layout
16676 needs to be loaded to define it on-the-fly.
16678 \begin_inset Flex Code
16681 \begin_layout Plain Layout
16688 \begin_inset Flex Code
16691 \begin_layout Plain Layout
16698 It should be set to
16699 \begin_inset Flex Code
16702 \begin_layout Plain Layout
16708 if the float is already defined by the \SpecialChar LaTeX
16712 \begin_layout Description
16713 \begin_inset Flex Code
16716 \begin_layout Plain Layout
16723 \begin_inset Flex Code
16726 \begin_layout Plain Layout
16733 \begin_inset Quotes erd
16737 \begin_inset Quotes erd
16740 ] The command used to generate a list of floats of this type; the leading
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16758 is false, since there is no standard way to generate this command.
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16769 is true, since in that case there is a standard way to define the command.
16772 \begin_layout Description
16773 \begin_inset Flex Code
16776 \begin_layout Plain Layout
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16793 \begin_inset Quotes erd
16797 \begin_inset Quotes erd
16800 ] A title for a list of floats of this kind (list of figures, tables, or
16802 It is used for the screen label within \SpecialChar LyX
16803 , it is used by \SpecialChar LaTeX
16805 it is used as the title in the XHTML output.
16806 It will be translated to the document language.
16809 \begin_layout Description
16810 \begin_inset Flex Code
16813 \begin_layout Plain Layout
16820 \begin_inset Flex Code
16823 \begin_layout Plain Layout
16830 \begin_inset Quotes erd
16834 \begin_inset Quotes erd
16837 ] This (optional) argument determines whether floats of this class will
16838 be numbered within some sectional unit of the document.
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 \begin_inset Quotes eld
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16864 \begin_inset Quotes erd
16867 , the floats will be numbered within chapters.
16871 \begin_layout Description
16872 \begin_inset Flex Code
16875 \begin_layout Plain Layout
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16892 \begin_inset Quotes erd
16896 \begin_inset Quotes erd
16899 ] The default placement for the given class of floats.
16900 The string should be as in standard \SpecialChar LaTeX
16902 \begin_inset Flex Code
16905 \begin_layout Plain Layout
16912 \begin_inset Flex Code
16915 \begin_layout Plain Layout
16922 \begin_inset Flex Code
16925 \begin_layout Plain Layout
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 for top, bottom, page, and here, respectively.
16945 \begin_layout Plain Layout
16946 Note that the order of these letters in the string is irrelevant, like in
16953 On top of that there is a new type,
16954 \begin_inset Flex Code
16957 \begin_layout Plain Layout
16963 , which does not really correspond to a float, since it means: put it
16964 \begin_inset Quotes eld
16968 \begin_inset Quotes erd
16972 Note however that the
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16982 specifier is special and, because of implementation details, cannot be
16983 used in non-built in float types.
16984 If you do not understand what this means, just use
16985 \begin_inset Quotes eld
16989 \begin_inset Flex Code
16992 \begin_layout Plain Layout
16999 \begin_inset Quotes erd
17005 \begin_layout Description
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17016 \begin_inset Flex Code
17019 \begin_layout Plain Layout
17025 ] The prefix to use when creating labels referring to floats of this type.
17026 This allows the use of formatted references.
17027 Note that you can remove any
17028 \begin_inset Flex Code
17031 \begin_layout Plain Layout
17037 set by a copied style by using the special value
17038 \begin_inset Quotes eld
17042 \begin_inset Quotes erd
17045 , which must be all caps.
17048 \begin_layout Description
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17069 \begin_inset Quotes erd
17073 \begin_inset Quotes erd
17076 ] The style used when defining the float using
17077 \begin_inset Flex Code
17080 \begin_layout Plain Layout
17091 \begin_layout Description
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17102 \begin_inset Flex Code
17105 \begin_layout Plain Layout
17112 \begin_inset Quotes erd
17116 \begin_inset Quotes erd
17120 \begin_inset Quotes eld
17124 \begin_inset Quotes erd
17127 of the new class of floats, like program or algorithm.
17128 After the appropriate
17129 \begin_inset Flex Code
17132 \begin_layout Plain Layout
17141 \begin_inset Flex Code
17144 \begin_layout Plain Layout
17153 \begin_inset Flex Code
17156 \begin_layout Plain Layout
17167 \begin_layout Description
17168 \begin_inset Flex Code
17171 \begin_layout Plain Layout
17178 \begin_inset Flex Code
17181 \begin_layout Plain Layout
17188 \begin_inset space \thinspace{}
17192 \begin_inset Flex Code
17195 \begin_layout Plain Layout
17203 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17205 \begin_inset Flex Code
17208 \begin_layout Plain Layout
17214 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17218 \begin_layout Standard
17219 Note that defining a float with type
17220 \begin_inset Flex Code
17223 \begin_layout Plain Layout
17231 automatically defines the corresponding counter with name
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17246 \begin_layout Subsection
17247 Flex insets and InsetLayout
17248 \begin_inset CommandInset label
17250 name "subsec:Flex-insets-and"
17257 \begin_layout Standard
17258 Flex insets come in three different kinds:
17261 \begin_layout Itemize
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17272 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17274 \begin_inset Flex Code
17277 \begin_layout Plain Layout
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17300 \begin_layout Itemize
17302 \begin_inset Flex Code
17305 \begin_layout Plain Layout
17311 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17313 footnote, and the like.
17314 An obvious example is an endnote inset, which is defined in the
17315 \begin_inset Flex Code
17318 \begin_layout Plain Layout
17327 \begin_layout Itemize
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17338 ): For use with DocBook classes.
17341 \begin_layout Standard
17342 Flex insets are defined using the
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17352 tag, which shall be explained in a moment.
17355 \begin_layout Standard
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17366 tag also serves another function: It can be used to customize the general
17367 layout of many different types of insets.
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17378 can be used to customize the layout parameters for footnotes, marginal
17379 notes, note insets, \SpecialChar TeX
17380 code (ERT) insets, branches, listings, indexes, boxes,
17381 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17384 \begin_layout Standard
17386 \begin_inset Flex Code
17389 \begin_layout Plain Layout
17395 definition must begin with a line of the form:
17398 \begin_layout LyX-Code
17402 \begin_layout Standard
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17413 indicates the inset whose layout is being defined, and here there are four
17417 \begin_layout Enumerate
17418 The layout for a pre-existing inset is being modified.
17419 In this case, can be
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17429 any one of the following:
17430 \begin_inset Flex Code
17433 \begin_layout Plain Layout
17440 \begin_inset Flex Code
17443 \begin_layout Plain Layout
17450 \begin_inset Flex Code
17453 \begin_layout Plain Layout
17460 \begin_inset Flex Code
17463 \begin_layout Plain Layout
17470 \begin_inset Flex Code
17473 \begin_layout Plain Layout
17480 \begin_inset Flex Code
17483 \begin_layout Plain Layout
17490 \begin_inset Flex Code
17493 \begin_layout Plain Layout
17500 \begin_inset Flex Code
17503 \begin_layout Plain Layout
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17520 \begin_inset Flex Code
17523 \begin_layout Plain Layout
17530 \begin_inset Flex Code
17533 \begin_layout Plain Layout
17540 \begin_inset Flex Code
17543 \begin_layout Plain Layout
17550 \begin_inset Flex Code
17553 \begin_layout Plain Layout
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17570 \begin_inset Flex Code
17573 \begin_layout Plain Layout
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17632 \begin_layout Enumerate
17633 The layout for a Flex inset is being defined.
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17644 must be of the form
17645 \begin_inset Quotes eld
17649 \begin_inset Flex Code
17652 \begin_layout Plain Layout
17659 \begin_inset Quotes erd
17663 \begin_inset Flex Code
17666 \begin_layout Plain Layout
17672 may be be any valid identifier not used by a pre-existing Flex inset.
17673 The identifier may include spaces, but in that case the whole thing must
17674 be wrapped in quotes.
17675 Note that the definition of a flex inset
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17689 entry, declaring which type of inset it defines.
17692 \begin_layout Enumerate
17693 The layout for user specific branch is being defined.
17695 \begin_inset Flex Code
17698 \begin_layout Plain Layout
17704 must be of the form
17705 \begin_inset Quotes eld
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17719 \begin_inset Quotes erd
17723 \begin_inset Flex Code
17726 \begin_layout Plain Layout
17732 may be be any valid identifier of branch defined in user's document.
17733 The identifier may include spaces, but in that case the whole thing must
17734 be wrapped in quotes.
17735 The main purpose of this feature is to allow \SpecialChar LaTeX
17736 wrapping around specific
17737 branches as user needs.
17740 \begin_layout Enumerate
17741 The layout of a user (or class) specific caption is being defined.
17743 \begin_inset Flex Code
17746 \begin_layout Plain Layout
17752 must be of the form
17753 \begin_inset Quotes eld
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17767 \begin_inset Quotes erd
17771 \begin_inset Flex Code
17774 \begin_layout Plain Layout
17780 specifies the name of the caption as it appears in the menu.
17781 Have a look at the standard caption (
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17791 ), the specific captions of the KOMA-Script classes (
17792 \begin_inset Flex Code
17795 \begin_layout Plain Layout
17802 \begin_inset Flex Code
17805 \begin_layout Plain Layout
17814 \begin_inset space ~
17820 \begin_inset Flex Code
17823 \begin_layout Plain Layout
17829 ) for applications.
17832 \begin_layout Standard
17834 \begin_inset Flex Code
17837 \begin_layout Plain Layout
17843 definition can contain the following entries:
17846 \begin_layout Description
17847 \begin_inset Flex Code
17850 \begin_layout Plain Layout
17857 \begin_inset Flex Code
17860 \begin_layout Plain Layout
17866 =""] This inset will appear in the table of contents of the given type.
17867 An empty string disables.
17868 See also the OutlinerName and the IsTocCaption commands.
17869 This is only implemented for Flex insets.
17873 \begin_layout Description
17874 \begin_inset Flex Code
17877 \begin_layout Plain Layout
17884 \begin_inset Flex Code
17887 \begin_layout Plain Layout
17893 ] Defines argument number of a command\SpecialChar breakableslash
17894 environment associated with the current
17896 The definition must end with
17897 \begin_inset Flex Code
17900 \begin_layout Plain Layout
17908 \begin_inset CommandInset ref
17910 reference "subsec:Paragraph-Styles"
17917 \begin_layout Description
17918 \begin_inset Flex Code
17921 \begin_layout Plain Layout
17927 Preamble for changing language commands; see
17928 \begin_inset CommandInset ref
17930 reference "subsec:I18n"
17937 \begin_layout Description
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17948 \begin_inset Flex Code
17951 \begin_layout Plain Layout
17957 ] The color for the inset's background.
17959 \begin_inset CommandInset ref
17961 reference "chap:Names-of-colors"
17965 for a list of the available color names.
17968 \begin_layout Description
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17991 \begin_inset space \thinspace{}
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18004 ] Whether to use the content of the inset as the label, when the inset is
18009 \begin_layout Description
18010 \begin_inset Flex Code
18013 \begin_layout Plain Layout
18020 \begin_inset Flex Code
18023 \begin_layout Plain Layout
18029 ] As with paragraph styles, see
18030 \begin_inset CommandInset ref
18032 reference "subsec:Paragraph-Styles"
18037 Note that you need to specify the complete type, e.
18038 \begin_inset space \thinspace{}
18042 \begin_inset space ~
18046 \begin_inset Flex Code
18049 \begin_layout Plain Layout
18050 CopyStyle Flex:<name>
18058 \begin_layout Description
18059 \begin_inset Flex Code
18062 \begin_layout Plain Layout
18069 \begin_inset Flex Code
18072 \begin_layout Plain Layout
18081 \begin_inset space \thinspace{}
18085 \begin_inset Flex Code
18088 \begin_layout Plain Layout
18094 ] Indicates whether the user may employ the Paragraph Settings dialog to
18095 customize the paragraph.
18098 \begin_layout Description
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18109 \begin_inset Flex Code
18112 \begin_layout Plain Layout
18119 \begin_inset Flex Code
18122 \begin_layout Plain Layout
18129 \begin_inset Flex Code
18132 \begin_layout Plain Layout
18138 , describing the rendering style used for the inset's frame and buttons.
18139 Footnotes generally use
18140 \begin_inset Flex Code
18143 \begin_layout Plain Layout
18149 , ERT insets generally
18150 \begin_inset Flex Code
18153 \begin_layout Plain Layout
18159 , and character styles
18160 \begin_inset Flex Code
18163 \begin_layout Plain Layout
18172 \begin_layout Description
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18195 \begin_inset space \thinspace{}
18201 \begin_inset Flex Code
18204 \begin_layout Plain Layout
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18233 Indicates whether the environment will stand on its own in the output or
18234 will appear inline with the surrounding text.
18235 If set to false, it is supposed that the \SpecialChar LaTeX
18236 environment ignores white space
18237 (including one newline character) after the
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18254 \begin_inset Flex Code
18257 \begin_layout Plain Layout
18273 \begin_layout Description
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18283 Required at the end of the
18284 \begin_inset Flex Code
18287 \begin_layout Plain Layout
18296 \begin_layout Description
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 The font used for both the text body
18312 \begin_inset CommandInset ref
18314 reference "subsec:Font-description"
18319 Note that defining this font automatically defines the
18320 \begin_inset Flex Code
18323 \begin_layout Plain Layout
18329 to the same value, so define this first and define
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18339 later if you want them to be different.
18342 \begin_layout Description
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18347 FixedWidthPreambleEncoding
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18365 \begin_inset space \thinspace{}
18369 \begin_inset Flex Code
18372 \begin_layout Plain Layout
18378 ] Force a fixed width encoding for the translated contents of
18379 \begin_inset Flex Code
18382 \begin_layout Plain Layout
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18398 code generated by this layout.
18399 This is needed for special \SpecialChar LaTeX
18404 that do not work with variable width encodings such as
18409 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18410 backends such as Xe\SpecialChar TeX
18412 Lua\SpecialChar TeX
18416 \begin_layout Description
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18421 ForceLocalFontSwitch
18427 \begin_inset Flex Code
18430 \begin_layout Plain Layout
18439 \begin_inset space \thinspace{}
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18452 ] When using babel, always use a local font switch (
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18464 ), never a global one (such as
18465 \begin_inset Flex Code
18468 \begin_layout Plain Layout
18479 \begin_layout Description
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18502 \begin_inset space \thinspace{}
18506 \begin_inset Flex Code
18509 \begin_layout Plain Layout
18516 \begin_inset Quotes eld
18520 \begin_inset Quotes erd
18523 language, leading to Left-to-Right (Latin) output, e.
18524 \begin_inset space \thinspace{}
18528 \begin_inset space \space{}
18531 in \SpecialChar TeX
18536 \begin_layout Description
18537 \begin_inset Flex Code
18540 \begin_layout Plain Layout
18547 \begin_inset Flex Code
18550 \begin_layout Plain Layout
18559 \begin_inset space \thinspace{}
18563 \begin_inset Flex Code
18566 \begin_layout Plain Layout
18572 ] Force a a line break in the \SpecialChar LaTeX
18573 output before the inset starts and after
18575 This assures the inset itself is output on its own lines, for parsing purposes.
18578 \begin_layout Description
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18601 \begin_inset space \thinspace{}
18605 \begin_inset Flex Code
18608 \begin_layout Plain Layout
18614 ] Indicates whether the
18615 \begin_inset Flex Code
18618 \begin_layout Plain Layout
18624 should be used or, instead, the user can change the paragraph style used
18629 \begin_layout Description
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18652 \begin_inset space \thinspace{}
18656 \begin_inset Flex Code
18659 \begin_layout Plain Layout
18665 ] As with paragraph styles, see
18666 \begin_inset CommandInset ref
18668 reference "subsec:Paragraph-Styles"
18675 \begin_layout Description
18676 \begin_inset Flex Code
18679 \begin_layout Plain Layout
18685 These tags control the XHTML output.
18687 \begin_inset CommandInset ref
18689 reference "sec:Tags-for-XHTML"
18696 \begin_layout Description
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18719 \begin_inset space \thinspace{}
18723 \begin_inset Flex Code
18726 \begin_layout Plain Layout
18732 ] Whether to include the contents of this inset in the strings generated
18733 for the `Outline' pane for all table of contents, regardless of the AddToToc
18735 One would not, for example, want the content of a footnote in a section
18736 header to be included in the TOC displayed in the outline, but one would
18737 normally want the content of a character style displayed.
18738 Default is false: not to include.
18741 \begin_layout Description
18742 \begin_inset Flex Code
18745 \begin_layout Plain Layout
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18764 \begin_inset space \thinspace{}
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18777 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18778 of its contents in its item in the table of contents.
18779 Otherwise, only the label appears.
18782 \begin_layout Description
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18795 \begin_inset Flex Code
18798 \begin_layout Plain Layout
18807 \begin_inset space \thinspace{}
18811 \begin_inset Flex Code
18814 \begin_layout Plain Layout
18820 ] As with paragraph styles, see
18821 \begin_inset CommandInset ref
18823 reference "subsec:Paragraph-Styles"
18830 \begin_layout Description
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18840 The font used for the label.
18842 \begin_inset CommandInset ref
18844 reference "subsec:Font-description"
18849 Note that this definition can never appear before
18850 \begin_inset Flex Code
18853 \begin_layout Plain Layout
18859 , lest it be ineffective.
18862 \begin_layout Description
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18883 \begin_inset Quotes erd
18887 \begin_inset Quotes erd
18890 ] What will be displayed on the button or elsewhere as the inset label.
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18912 ) modify this label on the fly.
18915 \begin_layout Description
18916 \begin_inset Flex Code
18919 \begin_layout Plain Layout
18925 Language dependent preamble; see
18926 \begin_inset CommandInset ref
18928 reference "subsec:I18n"
18935 \begin_layout Description
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18955 ] The name of the corresponding \SpecialChar LaTeX
18957 Either the environment or command name.
18960 \begin_layout Description
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18971 \begin_inset Flex Code
18974 \begin_layout Plain Layout
18980 ] The optional parameter for the corresponding
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18990 stuff, including possible bracket pairs like
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19001 This parameter cannot be changed from within \SpecialChar LyX
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19012 for customizable parameters).
19013 It will be output as is after all \SpecialChar LaTeX
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19027 \begin_layout Description
19028 \begin_inset Flex Code
19031 \begin_layout Plain Layout
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19042 Command, Environment, None
19047 ] How the style should be translated into \SpecialChar LaTeX
19052 \begin_layout Plain Layout
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19062 is perhaps a bit misleading, since these rules apply to SGML classes too.
19063 Visit the SGML class files for specific examples.
19072 \begin_layout Description
19073 \begin_inset Flex Code
19076 \begin_layout Plain Layout
19082 means nothing special
19085 \begin_layout Description
19086 \begin_inset Flex Code
19089 \begin_layout Plain Layout
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19106 {\SpecialChar ldots
19115 \begin_layout Description
19116 \begin_inset Flex Code
19119 \begin_layout Plain Layout
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19136 }\SpecialChar ldots
19151 \begin_layout Standard
19152 Putting the last few things together, the \SpecialChar LaTeX
19153 output will be either:
19156 \begin_layout LyX-Code
19159 LatexName[LatexParam]{\SpecialChar ldots
19163 \begin_layout Standard
19167 \begin_layout LyX-Code
19170 begin{LatexName}[LatexParam] \SpecialChar ldots
19176 \begin_layout Standard
19177 depending upon the \SpecialChar LaTeX
19182 \begin_layout Description
19183 \begin_inset Flex Code
19186 \begin_layout Plain Layout
19193 \begin_inset Flex Code
19196 \begin_layout Plain Layout
19202 ] A string that is put at the beginning of the layout content.
19203 A line break in the output can be indicated by
19204 \begin_inset Flex Code
19207 \begin_layout Plain Layout
19216 \begin_layout Description
19217 \begin_inset Flex Code
19220 \begin_layout Plain Layout
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19237 \begin_inset Flex Code
19240 \begin_layout Plain Layout
19247 \begin_inset Flex Code
19250 \begin_layout Plain Layout
19257 \begin_inset Flex Code
19260 \begin_layout Plain Layout
19266 (indicating a dummy definition ending definitions of charstyles, etc).
19267 This entry is required in and is only meaningful for Flex insets.
19268 Among other things, it determines on which menu this inset will appear.
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 will automatically set
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19300 \begin_inset Flex Code
19303 \begin_layout Plain Layout
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19320 can be set to true, or
19321 \begin_inset Flex Code
19324 \begin_layout Plain Layout
19331 \begin_inset Flex Code
19334 \begin_layout Plain Layout
19340 insets by setting it
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19357 \begin_layout Description
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19380 \begin_inset space \thinspace{}
19384 \begin_inset Flex Code
19387 \begin_layout Plain Layout
19393 ] Whether multiple paragraphs are permitted in this inset.
19395 \begin_inset Flex Code
19398 \begin_layout Plain Layout
19404 to the same value and
19405 \begin_inset Flex Code
19408 \begin_layout Plain Layout
19414 to the opposite value.
19415 These can be reset to other values, if they are used
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19433 \begin_layout Description
19434 \begin_inset Flex Code
19437 \begin_layout Plain Layout
19444 \begin_inset Flex Code
19447 \begin_layout Plain Layout
19456 \begin_inset space \thinspace{}
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19469 ] Whether fragile commands in this inset should be
19470 \begin_inset Flex Code
19473 \begin_layout Plain Layout
19486 whether the command should itself be protected.) Default is false.
19489 \begin_layout Description
19490 \begin_inset Flex Code
19493 \begin_layout Plain Layout
19500 \begin_inset Flex Code
19503 \begin_layout Plain Layout
19509 ] Deletes an existing
19510 \begin_inset Flex Code
19513 \begin_layout Plain Layout
19522 \begin_layout Description
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19552 that has replaced this
19553 \begin_inset Flex Code
19556 \begin_layout Plain Layout
19563 This is used to rename an
19564 \begin_inset Flex Code
19567 \begin_layout Plain Layout
19573 , while keeping backward compatibility.
19576 \begin_layout Description
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19587 \begin_inset Flex Code
19590 \begin_layout Plain Layout
19599 \begin_inset space \thinspace{}
19603 \begin_inset Flex Code
19606 \begin_layout Plain Layout
19612 ] As with paragraph styles, see
19613 \begin_inset CommandInset ref
19615 reference "subsec:Paragraph-Styles"
19623 \begin_layout Description
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19646 \begin_inset space \thinspace{}
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19659 ] As with paragraph styles, see
19660 \begin_inset CommandInset ref
19662 reference "subsec:Paragraph-Styles"
19670 \begin_layout Description
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19680 As with paragraph styles, see
19681 \begin_inset CommandInset ref
19683 reference "subsec:Paragraph-Styles"
19690 \begin_layout Description
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19710 ] The prefix to use when creating labels referring to insets of this type.
19711 This allows the use of formatted references.
19714 \begin_layout Description
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19734 ] As with paragraph styles, see
19735 \begin_inset CommandInset ref
19737 reference "subsec:Paragraph-Styles"
19744 \begin_layout Description
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19767 \begin_inset space \thinspace{}
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19780 ] Resets the \SpecialChar LaTeX
19781 arguments of this layout (as defined via the
19782 \begin_inset Flex Code
19785 \begin_layout Plain Layout
19792 This is useful if you have copied a style via
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19802 , but you do not want to inherit its (required and optional) arguments.
19805 \begin_layout Description
19806 \begin_inset Flex Code
19809 \begin_layout Plain Layout
19816 \begin_inset Flex Code
19819 \begin_layout Plain Layout
19826 \begin_inset space \thinspace{}
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19841 ] Whether this inset should use the font of its surrounding environment
19843 Default is false: use the font of the surrounding environment.
19846 \begin_layout Description
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19866 ] A string that is put at the end of the layout content.
19867 A line break in the output can be indicated by
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19880 \begin_layout Description
19881 \begin_inset Flex Code
19884 \begin_layout Plain Layout
19891 \begin_inset Flex Code
19894 \begin_layout Plain Layout
19901 \begin_inset space \thinspace{}
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19916 ] Allow spell-checking the contents of this inset.
19920 \begin_layout Subsection
19922 \begin_inset CommandInset label
19924 name "subsec:Counters"
19931 \begin_layout Standard
19932 It is necessary to define the counters (
19933 \begin_inset Flex Noun
19936 \begin_layout Plain Layout
19943 \begin_inset Flex Noun
19946 \begin_layout Plain Layout
19952 , \SpecialChar ldots
19953 ) in the text class itself.
19954 The standard counters are defined in the file
19955 \begin_inset Flex Code
19958 \begin_layout Plain Layout
19964 , so you may have to do no more than add
19967 \begin_layout LyX-Code
19968 Input stdcounters.inc
19971 \begin_layout Standard
19972 to your layout file to get them to work.
19973 But if you want to define custom counters, then you can do so.
19974 The counter declaration must begin with:
19977 \begin_layout LyX-Code
19978 Counter CounterName
19981 \begin_layout Standard
19983 \begin_inset Flex Code
19986 \begin_layout Plain Layout
19992 ' is replaced by the name of the counter.
19993 And it must end with
19994 \begin_inset Quotes eld
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20008 \begin_inset Quotes erd
20012 The following parameters can also be used:
20015 \begin_layout Description
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20035 ] Sets the initial value for the counter, to which it will be reset whenever
20037 Normally, one will want the default, 1.
20040 \begin_layout Description
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20061 \begin_inset Quotes erd
20065 \begin_inset Quotes erd
20068 ] When defined, this string defines how the counter is displayed.
20069 Setting this value sets
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20074 LabelStringAppendix
20080 The following special constructs can be used in the string:
20084 \begin_layout Itemize
20085 \begin_inset Flex Code
20088 \begin_layout Plain Layout
20096 will be replaced by the expansion of the
20097 \begin_inset Flex Code
20100 \begin_layout Plain Layout
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20111 LabelStringAppendix
20117 \begin_inset Flex Code
20120 \begin_layout Plain Layout
20130 \begin_layout Itemize
20131 counter values can be expressed using \SpecialChar LaTeX
20133 \begin_inset Newline newline
20137 \begin_inset Flex Code
20140 \begin_layout Plain Layout
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20172 \begin_layout Plain Layout
20182 Actually, the situation is a bit more complicated: any
20201 other than those described below will produce arabic numerals.
20202 It would not be surprising to see this change in the future.
20208 \begin_inset Flex Code
20211 \begin_layout Plain Layout
20217 : 1, 2, 3,\SpecialChar ldots
20219 \begin_inset Flex Code
20222 \begin_layout Plain Layout
20228 for lower-case letters: a, b, c, \SpecialChar ldots
20230 \begin_inset Flex Code
20233 \begin_layout Plain Layout
20239 for upper-case letters: A, B, C, \SpecialChar ldots
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20252 \begin_inset Flex Code
20255 \begin_layout Plain Layout
20261 for upper-case roman numerals: I, II, III\SpecialChar ldots
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20272 for hebrew numerals.
20276 \begin_layout Standard
20277 If LabelString is not defined, a default value is constructed as follows:
20278 if the counter has a master counter
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20299 \begin_inset Newline newline
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20316 is used; otherwise the string
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20331 \begin_layout Description
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20336 LabelStringAppendix
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20352 \begin_inset Quotes erd
20356 \begin_inset Quotes erd
20360 \begin_inset Flex Code
20363 \begin_layout Plain Layout
20369 , but for use in the Appendix.
20372 \begin_layout Description
20373 \begin_inset Flex Code
20376 \begin_layout Plain Layout
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20393 \begin_inset Quotes erd
20397 \begin_inset Quotes erd
20400 ] A format for use with formatted references to this counter.
20401 For example, one might want to have references to section numbers appear
20403 \begin_inset Quotes eld
20407 \begin_inset Quotes erd
20411 The string should contain
20412 \begin_inset Quotes eld
20416 \begin_inset Quotes erd
20420 This will be replaced by the counter number itself.
20421 So, for sections, it would be: Section ##.
20424 \begin_layout Description
20425 \begin_inset Flex Code
20428 \begin_layout Plain Layout
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20445 \begin_inset Quotes erd
20449 \begin_inset Quotes erd
20452 ] If this is set to the name of another counter, the present counter will
20453 be reset every time the other one is increased.
20455 \begin_inset Flex Code
20458 \begin_layout Plain Layout
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20477 \begin_layout Subsection
20479 \begin_inset CommandInset label
20481 name "subsec:Font-description"
20488 \begin_layout Standard
20489 A font description looks like this:
20492 \begin_layout LyX-Code
20509 \begin_layout LyX-Code
20513 \begin_layout LyX-Code
20517 \begin_layout Standard
20518 The following commands are available:
20521 \begin_layout Description
20522 \begin_inset Flex Code
20525 \begin_layout Plain Layout
20532 \begin_inset Flex Code
20535 \begin_layout Plain Layout
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20574 \begin_inset Flex Code
20577 \begin_layout Plain Layout
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20604 \begin_inset Flex Code
20607 \begin_layout Plain Layout
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20624 \begin_inset Flex Code
20627 \begin_layout Plain Layout
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20644 \begin_inset Flex Code
20647 \begin_layout Plain Layout
20654 \begin_inset Flex Code
20657 \begin_layout Plain Layout
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20674 \begin_inset Flex Code
20677 \begin_layout Plain Layout
20684 \begin_inset Flex Code
20687 \begin_layout Plain Layout
20694 \begin_inset Flex Code
20697 \begin_layout Plain Layout
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20724 \begin_inset Flex Code
20727 \begin_layout Plain Layout
20736 \begin_layout Description
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20759 \begin_inset Flex Code
20762 \begin_layout Plain Layout
20769 \begin_inset Flex Code
20772 \begin_layout Plain Layout
20781 \begin_layout Description
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20801 ] Valid arguments are:
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20812 \begin_inset Flex Code
20815 \begin_layout Plain Layout
20822 \begin_inset Flex Code
20825 \begin_layout Plain Layout
20832 \begin_inset Flex Code
20835 \begin_layout Plain Layout
20842 \begin_inset Flex Code
20845 \begin_layout Plain Layout
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20882 \begin_inset Flex Code
20885 \begin_layout Plain Layout
20892 \begin_inset Flex Code
20895 \begin_layout Plain Layout
20902 \begin_inset Flex Code
20905 \begin_layout Plain Layout
20912 \begin_inset Flex Code
20915 \begin_layout Plain Layout
20922 Each of these turns on or off the corresponding attribute.
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
20933 turns on emphasis, and
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20945 \begin_inset Newline newline
20948 If the latter seems puzzling, remember that the font settings for the present
20949 context are generally inherited from the surrounding context.
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20960 would turn off the emphasis that was anyway in effect, say, in a theorem
20964 \begin_layout Description
20965 \begin_inset Flex Code
20968 \begin_layout Plain Layout
20975 \begin_inset Flex Code
20978 \begin_layout Plain Layout
20987 \begin_inset Flex Code
20990 \begin_layout Plain Layout
20999 \begin_layout Description
21000 \begin_inset Flex Code
21003 \begin_layout Plain Layout
21010 \begin_inset Flex Code
21013 \begin_layout Plain Layout
21022 \begin_inset Flex Code
21025 \begin_layout Plain Layout
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21054 \begin_layout Description
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21085 \begin_inset Flex Code
21088 \begin_layout Plain Layout
21097 \begin_inset Flex Code
21100 \begin_layout Plain Layout
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21117 \begin_inset Flex Code
21120 \begin_layout Plain Layout
21127 \begin_inset Flex Code
21130 \begin_layout Plain Layout
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21149 \begin_layout Subsection
21150 \begin_inset CommandInset label
21152 name "subsec:Citation-engine-description"
21156 Cite engine description
21159 \begin_layout Standard
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21170 blocks, as used mainly in cite engine files (see
21171 \begin_inset CommandInset ref
21173 reference "subsec:Cite-Engine-Files"
21180 ), define the citation commands provided by a specific
21181 \begin_inset Quotes eld
21185 \begin_inset Quotes erd
21189 A cite engine, in \SpecialChar LyX
21190 terms, is way specific way to format citations, using
21191 numbers, author names and/or years.
21192 Currently, \SpecialChar LyX
21193 supports three such engine types, namely:
21196 \begin_layout Enumerate
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21206 : the default Bib\SpecialChar TeX
21207 way to format citations, a simple numeric style (e.
21208 \begin_inset space \thinspace{}
21212 \begin_inset Quotes eld
21216 \begin_inset Quotes erd
21222 \begin_layout Enumerate
21223 \begin_inset Flex Code
21226 \begin_layout Plain Layout
21232 : Harvard-styled citations using author names and publication year (e.
21233 \begin_inset space \thinspace{}
21237 \begin_inset Quotes eld
21240 Smith and Miller (2017b)
21241 \begin_inset Quotes erd
21247 \begin_layout Enumerate
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 : extended numerical citations that also allow for author or title next
21259 \begin_inset space \thinspace{}
21263 \begin_inset Quotes eld
21266 Smith and Miller [1]
21267 \begin_inset Quotes erd
21273 \begin_layout Standard
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21283 blocks look like this:
21286 \begin_layout LyX-Code
21290 \begin_layout LyX-Code
21294 \begin_layout LyX-Code
21298 \begin_layout LyX-Code
21299 citeyearpar[][]=parencite*
21302 \begin_layout LyX-Code
21306 \begin_layout LyX-Code
21310 \begin_layout Standard
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21321 denotes the engine.
21322 The individual lines respectively define a cite command or cite command
21323 paradigm supported by this engine.
21324 The line can be as simple as a cite command that is used both to name the
21325 respective \SpecialChar LyX
21326 command and the \SpecialChar LaTeX
21327 output or more complex in order to differentiate
21329 The full syntax is:
21332 \begin_layout LyX-Code
21333 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21336 \begin_layout Itemize
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21346 : The name as used in the
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21360 \begin_layout Standard
21361 For portability reasons, we try to use the same name for same-formatted
21362 commands in different cite packages (thus many names stem from natbib,
21363 and thus we need to differentiate a
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21373 sometimes, if the \SpecialChar LaTeX
21374 command names differ).
21378 \begin_layout Itemize
21379 \begin_inset Flex Code
21382 \begin_layout Plain Layout
21388 : a (comma-separated) list of commands that fall back to the given
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21398 in the current engine.
21399 This eases the switch of citation packages and engines.
21401 \begin_inset Flex Code
21404 \begin_layout Plain Layout
21411 \begin_inset Flex Code
21414 \begin_layout Plain Layout
21420 in layout definitions.
21423 \begin_layout Itemize
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21433 : The actual \SpecialChar LaTeX
21434 command that is output.
21438 \begin_layout Standard
21439 \begin_inset Flex Code
21442 \begin_layout Plain Layout
21449 \begin_inset Flex Code
21452 \begin_layout Plain Layout
21460 \begin_inset Flex Code
21463 \begin_layout Plain Layout
21470 \begin_inset Flex Code
21473 \begin_layout Plain Layout
21479 will be output to \SpecialChar LaTeX
21483 \begin_layout Standard
21487 \begin_layout Itemize
21488 Capitalization indicates that the command also has a capitalized form (
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21514 These usually enforce up-casing of name prefixes (
21519 \begin_inset Formula $\Rightarrow$
21529 \begin_layout Itemize
21531 \begin_inset Flex Code
21534 \begin_layout Plain Layout
21540 indicate the number of optional arguments (there can be 0–2).
21543 \begin_layout Itemize
21545 \begin_inset Flex Code
21548 \begin_layout Plain Layout
21554 indicates there is a starred version of the command (
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21584 \begin_layout Standard
21585 By default, the starred version means: Output all authors even if it should
21587 \begin_inset Quotes eld
21591 \begin_inset Quotes erd
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21607 \begin_layout Standard
21608 If the star has a different meaning for a given command, it can be specified
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21614 <!_stardesc!_stardesctooltip>
21620 Maximal two translatable macro keywords, marked by the prefix
21621 \begin_inset Flex Code
21624 \begin_layout Plain Layout
21631 The first points to the string that replaces the
21632 \begin_inset Quotes eld
21636 \begin_inset Quotes erd
21639 checkbox label in the citation dialog, the second one to an optional tool
21640 tip for this checkbox.
21644 \begin_layout Standard
21645 Note that these two macros have to be defined in a
21646 \begin_inset Flex Code
21649 \begin_layout Plain Layout
21655 (see next section), dropping the
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21665 from the prefix, like this:
21668 \begin_layout LyX-Code
21669 _stardesc Sta&rred command label
21672 \begin_layout LyX-Code
21673 _stardesctooltip Tooltip for the starred command checkbox.
21677 \begin_layout Itemize
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21688 indicates that this command features
21689 \begin_inset Quotes eld
21692 qualified citation lists
21693 \begin_inset Quotes erd
21701 -specific feature for multi-reference citations where an individual pre-
21702 and postnote can be given to each reference in the list.
21703 Please refer to the
21707 manual for details.
21710 \begin_layout Subsection
21711 \begin_inset CommandInset label
21713 name "subsec:Citation-format-description"
21717 Cite format description
21720 \begin_layout Standard
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21731 blocks are used to describe how bibliographic information should be displayed,
21732 both within \SpecialChar LyX
21733 itself (in the citation dialog and in tooltips, for example)
21734 and in XHTML output.
21735 Such a block might look like this:
21738 \begin_layout LyX-Code
21742 \begin_layout LyX-Code
21746 \begin_layout LyX-Code
21750 \begin_layout LyX-Code
21754 \begin_layout Standard
21758 \begin_layout LyX-Code
21762 \begin_layout LyX-Code
21766 \begin_layout LyX-Code
21770 \begin_layout LyX-Code
21774 \begin_layout Standard
21775 In the first case, the individual lines define how the bibliographic information
21776 associated with an article or book, respectively, is to be displayed, and
21777 such a definition can be given for any
21778 \begin_inset Quotes els
21782 \begin_inset Quotes ers
21785 that might be present in a Bib\SpecialChar TeX
21788 defines a default format in the source code that will be used if no specific
21789 definition has been given.
21791 predefines several formats in the file
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21801 , which is included in most of \SpecialChar LyX
21802 's document classes.
21805 \begin_layout Standard
21806 In the second case, the lines define how a specific citation command (in
21808 \begin_inset Flex Code
21811 \begin_layout Plain Layout
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21831 ) is to be displayed on the citation inset label, in the citation dialog,
21832 menu or XHTML output.
21834 defines such formats for the citation style variants it supports via
21836 Document\SpecialChar menuseparator
21837 Setting\SpecialChar menuseparator
21838 Bibliography\SpecialChar ldots
21842 \begin_inset Flex Code
21845 \begin_layout Plain Layout
21851 files that are shipped with \SpecialChar LyX
21853 \begin_inset CommandInset ref
21855 reference "subsec:Cite-Engine-Files"
21865 \begin_layout Standard
21866 The definitions use a simple language that allows Bib\SpecialChar TeX
21867 keys to be replaced
21869 Keys should be enclosed in
21870 \begin_inset Flex Code
21873 \begin_layout Plain Layout
21880 \begin_inset Flex Code
21883 \begin_layout Plain Layout
21890 So a simple definition might look like this:
21893 \begin_layout LyX-Code
21895 \begin_inset Quotes eld
21899 \begin_inset Quotes erd
21905 \begin_layout Standard
21906 This would print the author, followed by a comma, followed by the title,
21907 in quotes, followed by a period.
21910 \begin_layout Standard
21911 Of course, sometimes you may want to print a key only if it exists.
21912 This can be done by using a conditional construction, such as:
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21918 \begin_inset space ~
21928 \begin_inset Flex Code
21931 \begin_layout Plain Layout
21937 key exists, then print
21938 \begin_inset Quotes eld
21942 \begin_inset space ~
21946 \begin_inset Quotes erd
21949 followed by the volume key.
21950 It is also possible to have an else clause in the conditional, such as:
21951 \begin_inset Newline newline
21955 \begin_inset Flex Code
21958 \begin_layout Plain Layout
21959 {%author%[[%author%]][[%editor%, ed.]]}
21965 \begin_inset Newline newline
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21978 key is printed if it exists; otherwise, the editor key is printed, followed
21980 \begin_inset Quotes eld
21984 \begin_inset space ~
21988 \begin_inset Quotes erd
21991 Note that the key is again enclosed in
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 signs; the entire conditional is enclosed in braces; and the if and else
22002 clauses are enclosed in double brackets,
22003 \begin_inset Quotes eld
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22017 \begin_inset Quotes eld
22021 \begin_inset Quotes eld
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22035 \begin_inset Quotes erd
22039 There must be no space between any of these.
22042 \begin_layout Standard
22043 Next to the entry keys, there are some special keys that can be used for
22044 these conditionals:
22047 \begin_layout Itemize
22048 \begin_inset Flex Code
22051 \begin_layout Plain Layout
22052 {%dialog%[[true]][[false]]}
22058 \begin_inset Quotes eld
22062 \begin_inset Quotes erd
22065 part for dialogs and menus, the
22066 \begin_inset Quotes eld
22070 \begin_inset Quotes erd
22073 part for other contexts (workarea, export)
22076 \begin_layout Itemize
22077 \begin_inset Flex Code
22080 \begin_layout Plain Layout
22081 {%export%[[true]][[false]]}
22087 \begin_inset Quotes eld
22091 \begin_inset Quotes erd
22094 part for export and menus, the
22095 \begin_inset Quotes eld
22099 \begin_inset Quotes erd
22102 part for other contexts (workarea, dialog)
22105 \begin_layout Itemize
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22116 \begin_inset Quotes eld
22120 \begin_inset Quotes erd
22123 part if another item follows (e.
22124 \begin_inset space \thinspace{}
22127 g., in a citation with multiple keys)
22130 \begin_layout Itemize
22131 \begin_inset Flex Code
22134 \begin_layout Plain Layout
22135 {%second%[[true]][[false]]}
22141 \begin_inset Quotes eld
22145 \begin_inset Quotes erd
22148 if this is the second of multiple items, else the
22149 \begin_inset Quotes eld
22153 \begin_inset Quotes erd
22159 \begin_layout Itemize
22160 \begin_inset Flex Code
22163 \begin_layout Plain Layout
22164 {%ifstar%[[true]][[false]]}
22170 \begin_inset Quotes eld
22174 \begin_inset Quotes erd
22177 part for starred citation commands (such as
22178 \begin_inset Flex Code
22181 \begin_layout Plain Layout
22189 ), the false part for unstarred
22192 \begin_layout Itemize
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22197 {%ifentrytype:<type>%[[true]][[false]]}
22203 \begin_inset Quotes eld
22207 \begin_inset Quotes erd
22210 if the current entry type matches
22211 \begin_inset Flex Code
22214 \begin_layout Plain Layout
22220 , else the false part (e.g., in a citation definition:
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22225 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22233 \begin_layout Itemize
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22238 {%ifmultiple:<authortype>%[[true]][[false]]}
22244 \begin_inset Quotes eld
22248 \begin_inset Quotes erd
22251 if the current author type (author, editor etc.) has multiple authors, else
22252 the false part (e.g., in a bibliography definition:
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22257 {%ifmultiple:editor%[[eds.]][[ed.]]}
22265 \begin_layout Itemize
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22270 {%ifqualified%[[true]][[false]]}
22276 \begin_inset Quotes eld
22280 \begin_inset Quotes erd
22283 part if the current citation is a qualified citation list (a specific
22287 format for multi-reference citations), the false part if this is not the
22291 \begin_layout Standard
22293 \begin_inset Flex Code
22296 \begin_layout Plain Layout
22302 prints the author key as it is recorded in the bibliography file.
22303 This might not be what you want, since it will result in a string such
22305 \begin_inset Quotes eld
22308 Miller, Peter and Smith, Mary and White, Jane
22309 \begin_inset Quotes erd
22313 \begin_inset Quotes eld
22317 \begin_inset Quotes erd
22320 is used by Bib\SpecialChar TeX
22321 to delimit authors).
22323 therefore provides some methods to get properly formatted name lists (which
22324 will also get translated).
22325 The following keys are provided:
22328 \begin_layout Enumerate
22329 For name lists with pre- and surname, suitable for the main authors/editors
22330 of a bibliography item.
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22341 part denotes the kind of list that is requested (e.g.
22343 \begin_inset Flex Code
22346 \begin_layout Plain Layout
22356 \begin_layout Itemize
22357 \begin_inset Flex Code
22360 \begin_layout Plain Layout
22361 %abbrvnames:<nametype>%
22366 : Provides a name list which is abbreviated (with
22367 \begin_inset Quotes eld
22371 \begin_inset Quotes erd
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22387 \begin_layout Itemize
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22392 %fullnames:<nametype>%
22397 : Provides a full name list (never abbreviated with
22398 \begin_inset Quotes eld
22402 \begin_inset Quotes erd
22408 \begin_layout Itemize
22409 \begin_inset Flex Code
22412 \begin_layout Plain Layout
22413 %forceabbrvnames:<nametype>%
22418 : Provides a name list which is always abbreviated (with
22419 \begin_inset Quotes eld
22423 \begin_inset Quotes erd
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22440 \begin_layout Enumerate
22441 Alternative name lists with pre- and surname, if the order of pre- and surname
22442 inside the bibliography item differs (as in:
22443 \begin_inset Quotes eld
22446 Miller, John: Some text, in: Mary Smith, ed.: A volume
22447 \begin_inset Quotes erd
22454 \begin_layout Itemize
22455 \begin_inset Flex Code
22458 \begin_layout Plain Layout
22459 %abbrvbynames:<nametype>%
22464 : Provides a name list which is abbreviated (with
22465 \begin_inset Quotes eld
22469 \begin_inset Quotes erd
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22485 \begin_layout Itemize
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22490 %fullbynames:<nametype>%
22495 : Provides a full name list (never abbreviated with
22496 \begin_inset Quotes eld
22500 \begin_inset Quotes erd
22506 \begin_layout Itemize
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22511 %forceabbrvbynames:<nametype>%
22516 : Provides a name list which is always abbreviated (with
22517 \begin_inset Quotes eld
22521 \begin_inset Quotes erd
22525 \begin_inset Flex Code
22528 \begin_layout Plain Layout
22538 \begin_layout Enumerate
22539 And finally name lists which consist of family names only, as used in author-yea
22541 These do not take a
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22551 part, but always return either an author list or, if this does not exist,
22552 an editor list (as common in author-year labels):
22556 \begin_layout Itemize
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22566 : Provides a name list which is abbreviated (with
22567 \begin_inset Quotes eld
22571 \begin_inset Quotes erd
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22587 \begin_layout Itemize
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22597 : Provides a full name list (never abbreviated with
22598 \begin_inset Quotes eld
22602 \begin_inset Quotes erd
22608 \begin_layout Itemize
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22613 %forceabbrvciteauthor%
22618 : Provides a name list which is always abbreviated (with
22619 \begin_inset Quotes eld
22623 \begin_inset Quotes erd
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22640 \begin_layout Standard
22641 The order of pre- and surname in the former two lists can be adjusted by
22645 \begin_layout Itemize
22646 \begin_inset Flex Code
22649 \begin_layout Plain Layout
22650 !firstnameform %surname%, %prename%
22655 (first author in lists of type 1)
22658 \begin_layout Itemize
22659 \begin_inset Flex Code
22662 \begin_layout Plain Layout
22663 !othernameform %surname%, %prename%
22668 (other authors in lists of type 1)
22671 \begin_layout Itemize
22672 \begin_inset Flex Code
22675 \begin_layout Plain Layout
22676 !firstbynameform %prename% %surname%
22681 (first author in lists of type 2)
22684 \begin_layout Itemize
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22689 !otherbynameform %prename% %surname%
22694 (other authors in lists of type 2)
22697 \begin_layout Standard
22698 This allows you to configure namings like
22699 \begin_inset Quotes eld
22702 Miller, Peter and Mary Smith: \SpecialChar ldots
22703 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22705 \begin_inset Quotes erd
22711 \begin_layout Standard
22712 There is one other piece of syntax available in definitions, which looks
22714 \begin_inset Flex Code
22717 \begin_layout Plain Layout
22724 This defines a piece of formatting information that is to be used when
22726 \begin_inset Quotes eld
22730 \begin_inset Quotes erd
22734 Obviously, we do not want to output HTML tags when writing plain text,
22735 so they should be wrapped in
22736 \begin_inset Quotes eld
22740 \begin_inset Quotes erd
22744 \begin_inset Quotes eld
22748 \begin_inset Quotes erd
22754 \begin_layout Standard
22755 Two special sorts of definitions are also possible in a
22756 \begin_inset Flex Code
22759 \begin_layout Plain Layout
22766 An example of the first would be:
22769 \begin_layout LyX-Code
22771 \begin_inset Quotes eld
22775 \begin_inset Quotes erd
22781 \begin_layout Standard
22782 This is an abbreviation, or macro, and it can be used by treating it as
22784 \begin_inset Flex Code
22787 \begin_layout Plain Layout
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22805 exactly as it would treat its definition.
22806 So, let us issue the obvious
22814 \begin_layout LyX-Code
22818 \begin_layout Standard
22819 or anything like it.
22821 shouldn't go into an infinite loop, but it may go into a long one before
22825 \begin_layout Standard
22826 The second sort of special definition might look like this:
22829 \begin_layout LyX-Code
22833 \begin_layout Standard
22834 This defines a translatable piece of text, which allows relevant parts of
22835 the bibliography or citation to be translated.
22836 It can be included in a definition by treating it as a key:
22837 \begin_inset Flex Code
22840 \begin_layout Plain Layout
22847 Several of these are predefined in
22848 \begin_inset Flex Code
22851 \begin_layout Plain Layout
22858 \begin_inset Flex Code
22861 \begin_layout Plain Layout
22868 Note that these are not macros, in the sense just defined.
22869 They will not be expanded.
22872 \begin_layout Standard
22873 So here then is an example that use all these features:
22874 \begin_inset VSpace defskip
22880 \begin_layout Standard
22884 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22887 \begin_layout Standard
22888 \begin_inset VSpace defskip
22891 This defines a macro that prints the author, followed by a comma, if the
22893 \begin_inset Flex Code
22896 \begin_layout Plain Layout
22902 key is defined, or else prints the name of the editor, followed by the
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22913 or its translation (it is by default
22914 \begin_inset Quotes eld
22918 \begin_inset Quotes erd
22922 \begin_inset Flex Code
22925 \begin_layout Plain Layout
22932 Note that this is in fact defined in
22933 \begin_inset Flex Code
22936 \begin_layout Plain Layout
22942 , so you can use it in your own definitions, or re-definitions, if you load
22946 \begin_layout Section
22947 \begin_inset CommandInset label
22949 name "sec:Tags-for-XHTML"
22953 Tags for XHTML output
22956 \begin_layout Standard
22957 As with \SpecialChar LaTeX
22958 or DocBook, the format of \SpecialChar LyX
22959 's XHTML output is also controlled by
22960 layout information.
22961 In general, \SpecialChar LyX
22962 provides sensible defaults and, as mentioned earlier, it will
22963 even construct default CSS style rules from the other layout tags.
22964 For example, \SpecialChar LyX
22965 will attempt to use the information provided in the
22966 \begin_inset Flex Code
22969 \begin_layout Plain Layout
22975 declaration for the Chapter style to write CSS that will appropriately
22976 format chapter headings.
22979 \begin_layout Standard
22980 In many cases, then, you may not have to do anything at all to get acceptable
22981 XHTML output for your own environments, custom insets, and so forth.
22982 But in some cases you will, and so \SpecialChar LyX
22983 provides a number of layout tags that
22984 can be used to customize the XHTML and CSS that are generated.
22987 \begin_layout Standard
22988 Note that there are two tags,
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23008 that may appear outside style and inset declarations.
23010 \begin_inset CommandInset ref
23012 reference "subsec:General-text-class"
23016 for details on these.
23019 \begin_layout Subsection
23020 \begin_inset CommandInset label
23022 name "subsec:Paragraph-Style-XHTML"
23029 \begin_layout Standard
23030 The sort of XHTML \SpecialChar LyX
23031 outputs for a paragraph depends upon whether we are dealing
23032 with a normal paragraph, a command, or an environment, where this is itself
23033 determined by the contents of the corresponding
23034 \begin_inset Flex Code
23037 \begin_layout Plain Layout
23048 \begin_layout Standard
23049 For a command or normal paragraph, the output XHTML has the following form:
23052 \begin_layout LyX-Code
23054 \begin_inset Quotes erd
23058 \begin_inset Quotes erd
23064 \begin_layout LyX-Code
23066 \begin_inset Quotes erd
23070 \begin_inset Quotes erd
23076 \begin_layout LyX-Code
23077 Contents of the paragraph.
23080 \begin_layout LyX-Code
23084 \begin_layout Standard
23085 The label tags are of course omitted if the paragraph does not have a label.
23088 \begin_layout Standard
23089 For an environment that is not some sort of list, the XHTML takes this form:
23092 \begin_layout LyX-Code
23094 \begin_inset Quotes erd
23098 \begin_inset Quotes erd
23104 \begin_layout LyX-Code
23106 \begin_inset Quotes erd
23110 \begin_inset Quotes erd
23114 \begin_inset Quotes erd
23118 \begin_inset Quotes erd
23121 >Environment Label</labeltag>First paragraph.</itemtag>
23124 \begin_layout LyX-Code
23125 <itemtag>Second paragraph.</itemtag>
23128 \begin_layout LyX-Code
23132 \begin_layout Standard
23133 Note that the label is output only for the first paragraph, as it should
23134 be for a theorem, for example.
23138 \begin_layout Standard
23139 For a list, we have one of these forms:
23142 \begin_layout LyX-Code
23144 \begin_inset Quotes erd
23148 \begin_inset Quotes erd
23154 \begin_layout LyX-Code
23156 \begin_inset Quotes erd
23160 \begin_inset Quotes erd
23164 \begin_inset Quotes erd
23168 \begin_inset Quotes erd
23171 >List Label</labeltag>First item.</itemtag>
23174 \begin_layout LyX-Code
23176 \begin_inset Quotes erd
23180 \begin_inset Quotes erd
23184 \begin_inset Quotes erd
23188 \begin_inset Quotes erd
23191 >List Label</labeltag>Second item.</itemtag>
23194 \begin_layout LyX-Code
23198 \begin_layout LyX-Code
23202 \begin_layout LyX-Code
23204 \begin_inset Quotes erd
23208 \begin_inset Quotes erd
23214 \begin_layout LyX-Code
23216 \begin_inset Quotes erd
23220 \begin_inset Quotes erd
23223 >List Label</labeltag><itemtag attr=
23224 \begin_inset Quotes erd
23228 \begin_inset Quotes erd
23231 >First item.</itemtag>
23234 \begin_layout LyX-Code
23236 \begin_inset Quotes erd
23240 \begin_inset Quotes erd
23243 >List Label</labeltag><itemtag attr=
23244 \begin_inset Quotes erd
23248 \begin_inset Quotes erd
23251 >Second item.</itemtag>
23254 \begin_layout LyX-Code
23258 \begin_layout Standard
23259 Note the different orders of
23260 \begin_inset Flex Code
23263 \begin_layout Plain Layout
23270 \begin_inset Flex Code
23273 \begin_layout Plain Layout
23280 Which order we get depends upon the setting of
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23291 \begin_inset Flex Code
23294 \begin_layout Plain Layout
23300 is false (the default), you get the first of these, with the label within
23301 the item; if true, you get the second, with the label outside the item.
23304 \begin_layout Standard
23305 The specific tags and attributes output for each paragraph type can be controlle
23306 d by means of the layout tags we are about to describe.
23307 As mentioned earlier, however, \SpecialChar LyX
23308 uses sensible defaults for many of these,
23309 so you often may not need to do very much to get good XHTML output.
23310 Think of the available tags as there so you can tweak things to your liking.
23313 \begin_layout Description
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23333 ] Specifies attribute information to be output with the main tag.
23335 \begin_inset Quotes eld
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23349 \begin_inset Quotes erd
23353 By default, \SpecialChar LyX
23355 \begin_inset Quotes eld
23359 \begin_inset Flex Code
23362 \begin_layout Plain Layout
23369 \begin_inset Quotes erd
23373 \begin_inset Flex Code
23376 \begin_layout Plain Layout
23382 is the \SpecialChar LyX
23383 name of the layout, made lowercase, for example: chapter.
23388 contain any style information.
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23402 \begin_layout Description
23403 \begin_inset Flex Code
23406 \begin_layout Plain Layout
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23426 ] Whether to output the default CSS information \SpecialChar LyX
23427 generates for this layout,
23428 even if additional information is explicitly provided via
23429 \begin_inset Flex Code
23432 \begin_layout Plain Layout
23440 \begin_inset Flex Code
23443 \begin_layout Plain Layout
23449 allows you to alter or augment the generated CSS, rather than to override
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23464 \begin_layout Description
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23475 \begin_inset Flex Code
23478 \begin_layout Plain Layout
23484 ] The tag to be used for individual paragraphs of environments, replacing
23486 \begin_inset Flex Code
23489 \begin_layout Plain Layout
23495 in the examples above.
23497 \begin_inset Flex Code
23500 \begin_layout Plain Layout
23509 \begin_layout Description
23510 \begin_inset Flex Code
23513 \begin_layout Plain Layout
23520 \begin_inset Flex Code
23523 \begin_layout Plain Layout
23529 ] Attributes for the item tag.
23531 \begin_inset Quotes eld
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23539 class=`layoutname_item'
23545 \begin_inset Quotes erd
23553 contain any style information.
23555 \begin_inset Flex Code
23558 \begin_layout Plain Layout
23567 \begin_layout Description
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23587 ] The tag to be used for paragraph and item labels, replacing
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23597 in the examples above.
23599 \begin_inset Flex Code
23602 \begin_layout Plain Layout
23609 \begin_inset Flex Code
23612 \begin_layout Plain Layout
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23633 Centered_Top_Environment
23638 , in which case it defaults to
23639 \begin_inset Flex Code
23642 \begin_layout Plain Layout
23651 \begin_layout Description
23652 \begin_inset Flex Code
23655 \begin_layout Plain Layout
23662 \begin_inset Flex Code
23665 \begin_layout Plain Layout
23671 ] Attributes for the label tag.
23673 \begin_inset Quotes eld
23677 \begin_inset Flex Code
23680 \begin_layout Plain Layout
23681 class=`layoutname_label'
23687 \begin_inset Quotes erd
23695 contain any style information.
23697 \begin_inset Flex Code
23700 \begin_layout Plain Layout
23709 \begin_layout Description
23710 \begin_inset Flex Code
23713 \begin_layout Plain Layout
23720 \begin_inset Flex Code
23723 \begin_layout Plain Layout
23733 ] Meaningful only for list-like environments, this tag controls whether
23734 the label tag is output before or inside the item tag.
23735 This is used, for example, in the description environment, where we want
23737 \begin_inset Flex Code
23740 \begin_layout Plain Layout
23741 <dt>\SpecialChar ldots
23742 </dt><dd>\SpecialChar ldots
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23759 : The label tag is output inside the item tag.
23762 \begin_layout Description
23763 \begin_inset Flex Code
23766 \begin_layout Plain Layout
23772 Information to be output in the
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23782 section when this style is used.
23783 This might, for example, be used to include a
23784 \begin_inset Flex Code
23787 \begin_layout Plain Layout
23794 \begin_inset Flex Code
23797 \begin_layout Plain Layout
23806 \begin_layout Description
23807 \begin_inset Flex Code
23810 \begin_layout Plain Layout
23816 CSS style information to be included when this style is used.
23817 Note that this will automatically be wrapped in a layout-generated
23818 \begin_inset Flex Code
23821 \begin_layout Plain Layout
23827 block, so only the CSS itself need be included.
23829 \begin_inset Flex Code
23832 \begin_layout Plain Layout
23841 \begin_layout Description
23842 \begin_inset Flex Code
23845 \begin_layout Plain Layout
23852 \begin_inset Flex Code
23855 \begin_layout Plain Layout
23861 ] The tag to be used for the main label, replacing
23862 \begin_inset Flex Code
23865 \begin_layout Plain Layout
23871 in the examples above.
23873 \begin_inset Flex Code
23876 \begin_layout Plain Layout
23885 \begin_layout Description
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23909 ] Marks this style as the one to be used to generate the
23910 \begin_inset Flex Code
23913 \begin_layout Plain Layout
23919 tag for the XHTML file.
23920 By default, it is false.
23922 \begin_inset Flex Code
23925 \begin_layout Plain Layout
23931 file sets it to true for the
23932 \begin_inset Flex Code
23935 \begin_layout Plain Layout
23945 \begin_layout Subsection
23949 \begin_layout Standard
23950 The XHTML output of insets can also be controlled by information in layout
23955 \begin_layout Plain Layout
23956 At present, this is true only for
23957 \begin_inset Quotes eld
23961 \begin_inset Quotes erd
23964 insets (insets you can type into) and is not true for
23965 \begin_inset Quotes eld
23969 \begin_inset Quotes erd
23972 insets (insets that are associated with dialog boxes).
23977 Here, too, \SpecialChar LyX
23978 tries to provide sensible defaults, and it constructs default
23980 But everything can be customized.
23983 \begin_layout Standard
23984 The XHTML \SpecialChar LyX
23985 outputs for an inset has the following form:
23988 \begin_layout LyX-Code
23990 \begin_inset Quotes erd
23994 \begin_inset Quotes erd
24000 \begin_layout LyX-Code
24001 <labeltag>Label</labeltag>
24004 \begin_layout LyX-Code
24006 \begin_inset Quotes erd
24010 \begin_inset Quotes erd
24013 >Contents of the inset.</innertag>
24016 \begin_layout LyX-Code
24020 \begin_layout Standard
24021 If the inset permits multiple paragraphs—that is, if
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24031 is true—then the contents of the inset will itself be output as paragraphs
24032 formatted according to the styles used for those paragraphs (standard,
24033 quote, and the like).
24034 The label tag is of course omitted if the paragraph does not have a label
24035 and, at present, is always
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24046 The inner tag is optional and, by default, does not appear.
24049 \begin_layout Standard
24050 The specific tags and attributes output for each inset can be controlled
24051 by means of the following layout tags.
24054 \begin_layout Description
24055 \begin_inset Flex Code
24058 \begin_layout Plain Layout
24065 \begin_inset Flex Code
24068 \begin_layout Plain Layout
24074 ] Specifies attribute information to be output with the main tag.
24076 \begin_inset Quotes eld
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24084 class=`myinset' onclick=`\SpecialChar ldots
24091 \begin_inset Quotes erd
24095 By default, \SpecialChar LyX
24097 \begin_inset Quotes eld
24101 \begin_inset Flex Code
24104 \begin_layout Plain Layout
24111 \begin_inset Quotes erd
24115 \begin_inset Flex Code
24118 \begin_layout Plain Layout
24124 is the \SpecialChar LyX
24125 name of the inset, made lowercase and with non-alphanumeric characters
24126 converted to underscores, for example: footnote.
24129 \begin_layout Description
24130 \begin_inset Flex Code
24133 \begin_layout Plain Layout
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24153 ] Whether to output the default CSS information \SpecialChar LyX
24154 generates for this layout,
24155 even if additional information is explicitly provided via
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24167 \begin_inset Flex Code
24170 \begin_layout Plain Layout
24176 allows you to alter or augment the generated CSS, rather than to override
24181 \begin_layout Description
24182 \begin_inset Flex Code
24185 \begin_layout Plain Layout
24192 \begin_inset Flex Code
24195 \begin_layout Plain Layout
24201 ] Attributes for the inner tag.
24203 \begin_inset Quotes eld
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24211 class=`insetname_inner'
24217 \begin_inset Quotes erd
24223 \begin_layout Description
24224 \begin_inset Flex Code
24227 \begin_layout Plain Layout
24234 \begin_inset Flex Code
24237 \begin_layout Plain Layout
24243 ] The inner tag, replacing
24244 \begin_inset Flex Code
24247 \begin_layout Plain Layout
24253 in the examples above.
24254 By default, there is none.
24257 \begin_layout Description
24258 \begin_inset Flex Code
24261 \begin_layout Plain Layout
24268 \begin_inset Flex Code
24271 \begin_layout Plain Layout
24279 ] Whether this inset represents a standalone block of text (such as a footnote)
24280 or instead represents material that is included in the surrounding text
24281 (such as a branch).
24285 \begin_layout Description
24286 \begin_inset Flex Code
24289 \begin_layout Plain Layout
24296 \begin_inset Flex Code
24299 \begin_layout Plain Layout
24305 ] A label for this inset, possibly including a reference to a counter.
24306 For example, for footnote, it might be:
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24319 This is optional, and there is no default.
24322 \begin_layout Description
24323 \begin_inset Flex Code
24326 \begin_layout Plain Layout
24332 Information to be output in the
24333 \begin_inset Flex Code
24336 \begin_layout Plain Layout
24342 section when this style is used.
24343 This might, for example, be used to include a
24344 \begin_inset Flex Code
24347 \begin_layout Plain Layout
24354 \begin_inset Flex Code
24357 \begin_layout Plain Layout
24366 \begin_layout Description
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24376 CSS style information to be included when this style is used.
24377 Note that this will automatically be wrapped in a layout-generated
24378 \begin_inset Flex Code
24381 \begin_layout Plain Layout
24387 block, so only the CSS itself need be included.
24390 \begin_layout Description
24391 \begin_inset Flex Code
24394 \begin_layout Plain Layout
24401 \begin_inset Flex Code
24404 \begin_layout Plain Layout
24410 ] The tag to be used for the main label, replacing
24411 \begin_inset Flex Code
24414 \begin_layout Plain Layout
24420 in the examples above.
24421 The default depends upon the setting of
24422 \begin_inset Flex Code
24425 \begin_layout Plain Layout
24432 \begin_inset Flex Code
24435 \begin_layout Plain Layout
24441 is true, the default is
24442 \begin_inset Flex Code
24445 \begin_layout Plain Layout
24451 ; if it is false, the default is
24452 \begin_inset Flex Code
24455 \begin_layout Plain Layout
24464 \begin_layout Subsection
24468 \begin_layout Standard
24469 The XHTML output for floats too can be controlled by layout information.
24470 The output has the following form:
24473 \begin_layout LyX-Code
24475 \begin_inset Quotes erd
24479 \begin_inset Quotes erd
24485 \begin_layout LyX-Code
24486 Contents of the float.
24489 \begin_layout LyX-Code
24493 \begin_layout Standard
24494 The caption, if there is one, is a separate inset and will be output as
24496 Its appearance can be controlled via the InsetLayout for caption insets.
24500 \begin_layout Description
24501 \begin_inset Flex Code
24504 \begin_layout Plain Layout
24511 \begin_inset Flex Code
24514 \begin_layout Plain Layout
24520 ] Specifies attribute information to be output with the main tag.
24522 \begin_inset Quotes eld
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24530 class=`myfloat' onclick=`\SpecialChar ldots
24537 \begin_inset Quotes erd
24541 By default, \SpecialChar LyX
24543 \begin_inset Quotes eld
24547 \begin_inset Flex Code
24550 \begin_layout Plain Layout
24551 class=`float float-floattype'
24557 \begin_inset Quotes erd
24561 \begin_inset Flex Code
24564 \begin_layout Plain Layout
24570 is \SpecialChar LyX
24571 's name for this type of float, as determined by the float declaration
24573 \begin_inset CommandInset ref
24575 reference "subsec:Floats"
24579 ), though made lowercase and with non-alphanumeric characters converted
24580 to underscores, for example: float-table.
24583 \begin_layout Description
24584 \begin_inset Flex Code
24587 \begin_layout Plain Layout
24593 CSS style information to be included when this float is used.
24594 Note that this will automatically be wrapped in a layout-generated
24595 \begin_inset Flex Code
24598 \begin_layout Plain Layout
24604 block, so only the CSS itself need be included.
24607 \begin_layout Description
24608 \begin_inset Flex Code
24611 \begin_layout Plain Layout
24618 \begin_inset Flex Code
24621 \begin_layout Plain Layout
24627 ] The tag to be used for this float, replacing
24628 \begin_inset Quotes eld
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24642 \begin_inset Quotes erd
24645 in the example above.
24647 \begin_inset Flex Code
24650 \begin_layout Plain Layout
24656 and will rarely need changing.
24659 \begin_layout Subsection
24660 Bibliography formatting
24663 \begin_layout Standard
24664 The bibliography can be formatted using
24665 \begin_inset Flex Code
24668 \begin_layout Plain Layout
24676 \begin_inset CommandInset ref
24678 reference "subsec:Citation-format-description"
24685 \begin_layout Subsection
24690 \begin_layout Standard
24691 We have several times mentioned that \SpecialChar LyX
24692 will generate default CSS style rules
24693 for both insets and paragraph styles, based upon the other layout information
24695 In this section, we shall say a word about which layout information \SpecialChar LyX
24700 \begin_layout Standard
24701 At present, \SpecialChar LyX
24702 auto-generates CSS only for font information, making use of
24704 \begin_inset Flex Code
24707 \begin_layout Plain Layout
24714 \begin_inset Flex Code
24717 \begin_layout Plain Layout
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24734 \begin_inset Flex Code
24737 \begin_layout Plain Layout
24744 \begin_inset Flex Code
24747 \begin_layout Plain Layout
24754 \begin_inset CommandInset ref
24756 reference "subsec:Font-description"
24761 The translation is mostly straightforward and obvious.
24763 \begin_inset Quotes eld
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24777 \begin_inset Quotes erd
24781 \begin_inset Quotes eld
24785 \begin_inset Flex Code
24788 \begin_layout Plain Layout
24789 font-family: sans-serif;
24795 \begin_inset Quotes erd
24799 The correspondence of \SpecialChar LyX
24800 sizes and CSS sizes is a little less obvious but
24801 nonetheless intuitive.
24803 \begin_inset Flex Code
24806 \begin_layout Plain Layout
24813 \begin_inset Flex URL
24816 \begin_layout Plain Layout
24826 \begin_layout Chapter
24827 Including External Material
24828 \begin_inset CommandInset label
24830 name "chap:Including-External-Material"
24837 \begin_layout Standard
24838 \begin_inset Box Shadowbox
24848 height_special "totalheight"
24853 backgroundcolor "none"
24856 \begin_layout Plain Layout
24857 WARNING: This portion of the documentation has not been updated for some
24859 We certainly hope that it is still accurate, but there are no guarantees.
24867 \begin_layout Standard
24868 The use of material from sources external to \SpecialChar LyX
24869 is covered in detail in the
24875 This part of the manual covers what needs to happen behind the scenes for
24876 new sorts of material to be included.
24879 \begin_layout Section
24883 \begin_layout Standard
24884 The external material feature is based on the concept of a
24889 A template is a specification of how \SpecialChar LyX
24890 should interface with a certain kind
24892 As bundled, \SpecialChar LyX
24893 comes with predefined templates for Xfig figures, various
24894 raster format images, chess diagrams, and LilyPond music notation.
24895 You can check the actual list by using the menu
24896 \begin_inset Flex Noun
24899 \begin_layout Plain Layout
24900 Insert\SpecialChar menuseparator
24901 File\SpecialChar menuseparator
24908 Furthermore, it is possible to roll your own template to support a specific
24910 Later we'll describe in more detail what is involved, and hopefully you
24911 will submit all the templates you create so we can include them in a later
24916 \begin_layout Standard
24917 Another basic idea of the external material feature is to distinguish between
24918 the original file that serves as a base for final material and the produced
24919 file that is included in your exported or printed document.
24920 For example, consider the case of a figure produced with
24921 \begin_inset Flex Code
24924 \begin_layout Plain Layout
24931 The Xfig application itself works on an original file with the
24932 \begin_inset Flex Code
24935 \begin_layout Plain Layout
24942 Within Xfig, you create and change your figure, and when you are done,
24944 \begin_inset Flex Code
24947 \begin_layout Plain Layout
24954 When you want to include the figure in your document, you invoke
24955 \begin_inset Flex Code
24958 \begin_layout Plain Layout
24964 in order to create a PostScript file that can readily be included in your
24968 \begin_inset Flex Code
24971 \begin_layout Plain Layout
24977 file is the original file, and the PostScript file is the produced file.
24980 \begin_layout Standard
24981 This distinction is important in order to allow updating of the material
24982 while you are in the process of writing the document.
24983 Furthermore, it provides us with the flexibility that is needed to support
24984 multiple export formats.
24985 For instance, in the case of a plain text file, it is not exactly an award-winn
24986 ing idea to include the figure as raw PostScript.
24987 Instead, you would either prefer to just include a reference to the figure
24988 or try to invoke some graphics to ASCII converter to make the final result
24989 look similar to the real graphics.
24990 The external material management allows you to do this, because it is parametri
24991 zed on the different export formats that \SpecialChar LyX
24995 \begin_layout Standard
24996 Besides supporting the production of different products according to the
24997 exported format, it supports tight integration with editing and viewing
24999 In the case of an Xfig figure, you are able to invoke Xfig on the original
25000 file with a single click from within the external material dialog in \SpecialChar LyX
25002 and also preview the produced PostScript file with Ghostview with another
25004 No more fiddling around with the command line and/or file browsers to locate
25005 and manipulate the original or produced files.
25006 In this way, you are finally able to take full advantage of the many different
25007 applications that are relevant to use when you write your documents, and
25008 ultimately be more productive.
25011 \begin_layout Section
25012 The external template configuration files
25015 \begin_layout Standard
25016 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25018 However, be aware that doing this in an careless manner most probably
25022 introduce an easily exploitable security hole.
25023 So before you do this, please read the discussion about security in
25024 \begin_inset CommandInset ref
25026 reference "sec:Security-discussion"
25033 \begin_layout Standard
25034 Having said that, we encourage you to submit any interesting templates that
25039 \begin_layout Standard
25040 The external templates are defined in the
25041 \begin_inset Flex Code
25044 \begin_layout Plain Layout
25050 files that are stored in the
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25055 LyXDir/lib/xtemplates/
25061 Each template is defined in a file of its own.
25062 You can place your own templates in
25063 \begin_inset Flex Code
25066 \begin_layout Plain Layout
25067 UserDir/xtemplates/
25072 or copy existing templates to that directory in order to modify them.
25075 \begin_layout Standard
25076 A typical template looks like this:
25079 \begin_layout LyX-Code
25083 \begin_layout LyX-Code
25084 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25087 \begin_layout LyX-Code
25091 \begin_layout LyX-Code
25095 \begin_layout LyX-Code
25099 \begin_layout LyX-Code
25103 \begin_layout LyX-Code
25107 \begin_layout LyX-Code
25108 AutomaticProduction true
25111 \begin_layout LyX-Code
25115 \begin_layout LyX-Code
25119 \begin_layout LyX-Code
25123 \begin_layout LyX-Code
25124 TransformCommand Rotate RotationLatexCommand
25127 \begin_layout LyX-Code
25128 TransformCommand Resize ResizeLatexCommand
25131 \begin_layout LyX-Code
25132 Product "$$RotateFront$$ResizeFront
25135 \begin_layout LyX-Code
25140 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25143 \begin_layout LyX-Code
25144 $$ResizeBack$$RotateBack"
25147 \begin_layout LyX-Code
25151 \begin_layout LyX-Code
25152 UpdateResult "$$AbsPath$$Basename.pstex_t"
25155 \begin_layout LyX-Code
25156 Requirement "graphicx"
25159 \begin_layout LyX-Code
25160 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25163 \begin_layout LyX-Code
25164 ReferencedFile latex "$$AbsPath$$Basename.eps"
25167 \begin_layout LyX-Code
25168 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25171 \begin_layout LyX-Code
25175 \begin_layout LyX-Code
25179 \begin_layout LyX-Code
25180 TransformCommand Rotate RotationLatexCommand
25183 \begin_layout LyX-Code
25184 TransformCommand Resize ResizeLatexCommand
25187 \begin_layout LyX-Code
25188 Product "$$RotateFront$$ResizeFront
25191 \begin_layout LyX-Code
25196 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25199 \begin_layout LyX-Code
25200 $$ResizeBack$$RotateBack"
25203 \begin_layout LyX-Code
25204 UpdateFormat pdftex
25207 \begin_layout LyX-Code
25208 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25211 \begin_layout LyX-Code
25212 Requirement "graphicx"
25215 \begin_layout LyX-Code
25216 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25219 \begin_layout LyX-Code
25220 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25223 \begin_layout LyX-Code
25227 \begin_layout LyX-Code
25231 \begin_layout LyX-Code
25232 Product "[XFig: $$FName]"
25235 \begin_layout LyX-Code
25239 \begin_layout LyX-Code
25243 \begin_layout LyX-Code
25244 Product "<graphic fileref=
25246 "$$AbsOrRelPathMaster$$Basename.eps
25251 \begin_layout LyX-Code
25255 \begin_layout LyX-Code
25259 \begin_layout LyX-Code
25260 UpdateResult "$$AbsPath$$Basename.eps"
25263 \begin_layout LyX-Code
25264 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25267 \begin_layout LyX-Code
25268 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25271 \begin_layout LyX-Code
25275 \begin_layout LyX-Code
25279 \begin_layout Standard
25280 As you can see, the template is enclosed in
25281 \begin_inset Flex Code
25284 \begin_layout Plain Layout
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25302 It contains a header specifying some general settings and, for each supported
25303 primary document file format, a section
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25315 \begin_inset Flex Code
25318 \begin_layout Plain Layout
25327 \begin_layout Subsection
25328 The template header
25331 \begin_layout Description
25332 \begin_inset Flex Code
25335 \begin_layout Plain Layout
25336 AutomaticProduction
25337 \begin_inset space ~
25345 Whether the file represented by the template must be generated by \SpecialChar LyX
25347 This command must occur exactly once.
25350 \begin_layout Description
25351 \begin_inset Flex Code
25354 \begin_layout Plain Layout
25356 \begin_inset space ~
25364 A glob pattern that is used in the file dialog to filter out the desired
25366 If there is more than one possible file extension (e.
25367 \begin_inset space \thinspace{}
25371 \begin_inset space \space{}
25375 \begin_inset Flex Code
25378 \begin_layout Plain Layout
25385 \begin_inset Flex Code
25388 \begin_layout Plain Layout
25394 ), use something like
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25405 This command must occur exactly once.
25408 \begin_layout Description
25409 \begin_inset Flex Code
25412 \begin_layout Plain Layout
25414 \begin_inset space ~
25422 The text that is displayed on the button.
25423 This command must occur exactly once.
25426 \begin_layout Description
25427 \begin_inset Flex Code
25430 \begin_layout Plain Layout
25432 \begin_inset space ~
25436 \begin_inset space ~
25444 The help text that is used in the External dialog.
25445 Provide enough information to explain to the user just what the template
25446 can provide him with.
25447 This command must occur exactly once.
25450 \begin_layout Description
25451 \begin_inset Flex Code
25454 \begin_layout Plain Layout
25456 \begin_inset space ~
25464 The file format of the original file.
25465 This must be the name of a format that is known to \SpecialChar LyX
25467 \begin_inset CommandInset ref
25469 reference "sec:Formats"
25475 \begin_inset Quotes eld
25479 \begin_inset Flex Code
25482 \begin_layout Plain Layout
25489 \begin_inset Quotes erd
25492 if the template can handle original files of more than one format.
25494 will attempt to interrogate the file itself in order to deduce its format
25496 This command must occur exactly once.
25499 \begin_layout Description
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25505 \begin_inset space ~
25513 A unique name for the template.
25514 It must not contain substitution macros (see below).
25517 \begin_layout Description
25518 \begin_inset Flex Code
25521 \begin_layout Plain Layout
25523 \begin_inset space ~
25526 Rotate|Resize|Clip|Extra
25531 This command specifies which transformations are supported by this template.
25532 It may occur zero or more times.
25533 This command enables the corresponding tabs in the external dialog.
25535 \begin_inset Flex Code
25538 \begin_layout Plain Layout
25544 command must have either a corresponding
25545 \begin_inset Flex Code
25548 \begin_layout Plain Layout
25555 \begin_inset Flex Code
25558 \begin_layout Plain Layout
25565 \begin_inset Flex Code
25568 \begin_layout Plain Layout
25575 Otherwise the transformation will not be supported by that format.
25578 \begin_layout Subsection
25582 \begin_layout Description
25583 \begin_inset Flex Code
25586 \begin_layout Plain Layout
25588 \begin_inset space ~
25591 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25596 The primary document file format that this format definition is for.
25597 Not every template has a sensible representation in all document file formats.
25598 Please define nevertheless a
25599 \begin_inset Flex Code
25602 \begin_layout Plain Layout
25608 section for all templates.
25609 Use a dummy text when no representation is available.
25610 Then you can at least see a reference to the external material in the exported
25614 \begin_layout Description
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25620 \begin_inset space ~
25624 \begin_inset space ~
25632 This command defines an additional macro
25633 \begin_inset Flex Code
25636 \begin_layout Plain Layout
25642 for substitution in
25643 \begin_inset Flex Code
25646 \begin_layout Plain Layout
25654 \begin_inset Flex Code
25657 \begin_layout Plain Layout
25663 itself may contain substitution macros.
25664 The advantage over using
25665 \begin_inset Flex Code
25668 \begin_layout Plain Layout
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25684 is that the substituted value of
25685 \begin_inset Flex Code
25688 \begin_layout Plain Layout
25694 is sanitized so that it is a valid optional argument in the document format.
25695 This command may occur zero or more times.
25698 \begin_layout Description
25699 \begin_inset Flex Code
25702 \begin_layout Plain Layout
25704 \begin_inset space ~
25712 The text that is inserted in the exported document.
25713 This is actually the most important command and can be quite complex.
25714 This command must occur exactly once.
25717 \begin_layout Description
25718 \begin_inset Flex Code
25721 \begin_layout Plain Layout
25723 \begin_inset space ~
25731 This command specifies a preamble snippet that will be included in the
25734 It has to be defined using
25735 \begin_inset Flex Code
25738 \begin_layout Plain Layout
25746 \begin_inset Flex Code
25749 \begin_layout Plain Layout
25756 This command may occur zero or more times.
25759 \begin_layout Description
25760 \begin_inset Flex Code
25763 \begin_layout Plain Layout
25765 \begin_inset space ~
25769 \begin_inset space ~
25777 This command denotes files that are created by the conversion process and
25778 are needed for a particular export format.
25779 If the filename is relative, it is interpreted relative to the master document.
25780 This command may be given zero or more times.
25783 \begin_layout Description
25784 \begin_inset Flex Code
25787 \begin_layout Plain Layout
25789 \begin_inset space ~
25797 The name of a required \SpecialChar LaTeX
25799 The package is included via
25800 \begin_inset Flex Code
25803 \begin_layout Plain Layout
25811 in the \SpecialChar LaTeX
25813 This command may occur zero or more times.
25816 \begin_layout Description
25817 \begin_inset Flex Code
25820 \begin_layout Plain Layout
25822 \begin_inset space ~
25826 \begin_inset space ~
25829 RotationLatexCommand
25834 This command specifies that the built in \SpecialChar LaTeX
25835 command should be used for rotation.
25836 This command may occur once or not at all.
25839 \begin_layout Description
25840 \begin_inset Flex Code
25843 \begin_layout Plain Layout
25845 \begin_inset space ~
25849 \begin_inset space ~
25857 This command specifies that the built in \SpecialChar LaTeX
25858 command should be used for resizing.
25859 This command may occur once or not at all.
25862 \begin_layout Description
25863 \begin_inset Flex Code
25866 \begin_layout Plain Layout
25868 \begin_inset space ~
25872 \begin_inset space ~
25875 RotationLatexOption
25880 This command specifies that rotation is done via an optional argument.
25881 This command may occur once or not at all.
25884 \begin_layout Description
25885 \begin_inset Flex Code
25888 \begin_layout Plain Layout
25890 \begin_inset space ~
25894 \begin_inset space ~
25902 This command specifies that resizing is done via an optional argument.
25903 This command may occur once or not at all.
25906 \begin_layout Description
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25912 \begin_inset space ~
25916 \begin_inset space ~
25924 This command specifies that clipping is done via an optional argument.
25925 This command may occur once or not at all.
25928 \begin_layout Description
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25934 \begin_inset space ~
25938 \begin_inset space ~
25946 This command specifies that an extra optional argument is used.
25947 This command may occur once or not at all.
25950 \begin_layout Description
25951 \begin_inset Flex Code
25954 \begin_layout Plain Layout
25956 \begin_inset space ~
25964 The file format of the converted file.
25965 This must be the name of a format that is known to \SpecialChar LyX
25967 \begin_inset Flex Noun
25970 \begin_layout Plain Layout
25971 Tools\SpecialChar menuseparator
25972 Preferences\SpecialChar menuseparator
25973 File Handling\SpecialChar menuseparator
25980 This command must occur exactly once.
25981 If the resulting file format is PDF, you need to specify the format
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25992 This is the PDF format used for including graphics.
25993 The other defined PDF formats are for document export.
25996 \begin_layout Description
25997 \begin_inset Flex Code
26000 \begin_layout Plain Layout
26002 \begin_inset space ~
26010 The file name of the converted file.
26011 The file name must be absolute.
26012 This command must occur exactly once.
26015 \begin_layout Subsection
26016 Preamble definitions
26019 \begin_layout Standard
26020 The external template configuration file may contain additional preamble
26021 definitions enclosed by
26022 \begin_inset Flex Code
26025 \begin_layout Plain Layout
26033 \begin_inset Flex Code
26036 \begin_layout Plain Layout
26043 They can be used by the templates in the
26044 \begin_inset Flex Code
26047 \begin_layout Plain Layout
26056 \begin_layout Section
26057 The substitution mechanism
26060 \begin_layout Standard
26061 When the external material facility invokes an external program, it is done
26062 on the basis of a command defined in the template configuration file.
26063 These commands can contain various macros that are expanded before execution.
26064 Execution always take place in the directory of the containing document.
26067 \begin_layout Standard
26068 Also, whenever external material is to be displayed, the name will be produced
26069 by the substitution mechanism, and most other commands in the template
26070 definition support substitution as well.
26073 \begin_layout Standard
26074 The available macros are the following:
26077 \begin_layout Description
26078 \begin_inset Flex Code
26081 \begin_layout Plain Layout
26082 $$AbsOrRelPathMaster
26087 The file path, absolute or relative to the master \SpecialChar LyX
26091 \begin_layout Description
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26096 $$AbsOrRelPathParent
26101 The file path, absolute or relative to the \SpecialChar LyX
26105 \begin_layout Description
26106 \begin_inset Flex Code
26109 \begin_layout Plain Layout
26115 The absolute file path.
26118 \begin_layout Description
26119 \begin_inset Flex Code
26122 \begin_layout Plain Layout
26128 The filename without path and without the extension.
26131 \begin_layout Description
26132 \begin_inset Flex Code
26135 \begin_layout Plain Layout
26137 \begin_inset Quotes eld
26141 \begin_inset Quotes erd
26149 This macro will expand to the contents of the file with the name
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26162 \begin_layout Description
26163 \begin_inset Flex Code
26166 \begin_layout Plain Layout
26172 The file extension (including the dot).
26175 \begin_layout Description
26176 \begin_inset Flex Code
26179 \begin_layout Plain Layout
26185 This will be the string
26186 \begin_inset Quotes eld
26190 \begin_inset Quotes erd
26193 if the file is in JPEG format, otherwise it will be the string
26194 \begin_inset Quotes eld
26198 \begin_inset Quotes erd
26202 This is useful to avoid uneeded conversions for output formats that support
26203 both PNG and JPEG fomats.
26204 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26209 \begin_layout Description
26210 \begin_inset Flex Code
26213 \begin_layout Plain Layout
26219 The filename of the file specified in the external material dialog.
26220 This is either an absolute name, or it is relative to the \SpecialChar LyX
26224 \begin_layout Description
26225 \begin_inset Flex Code
26228 \begin_layout Plain Layout
26235 \begin_inset Flex Code
26238 \begin_layout Plain Layout
26244 (absolute name or relative to the \SpecialChar LyX
26248 \begin_layout Description
26249 \begin_inset Flex Code
26252 \begin_layout Plain Layout
26258 The file path, relative to the master \SpecialChar LyX
26262 \begin_layout Description
26263 \begin_inset Flex Code
26266 \begin_layout Plain Layout
26272 The file path, relative to the \SpecialChar LyX
26276 \begin_layout Description
26277 \begin_inset Flex Code
26280 \begin_layout Plain Layout
26286 This macro will expand to the absolute path of the system directory.
26287 This is typically used to point to the various helper scripts that are
26288 bundled with \SpecialChar LyX
26292 \begin_layout Description
26293 \begin_inset Flex Code
26296 \begin_layout Plain Layout
26302 A name and full path to a temporary file which will be automatically deleted
26303 whenever the containing document is closed, or the external material insertion
26307 \begin_layout Standard
26308 All path macros contain a trailing directory separator, so you can construct
26310 \begin_inset space \thinspace{}
26314 \begin_inset space \space{}
26317 the absolute filename with
26318 \begin_inset Flex Code
26321 \begin_layout Plain Layout
26322 $$AbsPath$$Basename$$Extension
26330 \begin_layout Standard
26331 The macros above are substituted in all commands unless otherwise noted.
26333 \begin_inset Flex Code
26336 \begin_layout Plain Layout
26342 supports additionally the following substitutions if they are enabled by
26344 \begin_inset Flex Code
26347 \begin_layout Plain Layout
26354 \begin_inset Flex Code
26357 \begin_layout Plain Layout
26366 \begin_layout Description
26367 \begin_inset Flex Code
26370 \begin_layout Plain Layout
26376 The front part of the resize command.
26379 \begin_layout Description
26380 \begin_inset Flex Code
26383 \begin_layout Plain Layout
26389 The back part of the resize command.
26392 \begin_layout Description
26393 \begin_inset Flex Code
26396 \begin_layout Plain Layout
26402 The front part of the rotation command.
26405 \begin_layout Description
26406 \begin_inset Flex Code
26409 \begin_layout Plain Layout
26415 The back part of the rotation command.
26418 \begin_layout Standard
26419 The value string of the
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26429 command supports additionally the following substitutions if they are enabled
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26441 \begin_inset Flex Code
26444 \begin_layout Plain Layout
26453 \begin_layout Description
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26466 \begin_layout Description
26467 \begin_inset Flex Code
26470 \begin_layout Plain Layout
26479 \begin_layout Description
26480 \begin_inset Flex Code
26483 \begin_layout Plain Layout
26492 \begin_layout Description
26493 \begin_inset Flex Code
26496 \begin_layout Plain Layout
26502 The rotation option.
26505 \begin_layout Standard
26506 You may ask why there are so many path macros.
26507 There are mainly two reasons:
26510 \begin_layout Enumerate
26511 Relative and absolute file names should remain relative or absolute, respectivel
26513 Users may have reasons to prefer either form.
26514 Relative names are useful for portable documents that should work on different
26515 machines, for example.
26516 Absolute names may be required by some programs.
26519 \begin_layout Enumerate
26521 treats relative file names differently than \SpecialChar LyX
26522 and other programs in nested
26524 For \SpecialChar LyX
26525 , a relative file name is always relative to the document that contains
26527 For \SpecialChar LaTeX
26528 , it is always relative to the master document.
26529 These two definitions are identical if you have only one document, but
26530 differ if you have a master document that includes part documents.
26531 That means that relative filenames must be transformed when presented to
26534 Fortunately \SpecialChar LyX
26535 does this automatically for you if you choose the right macros.
26538 \begin_layout Standard
26539 So which path macro should be used in new template definitions? The rule
26543 \begin_layout Itemize
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26554 if an absolute path is required.
26557 \begin_layout Itemize
26559 \begin_inset Flex Code
26562 \begin_layout Plain Layout
26563 $$AbsOrRelPathMaster
26568 if the substituted string is some kind of \SpecialChar LaTeX
26572 \begin_layout Itemize
26574 \begin_inset Flex Code
26577 \begin_layout Plain Layout
26578 $$AbsOrRelPathParent
26583 in order to preserve the user's choice.
26586 \begin_layout Standard
26587 There are special cases where this rule does not work and e.
26588 \begin_inset space \thinspace{}
26592 \begin_inset space \space{}
26595 relative names are needed, but normally it will work just fine.
26596 One example for such a case is the command
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26601 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26606 in the XFig template above: We can't use the absolute name because the
26608 \begin_inset Flex Code
26611 \begin_layout Plain Layout
26617 files needs the relative name in order to rewrite the file content.
26620 \begin_layout Section
26621 Security discussion
26622 \begin_inset CommandInset label
26624 name "sec:Security-discussion"
26631 \begin_layout Standard
26632 The external material feature interfaces with a lot of external programs
26633 and does so automatically, so we have to consider the security implications
26635 In particular, since you have the option of including your own filenames
26636 and/or parameter strings and those are expanded into a command, it seems
26637 that it would be possible to create a malicious document which executes
26638 arbitrary commands when a user views or prints the document.
26639 This is something we definitely want to avoid.
26642 \begin_layout Standard
26643 However, since the external program commands are specified in the template
26644 configuration file only, there are no security issues if \SpecialChar LyX
26645 is properly configure
26646 d with safe templates only.
26647 This is so because the external programs are invoked with the
26648 \begin_inset Flex Code
26651 \begin_layout Plain Layout
26657 -system call rather than the
26658 \begin_inset Flex Code
26661 \begin_layout Plain Layout
26667 system-call, so it's not possible to execute arbitrary commands from the
26668 filename or parameter section via the shell.
26671 \begin_layout Standard
26672 This also implies that you are restricted in what command strings you can
26673 use in the external material templates.
26674 In particular, pipes and redirection are not readily available.
26675 This has to be so if \SpecialChar LyX
26676 should remain safe.
26677 If you want to use some of the shell features, you should write a safe
26678 script to do this in a controlled manner, and then invoke the script from
26679 the command string.
26683 \begin_layout Standard
26684 It is possible to design a template that interacts directly with the shell,
26685 but since this would allow a malicious user to execute arbitrary commands
26686 by writing clever filenames and/or parameters, we generally recommend that
26687 you only use safe scripts that work with the
26688 \begin_inset Flex Code
26691 \begin_layout Plain Layout
26697 system call in a controlled manner.
26698 Of course, for use in a controlled environment, it can be tempting to just
26699 fall back to use ordinary shell scripts.
26700 If you do so, be aware that you
26704 provide an easily exploitable security hole in your system.
26705 Of course it stands to reason that such unsafe templates will never be
26706 included in the standard \SpecialChar LyX
26707 distribution, although we do encourage people
26708 to submit new templates in the open source tradition.
26709 But \SpecialChar LyX
26710 as shipped from the official distribution channels will never have
26714 \begin_layout Standard
26715 Including external material provides a lot of power, and you have to be
26716 careful not to introduce security hazards with this power.
26717 A subtle error in a single line in an innocent looking script can open
26718 the door to huge security problems.
26719 So if you do not fully understand the issues, we recommend that you consult
26720 a knowledgeable security professional or the \SpecialChar LyX
26721 development team if you have
26722 any questions about whether a given template is safe or not.
26723 And do this before you use it in an uncontrolled environment.
26726 \begin_layout Chapter
26728 List of supported \SpecialChar LyX
26729 functions to be used in layouts
26730 \begin_inset CommandInset label
26732 name "chap:List-of-functions"
26739 \begin_layout Standard
26741 \begin_inset Tabular
26742 <lyxtabular version="3" rows="11" columns="8">
26743 <features tabularvalignment="middle">
26744 <column alignment="left" valignment="top">
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">
26753 <cell alignment="left" valignment="top" usebox="none">
26756 \begin_layout Plain Layout
26762 <cell alignment="left" valignment="top" usebox="none">
26765 \begin_layout Plain Layout
26771 <cell alignment="left" valignment="top" usebox="none">
26774 \begin_layout Plain Layout
26780 <cell alignment="left" valignment="top" usebox="none">
26783 \begin_layout Plain Layout
26789 <cell alignment="center" valignment="top" usebox="none">
26792 \begin_layout Plain Layout
26798 <cell alignment="center" valignment="top" usebox="none">
26801 \begin_layout Plain Layout
26807 <cell alignment="center" valignment="top" usebox="none">
26810 \begin_layout Plain Layout
26816 <cell alignment="center" valignment="top" usebox="none">
26819 \begin_layout Plain Layout
26827 <cell alignment="left" valignment="top" usebox="none">
26830 \begin_layout Plain Layout
26836 <cell alignment="left" valignment="top" usebox="none">
26839 \begin_layout Plain Layout
26845 <cell alignment="left" valignment="top" usebox="none">
26848 \begin_layout Plain Layout
26854 <cell alignment="left" valignment="top" usebox="none">
26857 \begin_layout Plain Layout
26863 <cell alignment="center" valignment="top" usebox="none">
26866 \begin_layout Plain Layout
26872 <cell alignment="center" valignment="top" usebox="none">
26875 \begin_layout Plain Layout
26881 <cell alignment="center" valignment="top" usebox="none">
26884 \begin_layout Plain Layout
26890 <cell alignment="center" valignment="top" usebox="none">
26893 \begin_layout Plain Layout
26901 <cell alignment="left" valignment="top" usebox="none">
26904 \begin_layout Plain Layout
26910 <cell alignment="left" valignment="top" usebox="none">
26913 \begin_layout Plain Layout
26919 <cell alignment="left" valignment="top" usebox="none">
26922 \begin_layout Plain Layout
26928 <cell alignment="left" valignment="top" usebox="none">
26931 \begin_layout Plain Layout
26937 <cell alignment="center" valignment="top" usebox="none">
26940 \begin_layout Plain Layout
26946 <cell alignment="center" valignment="top" usebox="none">
26949 \begin_layout Plain Layout
26955 <cell alignment="center" valignment="top" usebox="none">
26958 \begin_layout Plain Layout
26964 <cell alignment="center" valignment="top" usebox="none">
26967 \begin_layout Plain Layout
26975 <cell alignment="left" valignment="top" usebox="none">
26978 \begin_layout Plain Layout
26984 <cell alignment="left" valignment="top" usebox="none">
26987 \begin_layout Plain Layout
26993 <cell alignment="left" valignment="top" usebox="none">
26996 \begin_layout Plain Layout
27002 <cell alignment="left" valignment="top" usebox="none">
27005 \begin_layout Plain Layout
27011 <cell alignment="center" valignment="top" usebox="none">
27014 \begin_layout Plain Layout
27020 <cell alignment="center" valignment="top" usebox="none">
27023 \begin_layout Plain Layout
27029 <cell alignment="center" valignment="top" usebox="none">
27032 \begin_layout Plain Layout
27038 <cell alignment="center" valignment="top" usebox="none">
27041 \begin_layout Plain Layout
27049 <cell alignment="left" valignment="top" usebox="none">
27052 \begin_layout Plain Layout
27058 <cell alignment="left" valignment="top" usebox="none">
27061 \begin_layout Plain Layout
27067 <cell alignment="left" valignment="top" usebox="none">
27070 \begin_layout Plain Layout
27076 <cell alignment="left" valignment="top" usebox="none">
27079 \begin_layout Plain Layout
27085 <cell alignment="center" valignment="top" usebox="none">
27088 \begin_layout Plain Layout
27094 <cell alignment="center" valignment="top" usebox="none">
27097 \begin_layout Plain Layout
27103 <cell alignment="center" valignment="top" usebox="none">
27106 \begin_layout Plain Layout
27112 <cell alignment="center" valignment="top" usebox="none">
27115 \begin_layout Plain Layout
27123 <cell alignment="left" valignment="top" usebox="none">
27126 \begin_layout Plain Layout
27132 <cell alignment="left" valignment="top" usebox="none">
27135 \begin_layout Plain Layout
27141 <cell alignment="left" valignment="top" usebox="none">
27144 \begin_layout Plain Layout
27150 <cell alignment="left" valignment="top" usebox="none">
27153 \begin_layout Plain Layout
27159 <cell alignment="center" valignment="top" usebox="none">
27162 \begin_layout Plain Layout
27168 <cell alignment="center" valignment="top" usebox="none">
27171 \begin_layout Plain Layout
27177 <cell alignment="center" valignment="top" usebox="none">
27180 \begin_layout Plain Layout
27186 <cell alignment="center" valignment="top" usebox="none">
27189 \begin_layout Plain Layout
27197 <cell alignment="left" valignment="top" usebox="none">
27200 \begin_layout Plain Layout
27206 <cell alignment="left" valignment="top" usebox="none">
27209 \begin_layout Plain Layout
27215 <cell alignment="left" valignment="top" usebox="none">
27218 \begin_layout Plain Layout
27224 <cell alignment="left" valignment="top" usebox="none">
27227 \begin_layout Plain Layout
27233 <cell alignment="center" valignment="top" usebox="none">
27236 \begin_layout Plain Layout
27242 <cell alignment="center" valignment="top" usebox="none">
27245 \begin_layout Plain Layout
27251 <cell alignment="center" valignment="top" usebox="none">
27254 \begin_layout Plain Layout
27260 <cell alignment="center" valignment="top" usebox="none">
27263 \begin_layout Plain Layout
27271 <cell alignment="left" valignment="top" usebox="none">
27274 \begin_layout Plain Layout
27280 <cell alignment="left" valignment="top" usebox="none">
27283 \begin_layout Plain Layout
27289 <cell alignment="left" valignment="top" usebox="none">
27292 \begin_layout Plain Layout
27298 <cell alignment="left" valignment="top" usebox="none">
27301 \begin_layout Plain Layout
27307 <cell alignment="center" valignment="top" usebox="none">
27310 \begin_layout Plain Layout
27316 <cell alignment="center" valignment="top" usebox="none">
27319 \begin_layout Plain Layout
27325 <cell alignment="center" valignment="top" usebox="none">
27328 \begin_layout Plain Layout
27334 <cell alignment="center" valignment="top" usebox="none">
27337 \begin_layout Plain Layout
27345 <cell alignment="left" valignment="top" usebox="none">
27348 \begin_layout Plain Layout
27354 <cell alignment="left" valignment="top" usebox="none">
27357 \begin_layout Plain Layout
27363 <cell alignment="left" valignment="top" usebox="none">
27366 \begin_layout Plain Layout
27372 <cell alignment="left" valignment="top" usebox="none">
27375 \begin_layout Plain Layout
27381 <cell alignment="center" valignment="top" usebox="none">
27384 \begin_layout Plain Layout
27390 <cell alignment="center" valignment="top" usebox="none">
27393 \begin_layout Plain Layout
27399 <cell alignment="center" valignment="top" usebox="none">
27402 \begin_layout Plain Layout
27408 <cell alignment="center" valignment="top" usebox="none">
27411 \begin_layout Plain Layout
27419 <cell alignment="left" valignment="top" usebox="none">
27422 \begin_layout Plain Layout
27428 <cell alignment="left" valignment="top" usebox="none">
27431 \begin_layout Plain Layout
27437 <cell alignment="left" valignment="top" usebox="none">
27440 \begin_layout Plain Layout
27446 <cell alignment="left" valignment="top" usebox="none">
27449 \begin_layout Plain Layout
27455 <cell alignment="center" valignment="top" usebox="none">
27458 \begin_layout Plain Layout
27464 <cell alignment="center" valignment="top" usebox="none">
27467 \begin_layout Plain Layout
27473 <cell alignment="center" valignment="top" usebox="none">
27476 \begin_layout Plain Layout
27482 <cell alignment="center" valignment="top" usebox="none">
27485 \begin_layout Plain Layout
27493 <cell alignment="center" valignment="top" usebox="none">
27496 \begin_layout Plain Layout
27502 <cell alignment="center" valignment="top" usebox="none">
27505 \begin_layout Plain Layout
27511 <cell alignment="center" valignment="top" usebox="none">
27514 \begin_layout Plain Layout
27520 <cell alignment="center" valignment="top" usebox="none">
27523 \begin_layout Plain Layout
27529 <cell alignment="center" valignment="top" usebox="none">
27532 \begin_layout Plain Layout
27538 <cell alignment="center" valignment="top" usebox="none">
27541 \begin_layout Plain Layout
27547 <cell alignment="center" valignment="top" usebox="none">
27550 \begin_layout Plain Layout
27556 <cell alignment="center" valignment="top" usebox="none">
27559 \begin_layout Plain Layout
27573 \begin_layout Chapter
27574 Names of available colors to be used in layouts
27575 \begin_inset CommandInset label
27577 name "chap:Names-of-colors"
27584 \begin_layout Standard
27585 The colors listed below are the standard colors and those that you can adjust
27586 in the \SpecialChar LyX
27590 \begin_layout Section
27594 \begin_layout Standard
27595 The following are no real colors, but rather act on color definitions:
27598 \begin_layout Description
27599 ignore The color is ignored
27602 \begin_layout Description
27603 inherit The color is inherited
27606 \begin_layout Description
27619 No particular color – clear or default
27622 \begin_layout Section
27626 \begin_layout Standard
27627 These are fixed colors that cannot me customized:
27630 \begin_layout Description
27634 \begin_layout Description
27638 \begin_layout Description
27642 \begin_layout Description
27646 \begin_layout Description
27650 \begin_layout Description
27654 \begin_layout Description
27658 \begin_layout Description
27662 \begin_layout Description
27666 \begin_layout Description
27670 \begin_layout Description
27674 \begin_layout Description
27678 \begin_layout Description
27682 \begin_layout Description
27686 \begin_layout Description
27690 \begin_layout Description
27694 \begin_layout Description
27698 \begin_layout Description
27702 \begin_layout Description
27706 \begin_layout Section
27710 \begin_layout Standard
27711 These are the colors allocated to specific elements in
27714 arg "dialog-show prefs"
27720 \begin_layout Description
27721 added_space Added space color
27724 \begin_layout Description
27725 addedtext Added text color
27728 \begin_layout Description
27729 appendix Appendix marker color
27732 \begin_layout Description
27733 background Background color
27736 \begin_layout Description
27737 bottomarea Bottom area color
27740 \begin_layout Description
27741 branchlabel Label color for branches
27744 \begin_layout Description
27745 buttonbg Color used for button background
27748 \begin_layout Description
27749 buttonframe Color for inset button frames
27752 \begin_layout Description
27753 buttonhoverbg Color used for button background under focus
27756 \begin_layout Description
27757 changebar Changebar color
27760 \begin_layout Description
27761 changedtextauthor1 Changed text color author 1
27764 \begin_layout Description
27765 changedtextauthor2 Changed text color author 2
27768 \begin_layout Description
27769 changedtextauthor3 Changed text color author 3
27772 \begin_layout Description
27773 changedtextauthor4 Changed text color author 4
27776 \begin_layout Description
27777 changedtextauthor5 Changed text color author 5
27780 \begin_layout Description
27781 collapsible Collapsible insets text color
27784 \begin_layout Description
27785 collapsibleframe Collapsible insets framecolor
27788 \begin_layout Description
27789 command Text color for command insets
27792 \begin_layout Description
27793 commandbg Background color for command insets
27796 \begin_layout Description
27797 commandframe Frame color for command insets
27800 \begin_layout Description
27801 commentbg Background color of comments
27804 \begin_layout Description
27805 commentlabel Label color for comments
27808 \begin_layout Description
27809 cursor Cursor color
27812 \begin_layout Description
27813 deletedtext Deleted text color
27816 \begin_layout Description
27817 deletedtextmodifier Deleted text modifying color
27820 \begin_layout Description
27821 depthbar Color for the depth bars in the margin
27824 \begin_layout Description
27825 eolmarker End of line marker color
27828 \begin_layout Description
27829 error Color of the \SpecialChar LaTeX
27833 \begin_layout Description
27834 footlabel Label color for footnotes
27837 \begin_layout Description
27838 foreground Foreground color
27841 \begin_layout Description
27842 graphicsbg Graphics inset background color
27845 \begin_layout Description
27846 greyedoutbg Background color of greyedout inset
27849 \begin_layout Description
27850 greyedoutlabel Label color for greyedout insets
27853 \begin_layout Description
27854 greyedouttext Color for greyedout inset text
27857 \begin_layout Description
27858 indexlabel Label color for index insets
27861 \begin_layout Description
27862 inlinecompletion Inline completion color
27865 \begin_layout Description
27866 insetbg Inset marker background color
27869 \begin_layout Description
27870 insetframe Inset marker frame color
27873 \begin_layout Description
27874 language Color for marking foreign language words
27877 \begin_layout Description
27878 latex Text color in \SpecialChar LaTeX
27882 \begin_layout Description
27883 listingsbg Background color of listings inset
27886 \begin_layout Description
27887 marginlabel Label color for margin notes
27890 \begin_layout Description
27891 math Math inset text color
27894 \begin_layout Description
27895 mathbg Math inset background color
27898 \begin_layout Description
27899 mathcorners Math inset frame color not under focus
27902 \begin_layout Description
27903 mathframe Math inset frame color under focus
27906 \begin_layout Description
27907 mathline Math line color
27910 \begin_layout Description
27911 mathmacrobg Macro math inset background color
27914 \begin_layout Description
27915 mathmacroblend Macro math blended color
27918 \begin_layout Description
27919 mathmacroframe Macro math frame color
27922 \begin_layout Description
27923 mathmacrohoverbg Macro math inset background color hovered
27926 \begin_layout Description
27927 mathmacrolabel Macro math label color
27930 \begin_layout Description
27931 mathmacronewarg Macro template color for new parameters
27934 \begin_layout Description
27935 mathmacrooldarg Macro template color for old parameters
27938 \begin_layout Description
27939 newpage New page color
27942 \begin_layout Description
27943 nonunique_inlinecompletion Inline completion color for the non-unique part
27946 \begin_layout Description
27947 notebg Background color of notes
27950 \begin_layout Description
27951 notelabel Label color for notes
27954 \begin_layout Description
27955 pagebreak Page break/line break color
27958 \begin_layout Description
27959 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
27962 \begin_layout Description
27963 phantomtext Text color for phantom insets
27966 \begin_layout Description
27967 preview The color used for previews
27970 \begin_layout Description
27971 previewframe Preview frame color
27974 \begin_layout Description
27975 regexpframe Color for regexp frame
27978 \begin_layout Description
27979 scroll Color that indicates when a row can be scrolled
27982 \begin_layout Description
27983 selection Background color of selected text
27986 \begin_layout Description
27987 selectiontext Foreground color of selected text
27990 \begin_layout Description
27991 shadedbg Background color of shaded box
27994 \begin_layout Description
27995 special Special chars text color
27998 \begin_layout Description
27999 tabularline Table line color
28002 \begin_layout Description
28003 tabularonoffline Table line color
28006 \begin_layout Description
28007 urllabel Label color for URL insets
28010 \begin_layout Description
28011 urltext Color for URL inset text