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 true
128 \output_changes false
132 \author -712698321 "Jürgen Spitzmüller"
138 Customizing \SpecialChar LyX
139 : Features for the Advanced User
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset CommandInset href
155 target "lyx-docs@lists.lyx.org"
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
170 in the subject header, and please cc the current maintainer of this file,
171 Richard Heck <rgheck@comcast.net>.
177 \begin_inset Newline newline
181 \begin_inset Newline newline
187 \begin_layout Standard
188 \begin_inset CommandInset toc
189 LatexCommand tableofcontents
196 \begin_layout Standard
197 \begin_inset Note Note
200 \begin_layout Plain Layout
201 Please use change tracking when modifying this document.
202 This makes it easier for our translators to recognize things that have
203 been changed, and it helps the maintainer keep up-to-date with what's been
212 \begin_layout Chapter
216 \begin_layout Standard
217 This manual covers the customization features present in \SpecialChar LyX
219 In it, we discuss issues like keyboard shortcuts, screen previewing options,
220 printer options, sending commands to \SpecialChar LyX
221 via the \SpecialChar LyX
222 Server, internationalization,
223 installing new \SpecialChar LaTeX
224 classes and \SpecialChar LyX
226 We can't possibly hope to touch on everything you can change—our developers
227 add new features faster than we can document them—but we will explain the
228 most common customizations and hopefully point you in the right direction
229 for some of the more obscure ones.
232 \begin_layout Standard
233 \begin_inset Branch OutDated
237 \begin_layout Standard
238 Information from previous versions of this document that now seems to be
239 outdated is contained in the OutDated branch of this document.
240 By default, this information will not appear in the \SpecialChar LaTeX
249 \begin_layout Chapter
254 \begin_layout Standard
255 This chapter aims to help you to find your way through the \SpecialChar LyX
258 Before continuing to read this chapter, you should find out where your
260 library and user directories are by using
261 \begin_inset Flex Noun
264 \begin_layout Plain Layout
265 Help\SpecialChar menuseparator
276 The library directory is the place where \SpecialChar LyX
277 places its system-wide configuration
278 files; the user directory is where you can place your modified versions.
279 We will call the former
280 \begin_inset Flex Code
283 \begin_layout Plain Layout
290 \begin_inset Flex Noun
293 \begin_layout Plain Layout
299 in the remainder of this document.
303 \begin_layout Section
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
317 \begin_layout Standard
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
327 and its sub-directories contain a number of files and that can be used
328 to customize \SpecialChar LyX
330 You can change many of these files from within \SpecialChar LyX
332 \begin_inset Flex Noun
335 \begin_layout Plain Layout
336 Tools\SpecialChar menuseparator
343 Most customization that you will want to do in \SpecialChar LyX
344 is possible through this
346 However, many other inner aspects of \SpecialChar LyX
347 can be customized by modifying the
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
359 These files fall in different categories, described in the following subsection
363 \begin_layout Subsection
364 Automatically generated files
367 \begin_layout Standard
368 The files, which are to be found in
369 \begin_inset Flex Noun
372 \begin_layout Plain Layout
378 , are generated when you configure \SpecialChar LyX
380 They contain various default values that are guessed by inspection.
381 In general, it is not a good idea to modify them, since they might be overwritt
385 \begin_layout Labeling
386 \labelwidthstring 00.00.0000
387 \begin_inset Flex Code
390 \begin_layout Plain Layout
396 contains defaults for various commands.
399 \begin_layout Labeling
400 \labelwidthstring 00.00.0000
401 \begin_inset Flex Code
404 \begin_layout Plain Layout
410 contains the list of packages that have been recognized by \SpecialChar LyX
412 It is currently unused by the \SpecialChar LyX
413 program itself, but the information extracted,
414 and more, is made available with
415 \begin_inset Flex Noun
418 \begin_layout Plain Layout
419 Help\SpecialChar menuseparator
433 \begin_layout Labeling
434 \labelwidthstring 00.00.0000
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 the list of text classes that have been found in your
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 directories, along with the associated \SpecialChar LaTeX
455 document class and their description.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of layout modules found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Labeling
483 \labelwidthstring 00.00.0000
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 lists of various sorts of \SpecialChar LaTeX
494 -related files found on your system
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
503 doc/\SpecialChar LaTeX
509 is automatically generated during configuration from the file
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
521 It contains information on your \SpecialChar LaTeX
525 \begin_layout Subsection
529 \begin_layout Standard
530 These directories are duplicated between
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 If a particular files exists in both places, the one in
552 \begin_inset Flex Code
555 \begin_layout Plain Layout
564 \begin_layout Labeling
565 \labelwidthstring 00.00.0000
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 this directory contains files with the extension
576 \begin_inset Flex Code
579 \begin_layout Plain Layout
585 that define the keybindings used in \SpecialChar LyX
587 If there exists an internationalized version of the bind file named
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 , that will be used first.
600 \begin_layout Labeling
601 \labelwidthstring 00.00.0000
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
611 contains files with the extension
612 \begin_inset Flex Code
615 \begin_layout Plain Layout
621 which define the diverse citation possibilities (natbib, biblatex etc.).
623 \begin_inset CommandInset ref
625 reference "subsec:Cite-Engine-Files"
635 \begin_layout Labeling
636 \labelwidthstring 00.00.0000
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 contains graphics files that can be included in documents.
650 \begin_layout Labeling
651 \labelwidthstring 00.00.0000
652 \begin_inset Flex Code
655 \begin_layout Plain Layout
661 contains \SpecialChar LyX
662 documentation files (including the one you are currently reading).
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
674 deserves special attention, as noted above.
675 The internationalized help docs are in subdirectories
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
686 \begin_inset Quotes eld
690 \begin_inset Quotes erd
693 is the ISO language code.
695 \begin_inset CommandInset ref
697 reference "cha:Internationalizing-LyX"
704 \begin_layout Labeling
705 \labelwidthstring 00.00.0000
706 \begin_inset Flex Code
709 \begin_layout Plain Layout
715 contains example files that explain how to use some features.
716 In the file browser, press the
717 \begin_inset Flex Noun
720 \begin_layout Plain Layout
729 \begin_layout Labeling
730 \labelwidthstring 00.00.0000
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
740 contains image files that are used by the
741 \begin_inset Flex Noun
744 \begin_layout Plain Layout
751 In addition, it also contains the individual icons used in the toolbar
752 and the banners that can be shown when \SpecialChar LyX
756 \begin_layout Labeling
757 \labelwidthstring 00.00.0000
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
767 contains keyboard keymapping files.
769 \begin_inset CommandInset ref
771 reference "sec:International-Keymap-Stuff"
778 \begin_layout Labeling
779 \labelwidthstring 00.00.0000
780 \begin_inset Flex Code
783 \begin_layout Plain Layout
789 contains the text class and module files described in
790 \begin_inset CommandInset ref
792 reference "cha:Installing-New-Document"
799 \begin_layout Labeling
800 \labelwidthstring 00.00.0000
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
820 Python scripts used to convert between \SpecialChar LyX
822 These can be run from the command line if, say, you want to batch-convert
826 \begin_layout Labeling
827 \labelwidthstring 00.00.0000
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
837 contains some files that demonstrate the capabilities of the
838 \begin_inset Flex Noun
841 \begin_layout Plain Layout
852 Also contains some scripts used by \SpecialChar LyX
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 contains the standard \SpecialChar LyX
868 template files described in
869 \begin_inset CommandInset ref
871 reference "subsec:Creating-Templates"
878 \begin_layout Labeling
879 \labelwidthstring 00.00.0000
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 contains files with the extension
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 that define the user interface to \SpecialChar LyX
901 That is, the files define which items appear in which menus and the items
902 appearing on the toolbar.
905 \begin_layout Labeling
906 \labelwidthstring 00.00.0000
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 contains files with the extension
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
926 which define the templates for the insertion of external material to a
929 \begin_inset CommandInset ref
931 reference "chap:Including-External-Material"
938 \begin_layout Subsection
939 Files you don't want to modify
942 \begin_layout Standard
943 These files are used internally by \SpecialChar LyX
944 and you generally do not need to modify
945 them unless you are a developer.
948 \begin_layout Labeling
949 \labelwidthstring 00.00.0000
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 this file contains the list of \SpecialChar LyX
961 The contents are displayed with the menu entry
962 \begin_inset Flex Noun
965 \begin_layout Plain Layout
966 Help\SpecialChar menuseparator
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 this is a \SpecialChar LaTeX
991 script used during the configuration process.
995 \begin_layout Labeling
996 \labelwidthstring 00.00.0000
997 \begin_inset Flex Code
1000 \begin_layout Plain Layout
1006 this is a Python script that is used to re-configure \SpecialChar LyX
1008 It creates configuration files in the directory it was run from.
1011 \begin_layout Subsection
1012 Other files needing a line or two
1015 \begin_layout Labeling
1016 \labelwidthstring 00.00.0000
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 this contains tables describing how different character encodings can be
1030 \begin_layout Labeling
1031 \labelwidthstring 00.00.0000
1032 \begin_inset Flex Code
1035 \begin_layout Plain Layout
1041 this file contains a list of all the languages currently supported by \SpecialChar LyX
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1056 contains information about the supported fonts.
1059 \begin_layout Labeling
1060 \labelwidthstring 00.00.0000
1061 \begin_inset Flex Code
1064 \begin_layout Plain Layout
1070 this file contains translations for internationalized paragraph styles
1072 \begin_inset CommandInset ref
1074 reference "subsec:I18n"
1081 \begin_layout Labeling
1082 \labelwidthstring 00.00.0000
1083 \begin_inset Flex Code
1086 \begin_layout Plain Layout
1092 this file contains information about Unicode-encoded glyphs and the way
1093 they are supported by \SpecialChar LyX
1094 via \SpecialChar LaTeX
1098 \begin_layout Section
1099 Your local configuration directory
1102 \begin_layout Standard
1103 Even if you are using \SpecialChar LyX
1104 as an unprivileged user, you might want to change
1106 configuration for your own use.
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1117 directory contains all your personal configuration files.
1118 This is the directory described as
1119 \begin_inset Quotes eld
1123 \begin_inset Quotes erd
1127 \begin_inset Flex Noun
1130 \begin_layout Plain Layout
1131 Help\SpecialChar menuseparator
1133 \begin_inset space ~
1142 This directory is used as a mirror of
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 , which means that every file in
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 is a replacement for the corresponding file in
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1173 Any configuration file described in the above sections can be placed either
1174 in the system-wide directory, in which case it will affect all users, or
1175 in your local directory for your own use.
1178 \begin_layout Standard
1179 To make things clearer, let's provide a few examples:
1182 \begin_layout Itemize
1183 The preferences set in the
1184 \begin_inset Flex Noun
1187 \begin_layout Plain Layout
1188 Tools\SpecialChar menuseparator
1194 dialog are saved to a file
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1217 \begin_layout Itemize
1218 When you reconfigure using
1219 \begin_inset Flex Noun
1222 \begin_layout Plain Layout
1223 Tools\SpecialChar menuseparator
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 script, and the resulting files are written in your local configuration
1242 This means that any additional text class file that you might have added
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1253 will be added to the list of classes in the
1254 \begin_inset Flex Noun
1257 \begin_layout Plain Layout
1258 Document\SpecialChar menuseparator
1267 \begin_layout Itemize
1268 If you get some updated documentation from \SpecialChar LyX
1269 ftp site and cannot install
1270 it because you do not have sysadmin rights on your system, you can just
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1281 and the items in the
1282 \begin_inset Flex Noun
1285 \begin_layout Plain Layout
1291 menu will open them!
1294 \begin_layout Section
1295 Running \SpecialChar LyX
1296 with multiple configurations
1299 \begin_layout Standard
1300 The configuration freedom of the local configuration directory may not suffice
1301 if you want to have more than one configuration at your disposal.
1302 For example, you may want to be use different key bindings or printer settings
1304 You can achieve this by having several such directories.
1305 You then specify which directory to use at run-time.
1308 \begin_layout Standard
1309 Invoking \SpecialChar LyX
1310 with the command line switch
1311 \begin_inset Flex Code
1314 \begin_layout Plain Layout
1324 instructs the program to read the configuration from that directory, and
1325 not from the default directory.
1326 (You can determine the default directory by running \SpecialChar LyX
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1337 switch.) If the specified directory does not exist, \SpecialChar LyX
1339 for you, just like it does for the default directory on the first time
1340 you run the program.
1341 You can modify the configuration options in this additional user directory
1342 exactly as you would for the default directory.
1343 These directories are completely independent (but read on).
1344 Note that setting the environment variable
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1354 to some value has exactly the same effect.
1357 \begin_layout Standard
1358 Having several configurations also requires more maintenance: if you want
1359 to add a new layout to
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 which you want available from all your configurations, you must add it
1370 to each directory separately.
1371 You can avoid this with the following trick: after \SpecialChar LyX
1372 creates the additional
1373 directory, most of the subdirectories (see above) are empty.
1374 If you want the new configuration to mirror an existing one, replace the
1375 empty subdirectory with a symbolic link to the matching subdirectory in
1376 the existing configuration.
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1387 subdirectory, however, since it contains a file written by the configuration
1388 script (also accessible through
1389 \begin_inset Flex Noun
1392 \begin_layout Plain Layout
1393 Tools\SpecialChar menuseparator
1399 ) which is configuration-specific.
1402 \begin_layout Chapter
1403 The Preferences dialog
1406 \begin_layout Standard
1407 All options of the preferences dialog are described in the Appendix
1409 The Preferences Dialog
1416 For some options you might find here more details.
1419 \begin_layout Section
1421 \begin_inset CommandInset label
1430 \begin_layout Standard
1431 The first step is to define your file formats if they are not already defined.
1433 \begin_inset Flex Noun
1436 \begin_layout Plain Layout
1437 Tools\SpecialChar menuseparator
1445 \begin_inset Flex Noun
1448 \begin_layout Plain Layout
1449 File Handling\SpecialChar menuseparator
1456 \begin_inset Flex Noun
1459 \begin_layout Plain Layout
1465 button to define your new format.
1467 \begin_inset Flex Noun
1470 \begin_layout Plain Layout
1476 field contains the name used to identify the format in the GUI.
1478 \begin_inset Flex Noun
1481 \begin_layout Plain Layout
1487 is used to identify the format internally.
1488 You will also need to enter a file extension.
1489 These are all required.
1491 \begin_inset Flex Noun
1494 \begin_layout Plain Layout
1500 field is used to provide a keyboard shortcut on the menus.
1501 (For example, pressing
1502 \begin_inset Flex Noun
1505 \begin_layout Plain Layout
1512 \begin_inset Flex Noun
1515 \begin_layout Plain Layout
1516 Document\SpecialChar menuseparator
1517 View (Other Formats)\SpecialChar menuseparator
1526 \begin_layout Standard
1528 \begin_inset Flex Noun
1531 \begin_layout Plain Layout
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1548 For example, you might want to use
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1558 to view PostScript files.
1559 You can enter the command needed to start the program in the corresponding
1561 In defining this command, you can use the four variables listed in the
1563 The viewer is launched when you view an image in \SpecialChar LyX
1565 \begin_inset Flex Noun
1568 \begin_layout Plain Layout
1569 Document\SpecialChar menuseparator
1576 The editor is for example launched when you right-click on an image and
1578 \begin_inset Flex Noun
1581 \begin_layout Plain Layout
1587 in the appearing context menu.
1590 \begin_layout Standard
1592 \begin_inset Flex Noun
1595 \begin_layout Plain Layout
1601 type of a format is optional, but if it is specified, it must be unique
1603 It is used to detect files of this format from the file contents.
1604 For some important file formats there is no MIME type officially registered
1606 \begin_inset CommandInset href
1609 target "http://www.iana.org/assignments/media-types/"
1615 Therefore \SpecialChar LyX
1616 uses the extended list of MIME types as specified by
1617 \begin_inset CommandInset href
1619 name "freedesktop.org"
1620 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1628 \begin_layout Standard
1630 \begin_inset Flex Noun
1633 \begin_layout Plain Layout
1639 option tells \SpecialChar LyX
1640 that a format is suitable for document export.
1641 If this is set and if a suitable conversion route exists (see
1642 \begin_inset CommandInset ref
1644 reference "sec:Converters"
1648 ), the format will appear in the
1649 \begin_inset Flex Noun
1652 \begin_layout Plain Layout
1653 File\SpecialChar menuseparator
1660 The format will also appear in the
1661 \begin_inset Flex Noun
1664 \begin_layout Plain Layout
1665 Document\SpecialChar menuseparator
1671 menu if a viewer is specified for the format.
1672 Pure image formats, such as
1673 \begin_inset Flex Code
1676 \begin_layout Plain Layout
1682 , should not use this option.
1683 Formats that can both represent vector graphics and documents like
1684 \begin_inset Flex Code
1687 \begin_layout Plain Layout
1696 \begin_layout Standard
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Vector graphics format
1707 tells \SpecialChar LyX
1708 that a format can contain vector graphics.
1709 This information is used to determine the target format of included graphics
1711 \begin_inset Flex Noun
1714 \begin_layout Plain Layout
1721 Included graphics may need to be converted to either
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1752 \begin_inset Flex Noun
1755 \begin_layout Plain Layout
1761 cannot handle other image formats.
1762 If an included graphic is not already in
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1773 \begin_inset Flex Noun
1776 \begin_layout Plain Layout
1783 \begin_inset Flex Noun
1786 \begin_layout Plain Layout
1792 format, it is converted to
1793 \begin_inset Flex Noun
1796 \begin_layout Plain Layout
1802 if the vector format option is set, and otherwise to
1803 \begin_inset Flex Noun
1806 \begin_layout Plain Layout
1815 \begin_layout Section
1819 \begin_layout Standard
1820 Since all conversions from one format to another take place in \SpecialChar LyX
1822 directory, it is sometimes necessary to modify a file before copying it
1823 to the temporary directory in order that the conversion may be performed.
1827 \begin_layout Plain Layout
1828 For example, the file may refer to other files—images, for example—using
1829 relative file names, and these may become invalid when the file is copied
1830 to the temporary directory.
1835 This is done by a Copier: It copies a file to (or from) the temporary directory
1836 and may modify it in the process.
1839 \begin_layout Standard
1840 The definitions of the copiers may use eight variables:
1843 \begin_layout Labeling
1844 \labelwidthstring 00.00.0000
1845 \begin_inset Flex Code
1848 \begin_layout Plain Layout
1854 The \SpecialChar LyX
1855 system directory (e.
1856 \begin_inset space \thinspace{}
1860 \begin_inset space \space{}
1864 \begin_inset Flex Noun
1867 \begin_layout Plain Layout
1876 \begin_layout Labeling
1877 \labelwidthstring 00.00.0000
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1906 \begin_inset Flex Code
1909 \begin_layout Plain Layout
1915 The base name (without filename extension) in the \SpecialChar LyX
1919 \begin_layout Labeling
1920 \labelwidthstring 00.00.0000
1921 \begin_inset Flex Code
1924 \begin_layout Plain Layout
1930 The full directory path of the \SpecialChar LyX
1934 \begin_layout Labeling
1935 \labelwidthstring 00.00.0000
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1945 The full pathname to the original \SpecialChar LyX
1946 file being processed
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1960 The filename (without any directory path) of the \SpecialChar LyX
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The `\SpecialChar LaTeX
1979 \begin_layout Standard
1980 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1988 It is relevant only when exporting files suitable for such inclusion.
1991 \begin_layout Standard
1992 Copiers can be used to do almost anything with output files.
1993 For example, suppose you want generated pdf files to be copied to a special
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2005 Then you could write a shell script such as this one:
2008 \begin_layout Standard
2009 \begin_inset listings
2013 \begin_layout Plain Layout
2018 \begin_layout Plain Layout
2023 \begin_layout Plain Layout
2025 TOFILE=`basename $2`
2028 \begin_layout Plain Layout
2030 cp $FROMFILE /home/you/pdf/$TOFILE
2035 Save it in your local \SpecialChar LyX
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 /home/you/.lyx/scripts/pdfcopier.sh
2046 —and make it executable, if you need to do so on your platform.
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2052 Tools\SpecialChar menuseparator
2058 dialog, select under
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2063 File Handling\SpecialChar menuseparator
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2079 format—or one of the other pdf formats—and enter
2080 \begin_inset Flex Code
2083 \begin_layout Plain Layout
2084 pdfcopier.sh $$i $$o
2090 \begin_inset Flex Noun
2093 \begin_layout Plain Layout
2103 \begin_layout Standard
2104 Copiers are used by \SpecialChar LyX
2105 in various of its own conversions.
2106 For example, if appropriate programs are found, \SpecialChar LyX
2107 will automatically install
2109 \begin_inset Flex Noun
2112 \begin_layout Plain Layout
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2124 \begin_inset space ~
2133 When these formats are exported, the copier sees that not just the main
2134 HTML file but various associated files (style files, images, etc.) are also
2136 All these files are written to a subdirectory of the directory in which
2137 the original \SpecialChar LyX
2142 \begin_layout Plain Layout
2143 This copier can be customized.
2145 \begin_inset Quotes eld
2149 \begin_inset Quotes erd
2152 argument takes a comma-separated list of extensions to be copied; if it
2153 is omitted, all files will be copied.
2155 \begin_inset Quotes eld
2159 \begin_inset Quotes erd
2162 argument determines the extension added to the generated directory.
2164 \begin_inset Quotes eld
2168 \begin_inset Flex Noun
2171 \begin_layout Plain Layout
2178 \begin_inset Quotes erd
2181 , so HTML generated from
2182 \begin_inset Flex Noun
2185 \begin_layout Plain Layout
2186 /path/to/filename.lyx
2192 \begin_inset Flex Noun
2195 \begin_layout Plain Layout
2196 /path/to/filename.html.LyXconv
2210 \begin_layout Section
2212 \begin_inset CommandInset label
2214 name "sec:Converters"
2221 \begin_layout Standard
2222 You can define your own Converters to convert files between different formats.
2224 \begin_inset Flex Noun
2227 \begin_layout Plain Layout
2228 Tools\SpecialChar menuseparator
2229 Preferences\SpecialChar menuseparator
2230 File Handling\SpecialChar menuseparator
2239 \begin_layout Standard
2240 To define a new converter, select the
2241 \begin_inset Flex Noun
2244 \begin_layout Plain Layout
2246 \begin_inset space ~
2255 \begin_inset Flex Noun
2258 \begin_layout Plain Layout
2260 \begin_inset space ~
2268 from the drop-down lists, enter the command needed for the conversion,
2270 \begin_inset Flex Noun
2273 \begin_layout Plain Layout
2280 Several variables can be used in the definition of converters:
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The \SpecialChar LyX
2298 \begin_layout Labeling
2299 \labelwidthstring 00.00.0000
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2312 \begin_layout Labeling
2313 \labelwidthstring 00.00.0000
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2326 \begin_layout Labeling
2327 \labelwidthstring 00.00.0000
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 The base filename of the input file (i.
2338 \begin_inset space \thinspace{}
2341 g., without the extension)
2344 \begin_layout Labeling
2345 \labelwidthstring 00.00.0000
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2355 The path to the input file
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2369 The path to the original input file (this is different from $$p when a
2370 chain of converters is called)
2373 \begin_layout Labeling
2374 \labelwidthstring 00.00.0000
2375 \begin_inset Flex Code
2378 \begin_layout Plain Layout
2384 The iconv name for the encoding of the document.
2387 \begin_layout Standard
2389 \begin_inset Flex Noun
2392 \begin_layout Plain Layout
2394 \begin_inset space ~
2402 field you can enter the following flags, separated by commas:
2405 \begin_layout Labeling
2406 \labelwidthstring 00.00.0000
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2416 This converter runs some form of \SpecialChar LaTeX
2418 This will make \SpecialChar LyX
2419 's \SpecialChar LaTeX
2420 error logs available.
2423 \begin_layout Labeling
2424 \labelwidthstring 00.00.0000
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2434 Needs the \SpecialChar LaTeX
2436 \begin_inset Flex Noun
2439 \begin_layout Plain Layout
2445 file for the conversion.
2448 \begin_layout Labeling
2449 \labelwidthstring 00.00.0000
2450 \begin_inset Flex Code
2453 \begin_layout Plain Layout
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2467 file from the backend, which in practice means a \SpecialChar LaTeX
2468 file like the one we
2469 would export, without
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2496 \begin_layout Standard
2497 The following three flags are not really flags at all because they take
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2504 \begin_inset space ~
2508 \begin_inset space ~
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2522 \change_inserted -712698321 1523206314
2523 \begin_inset Flex Code
2526 \begin_layout Plain Layout
2528 \change_inserted -712698321 1523206193
2534 The name of the driver that needs to be loaded with the
2538 package for this converter.
2539 The loading of the correct driver is necessary to get some PDF-specific
2548 \begin_layout Labeling
2549 \labelwidthstring 00.00.0000
2550 \begin_inset Flex Code
2553 \begin_layout Plain Layout
2559 If set, the converter's standard error will be redirected to a file
2560 \begin_inset Flex Code
2563 \begin_layout Plain Layout
2569 , and the script given as argument will be run as:
2570 \begin_inset Flex Code
2573 \begin_layout Plain Layout
2574 script < infile.out > infile.log
2580 The argument may contain
2581 \begin_inset Flex Code
2584 \begin_layout Plain Layout
2593 \begin_layout Labeling
2594 \labelwidthstring 00.00.0000
2595 \begin_inset Flex Code
2598 \begin_layout Plain Layout
2604 The name of the directory in which the converter will dump the generated
2607 will not create this directory, and it does not copy anything into it,
2608 though it will copy this directory to the destination.
2609 The argument may contain
2610 \begin_inset Flex Code
2613 \begin_layout Plain Layout
2619 , which will be replaced by the base name of the input and output files,
2620 respectively, when the directory is copied.
2621 \begin_inset Newline newline
2624 Note that resultdir and usetempdir make no sense together.
2625 The latter will be ignored if the former is given.
2628 \begin_layout Labeling
2629 \labelwidthstring 00.00.0000
2630 \begin_inset Flex Code
2633 \begin_layout Plain Layout
2639 Determines the output file name and may, contain
2640 \begin_inset Flex Code
2643 \begin_layout Plain Layout
2650 Sensible only with resultdir and optional even then; if not given, it defaults
2654 \begin_layout Standard
2656 \change_inserted -712698321 1523206384
2657 A suitable hyperref-driver is set for some converters that are installed
2658 with \SpecialChar LyX
2661 \change_deleted -712698321 1523206388
2663 \change_inserted -712698321 1523206389
2667 \change_inserted -712698321 1523206400
2671 \change_inserted -712698321 1523206407
2675 \change_inserted -712698321 1523206437
2679 \change_deleted -712698321 1523206442
2680 that are installed with \SpecialChar LyX
2687 \begin_layout Standard
2688 You do not have to define converters for all formats between which you want
2690 For example, you will note that there is no `\SpecialChar LyX
2691 to PostScript' converter,
2692 but \SpecialChar LyX
2693 will export PostScript.
2694 It does so by first creating a \SpecialChar LaTeX
2695 file (no converter needs to be defined
2696 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2698 and finally converting the resulting DVI file to PostScript.
2700 finds such `chains' of converters automatically, and it will always choose
2701 the shortest possible chain.
2702 You can, though, still define multiple conversion methods between file
2704 For example, the standard \SpecialChar LyX
2705 configuration provides five ways to convert
2710 \begin_layout Enumerate
2712 \begin_inset Flex Noun
2715 \begin_layout Plain Layout
2724 \begin_layout Enumerate
2725 via (DVI and) PostScript, using
2726 \begin_inset Flex Noun
2729 \begin_layout Plain Layout
2738 \begin_layout Enumerate
2740 \begin_inset Flex Noun
2743 \begin_layout Plain Layout
2752 \begin_layout Enumerate
2754 \begin_inset Flex Noun
2757 \begin_layout Plain Layout
2767 \begin_layout Enumerate
2769 \begin_inset Flex Noun
2772 \begin_layout Plain Layout
2782 \begin_layout Standard
2783 To define such alternate chains, you must define multiple target `file formats',
2785 \begin_inset CommandInset ref
2787 reference "sec:Formats"
2792 For example, in the standard configuration, the formats named
2793 \begin_inset Flex Noun
2796 \begin_layout Plain Layout
2803 \begin_inset Flex Noun
2806 \begin_layout Plain Layout
2813 \begin_inset Flex Noun
2816 \begin_layout Plain Layout
2823 \begin_inset Flex Noun
2826 \begin_layout Plain Layout
2833 \begin_inset Flex Noun
2836 \begin_layout Plain Layout
2843 \begin_inset Flex Noun
2846 \begin_layout Plain Layout
2853 \begin_inset Flex Noun
2856 \begin_layout Plain Layout
2863 \begin_inset Flex Noun
2866 \begin_layout Plain Layout
2874 \begin_inset Flex Noun
2877 \begin_layout Plain Layout
2884 \begin_inset Flex Noun
2887 \begin_layout Plain Layout
2894 ) are defined, all of which share the extension
2895 \begin_inset Flex Noun
2898 \begin_layout Plain Layout
2904 , and which correspond to the conversion methods just mentioned.
2907 \begin_layout Chapter
2908 Internationalizing \SpecialChar LyX
2910 \begin_inset CommandInset label
2912 name "cha:Internationalizing-LyX"
2919 \begin_layout Standard
2921 supports using a translated interface.
2922 Last time we checked, \SpecialChar LyX
2923 provided text in thirty languages.
2924 The language of choice is called your
2929 (For further reading on locale settings, see also the documentation for
2930 locale that comes with your operating system.
2931 For Linux, the manual page for
2932 \begin_inset Flex Code
2935 \begin_layout Plain Layout
2941 could be a good place to start).
2944 \begin_layout Standard
2945 Notice that these translations will work, but do contain a few flaws.
2946 In particular, all dialogs have been designed with the English text in
2947 mind, which means that some of the translated text will be too large to
2948 fit within the space allocated.
2949 This is only a display problem and will not cause any harm.
2950 Also, you will find that some of the translations do not define shortcut
2951 keys for everything.
2952 Sometimes, there are simply not enough free letters to do it.
2953 Other times, the translator just hasn't got around to doing it yet.
2954 Our localization team, which you may wish to join,
2958 \begin_layout Plain Layout
2959 If you are a fluent speaker of a language other than English, joining these
2960 teams is a great way to give back to the \SpecialChar LyX
2966 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2970 \begin_layout Section
2971 Translating \SpecialChar LyX
2975 \begin_layout Subsection
2976 Translating the graphical user interface (text messages).
2979 \begin_layout Standard
2982 \begin_inset Flex Code
2985 \begin_layout Plain Layout
2991 library to handle the internationalization of the interface.
2992 To have \SpecialChar LyX
2993 speak your favorite language in all menus and dialogs, you need
2995 \begin_inset Flex Code
2998 \begin_layout Plain Layout
3004 -file for that language.
3005 When this is available, you'll have to generate a
3006 \begin_inset Flex Code
3009 \begin_layout Plain Layout
3015 -file from it and install the
3016 \begin_inset Flex Code
3019 \begin_layout Plain Layout
3026 The process of doing all of this is explained in the documentation for
3028 \begin_inset Flex Code
3031 \begin_layout Plain Layout
3038 It is possible to do this just for yourself, but if you're going to do
3039 it, you might as well share the results of your labors with the rest of
3040 the \SpecialChar LyX
3042 Send a message to the \SpecialChar LyX
3043 developers' list for more information about how
3047 \begin_layout Standard
3048 In short, this is what you should do (xx denotes the language code):
3051 \begin_layout Itemize
3052 Check out the \SpecialChar LyX
3055 \begin_inset CommandInset href
3057 name "information on the web"
3058 target "https://www.lyx.org/HowToUseGIT"
3066 \begin_layout Itemize
3068 \begin_inset Flex Code
3071 \begin_layout Plain Layout
3077 to the folder of the
3078 \begin_inset Flex Code
3081 \begin_layout Plain Layout
3089 \begin_inset Flex Code
3092 \begin_layout Plain Layout
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3109 doesn't exist anywhere, it can be remade with the console command
3110 \begin_inset Flex Code
3113 \begin_layout Plain Layout
3119 in that directory, or you can use an existing po-file for some other language
3123 \begin_layout Itemize
3125 \begin_inset Flex Code
3128 \begin_layout Plain Layout
3138 \begin_layout Plain Layout
3139 This is just a text file, so it can be edited in any text editor.
3140 But there are also specialized programs that support such editing, such
3145 (for all platforms) or
3154 contains a `mode' for editing
3155 \begin_inset Flex Code
3158 \begin_layout Plain Layout
3165 \begin_inset Flex URL
3168 \begin_layout Plain Layout
3170 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3182 For some menu- and widget-labels, there are also shortcut keys that should
3184 Those keys are marked after a `|', and should be translated according to
3185 the words and phrases of the language.
3186 You should also fill also out the information at the beginning of the new
3188 \begin_inset Flex Code
3191 \begin_layout Plain Layout
3197 -file with your email-address, etc., so people know where to reach you with
3198 suggestions and entertaining flames.
3201 \begin_layout Standard
3202 If you are just doing this on your own, then:
3205 \begin_layout Itemize
3207 \begin_inset Flex Code
3210 \begin_layout Plain Layout
3217 This can be done with
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3222 msgfmt -o xx.mo < xx.po
3230 \begin_layout Itemize
3232 \begin_inset Flex Code
3235 \begin_layout Plain Layout
3241 -file to your locale-tree, at the correct directory for application messages
3246 xx, and under the name
3247 \begin_inset Flex Code
3250 \begin_layout Plain Layout
3257 \begin_inset space \thinspace{}
3261 \begin_inset space \space{}
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3269 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3279 \begin_layout Standard
3280 As said, however, it would be best if the new
3281 \begin_inset Flex Code
3284 \begin_layout Plain Layout
3290 file could be added to the \SpecialChar LyX
3291 distribution, so others can use it.
3292 Adding it involves making additional changes to \SpecialChar LyX
3294 So send an email to the developers' mailing list if you're interested in
3298 \begin_layout Subsubsection
3302 \begin_layout Standard
3303 Sometimes it turns out that one English message needs to be translated into
3304 different messages in the target language.
3305 One example is the message
3306 \begin_inset Flex Code
3309 \begin_layout Plain Layout
3315 which has the German translation
3323 , depending upon exactly what the English
3324 \begin_inset Quotes eld
3328 \begin_inset Quotes erd
3333 \begin_inset Flex Code
3336 \begin_layout Plain Layout
3342 does not handle such ambiguous translations.
3343 Therefore you have to add some context information to the message: Instead
3345 \begin_inset Flex Code
3348 \begin_layout Plain Layout
3355 \begin_inset Flex Code
3358 \begin_layout Plain Layout
3359 To[[as in 'From format x to format y']]
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3369 To[[as in 'From page x to page y']].
3374 Now the two occurrences of
3375 \begin_inset Flex Code
3378 \begin_layout Plain Layout
3385 \begin_inset Flex Code
3388 \begin_layout Plain Layout
3394 and can be translated correctly to
3405 \begin_layout Standard
3406 Of course the context information needs to be stripped off the original
3407 message when no translation is used.
3408 Therefore you have to put it in double square brackets at the end of the
3409 message (see the example above).
3410 The translation mechanism of \SpecialChar LyX
3411 ensures that everything in double square
3412 brackets at the end of messages is removed before displaying the message.
3415 \begin_layout Subsection
3416 Translating the documentation.
3419 \begin_layout Standard
3420 The online documentation (in the
3421 \begin_inset Flex Noun
3424 \begin_layout Plain Layout
3430 -menu) can (and should!) be translated.
3431 If there are translated versions of the documentation available
3435 \begin_layout Plain Layout
3436 As of March 2008, at least some of the documents have been translated into
3437 fourteen languages, with the Tutorial available in a few more.
3442 and the locale is set accordingly, these will be used automagically by
3446 looks for translated versions as
3447 \begin_inset Flex Code
3450 \begin_layout Plain Layout
3451 LyXDir/doc/xx/DocName.lyx
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3466 is the code for the language currently in use.
3467 If there are no translated documents, the default English versions will
3469 Note that the translated versions must have the same filenames (
3470 \begin_inset Flex Code
3473 \begin_layout Plain Layout
3479 above) as the original.
3480 If you feel up to translating the documentation (an excellent way to proof-read
3481 the original documentation by the way!), there are a few things you should
3485 \begin_layout Itemize
3486 Check out the documentation translation web page at
3487 \begin_inset CommandInset href
3489 name "https://www.lyx.org/Translation"
3490 target "https://www.lyx.org/Translation"
3496 That way, you can find out which (if any) documents have already been translate
3497 d into your language.
3498 You can also find out who (if anyone) is organizing the effort to translate
3499 the documentation into your language.
3500 If no one is organizing the effort, please let us know that you're interested.
3503 \begin_layout Standard
3504 Once you get to actually translating, here's a few hints for you that may
3508 \begin_layout Itemize
3509 Join the documentation team! There is information on how to do that in
3510 \begin_inset Flex Code
3513 \begin_layout Plain Layout
3520 \begin_inset Flex Noun
3523 \begin_layout Plain Layout
3524 Help\SpecialChar menuseparator
3530 ), which by the way is the first document you should translate.
3533 \begin_layout Itemize
3534 Learn the typographic conventions for the language you are translating to.
3535 Typography is an ancient art and over the centuries, a great variety of
3536 conventions have developed throughout different parts of the world.
3537 Also study the professional terminology amongst typographers in your country.
3538 Inventing your own terminology will only confuse the users.
3541 (Warning! Typography is addictive!)
3544 \begin_layout Itemize
3545 Make a copy of the document.
3546 This will be your working copy.
3547 You can use this as your personal translated help-file by placing it in
3549 \begin_inset Flex Code
3552 \begin_layout Plain Layout
3559 \begin_inset Note Greyedout
3562 \begin_layout Plain Layout
3567 For a complex document with external material (images, etc.), if you make
3569 \begin_inset space \thinspace{}
3573 \begin_inset space \space{}
3576 in a temp dir, beware that the links to external material may be broken
3577 when the document is moved to a different place.
3578 The best way is to retrieve the \SpecialChar LyX
3580 \begin_inset Flex URL
3583 \begin_layout Plain Layout
3585 https://www.lyx.org/HowToUseGIT
3590 ) and to edit the doc file in place.
3598 \begin_layout Itemize
3599 Sometimes the original document (from the \SpecialChar LyX
3600 team) will be updated.
3601 Use the source viewer at
3602 \begin_inset CommandInset href
3604 name "https://www.lyx.org/trac/timeline"
3605 target "https://www.lyx.org/trac/timeline"
3610 to see what has been changed.
3611 That way you can easily see which parts of the translated document need
3615 \begin_layout Standard
3616 If you ever find an error in the original document, fix it and notify the
3617 rest of the documentation team of the changes! (You didn't forget to join
3618 the documentation team, did you?)
3621 \begin_layout Standard
3622 \begin_inset Branch OutDated
3626 \begin_layout Section
3627 International Keyboard Support
3630 \begin_layout Standard
3633 [Editor's Note: The following section is by
3641 It needs to be fixed to conform to the new Documentation Style sheet and
3642 to make use of the new v1.0 features.
3643 The whole thing also needs to be merged with the section following it.-jw
3644 It may also be badly out of date.-rh (2008)]
3647 \begin_layout Subsection
3648 Defining Own Keymaps: Keymap File Format
3651 \begin_layout Standard
3652 Let's look at a keyboard definition file a little closer.
3653 It is a plain text file defining
3656 \begin_layout Itemize
3657 key-to-key or key-to-string translations
3660 \begin_layout Itemize
3664 \begin_layout Itemize
3665 dead keys exceptions
3668 \begin_layout Standard
3669 To define key-to-key or key-to-string translation, use this command:
3672 \begin_layout Quotation
3673 \begin_inset Flex Code
3676 \begin_layout Plain Layout
3685 \begin_inset Flex Code
3688 \begin_layout Plain Layout
3697 \begin_layout Standard
3699 \begin_inset Flex Code
3702 \begin_layout Plain Layout
3708 is the key to be translated and
3709 \begin_inset Flex Code
3712 \begin_layout Plain Layout
3718 is the string to be inserted into the document.
3719 To define dead keys, use:
3722 \begin_layout Quotation
3723 \begin_inset Flex Code
3726 \begin_layout Plain Layout
3735 \begin_inset Flex Code
3738 \begin_layout Plain Layout
3747 \begin_layout Standard
3749 \begin_inset Flex Code
3752 \begin_layout Plain Layout
3758 is a keyboard key and
3759 \begin_inset Flex Code
3762 \begin_layout Plain Layout
3769 The following dead keys are supported (shortcut name is in parentheses):
3772 \begin_layout Quotation
3776 \begin_inset space \hfill{}
3782 \begin_layout Quotation
3784 \begin_inset space \hfill{}
3790 \begin_layout Quotation
3792 \begin_inset space \hfill{}
3798 \begin_layout Quotation
3800 \begin_inset space \hfill{}
3806 \begin_layout Quotation
3808 \begin_inset space \hfill{}
3814 \begin_layout Quotation
3816 \begin_inset space \hfill{}
3823 \begin_layout Plain Layout
3835 \begin_layout Quotation
3837 \begin_inset space \hfill{}
3843 \begin_layout Quotation
3845 \begin_inset space \hfill{}
3852 \begin_layout Plain Layout
3864 \begin_layout Quotation
3866 \begin_inset space \hfill{}
3872 \begin_layout Quotation
3874 \begin_inset space \hfill{}
3880 \begin_layout Quotation
3882 \begin_inset space \hfill{}
3889 \begin_layout Plain Layout
3901 \begin_layout Quotation
3903 \begin_inset space \hfill{}
3910 \begin_layout Plain Layout
3922 \begin_layout Quotation
3924 \begin_inset space \hfill{}
3930 \begin_layout Quotation
3931 hungarian umlaut (hug)
3932 \begin_inset space \hfill{}
3938 \begin_layout Quotation
3940 \begin_inset space \hfill{}
3946 \begin_layout Quotation
3948 \begin_inset space \hfill{}
3955 \begin_layout Plain Layout
3967 \begin_layout Standard
3968 Since in many international keyboards there are exceptions to what some
3969 dead keys should do, you can define them using
3972 \begin_layout Quotation
3973 \begin_inset Flex Code
3976 \begin_layout Plain Layout
3984 deadkey key outstring
3987 \begin_layout Standard
3988 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3992 \begin_layout Quotation
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4009 \begin_layout Standard
4010 to make it work correctly.
4011 Also, you have to define as exceptions dead keys over i and j, to remove
4012 the dot from them before inserting an accent mark.
4013 I will change this when the time comes, but so far I haven't had time.
4016 \begin_layout Standard
4017 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4020 \begin_inset Flex Code
4023 \begin_layout Plain Layout
4029 have different meaning.
4031 \begin_inset Flex Code
4034 \begin_layout Plain Layout
4040 marks comments, quotes start and end \SpecialChar LaTeX
4042 To enter quote, you'll need to use
4043 \begin_inset Flex Code
4046 \begin_layout Plain Layout
4055 \begin_inset Flex Code
4058 \begin_layout Plain Layout
4065 \begin_inset Flex Code
4068 \begin_layout Plain Layout
4079 \begin_layout Standard
4080 If you make a keyboard description file that works for your language, please
4081 mail it to me, so I can include it in the next keymap distribution.
4084 \begin_layout Standard
4085 More keywords will be supported in keymap configuration file in future,
4089 \begin_layout Itemize
4090 \begin_inset Flex Code
4093 \begin_layout Plain Layout
4104 \begin_inset space \hfill{}
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4120 \begin_layout Itemize
4121 \begin_inset Flex Code
4124 \begin_layout Plain Layout
4135 \begin_inset space \hfill{}
4139 \begin_inset Flex Code
4142 \begin_layout Plain Layout
4148 an external keymap translation program
4151 \begin_layout Standard
4152 Also, it should look into
4153 \begin_inset Flex Code
4156 \begin_layout Plain Layout
4162 file for defaults, too (for example, a
4163 \begin_inset Flex Code
4166 \begin_layout Plain Layout
4174 option to include default keyboard).
4182 \begin_layout Section
4183 International Keymap Stuff
4184 \begin_inset CommandInset label
4186 name "sec:International-Keymap-Stuff"
4193 \begin_layout Standard
4194 \begin_inset Note Note
4197 \begin_layout Plain Layout
4198 In doing the revisions on this document in March 2008, I did not look over
4199 this stuff, as I do not understand it.
4200 It would be good if someone else could do so.
4209 \begin_layout Standard
4210 The next two sections describe the
4211 \begin_inset Flex Code
4214 \begin_layout Plain Layout
4223 \begin_inset Flex Code
4226 \begin_layout Plain Layout
4234 file syntax in detail.
4235 These sections should help you design your own key map if the ones provided
4236 do not meet your needs.
4239 \begin_layout Subsection
4243 \begin_layout Standard
4247 \begin_inset Flex Code
4250 \begin_layout Plain Layout
4256 file maps keystrokes to characters or strings.
4257 As the name suggests, it sets a keyboard mapping.
4259 \begin_inset Flex Code
4262 \begin_layout Plain Layout
4273 \begin_inset Flex Code
4276 \begin_layout Plain Layout
4291 \begin_inset Flex Code
4294 \begin_layout Plain Layout
4307 \begin_inset Flex Code
4310 \begin_layout Plain Layout
4319 \begin_inset Flex Code
4322 \begin_layout Plain Layout
4330 are described in this section.
4333 \begin_layout Labeling
4334 \labelwidthstring 00.00.0000
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4346 Map a character to a string
4349 \begin_layout LyX-Code
4364 \begin_layout Standard
4397 the double-quote (")
4414 must be escaped with a preceding backslash (
4425 \begin_layout Standard
4427 \begin_inset Flex Noun
4430 \begin_layout Plain Layout
4438 statement to cause the symbol
4439 \begin_inset Flex Noun
4442 \begin_layout Plain Layout
4450 to be output for the keystroke
4451 \begin_inset Flex Noun
4454 \begin_layout Plain Layout
4465 \begin_layout LyX-Code
4471 \begin_layout Labeling
4472 \labelwidthstring 00.00.0000
4473 \begin_inset Flex Code
4476 \begin_layout Plain Layout
4484 Specify an accent character
4487 \begin_layout LyX-Code
4496 \begin_layout Standard
4497 This will make the cha
4535 This is the dead key
4539 \begin_layout Plain Layout
4546 refers to a key that does not produce a character by itself, but when followed
4547 with another key, produces the desired accent character.
4548 For example, a German characte
4550 r with an umlaut like
4560 can be produced in this manner.
4569 \begin_layout Standard
4582 and then another key not in
4599 followed by the other, not allowed key, as output.
4603 \begin_inset Flex Noun
4606 \begin_layout Plain Layout
4614 cancels a dead key, so if
4625 \begin_inset Flex Noun
4628 \begin_layout Plain Layout
4637 , the cursor will not go one position backwards but will instead cancel
4653 might have had on the next keystroke.
4657 \begin_layout Standard
4658 The following example specifies that the character ' is to be an acute accent,
4659 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4662 \begin_layout LyX-Code
4665 kmod ' acute aeiouAEIOU
4668 \begin_layout Labeling
4669 \labelwidthstring 00.00.0000
4670 \begin_inset Flex Code
4673 \begin_layout Plain Layout
4679 Specify an exception to the accent character
4682 \begin_layout LyX-Code
4691 \begin_layout Standard
4692 This defines an exce
4733 have been assigned a keystroke with a previous
4736 \begin_inset Flex Code
4739 \begin_layout Plain Layout
4763 must not belong in the
4810 If such a declaration does not exist in
4818 \begin_inset Flex Code
4821 \begin_layout Plain Layout
4855 \begin_inset Flex Code
4858 \begin_layout Plain Layout
4872 \begin_layout Standard
4873 The following command produces causes äi to be produced when you enter acute-i
4877 \begin_layout LyX-Code
4891 \begin_layout Labeling
4892 \labelwidthstring 00.00.0000
4893 \begin_inset Flex Code
4896 \begin_layout Plain Layout
4902 Combine two accent characters
4905 \begin_layout LyX-Code
4911 accent1 accent2 allowed
4914 \begin_layout Standard
4915 This one is getting pretty esoteric.
4916 It allows you to combine the effect
4972 \begin_inset Flex Code
4975 \begin_layout Plain Layout
5003 \begin_layout Standard
5004 Consider this example from the
5005 \begin_inset Flex Code
5008 \begin_layout Plain Layout
5019 \begin_layout LyX-Code
5022 kmod ; acute aeioyvhAEIOYVH
5026 kcomb acute umlaut iyIY
5029 \begin_layout Standard
5030 This allows you to press
5031 \begin_inset Flex Noun
5034 \begin_layout Plain Layout
5042 and get the effect of
5043 \begin_inset Flex Code
5046 \begin_layout Plain Layout
5065 in this case cancels the last dead key, so if you press
5066 \begin_inset Flex Noun
5069 \begin_layout Plain Layout
5078 \begin_inset Flex Code
5081 \begin_layout Plain Layout
5094 \begin_layout Subsection
5098 \begin_layout Standard
5100 \begin_inset Flex Code
5103 \begin_layout Plain Layout
5111 mapping is performed, a
5112 \begin_inset Flex Code
5115 \begin_layout Plain Layout
5125 file maps the strings that the symbols generate to characters in the current
5127 The \SpecialChar LyX
5128 distribution currently includes at least the
5129 \begin_inset Flex Code
5132 \begin_layout Plain Layout
5141 \begin_inset Flex Code
5144 \begin_layout Plain Layout
5155 \begin_layout Standard
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5168 file is a sequence of declarations of the form
5171 \begin_layout LyX-Code
5184 \begin_layout Standard
5185 For example, in order to map
5186 \begin_inset Flex Noun
5189 \begin_layout Plain Layout
5199 to the corresponding character in the iso-8859-1 set (233), the following
5203 \begin_layout LyX-Code
5211 \begin_layout Standard
5213 \begin_inset Flex Code
5216 \begin_layout Plain Layout
5225 \begin_inset Flex Code
5228 \begin_layout Plain Layout
5246 the same character can apply to more than one string.
5248 \begin_inset Flex Code
5251 \begin_layout Plain Layout
5262 \begin_layout LyX-Code
5274 \begin_inset Newline newline
5290 \begin_layout Standard
5292 cannot find a mapping for the string produced by the keystroke or a
5293 deadkey sequence, it will check if it looks like an accented char and try
5294 to draw an accent over the character on screen.
5297 \begin_layout Subsection
5301 \begin_layout Standard
5302 There is a second way to add support for international characters through
5303 so-called dead-keys.
5304 A dead-key works in combination with a letter to produce an accented character.
5305 Here, we'll explain how to create a really simple dead-key to illustrate
5309 \begin_layout Standard
5310 Suppose you happen to need the circumflex character,
5311 \begin_inset Quotes eld
5315 \begin_inset Quotes erd
5320 \begin_inset Flex Noun
5323 \begin_layout Plain Layout
5330 \begin_inset space ~
5334 \begin_inset Flex Noun
5337 \begin_layout Plain Layout
5343 ] to the \SpecialChar LyX
5345 \begin_inset Flex Code
5348 \begin_layout Plain Layout
5355 \begin_inset Flex Code
5358 \begin_layout Plain Layout
5365 Now, whenever you type the
5366 \begin_inset Flex Noun
5369 \begin_layout Plain Layout
5375 -key followed by a letter, that letter will have a circumflex accent on
5377 For example, the sequence
5378 \begin_inset Quotes eld
5382 \begin_inset Flex Noun
5385 \begin_layout Plain Layout
5392 \begin_inset Quotes erd
5395 produces the letter:
5396 \begin_inset Quotes eld
5400 \begin_inset Quotes erd
5404 If you tried to type
5405 \begin_inset Quotes eld
5409 \begin_inset Flex Noun
5412 \begin_layout Plain Layout
5419 \begin_inset Quotes erd
5422 , however, \SpecialChar LyX
5423 will complain with a beep, since a
5424 \begin_inset Quotes eld
5428 \begin_inset Flex Noun
5431 \begin_layout Plain Layout
5438 \begin_inset Quotes erd
5441 never takes a circumflex accent.
5443 \begin_inset Flex Noun
5446 \begin_layout Plain Layout
5452 after a dead-key produces the bare-accent.
5453 Please note this last point! If you bind a key to a dead-key, you'll need
5454 to rebind the character on that key to yet another key.
5456 \begin_inset Flex Noun
5459 \begin_layout Plain Layout
5465 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5468 \begin_layout Standard
5469 One common way to bind dead-keys is to use
5470 \begin_inset Flex Noun
5473 \begin_layout Plain Layout
5480 \begin_inset Flex Noun
5483 \begin_layout Plain Layout
5490 \begin_inset Flex Noun
5493 \begin_layout Plain Layout
5499 in combination with an accent, like
5500 \begin_inset Quotes eld
5504 \begin_inset Flex Noun
5507 \begin_layout Plain Layout
5514 \begin_inset Quotes erd
5518 \begin_inset Quotes eld
5522 \begin_inset Flex Noun
5525 \begin_layout Plain Layout
5532 \begin_inset Quotes erd
5536 \begin_inset Quotes eld
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5550 \begin_inset Quotes erd
5554 Another way involves using
5555 \begin_inset Flex Code
5558 \begin_layout Plain Layout
5565 \begin_inset Flex Code
5568 \begin_layout Plain Layout
5574 to set up the special
5575 \begin_inset Flex Code
5578 \begin_layout Plain Layout
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5595 acts in some ways just like
5596 \begin_inset Flex Noun
5599 \begin_layout Plain Layout
5605 and permits you to bind keys to accented characters.
5606 You can also turn keys into dead-keys by binding them to something like
5608 \begin_inset Flex Code
5611 \begin_layout Plain Layout
5617 and then binding this symbolic key to the corresponding \SpecialChar LyX
5622 \begin_layout Plain Layout
5627 : This is exactly what I do in my
5628 \begin_inset Flex Code
5631 \begin_layout Plain Layout
5638 \begin_inset Flex Code
5641 \begin_layout Plain Layout
5649 \begin_inset Flex Noun
5652 \begin_layout Plain Layout
5654 \begin_inset space ~
5663 \begin_inset Flex Code
5666 \begin_layout Plain Layout
5672 and a bunch of these
5673 \begin_inset Quotes eld
5677 \begin_inset Flex Code
5680 \begin_layout Plain Layout
5687 \begin_inset Quotes erd
5690 symbolic keys bound such things as
5691 \begin_inset Flex Noun
5694 \begin_layout Plain Layout
5696 \begin_inset space ~
5705 \begin_inset Flex Noun
5708 \begin_layout Plain Layout
5710 \begin_inset space ~
5719 This is how I produce my accented characters.
5724 You can make just about anything into the
5725 \begin_inset Flex Code
5728 \begin_layout Plain Layout
5735 \begin_inset Flex Noun
5738 \begin_layout Plain Layout
5744 keys, a spare function key, etc.
5745 As for the \SpecialChar LyX
5746 commands that produce accents, check the entry for
5747 \begin_inset Flex Code
5750 \begin_layout Plain Layout
5761 You'll find the complete list there.
5764 \begin_layout Subsection
5765 Saving your Language Configuration
5768 \begin_layout Standard
5769 You can edit your preferences so that your desired language environment
5770 is automatically configured when \SpecialChar LyX
5772 \begin_inset Flex Noun
5775 \begin_layout Plain Layout
5776 Edit\SpecialChar menuseparator
5785 \begin_layout Chapter
5786 Installing New Document Classes, Layouts, and Templates
5787 \begin_inset CommandInset label
5789 name "cha:Installing-New-Document"
5794 \begin_inset Argument 1
5797 \begin_layout Plain Layout
5798 Installing New Document Classes
5806 \begin_layout Standard
5807 In this chapter, we describe the procedures for creating and installing
5808 new \SpecialChar LyX
5809 layout and template files, as well as offer a refresher on correctly
5810 installing new \SpecialChar LaTeX
5815 \begin_layout Standard
5816 First, let us a say a few words about how one ought to think about the relation
5817 between \SpecialChar LyX
5818 and \SpecialChar LaTeX
5820 The thing to understand is that, in a certain sense, \SpecialChar LyX
5821 doesn't know anything
5822 about \SpecialChar LaTeX
5824 Indeed, from \SpecialChar LyX
5825 's point of view, \SpecialChar LaTeX
5826 is just one of several
5827 \begin_inset Quotes eld
5831 \begin_inset Quotes erd
5834 in which it is capable of producing output.
5835 Other such formats are DocBook, plaintext, and XHTML.
5837 is, of course, a particularly important format, but very little of the
5838 information \SpecialChar LyX
5839 has about \SpecialChar LaTeX
5840 is actually contained in the program itself.
5844 \begin_layout Plain Layout
5845 Some commands are sufficiently complex that they are
5846 \begin_inset Quotes eld
5850 \begin_inset Quotes erd
5853 into \SpecialChar LyX
5855 But the developers generally regard this as a Bad Thing.
5860 Rather, that information, even for the standard classes like
5861 \begin_inset Flex Code
5864 \begin_layout Plain Layout
5870 , is contained in `layout files'.
5871 Similarly, \SpecialChar LyX
5872 itself does not know much about DocBook or XHTML.
5873 What it knows is contained in layout files.
5876 \begin_layout Standard
5877 You can think of the layout file for a given document class as a translation
5878 manual between \SpecialChar LyX
5879 constructs—paragraphs with their corresponding styles,
5880 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5883 Almost everything \SpecialChar LyX
5885 \begin_inset Flex Code
5888 \begin_layout Plain Layout
5894 , for example, is contained in the file
5895 \begin_inset Flex Code
5898 \begin_layout Plain Layout
5904 and in various other files it includes.
5905 For this reason, anyone intending to write layout files should plan to
5906 study the existing files.
5907 A good place to start is with
5908 \begin_inset Flex Code
5911 \begin_layout Plain Layout
5917 , which is included in
5918 \begin_inset Flex Code
5921 \begin_layout Plain Layout
5928 \begin_inset Flex Code
5931 \begin_layout Plain Layout
5937 , and many of the other layout files for document classes.
5938 This file is where sections and the like are defined:
5939 \begin_inset Flex Code
5942 \begin_layout Plain Layout
5948 tells \SpecialChar LyX
5949 how paragraphs that are marked with the Section, Subsection, etc,
5950 styles can be translated into corresponding \SpecialChar LaTeX
5951 , DocBook, and XHTML commands
5954 \begin_inset Flex Code
5957 \begin_layout Plain Layout
5963 file basically just includes several of these
5964 \begin_inset Flex Code
5967 \begin_layout Plain Layout
5976 \begin_layout Standard
5977 Defining the \SpecialChar LyX
5979 correspondence is not the only thing layout files do, though.
5980 Their other job is to define how the \SpecialChar LyX
5981 constructs themselves will appear
5983 The fact that layout files have these two jobs is often a source of confusion,
5984 because they are completely separate.
5985 Telling \SpecialChar LyX
5986 how to translate a certain paragraph style into \SpecialChar LaTeX
5989 how to display it; conversely, telling \SpecialChar LyX
5990 how to display a certain paragraph
5991 style does not tell \SpecialChar LyX
5992 how to translate it into \SpecialChar LaTeX
5993 (let alone tell \SpecialChar LaTeX
5996 So, in general, when you define a new \SpecialChar LyX
5997 construct, you must always do two
5998 quite separate things: (i)
5999 \begin_inset space ~
6002 tell \SpecialChar LyX
6003 how to translate it into \SpecialChar LaTeX
6005 \begin_inset space ~
6008 tell \SpecialChar LyX
6012 \begin_layout Standard
6013 Much the same is true, of course, as regards \SpecialChar LyX
6014 's other backend formats, though
6015 XHTML is in some ways different, because in that case \SpecialChar LyX
6020 able, to some extent, to use information about how it should display a
6021 paragraph on the screen to output information (in the form of CSS) about
6022 how the paragraph should be displayed in a browser.
6023 Even in this case, however, the distinction between what \SpecialChar LyX
6025 and how things are rendered externally remains in force, and the two can
6026 be controlled separately.
6028 \begin_inset CommandInset ref
6030 reference "sec:Tags-for-XHTML"
6037 \begin_layout Section
6038 Installing new \SpecialChar LaTeX
6042 \begin_layout Standard
6043 Some installations may not include a \SpecialChar LaTeX
6044 package or class file that you would
6045 like to use within \SpecialChar LyX
6047 For example, you might need Foil\SpecialChar TeX
6048 , a package for preparing slides for overhead
6050 Modern \SpecialChar LaTeX
6051 distributions like \SpecialChar TeX
6052 Live (2008 or newer) or MiK\SpecialChar TeX
6053 provide a user interface
6054 for installing such packages.
6055 For example, with MiK\SpecialChar TeX
6056 , you start the program
6057 \begin_inset Quotes eld
6061 \begin_inset space ~
6065 \begin_inset Quotes erd
6068 to get a list of available packages.
6069 To install one of them, right click on it or use the corresponding toolbar
6073 \begin_layout Standard
6074 If your \SpecialChar LaTeX
6075 distribution does not provide such a `package manager', or if the
6076 package is not available from your distribution, then follow these steps
6077 to install it manually:
6080 \begin_layout Enumerate
6081 Get the package from
6082 \begin_inset CommandInset href
6085 target "http://www.ctan.org/"
6093 \begin_layout Enumerate
6094 If the package contains a file with the ending
6095 \begin_inset Quotes eld
6099 \begin_inset Flex Code
6102 \begin_layout Plain Layout
6109 \begin_inset Quotes erd
6112 (is the case for Foil\SpecialChar TeX
6113 ) then open a console, change to the folder of this
6114 file and execute the command
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6125 You have now unpacked the package and have all files to install it.
6126 Most \SpecialChar LaTeX
6127 -packages are not packed and you can skip this step.
6130 \begin_layout Enumerate
6131 Now you need to decide if the package should be available for all users
6136 \begin_layout Enumerate
6137 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6138 for all users on your system, then install it in your `local' \SpecialChar TeX
6140 install it in your own `user' \SpecialChar TeX
6142 Where these trees should be created, if they do not already exist, depends
6144 To find this out, look in the file
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6158 \begin_layout Plain Layout
6159 This is usually in the directory
6160 \begin_inset Flex Code
6163 \begin_layout Plain Layout
6169 , though you can execute the command
6170 \begin_inset Flex Code
6173 \begin_layout Plain Layout
6184 The location of the `local' \SpecialChar TeX
6185 tree is defined by the
6186 \begin_inset Flex Code
6189 \begin_layout Plain Layout
6195 variable; this is usually somewhere like
6196 \begin_inset Flex Code
6199 \begin_layout Plain Layout
6200 /usr/local/share/texmf
6205 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6208 The location of the `user' \SpecialChar TeX
6210 \begin_inset Flex Code
6213 \begin_layout Plain Layout
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6242 (If these variables are not predefined, you have to define them.) You'll
6243 probably need root permissions to create or modify the `local' tree, but
6244 not for your `user' tree.
6245 \begin_inset Newline newline
6248 In general, it is recommended to install in the user tree because your user
6249 will not be modified or even overwritten when you upgrade your system.
6250 It will typically also be backed up together with everything else when
6251 you backup your home directory (which, of course, you do on a regular basis).
6254 \begin_layout Enumerate
6255 On Windows, if you want the new package to be available for all users on
6256 your system, change to the folder where \SpecialChar LaTeX
6257 is installed and then change to
6259 \begin_inset Flex Code
6262 \begin_layout Plain Layout
6273 (For MiK\SpecialChar TeX
6274 , this would be by default the folder
6275 \begin_inset Flex Code
6278 \begin_layout Plain Layout
6296 \begin_layout Plain Layout
6297 Note that this will be the correct path only on English installations.
6298 On a German one, it would be
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6316 , and similarly for other languages.
6321 Create there a new folder
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6331 and copy all files of the package into it.
6333 \begin_inset Newline newline
6336 If the package should only available for you or you don't have admin permissions
6337 , do the same, but in the local \SpecialChar LaTeX
6340 \begin_inset space \thinspace{}
6343 g., for MiK\SpecialChar TeX
6345 \begin_inset space ~
6348 2.8 under Windows XP, this would be the folder:
6349 \begin_inset Newline newline
6355 \begin_inset Flex Code
6358 \begin_layout Plain Layout
6361 Documents and Settings
6373 \begin_inset Newline newline
6379 \begin_inset Phantom HPhantom
6382 \begin_layout Plain Layout
6393 \begin_inset Flex Code
6396 \begin_layout Plain Layout
6409 \begin_inset Newline newline
6412 On Vista, it would be:
6413 \begin_inset Newline newline
6417 \begin_inset Flex Code
6420 \begin_layout Plain Layout
6446 \begin_layout Enumerate
6447 Now one only need to tell \SpecialChar LaTeX
6448 that there are new files.
6449 This depends on the used \SpecialChar LaTeX
6454 \begin_layout Enumerate
6455 For \SpecialChar TeX
6456 Live execute the command
6457 \begin_inset Flex Code
6460 \begin_layout Plain Layout
6467 If you installed the package for all users, then you will probably need
6468 to have root permissions for that.
6471 \begin_layout Enumerate
6472 For MiK\SpecialChar TeX
6473 , if you have installed the package for all users, start the program
6475 \begin_inset Quotes eld
6479 \begin_inset space ~
6483 \begin_inset Quotes erd
6486 and press the button marked
6487 \begin_inset Quotes eld
6491 \begin_inset Quotes erd
6495 Otherwise start the program
6496 \begin_inset Quotes eld
6500 \begin_inset Quotes erd
6507 \begin_layout Enumerate
6508 Finally, you need to tell \SpecialChar LyX
6509 that there are new packages available.
6510 So, in \SpecialChar LyX
6512 \begin_inset Flex Noun
6515 \begin_layout Plain Layout
6518 \SpecialChar menuseparator
6524 and then restart \SpecialChar LyX
6528 \begin_layout Standard
6529 Now the package is installed.
6530 In our example, the document class
6531 \begin_inset Flex Code
6534 \begin_layout Plain Layout
6540 will now be available under
6541 \begin_inset Flex Noun
6544 \begin_layout Plain Layout
6545 Document\SpecialChar menuseparator
6546 Settings\SpecialChar menuseparator
6553 \begin_inset Quotes eld
6557 \begin_inset Quotes erd
6564 \begin_layout Standard
6565 If you would like to use a \SpecialChar LaTeX
6566 document class that is not even listed in the
6568 \begin_inset Flex Noun
6571 \begin_layout Plain Layout
6572 Document\SpecialChar menuseparator
6573 Settings\SpecialChar menuseparator
6579 , then you need to create a `layout' file for it.
6580 That is the topic of the next section.
6583 \begin_layout Section
6584 Types of layout files
6587 \begin_layout Standard
6588 This section describes the various sorts of \SpecialChar LyX
6589 files that contain layout informati
6591 These files describe various paragraph and character styles, determining
6592 how \SpecialChar LyX
6593 should display them and how they should be translated into \SpecialChar LaTeX
6595 XHTML, or whatever output format is being used.
6599 \begin_layout Standard
6600 We shall try to provide a thorough description of the process of writing
6602 However, there are so many different types of documents supported even
6603 by just \SpecialChar LaTeX
6604 that we can't hope to cover every different possibility or problem
6605 you might encounter.
6606 The \SpecialChar LyX
6607 users' list is frequented by people with lots of experience with layout
6608 design who are willing to share what they've learned, so please feel free
6609 to ask questions there.
6612 \begin_layout Standard
6613 As you prepare to write a new layout, it is extremely helpful to look at
6614 the layouts distributed with \SpecialChar LyX
6616 If you write a \SpecialChar LyX
6617 layout for a \SpecialChar LaTeX
6618 document class that might also be used by
6619 others, or write a module that might be useful to others, then you should
6620 consider posting your layout to the
6621 \begin_inset CommandInset href
6623 name "layout section on the LyX wiki"
6624 target "https://wiki.lyx.org/Layouts/Layouts"
6629 or even to the \SpecialChar LyX
6630 developers' list, so that it might be included in \SpecialChar LyX
6635 \begin_layout Plain Layout
6636 Note that \SpecialChar LyX
6637 is licensed under the General Public License, so any material
6638 that is contributed to \SpecialChar LyX
6639 must be similarly licensed.
6647 \begin_layout Subsection
6649 \begin_inset CommandInset label
6651 name "subsec:Layout-modules"
6658 \begin_layout Standard
6659 We have spoken to this point about `layout files'.
6660 But there are different sorts of files that contain layout information.
6661 Layout files, strictly so called, have the
6662 \begin_inset Flex Code
6665 \begin_layout Plain Layout
6671 extension and provide \SpecialChar LyX
6672 with information about document classes.
6673 Since \SpecialChar LyX
6674 1.6 layout information can also be contained in layout
6679 \begin_inset Flex Code
6682 \begin_layout Plain Layout
6689 Modules are to \SpecialChar LaTeX
6690 packages much as layouts are to \SpecialChar LaTeX
6691 classes, and some modules—such
6693 \begin_inset Flex Code
6696 \begin_layout Plain Layout
6702 module—specifically provide support for one package.
6703 In a sense, layout modules are similar to included
6707 \begin_layout Plain Layout
6708 These can have any extension, but by convention have the
6709 \begin_inset Flex Code
6712 \begin_layout Plain Layout
6724 \begin_inset Flex Code
6727 \begin_layout Plain Layout
6733 —in that modules are not specific to a given document class but may be used
6734 with many different classes.
6735 The difference is that using an included file with
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6745 requires editing that file.
6746 Modules, by contrast, are selected in the
6747 \begin_inset Flex Noun
6750 \begin_layout Plain Layout
6751 Document\SpecialChar menuseparator
6760 \begin_layout Standard
6761 Building modules is the easiest way to get started with layout editing,
6762 since it can be as simple as adding a single new paragraph style or flex
6764 But modules may, in principle, contain anything a layout file can contain.
6767 \begin_layout Standard
6768 After creating a new module and copying it to the
6769 \begin_inset Flex Code
6772 \begin_layout Plain Layout
6778 folder, you will need to reconfigure and then restart \SpecialChar LyX
6781 However, changes you make to the module will be seen immediately, if you
6783 \begin_inset Flex Noun
6786 \begin_layout Plain Layout
6787 Document\SpecialChar menuseparator
6793 , highlight something, and then hit
6794 \begin_inset Quotes eld
6798 \begin_inset Quotes erd
6804 It is strongly recommended that you save your work before doing this
6809 it is strongly recommended that you not attempt to edit modules while simultaneo
6810 usly working on actual documents
6813 Though of course the developers strive to keep \SpecialChar LyX
6814 stable in such situations,
6815 syntax errors and the like in your module file could cause strange behavior.
6818 \begin_layout Subsubsection
6822 \begin_layout Standard
6823 Modules are to \SpecialChar LyX
6824 as packages are to \SpecialChar LaTeX
6826 Sometimes, however, you find yourself wanting a specific inset or character
6827 style just for one document and writing a module that will also be available
6828 to other documents makes little sense.
6829 What you need is \SpecialChar LyX
6831 \begin_inset Quotes eld
6835 \begin_inset Quotes erd
6841 \begin_layout Standard
6842 You will find it under
6844 Document\SpecialChar menuseparator
6845 Settings\SpecialChar menuseparator
6849 The large text box allows you to enter anything that you might enter in
6850 a layout file or module.
6851 You can think of a document's local layout, in fact, as a module that belongs
6853 So, in particular, you must enter a
6854 \begin_inset Flex Code
6857 \begin_layout Plain Layout
6864 Any format is acceptable, but one would normally use the format current
6866 (In \SpecialChar LyX
6867 2.3, the current layout format is 63.)
6870 \begin_layout Standard
6871 When you have entered something in the
6872 \begin_inset Flex Code
6875 \begin_layout Plain Layout
6881 pane, \SpecialChar LyX
6883 \begin_inset Quotes eld
6887 \begin_inset Quotes erd
6890 button at the bottom.
6891 Clicking this button will cause \SpecialChar LyX
6892 to determine whether what you have entered
6893 is valid layout information for the chosen format.
6895 will report the result but, unfortunately, will not tell you what errors
6896 there might have been.
6897 These will be written to the terminal, however, if \SpecialChar LyX
6898 is started from a terminal.
6899 You will not be permitted to save your local layout until you have entered
6903 \begin_layout Standard
6904 The warnings at the end of the previous section apply here, too.
6905 Do not play with local layout while you are actually working, especially
6906 if you have not saved your document.
6907 That said, using local layout with a test document can be a very convenient
6908 way to try out layout ideas, or even to start developing a module.
6911 \begin_layout Subsection
6913 \begin_inset Flex Noun
6916 \begin_layout Plain Layout
6925 \begin_layout Standard
6926 There are two situations you are likely to encounter when wanting to support
6927 a new \SpecialChar LaTeX
6928 document class, involving style (
6929 \begin_inset Flex Code
6932 \begin_layout Plain Layout
6938 ) files and \SpecialChar LaTeX2e
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6950 Supporting a style file is usually fairly easy.
6951 Supporting a new class file is a bit harder.
6952 We'll discuss the former in this section and the latter in the next.
6953 Similar remarks apply, of course, if you want to support a new DocBook
6957 \begin_layout Standard
6958 The easier case is the one in which your new document class is provided
6959 as a style file that is to be used in conjunction with an already supported
6961 For the sake of the example, we'll assume that the style file is called
6963 \begin_inset Flex Noun
6966 \begin_layout Plain Layout
6972 and that it is meant to be used with
6973 \begin_inset Flex Noun
6976 \begin_layout Plain Layout
6982 , which is a standard class.
6986 \begin_layout Standard
6987 Start by copying the existing class's layout file into your local directory:
6991 \begin_layout Plain Layout
6992 Of course, which directory is your local directory will vary by platform,
6993 and \SpecialChar LyX
6994 allows you to specify your local directory on startup, too, using
6996 \begin_inset Flex Code
6999 \begin_layout Plain Layout
7013 \begin_layout LyX-Code
7014 cp report.layout ~/.lyx/layouts/myclass.layout
7017 \begin_layout Standard
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7028 and change the line:
7031 \begin_layout LyX-Code
7034 DeclareLaTeXClass{Report (Standard Class)}
7037 \begin_layout Standard
7041 \begin_layout LyX-Code
7044 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7047 \begin_layout Standard
7051 \begin_layout LyX-Code
7053 \begin_inset Newline newline
7059 \begin_inset Newline newline
7065 \begin_layout Standard
7066 near the top of the file.
7069 \begin_layout Standard
7070 Start \SpecialChar LyX
7072 \begin_inset Flex Noun
7075 \begin_layout Plain Layout
7076 Tools\SpecialChar menuseparator
7083 Then restart \SpecialChar LyX
7084 and try creating a new document.
7086 \begin_inset Flex Noun
7089 \begin_layout Plain Layout
7095 " as a document class option in the
7096 \begin_inset Flex Noun
7099 \begin_layout Plain Layout
7100 Document\SpecialChar menuseparator
7107 It is likely that some of the sectioning commands and such in your new
7108 class will work differently from how they worked in the base class—
7109 \begin_inset Flex Code
7112 \begin_layout Plain Layout
7118 in this example—so you can fiddle around with the settings for the different
7119 sections if you wish.
7120 The layout information for sections is contained in
7121 \begin_inset Flex Code
7124 \begin_layout Plain Layout
7130 , but you do not need to copy and change this file.
7131 Instead, you can simply add your changes to your layout file, after the
7133 \begin_inset Flex Code
7136 \begin_layout Plain Layout
7142 , which itself includes
7143 \begin_inset Flex Code
7146 \begin_layout Plain Layout
7153 For example, you might add these lines:
7156 \begin_layout LyX-Code
7160 \begin_layout LyX-Code
7164 \begin_layout LyX-Code
7168 \begin_layout LyX-Code
7172 \begin_layout LyX-Code
7176 \begin_layout Standard
7177 to change the font for chapter headings to sans-serif.
7178 This will override (or, in this case, add to) the existing declaration
7179 for the Chapter style.
7183 \begin_layout Standard
7184 Your new package may also provide commands or environments not present in
7186 In this case, you will want to add these to the layout file.
7188 \begin_inset CommandInset ref
7190 reference "sec:TextClass"
7194 for information on how to do so.
7197 \begin_layout Standard
7199 \begin_inset Flex Noun
7202 \begin_layout Plain Layout
7208 can be used with several different document classes, and even if it cannot,
7209 you might find it easiest just to write a module that you can load with
7211 The simplest possible such module would be:
7214 \begin_layout LyX-Code
7217 DeclareLyXModule{My Class}
7220 \begin_layout LyX-Code
7224 \begin_layout LyX-Code
7225 #Support for myclass.sty.
7228 \begin_layout LyX-Code
7230 \begin_inset Newline newline
7236 \begin_layout LyX-Code
7238 \begin_inset Newline newline
7244 \begin_layout LyX-Code
7246 \begin_inset Newline newline
7252 \begin_inset Newline newline
7258 \begin_layout Standard
7259 A more complex module might modify the behavior of some existing constructs
7260 or define some new ones.
7262 \begin_inset CommandInset ref
7264 reference "sec:TextClass"
7271 \begin_layout Subsection
7273 \begin_inset Flex Noun
7276 \begin_layout Plain Layout
7285 \begin_layout Standard
7286 There are two possibilities here.
7287 One is that the class file is itself based upon an existing document class.
7288 For example, many thesis classes are based upon
7289 \begin_inset Flex Noun
7292 \begin_layout Plain Layout
7299 To see whether yours is, look for a line like
7302 \begin_layout LyX-Code
7308 \begin_layout Standard
7310 If so, then you may proceed largely as in the previous section, though
7312 \begin_inset Flex Code
7315 \begin_layout Plain Layout
7316 Declare\SpecialChar LaTeX
7322 line will be different.
7323 If your new class is
7324 \begin_inset Flex Code
7327 \begin_layout Plain Layout
7333 and it is based upon
7334 \begin_inset Flex Code
7337 \begin_layout Plain Layout
7343 , then the line should read:
7347 \begin_layout Plain Layout
7348 And it will be easiest if you save the file to
7349 \begin_inset Flex Code
7352 \begin_layout Plain Layout
7359 assumes that the document class has the same name as the layout file.
7368 \begin_layout LyX-Code
7371 DeclareLaTeXClass[thesis,book]{thesis}
7374 \begin_layout Standard
7375 If, on the other hand, the new class is not based upon an existing class,
7376 you will probably have to
7377 \begin_inset Quotes eld
7381 \begin_inset Quotes erd
7385 We strongly suggest copying an existing layout file which uses a similar
7387 class and then modifying it, if you can do so.
7388 At least use an existing file as a starting point so you can find out what
7389 items you need to worry about.
7390 Again, the specifics are covered below.
7393 \begin_layout Subsection
7395 \begin_inset CommandInset label
7397 name "subsec:Creating-Templates"
7404 \begin_layout Standard
7405 Once you have written a layout file for a new document class, you might
7406 want to consider writing a
7411 A template acts as a kind of tutorial for your layout, showing how it might
7412 be used, though containing dummy content.
7413 You can of course look at the various templates included with \SpecialChar LyX
7417 \begin_layout Standard
7418 Templates are created just like usual documents: using \SpecialChar LyX
7420 The only difference is that usual documents contain all possible settings,
7421 including the font scheme and the paper size.
7422 Usually a user doesn't want a template to overwrite his preferred settings
7423 for such parameters.
7424 For that reason, the designer of a template should remove the corresponding
7426 \begin_inset Flex Code
7429 \begin_layout Plain Layout
7438 \begin_inset Flex Code
7441 \begin_layout Plain Layout
7449 from the template \SpecialChar LyX
7451 This can be done with any simple text-editor, for example
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7462 \begin_inset Flex Code
7465 \begin_layout Plain Layout
7474 \begin_layout Standard
7475 Put the edited template files you create in
7476 \begin_inset Flex Code
7479 \begin_layout Plain Layout
7485 , copy the ones you use from the global template directory in
7486 \begin_inset Flex Code
7489 \begin_layout Plain Layout
7495 to the same place, and redefine the template path in the
7496 \begin_inset Flex Noun
7499 \begin_layout Plain Layout
7500 Tools\SpecialChar menuseparator
7501 Preferences\SpecialChar menuseparator
7510 \begin_layout Standard
7511 Note, by the way, that there is a template which has a particular meaning:
7512 \begin_inset Newline linebreak
7516 \begin_inset Flex Code
7519 \begin_layout Plain Layout
7526 This template is loaded every time you create a new document with
7527 \begin_inset Flex Noun
7530 \begin_layout Plain Layout
7531 File\SpecialChar menuseparator
7537 in order to provide useful defaults.
7538 To create this template from inside \SpecialChar LyX
7539 , all you have to do is to open a document
7540 with the correct settings, and use the
7541 \begin_inset Flex Noun
7544 \begin_layout Plain Layout
7545 Save as Document Defaults
7553 \begin_layout Subsection
7554 Upgrading old layout files
7557 \begin_layout Standard
7558 The format of layout files changes with each \SpecialChar LyX
7559 release, so old layout files
7560 need to be converted to the new format.
7562 reads a layout file in an older format, it automatically calls the
7564 \begin_inset Flex Code
7567 \begin_layout Plain Layout
7573 to convert it to a temporary file in current format.
7574 The original file is left untouched.
7575 If you use the layout file often, then, you may want to convert it permanently,
7576 so that \SpecialChar LyX
7577 does not have to do so itself every time.
7578 To do this, you can call the converter manually:
7581 \begin_layout Enumerate
7583 \begin_inset Flex Code
7586 \begin_layout Plain Layout
7593 \begin_inset Flex Code
7596 \begin_layout Plain Layout
7605 \begin_layout Enumerate
7607 \begin_inset Newline newline
7611 \begin_inset Flex Code
7614 \begin_layout Plain Layout
7615 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7621 \begin_inset Newline newline
7625 \begin_inset Flex Code
7628 \begin_layout Plain Layout
7634 is the name of your \SpecialChar LyX
7638 \begin_layout Standard
7639 Note that manual conversion does not affect included files, so these will
7640 have to be converted separately.
7643 \begin_layout Subsection
7644 \begin_inset CommandInset label
7646 name "subsec:Cite-Engine-Files"
7653 \begin_layout Standard
7654 A specific form of layout files are the so-called
7655 \begin_inset Flex Code
7658 \begin_layout Plain Layout
7664 files that are located in the
7665 \begin_inset Flex Code
7668 \begin_layout Plain Layout
7675 Their purpose is to define the specifics of \SpecialChar LaTeX
7676 packages aimed at bibliography
7689 , but also the way how normal Bib\SpecialChar TeX
7690 citations (without additional packages)
7691 are handled in \SpecialChar LyX
7692 is defined in such a file.
7696 \begin_layout Standard
7697 More specifically, it is defined which packages \SpecialChar LyX
7698 needs to load, which citation
7699 commands are available, how these are to be displayed in \SpecialChar LyX
7701 the dialogs, the context menus) as well as in the XHTML and plain text
7703 Furthermore, the files specify available style variants (author-year, numerical
7704 , etc.) and their specifics.
7705 The cite engine files are also used to generate the options that are available
7708 Document\SpecialChar menuseparator
7709 Settings\SpecialChar menuseparator
7710 Bibliography\SpecialChar menuseparator
7716 \begin_layout Standard
7717 Even though a cite engine file is essentially a normal layout file that
7718 could theoretically include any layout information, it usually primarily
7719 includes some specific parameters such as
7720 \begin_inset Flex Code
7723 \begin_layout Plain Layout
7730 \begin_inset Flex Code
7733 \begin_layout Plain Layout
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7750 \begin_inset Flex Code
7753 \begin_layout Plain Layout
7760 The syntax of the latter two is described in
7761 \begin_inset CommandInset ref
7763 reference "subsec:Citation-engine-description"
7771 \begin_inset CommandInset ref
7773 reference "subsec:Citation-format-description"
7777 , as well as in the files themselves.
7780 \begin_layout Section
7781 \begin_inset CommandInset label
7783 name "sec:TextClass"
7787 The layout file format
7790 \begin_layout Standard
7791 The following sections describe how layout files are structured and written.
7792 Our advice is to go slowly, save and test often.
7793 It is really not that hard, except that the multitude of options can become
7794 overwhelming, especially if you try to check out too many at once.
7795 It becomes easier if you use existing layouts of \SpecialChar LyX
7796 as examples/reference
7797 or if you modify an existing layout to your needs.
7800 \begin_layout Standard
7801 Note that all the tags used in layout files are case-insensitive.
7803 \begin_inset Flex Code
7806 \begin_layout Plain Layout
7813 \begin_inset Flex Code
7816 \begin_layout Plain Layout
7823 \begin_inset Flex Code
7826 \begin_layout Plain Layout
7832 are really the same tag.
7833 The possible arguments are printed in brackets after the tag's name.
7834 The default argument is typeset
7835 \begin_inset Flex Code
7838 \begin_layout Plain Layout
7847 If the argument has a data type like
7848 \begin_inset Quotes eld
7852 \begin_inset Quotes erd
7856 \begin_inset Quotes eld
7860 \begin_inset Quotes erd
7863 , the default is shown like this:
7864 \begin_inset Flex Code
7867 \begin_layout Plain Layout
7878 \begin_layout Subsection
7879 The document class declaration and classification
7882 \begin_layout Standard
7883 Lines in a layout file which begin with
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7894 There is one exception to this rule.
7896 \begin_inset Flex Code
7899 \begin_layout Plain Layout
7905 files should begin with lines like:
7908 \begin_layout LyX-Code
7911 #% Do not delete the line below; configure depends on this
7914 \begin_layout LyX-Code
7919 DeclareLaTeXClass{Article (Standard Class)}
7922 \begin_layout LyX-Code
7927 DeclareCategory{Articles}
7930 \begin_layout Standard
7931 The second and third lines are used when you (re)configure \SpecialChar LyX
7933 The layout file is read by the \SpecialChar LaTeX
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7944 , in a special mode where
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7955 The first line is just a \SpecialChar LaTeX
7956 comment, the second one contains the mandatory
7957 declaration of the text class and the third line contains the optional
7958 classification of the class.
7959 If these lines appear in a file named
7960 \begin_inset Flex Code
7963 \begin_layout Plain Layout
7969 , then they define a text class of name
7970 \begin_inset Flex Code
7973 \begin_layout Plain Layout
7979 (the name of the layout file) which uses the \SpecialChar LaTeX
7981 \begin_inset Flex Code
7984 \begin_layout Plain Layout
7990 (the default is to use the same name as the layout).
7992 \begin_inset Quotes eld
7995 Article (Standard Class)
7996 \begin_inset Quotes erd
7999 that appears above is used as a description of the text class in the
8000 \begin_inset Flex Noun
8003 \begin_layout Plain Layout
8004 Document\SpecialChar menuseparator
8012 \begin_inset Quotes eld
8016 \begin_inset Quotes erd
8019 in the example) is also used in the
8020 \begin_inset Flex Noun
8023 \begin_layout Plain Layout
8024 Document\SpecialChar menuseparator
8030 dialog: the text classes are grouped by these categories (which are usually
8031 genres, so typical categories are
8032 \begin_inset Quotes eld
8036 \begin_inset Quotes erd
8040 \begin_inset Quotes eld
8044 \begin_inset Quotes erd
8048 \begin_inset Quotes eld
8052 \begin_inset Quotes erd
8056 \begin_inset Quotes eld
8060 \begin_inset Quotes erd
8064 \begin_inset Quotes eld
8068 \begin_inset Quotes erd
8072 \begin_inset Quotes eld
8076 \begin_inset Quotes erd
8080 If no category has been declared, the class will be put in the
8081 \begin_inset Quotes eld
8085 \begin_inset Quotes erd
8091 \begin_layout Standard
8092 Let's assume that you wrote your own text class that uses the
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8102 document class, but where you changed the appearance of the section headings.
8103 If you put it in a file
8104 \begin_inset Flex Code
8107 \begin_layout Plain Layout
8113 , the header of this file should be:
8116 \begin_layout LyX-Code
8119 #% Do not delete the line below; configure depends on this
8122 \begin_layout LyX-Code
8127 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8130 \begin_layout LyX-Code
8135 DeclareCategory{Articles}
8138 \begin_layout Standard
8139 This declares a text class
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8149 , associated with the \SpecialChar LaTeX
8151 \begin_inset Flex Code
8154 \begin_layout Plain Layout
8161 \begin_inset Quotes eld
8164 Article (with My Own Headings)
8165 \begin_inset Quotes erd
8169 If your text class depends on several packages, you can declare it as:
8172 \begin_layout LyX-Code
8175 #% Do not delete the line below; configure depends on this
8178 \begin_layout LyX-Code
8183 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8186 \begin_layout LyX-Code
8191 DeclareCategory{Articles}
8194 \begin_layout Standard
8195 This indicates that your text class uses the
8196 \begin_inset Flex Code
8199 \begin_layout Plain Layout
8206 Finally, it is also possible to declare classes for DocBook code.
8207 Typical declarations will look like:
8210 \begin_layout LyX-Code
8213 #% Do not delete the line below; configure depends on this
8216 \begin_layout LyX-Code
8221 DeclareDocBookClass[article]{SGML (DocBook Article)}
8224 \begin_layout LyX-Code
8229 DeclareCategory{Articles (DocBook)}
8232 \begin_layout Standard
8233 Note that these declarations can also be given an optional parameter declaring
8234 the name of the document class (but not a list).
8237 \begin_layout Standard
8238 So, to be as explicit as possible, the form of the layout declaration is:
8241 \begin_layout LyX-Code
8246 DeclareLaTeXClass[class,package.sty]{layout description}
8249 \begin_layout LyX-Code
8254 DeclareCategory{category}
8257 \begin_layout Standard
8258 The class need only be specified if the name of the \SpecialChar LaTeX
8260 name of the layout file are different or if there are packages to load.
8261 If the name of the class file is not specified, then \SpecialChar LyX
8263 that it is the same as the name of the layout file.
8266 \begin_layout Standard
8267 When the text class has been modified to your taste, all you have to do
8268 is to copy it either to
8269 \begin_inset Flex Code
8272 \begin_layout Plain Layout
8279 \begin_inset Flex Code
8282 \begin_layout Plain Layout
8289 \begin_inset Flex Noun
8292 \begin_layout Plain Layout
8293 Tools\SpecialChar menuseparator
8299 , exit \SpecialChar LyX
8301 Then your new text class should be available along with the others.
8304 \begin_layout Standard
8305 Once the layout file is installed, you can edit it and see your changes
8306 without having to reconfigure or to restart \SpecialChar LyX
8311 \begin_layout Plain Layout
8312 In versions of \SpecialChar LyX
8313 prior to 1.6, this was not true.
8314 As a result, editing layout files was very time consuming, since you had
8315 constantly to restart \SpecialChar LyX
8321 You can force a reload of the current layout by using the \SpecialChar LyX
8323 \begin_inset Flex Noun
8326 \begin_layout Plain Layout
8333 There is no default binding for this function—though, of course, you can
8334 bind it to a key yourself.
8335 But you will normally use this function simply by entering it in the mini-buffe
8340 \begin_layout Standard
8346 \begin_inset Flex Noun
8349 \begin_layout Plain Layout
8355 is very much an `advanced feature'.
8360 recommended that you save your work before using this function.
8365 recommended that you not attempt to edit layout information while simultaneousl
8366 y working on a document that you care about.
8367 Use a test document.
8368 Syntax errors and the like in your layout file could cause peculiar behavior.
8369 In particular, such errors could cause \SpecialChar LyX
8370 to regard the current layout as
8371 invalid and to attempt to switch to some other layout.
8375 \begin_layout Plain Layout
8376 Really bad syntax errors may even caused \SpecialChar LyX
8378 This is because certain sorts of errors may make \SpecialChar LyX
8389 The \SpecialChar LyX
8390 team strives to keep \SpecialChar LyX
8391 stable in such situations, but safe is better
8396 \begin_layout Plain Layout
8397 While we're giving advice: make regular backups.
8398 And be nice to your mother.
8406 \begin_layout Subsection
8407 The Module declaration
8410 \begin_layout Standard
8411 A module must begin with a line like the following:
8414 \begin_layout LyX-Code
8417 DeclareLyXModule[endnotes.sty]{Endnotes}
8420 \begin_layout Standard
8421 The mandatory argument, in curly brackets, is the name of the module, as
8423 \begin_inset Flex Noun
8426 \begin_layout Plain Layout
8427 Document\SpecialChar menuseparator
8428 Settings\SpecialChar menuseparator
8435 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8437 on which the module depends.
8438 It is also possible to use the form
8439 \begin_inset Flex Noun
8442 \begin_layout Plain Layout
8448 as an optional argument, which declares that the module can only be used
8449 when there exists a conversion chain between the formats `
8450 \begin_inset Flex Code
8453 \begin_layout Plain Layout
8460 \begin_inset Flex Code
8463 \begin_layout Plain Layout
8472 \begin_layout Standard
8473 The module declaration should then be followed by lines like the following:
8477 \begin_layout Plain Layout
8478 Preferably in English if the module should be published with \SpecialChar LyX
8480 This description will appear in the list of messages to be translated and
8481 will be thus translated with the next interface update.
8489 \begin_layout LyX-Code
8493 \begin_layout LyX-Code
8494 #Adds an endnote command, in addition to footnotes.
8498 \begin_layout LyX-Code
8499 #You will need to add
8501 theendnotes in TeX code where you
8504 \begin_layout LyX-Code
8505 #want the endnotes to appear.
8509 \begin_layout LyX-Code
8513 \begin_layout LyX-Code
8514 #Requires: somemodule | othermodule
8517 \begin_layout LyX-Code
8518 #Excludes: badmodule
8521 \begin_layout Standard
8522 The description is used in
8523 \begin_inset Flex Noun
8526 \begin_layout Plain Layout
8527 Document\SpecialChar menuseparator
8528 Settings\SpecialChar menuseparator
8534 to provide the user with information about what the module does.
8536 \begin_inset Flex Code
8539 \begin_layout Plain Layout
8545 line is used to identify other modules with which this one must be used;
8547 \begin_inset Flex Code
8550 \begin_layout Plain Layout
8556 line is used to identify modules with which this one may not be used.
8557 Both are optional, and, as shown, multiple modules should be separated
8558 with the pipe symbol: |.
8559 Note that the required modules are treated disjunctively:
8563 of the required modules must be used.
8568 excluded module may be used.
8569 Note that modules are identified here by their filenames without the
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8581 \begin_inset Flex Code
8584 \begin_layout Plain Layout
8591 \begin_inset Flex Code
8594 \begin_layout Plain Layout
8603 \begin_layout Subsection
8604 The CiteEngine file declaration
8607 \begin_layout Standard
8608 A cite engine file must begin with a line like the following:
8611 \begin_layout LyX-Code
8614 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8617 \begin_layout Standard
8618 The mandatory argument, in curly brackets, is the name of the cite style,
8619 as it should appear in
8620 \begin_inset Flex Noun
8623 \begin_layout Plain Layout
8624 Document\SpecialChar menuseparator
8625 Settings\SpecialChar menuseparator
8632 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8634 on which the cite engine depends.
8637 \begin_layout Standard
8638 The cite engine declaration should then be followed by lines like the following:
8642 \begin_layout Plain Layout
8643 Preferably in English if the module should be published with \SpecialChar LyX
8645 This description will appear in the list of messages to be translated and
8646 will be thus translated with the next interface update.
8654 \begin_layout LyX-Code
8658 \begin_layout LyX-Code
8659 # Biblatex supports many author-year and numerical styles.
8662 \begin_layout LyX-Code
8663 # It is mainly aimed at the Humanities.
8667 \begin_layout LyX-Code
8668 # customizable, fully localized and provides many features
8671 \begin_layout LyX-Code
8672 # that are not possible with BibTeX.
8673 The use of 'biber' as
8676 \begin_layout LyX-Code
8677 # bibliography processor is advised.
8680 \begin_layout LyX-Code
8684 \begin_layout Standard
8685 The description is used in
8686 \begin_inset Flex Noun
8689 \begin_layout Plain Layout
8690 Document\SpecialChar menuseparator
8691 Settings\SpecialChar menuseparator
8697 to provide the user with information about the cite engine.
8700 \begin_layout Subsection
8704 \begin_layout Standard
8705 The first non-comment line of any layout file, included file, or module
8710 contain the file format number:
8713 \begin_layout Description
8714 \begin_inset Flex Code
8717 \begin_layout Plain Layout
8724 \begin_inset Flex Code
8727 \begin_layout Plain Layout
8733 ] The format number of the layout file.
8736 \begin_layout Standard
8737 This tag was introduced with \SpecialChar LyX
8739 \begin_inset space ~
8743 Layout files from older \SpecialChar LyX
8744 versions do not have an explicit file format and
8745 are considered to have
8746 \begin_inset Flex Code
8749 \begin_layout Plain Layout
8751 \begin_inset space ~
8760 The format for the present version of \SpecialChar LyX
8762 But each version of \SpecialChar LyX
8763 is capable of reading earlier versions' layout files,
8764 just as they are capable of reading files produced by earlier versions
8767 There is, however, no provision for converting to earlier formats.
8770 \begin_layout Subsection
8771 \begin_inset CommandInset label
8773 name "subsec:General-text-class"
8777 General text class parameters
8780 \begin_layout Standard
8781 These are general parameters that govern the behavior of an entire document
8787 mean that they must appear in
8788 \begin_inset Flex Code
8791 \begin_layout Plain Layout
8797 files rather than in modules.
8798 A module can contain any layout tag.)
8801 \begin_layout Description
8802 \begin_inset Flex Code
8805 \begin_layout Plain Layout
8811 Adds information that will be output in the
8812 \begin_inset Flex Code
8815 \begin_layout Plain Layout
8821 block when the document is output to XHTML.
8822 Typically, this would be used to output CSS style information, but it can
8823 be used for anything that can appear in
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8835 \begin_inset Quotes eld
8839 \begin_inset Flex Code
8842 \begin_layout Plain Layout
8849 \begin_inset Quotes erd
8855 \begin_layout Description
8856 \begin_inset Flex Code
8859 \begin_layout Plain Layout
8865 Adds information to the document preamble.
8867 \begin_inset Newline newline
8871 \begin_inset Quotes eld
8875 \begin_inset Flex Code
8878 \begin_layout Plain Layout
8885 \begin_inset Quotes erd
8891 \begin_layout Description
8892 \begin_inset Flex Code
8895 \begin_layout Plain Layout
8901 Defines the possibilities for displaying citation references.
8903 \begin_inset CommandInset ref
8905 reference "subsec:Citation-engine-description"
8914 \begin_inset Quotes eld
8918 \begin_inset Flex Code
8921 \begin_layout Plain Layout
8928 \begin_inset Quotes erd
8932 Primarily used in cite engine files (see
8933 \begin_inset CommandInset ref
8935 reference "subsec:Cite-Engine-Files"
8945 \begin_layout Description
8946 \begin_inset Flex Code
8949 \begin_layout Plain Layout
8955 Defines formats for use in the display of bibliographic information.
8957 \begin_inset CommandInset ref
8959 reference "subsec:Citation-format-description"
8965 \begin_inset Quotes eld
8969 \begin_inset Flex Code
8972 \begin_layout Plain Layout
8979 \begin_inset Quotes erd
8983 Primarily used in cite engine files (see
8984 \begin_inset CommandInset ref
8986 reference "subsec:Cite-Engine-Files"
8996 \begin_layout Description
8997 \begin_inset Flex Code
9000 \begin_layout Plain Layout
9007 \begin_inset Flex Code
9010 \begin_layout Plain Layout
9019 \begin_inset Flex Code
9022 \begin_layout Plain Layout
9028 ] Determines whether
9032 or Bib\SpecialChar TeX
9033 is used to generate a Bibliography.
9034 Primarily used in cite engine files (see
9035 \begin_inset CommandInset ref
9037 reference "subsec:Cite-Engine-Files"
9047 \begin_layout Description
9048 \begin_inset Flex Code
9051 \begin_layout Plain Layout
9057 Describes various global options supported by the document class.
9059 \begin_inset CommandInset ref
9061 reference "subsec:ClassOptions"
9067 \begin_inset Quotes eld
9071 \begin_inset Flex Code
9074 \begin_layout Plain Layout
9081 \begin_inset Quotes erd
9087 \begin_layout Description
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9098 \begin_inset Flex Code
9101 \begin_layout Plain Layout
9110 \begin_inset space \thinspace{}
9114 \begin_inset Flex Code
9117 \begin_layout Plain Layout
9123 ] Whether the class should
9127 to having one or two columns.
9128 Can be changed in the
9129 \begin_inset Flex Noun
9132 \begin_layout Plain Layout
9133 Document\SpecialChar menuseparator
9142 \begin_layout Description
9143 \begin_inset Flex Code
9146 \begin_layout Plain Layout
9153 \begin_inset Flex Code
9156 \begin_layout Plain Layout
9162 ] This sequence defines the properties for a counter.
9163 If the counter does not yet exist, it is created; if it does exist, it
9166 \begin_inset Quotes eld
9170 \begin_inset Flex Code
9173 \begin_layout Plain Layout
9180 \begin_inset Quotes erd
9184 \begin_inset Newline newline
9188 \begin_inset CommandInset ref
9190 reference "subsec:Counters"
9194 for details on counters.
9197 \begin_layout Description
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9207 Sets the default font used to display the document.
9209 \begin_inset CommandInset ref
9211 reference "subsec:Font-description"
9215 for how to declare fonts.
9217 \begin_inset Quotes eld
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9231 \begin_inset Quotes erd
9237 \begin_layout Description
9238 \begin_inset Flex Code
9241 \begin_layout Plain Layout
9248 \begin_inset Flex Code
9251 \begin_layout Plain Layout
9257 ] Specifies a module to be included by default with this document class.
9258 The module is specified as filename without the
9259 \begin_inset Flex Code
9262 \begin_layout Plain Layout
9269 The user can still remove the module, but it will be active at the outset.
9270 (This applies only when new files are created, or when this class is chosen
9271 for an existing document.)
9274 \begin_layout Description
9275 \begin_inset Flex Code
9278 \begin_layout Plain Layout
9285 \begin_inset Flex Code
9288 \begin_layout Plain Layout
9294 ] This is the style that will be assigned to new paragraphs, usually
9295 \begin_inset Flex Noun
9298 \begin_layout Plain Layout
9305 This will default to the first defined style if not given, but you are
9306 encouraged to use this directive.
9309 \begin_layout Description
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9320 \begin_inset Flex Code
9323 \begin_layout Plain Layout
9329 ] This tag indicates that the module (which is specified by filename without
9331 \begin_inset Flex Code
9334 \begin_layout Plain Layout
9340 extension) cannot be used with this document class.
9341 This might be used in a journal-specific layout file to prevent, say, the
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9352 module that numbers theorems by section.
9357 be used in a module.
9358 Modules have their own way of excluding other modules (see
9359 \begin_inset CommandInset ref
9361 reference "subsec:Layout-modules"
9368 \begin_layout Description
9369 \begin_inset Flex Code
9372 \begin_layout Plain Layout
9378 Defines a new float.
9380 \begin_inset CommandInset ref
9382 reference "subsec:Floats"
9388 \begin_inset Quotes eld
9392 \begin_inset Flex Code
9395 \begin_layout Plain Layout
9402 \begin_inset Quotes erd
9408 \begin_layout Description
9409 \begin_inset Flex Code
9412 \begin_layout Plain Layout
9418 Sets the information that will be output in the
9419 \begin_inset Flex Code
9422 \begin_layout Plain Layout
9428 block when this document class is output to XHTML.
9429 Note that this will completely override any prior
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9440 \begin_inset Flex Code
9443 \begin_layout Plain Layout
9451 \begin_inset Newline newline
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9464 if you just want to add material to the preamble.) Must end with
9465 \begin_inset Quotes eld
9469 \begin_inset Flex Code
9472 \begin_layout Plain Layout
9479 \begin_inset Quotes erd
9485 \begin_layout Description
9486 \begin_inset Flex Code
9489 \begin_layout Plain Layout
9496 \begin_inset Flex Code
9499 \begin_layout Plain Layout
9505 ] The style to use for the table of contents, bibliography, and so forth,
9506 when the document is output to HTML.
9507 For articles, this should normally be
9508 \begin_inset Flex Code
9511 \begin_layout Plain Layout
9518 \begin_inset Flex Code
9521 \begin_layout Plain Layout
9528 If it is not given, then \SpecialChar LyX
9529 will attempt to figure out which layout to use.
9532 \begin_layout Description
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9543 \begin_inset Flex Code
9546 \begin_layout Plain Layout
9552 ] Modifies the properties of the given counter.
9553 If the counter does not exist, the statement is ignored.
9555 \begin_inset Quotes eld
9559 \begin_inset Flex Code
9562 \begin_layout Plain Layout
9569 \begin_inset Quotes erd
9573 \begin_inset Newline newline
9577 \begin_inset CommandInset ref
9579 reference "subsec:Counters"
9583 for details on counters.
9586 \begin_layout Description
9587 \begin_inset Flex Code
9590 \begin_layout Plain Layout
9597 \begin_inset Flex Code
9600 \begin_layout Plain Layout
9606 ] This allows you to include another layout definition file within yours
9607 to avoid duplicating commands.
9608 Common examples are the standard layout files, for example,
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9618 , which contains most of the basic layouts.
9621 \begin_layout Description
9622 \begin_inset Flex Code
9625 \begin_layout Plain Layout
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9641 ] This section (re-)defines the layout of an inset.
9642 It can be applied to an existing inset or to a new, user-defined inset,
9643 e.g., a new character style.
9645 \begin_inset Quotes eld
9649 \begin_inset Flex Code
9652 \begin_layout Plain Layout
9659 \begin_inset Quotes erd
9663 \begin_inset Newline newline
9667 \begin_inset CommandInset ref
9669 reference "subsec:Flex-insets-and"
9673 for more information.
9677 \begin_layout Description
9678 \begin_inset Flex Code
9681 \begin_layout Plain Layout
9688 \begin_inset Flex Code
9691 \begin_layout Plain Layout
9697 ] A string that indicates the width of the left margin on the screen, for
9699 \begin_inset Quotes eld
9703 \begin_inset Flex Code
9706 \begin_layout Plain Layout
9713 \begin_inset Quotes erd
9717 (Note that this is not a `length', like
9718 \begin_inset Quotes eld
9722 \begin_inset Quotes erd
9728 \begin_layout Description
9729 \begin_inset Flex Code
9732 \begin_layout Plain Layout
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9748 ] An integer that determines the maximal number of names displayed in an
9749 author-year citation before the citation switches to
9750 \begin_inset Quotes eld
9754 \begin_inset Quotes erd
9758 Primarily used in cite engine files (see
9759 \begin_inset CommandInset ref
9761 reference "subsec:Cite-Engine-Files"
9771 \begin_layout Description
9772 \begin_inset Flex Code
9775 \begin_layout Plain Layout
9782 \begin_inset Flex Code
9785 \begin_layout Plain Layout
9791 ] Modifies the properties of the given paragraph style.
9792 If the style does not exist, this section is ignored.
9794 \begin_inset Quotes eld
9798 \begin_inset Flex Code
9801 \begin_layout Plain Layout
9808 \begin_inset Quotes erd
9814 \begin_layout Description
9815 \begin_inset Flex Code
9818 \begin_layout Plain Layout
9825 \begin_inset Flex Code
9828 \begin_layout Plain Layout
9834 ] Deletes an existing counter, usually one defined in an included file.
9837 \begin_layout Description
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9857 ] Deletes an existing float.
9858 This is particularly useful when you want to suppress a float that has
9859 been defined in an input file.
9862 \begin_layout Description
9863 \begin_inset Flex Code
9866 \begin_layout Plain Layout
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9882 ] Deletes an existing style.
9885 \begin_layout Description
9886 \begin_inset Flex Code
9889 \begin_layout Plain Layout
9896 \begin_inset Flex Code
9899 \begin_layout Plain Layout
9906 \begin_inset Flex Code
9909 \begin_layout Plain Layout
9915 ] Define a new table of contents with type
9916 \begin_inset Flex Code
9919 \begin_layout Plain Layout
9926 \begin_inset Flex Code
9929 \begin_layout Plain Layout
9936 See also the AddToToc commands.
9939 \begin_layout Description
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9959 ] The file format (as defined in the \SpecialChar LyX
9960 preferences) produced by this document
9962 It is mainly useful when
9963 \begin_inset Flex Code
9966 \begin_layout Plain Layout
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9982 and one wants to define a new type of literate document.
9983 The format is reset to
9984 \begin_inset Quotes eld
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9998 \begin_inset Quotes erd
10002 \begin_inset Quotes eld
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10016 \begin_inset Quotes erd
10019 when the corresponding
10020 \begin_inset Flex Code
10023 \begin_layout Plain Layout
10029 parameter is encountered.
10032 \begin_layout Description
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10043 \begin_inset Flex Code
10046 \begin_layout Plain Layout
10057 \begin_inset Flex Code
10060 \begin_layout Plain Layout
10067 \begin_inset Flex Code
10070 \begin_layout Plain Layout
10076 ] Specifies what sort of output documents using this class will produce.
10079 \begin_layout Description
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10090 \begin_inset Flex Code
10093 \begin_layout Plain Layout
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10109 ] Specifies options, given in the second string, for the package named by
10112 \begin_inset Quotes eld
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10120 PackageOptions natbib square
10126 \begin_inset Quotes erd
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10139 to be loaded with the
10140 \begin_inset Flex Code
10143 \begin_layout Plain Layout
10150 (For \SpecialChar TeX
10151 perts, this causes \SpecialChar LyX
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10159 PassOptionsToPackage{natbib}{square}
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10177 \begin_layout Description
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 ] The default pagestyle.
10220 Can be changed in the
10221 \begin_inset Flex Noun
10224 \begin_layout Plain Layout
10225 Document\SpecialChar menuseparator
10234 \begin_layout Description
10235 \begin_inset Flex Code
10238 \begin_layout Plain Layout
10244 Sets the preamble for the \SpecialChar LaTeX
10246 Note that this will completely override any prior
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10257 \begin_inset Flex Code
10260 \begin_layout Plain Layout
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10277 if you just want to add material to the preamble.) Must end with
10278 \begin_inset Quotes eld
10282 \begin_inset Flex Code
10285 \begin_layout Plain Layout
10292 \begin_inset Quotes erd
10298 \begin_layout Description
10299 \begin_inset Flex Code
10302 \begin_layout Plain Layout
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10331 \begin_inset space \thinspace{}
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10344 ] Whether the class already provides the feature
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10355 A feature is in general the name of a package (e.
10356 \begin_inset space \thinspace{}
10360 \begin_inset space \space{}
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10374 \begin_inset Flex Code
10377 \begin_layout Plain Layout
10384 \begin_inset space \thinspace{}
10388 \begin_inset space \space{}
10392 \begin_inset Flex Code
10395 \begin_layout Plain Layout
10402 \begin_inset Flex Code
10405 \begin_layout Plain Layout
10413 \begin_inset CommandInset ref
10415 reference "chap:List-of-functions"
10419 for the list of features.
10422 \begin_layout Description
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10442 ] Indicates that this layout provides the functionality of the module mentioned,
10443 which should be specified by the filename without the
10444 \begin_inset Flex Code
10447 \begin_layout Plain Layout
10454 This will typically be used if the layout includes the module directly,
10455 rather than using the
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10465 tag to indicate that it ought to be used.
10466 It could also be used in a module that provided an alternate implementation
10467 of the same functionality.
10470 \begin_layout Description
10471 \begin_inset Flex Code
10474 \begin_layout Plain Layout
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10490 ] Creates a new paragraph style if it does not already exist.
10491 If the style does exist, this section is ignored.
10493 \begin_inset Quotes eld
10497 \begin_inset Flex Code
10500 \begin_layout Plain Layout
10507 \begin_inset Quotes erd
10513 \begin_layout Description
10514 \begin_inset Flex Code
10517 \begin_layout Plain Layout
10524 \begin_inset Flex Code
10527 \begin_layout Plain Layout
10533 ] Whether the class requires the feature
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10544 Multiple features must be separated by commas.
10545 Note that you can only request supported features.
10547 \begin_inset CommandInset ref
10549 reference "chap:List-of-functions"
10553 for the list of features.).
10554 If you require a package with specific options, you can additionally use
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10568 \begin_layout Description
10569 \begin_inset Flex Code
10572 \begin_layout Plain Layout
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10588 ] A string that indicates the width of the right margin on the screen, for
10590 \begin_inset Quotes eld
10594 \begin_inset Flex Code
10597 \begin_layout Plain Layout
10604 \begin_inset Quotes erd
10610 \begin_layout Description
10611 \begin_inset Flex Code
10614 \begin_layout Plain Layout
10621 \begin_inset Flex Code
10624 \begin_layout Plain Layout
10630 ] Sets which divisions get numbered.
10632 \begin_inset Newline newline
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10645 counter in \SpecialChar LaTeX
10649 \begin_layout Description
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10672 \begin_inset space \thinspace{}
10676 \begin_inset Flex Code
10679 \begin_layout Plain Layout
10685 ] Whether the class-default should be printing on one or both sides of the
10687 Can be changed in the
10688 \begin_inset Flex Noun
10691 \begin_layout Plain Layout
10692 Document\SpecialChar menuseparator
10701 \begin_layout Description
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10712 \begin_inset Flex Code
10715 \begin_layout Plain Layout
10721 ] This sequence defines a paragraph style.
10722 If the style does not yet exist, it is created; if it does exist, its parameter
10725 \begin_inset Quotes eld
10729 \begin_inset Flex Code
10732 \begin_layout Plain Layout
10739 \begin_inset Quotes erd
10743 \begin_inset Newline newline
10747 \begin_inset CommandInset ref
10749 reference "subsec:Paragraph-Styles"
10753 for details on paragraph styles.
10756 \begin_layout Description
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10776 ] The name of the command or environment to be used with
10777 \begin_inset Flex Code
10780 \begin_layout Plain Layout
10789 \begin_layout Description
10790 \begin_inset Flex Code
10793 \begin_layout Plain Layout
10800 \begin_inset Flex Code
10803 \begin_layout Plain Layout
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10821 ] Indicates what kind of markup is used to define the title of a document.
10823 \begin_inset Flex Code
10826 \begin_layout Plain Layout
10832 means that the macro with name
10833 \begin_inset Flex Code
10836 \begin_layout Plain Layout
10842 will be inserted after the last layout which has
10843 \begin_inset Quotes eld
10847 \begin_inset Flex Code
10850 \begin_layout Plain Layout
10852 \begin_inset space ~
10861 \begin_inset Quotes erd
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10875 corresponds to the case where all layouts which have
10876 \begin_inset Quotes eld
10880 \begin_inset Flex Code
10883 \begin_layout Plain Layout
10885 \begin_inset space ~
10894 \begin_inset Quotes erd
10897 should be enclosed into the
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10910 \begin_layout Description
10911 \begin_inset Flex Code
10914 \begin_layout Plain Layout
10921 \begin_inset Flex Code
10924 \begin_layout Plain Layout
10930 ] Sets which divisions are included in the table of contents.
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10941 counter in \SpecialChar LaTeX
10945 \begin_layout Subsection
10946 \begin_inset Flex Code
10949 \begin_layout Plain Layout
10956 \begin_inset CommandInset label
10958 name "subsec:ClassOptions"
10965 \begin_layout Standard
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 section can contain the following entries:
10979 \begin_layout Description
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
10999 ] The list of available font sizes for the document's main font, separated
11001 \begin_inset Quotes eld
11005 \begin_inset Flex Code
11008 \begin_layout Plain Layout
11015 \begin_inset Quotes erd
11021 \begin_layout Description
11022 \begin_inset Flex Code
11025 \begin_layout Plain Layout
11031 Used to set the DTD line with XML-based output classes.
11033 \begin_inset space \thinspace{}
11037 \begin_inset Quotes eld
11040 -//OASIS//DTD DocBook V4.2//EN
11041 \begin_inset Quotes erd
11047 \begin_layout Description
11048 \begin_inset Flex Code
11051 \begin_layout Plain Layout
11058 \begin_inset Flex Code
11061 \begin_layout Plain Layout
11062 string="empty|plain|headings|fancy"
11067 ] The list of available page sty\SpecialChar softhyphen
11069 \begin_inset Quotes eld
11073 \begin_inset Flex Code
11076 \begin_layout Plain Layout
11083 \begin_inset Quotes erd
11089 \begin_layout Description
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11100 \begin_inset Flex Code
11103 \begin_layout Plain Layout
11109 ] Some document class options, separated by a comma, that will be added
11110 to the optional part of the
11111 \begin_inset Flex Code
11114 \begin_layout Plain Layout
11125 \begin_layout Standard
11127 \begin_inset Flex Code
11130 \begin_layout Plain Layout
11136 section must end with
11137 \begin_inset Quotes eld
11141 \begin_inset Flex Code
11144 \begin_layout Plain Layout
11151 \begin_inset Quotes erd
11157 \begin_layout Subsection
11159 \begin_inset CommandInset label
11161 name "subsec:Paragraph-Styles"
11168 \begin_layout Standard
11169 A paragraph style description looks like this:
11173 \begin_layout Plain Layout
11174 Note that this will either define a new style or modify an existing one.
11182 \begin_layout LyX-Code
11189 \begin_layout LyX-Code
11193 \begin_layout LyX-Code
11197 \begin_layout Standard
11198 where the following commands are allowed:
11201 \begin_layout Description
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11221 =""] This paragraph will appear in the table of contents of the given type.
11222 An empty string disables.
11223 See also the OutlinerName and the IsTocCaption commands.
11227 \begin_layout Description
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11238 \begin_inset Flex Code
11241 \begin_layout Plain Layout
11246 , left, right, center
11251 ] Paragraph alignment.
11254 \begin_layout Description
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11265 \begin_inset Flex Code
11268 \begin_layout Plain Layout
11273 , left, right, center
11278 ] A comma separated list of permitted alignments.
11279 (Some \SpecialChar LaTeX
11280 styles prohibit certain alignments, since those wouldn't make sense.
11281 For example a right-aligned or centered enumeration isn't possible.)
11284 \begin_layout Description
11285 \begin_inset Flex Code
11288 \begin_layout Plain Layout
11295 \begin_inset Flex Code
11298 \begin_layout Plain Layout
11304 ] Defines argument number <int> of a command\SpecialChar breakableslash
11305 environment associated with
11307 This is useful for things like section headings, and only makes sense with
11310 Every (optional or required) argument of a command or environment – except
11311 for the required argument that is associated with the content of the paragraph
11312 itself – has a separate definition, where the number specifies the order
11314 The definition must end with
11315 \begin_inset Flex Code
11318 \begin_layout Plain Layout
11325 So a command with two optional arguments has:
11329 \begin_layout Quote
11335 \begin_layout Quote
11341 \begin_layout Quote
11347 \begin_layout Quote
11353 \begin_layout Quote
11359 \begin_layout Quote
11365 \begin_layout Standard
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11376 definition, the following specifications are possible:
11379 \begin_layout Itemize
11380 \begin_inset Flex Code
11383 \begin_layout Plain Layout
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11399 The string that will appear both in the menu (to insert this argument)
11400 and on the argument inset button (unless you also specify a separate
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 For the menu, you can define an accelerator by appending the respective
11412 character to 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
11449 \begin_layout Itemize
11450 \begin_inset Flex Code
11453 \begin_layout Plain Layout
11460 \begin_inset Flex Code
11463 \begin_layout Plain Layout
11469 A separate string for the menu.
11470 You can define an accelerator by appending the respective character to
11471 the string, divided by
11472 \begin_inset Quotes eld
11476 \begin_inset Quotes erd
11480 \begin_inset space \thinspace{}
11484 \begin_inset space \space{}
11488 \begin_inset Quotes eld
11492 \begin_inset Flex Code
11495 \begin_layout Plain Layout
11502 \begin_inset Quotes erd
11506 This specification is optional.
11507 If it is not given the
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11517 will be used instead for the menu.
11520 \begin_layout Itemize
11521 \begin_inset Flex Code
11524 \begin_layout Plain Layout
11531 \begin_inset Flex Code
11534 \begin_layout Plain Layout
11540 A longer explanatory text that appears in the tooltip when hovering over
11541 the argument inset.
11544 \begin_layout Itemize
11545 \begin_inset Flex Code
11548 \begin_layout Plain Layout
11555 \begin_inset Flex Code
11558 \begin_layout Plain Layout
11567 \begin_inset space \thinspace{}
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11580 ] Declare if this is a mandatory (1) or an optional (0) argument.
11581 Mandatory arguments will be output empty if not given, while optional arguments
11582 will not be output at all.
11583 By default, mandatory arguments are delimited by
11584 \begin_inset Flex Code
11587 \begin_layout Plain Layout
11593 , while optional arguments are delimited by
11594 \begin_inset Flex Code
11597 \begin_layout Plain Layout
11606 \begin_layout Itemize
11607 \begin_inset Flex Code
11610 \begin_layout Plain Layout
11617 \begin_inset Flex Code
11620 \begin_layout Plain Layout
11626 defines another argument (by its number) which this argument requires to
11627 be output if it is itself output.
11629 \begin_inset space \thinspace{}
11632 g., in \SpecialChar LaTeX
11633 commands, optional arguments often require previous optional arguments
11634 to be output (at least empty), as in
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11641 command[][argument]{text}
11647 This can be achieved by the statement
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11670 \begin_layout Itemize
11671 \begin_inset Flex Code
11674 \begin_layout Plain Layout
11681 \begin_inset Flex Code
11684 \begin_layout Plain Layout
11690 defines a custom left delimiter (instead of
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11711 A line break in the output can be indicated by
11712 \begin_inset Flex Code
11715 \begin_layout Plain Layout
11724 \begin_layout Itemize
11725 \begin_inset Flex Code
11728 \begin_layout Plain Layout
11735 \begin_inset Flex Code
11738 \begin_layout Plain Layout
11744 defines a custom right delimiter (instead of
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11765 A line break in the output can be indicated by
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11778 \begin_layout Itemize
11779 \begin_inset Flex Code
11782 \begin_layout Plain Layout
11789 \begin_inset Flex Code
11792 \begin_layout Plain Layout
11798 defines an argument that is inserted if and only if no user-specified arguments
11800 \begin_inset space \thinspace{}
11804 \begin_inset space \space{}
11807 if no argument inset has been inserted (note that also an empty argument
11808 inset omits the DefaultArg).
11809 Multiple arguments need to be separated by comma.
11812 \begin_layout Itemize
11813 \begin_inset Flex Code
11816 \begin_layout Plain Layout
11823 \begin_inset Flex Code
11826 \begin_layout Plain Layout
11832 defines an argument that is inserted in any case (alone or in addition
11833 to user-specified arguments).
11834 Multiple arguments need to be separated by comma.
11837 \begin_layout Itemize
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11847 The font used for the argument content, see
11848 \begin_inset CommandInset ref
11850 reference "subsec:Font-description"
11857 \begin_layout Itemize
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11867 The font used for the label; see
11868 \begin_inset CommandInset ref
11870 reference "subsec:Font-description"
11877 \begin_layout Itemize
11878 \begin_inset Flex Code
11881 \begin_layout Plain Layout
11888 \begin_inset Flex Code
11891 \begin_layout Plain Layout
11896 , Minimalistic, Conglomerate
11901 ] describes the rendering style used for the inset's frame and buttons.
11904 \begin_layout Itemize
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11915 \begin_inset Flex Code
11918 \begin_layout Plain Layout
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11934 , this argument is automatically inserted when the respective style is selected.
11935 Currently, only one argument per style\SpecialChar breakableslash
11936 layout can be automatically inserted.
11939 \begin_layout Itemize
11940 \begin_inset Flex Code
11943 \begin_layout Plain Layout
11950 \begin_inset Flex Code
11953 \begin_layout Plain Layout
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11969 , this argument will be inserted with a copy of the co-text (either selected
11970 text or the whole paragraph) as content.
11973 \begin_layout Itemize
11974 \begin_inset Flex Code
11977 \begin_layout Plain Layout
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11997 ] Whether the contents of this argument should be output in raw form, meaning
11998 without special translations that \SpecialChar LaTeX
12001 \begin_inset Flex Code
12004 \begin_layout Plain Layout
12010 status is inherited by the inset or paragraph layout the argument belongs
12011 to, true and false change the status for the given argument only.
12014 \begin_layout Itemize
12015 \begin_inset Flex Code
12018 \begin_layout Plain Layout
12025 \begin_inset Flex Code
12028 \begin_layout Plain Layout
12029 string of characters
12038 Defines individual characters
12039 \begin_inset Newline linebreak
12042 that should be output in raw form, meaning without special translations
12043 that \SpecialChar LaTeX
12045 Note that, contrary to PassThru, this needs to be explicitly defined for
12047 That is, arguments do not inherit PassThruChars from their parent inset
12051 \begin_layout Itemize
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12074 \begin_inset space \thinspace{}
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12087 ] If this is set to 1, the argument will output its content in the corresponding
12088 item in the table of contents.
12092 \begin_layout Standard
12093 By default, the text entered in the \SpecialChar LyX
12094 workarea in the respective layout is
12095 the last (mandatory) argument of a command if the
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12106 \begin_inset Flex Code
12109 \begin_layout Plain Layout
12116 However, arguments with the prefix
12117 \begin_inset Flex Code
12120 \begin_layout Plain Layout
12126 are output after this workarea argument.
12127 Note that post-argument numbering restarts at 1, so the first argument
12128 following the workarea argument is
12129 \begin_inset Flex Code
12132 \begin_layout Plain Layout
12139 Post-arguments are ignored in any other
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12162 \begin_layout Standard
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12176 \begin_inset Flex Code
12179 \begin_layout Plain Layout
12188 \begin_inset Flex Code
12191 \begin_layout Plain Layout
12197 followed by the number (e.
12198 \begin_inset space \thinspace{}
12202 \begin_inset space \space{}
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12219 \begin_layout Description
12220 \begin_inset Flex Code
12223 \begin_layout Plain Layout
12229 Includes a comma-separated list of layouts that should be nested in and
12230 after the current layout.
12231 Only makes sense for nestable layouts (such as environments).
12233 \begin_inset Quotes eld
12237 \begin_inset Flex Code
12240 \begin_layout Plain Layout
12247 \begin_inset Quotes erd
12252 \begin_inset Flex Code
12255 \begin_layout Plain Layout
12264 \begin_layout Description
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12274 Note that this will completely override any prior
12275 \begin_inset Flex Code
12278 \begin_layout Plain Layout
12284 declaration for this style.
12286 \begin_inset Quotes eld
12290 \begin_inset Flex Code
12293 \begin_layout Plain Layout
12300 \begin_inset Quotes erd
12305 \begin_inset CommandInset ref
12307 reference "subsec:I18n"
12311 for details on its use.
12314 \begin_layout Description
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12338 \begin_layout Plain Layout
12339 Note that a `float' here is a real number, such as: 1.5.
12344 The vertical space with which the last of a chain of paragraphs with this
12345 style is separated from the following paragraph.
12346 If the next paragraph has another style, the separations are not simply
12347 added, but the maximum is taken.
12350 \begin_layout Description
12351 \begin_inset Flex Code
12354 \begin_layout Plain Layout
12361 \begin_inset Flex Code
12364 \begin_layout Plain Layout
12370 ] The category for this style.
12371 This is used to group related styles in the style combobox on the toolbar.
12372 Any string can be used, but you may want to use existing categories with
12377 \begin_layout Description
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12387 Depth of XML command.
12388 Used only with XML-type formats.
12391 \begin_layout Description
12392 \begin_inset Flex Code
12395 \begin_layout Plain Layout
12402 \begin_inset Flex Code
12405 \begin_layout Plain Layout
12411 ] Copies all the features of an existing style into the current one.
12415 \begin_layout Description
12416 \begin_inset Flex Code
12419 \begin_layout Plain Layout
12426 \begin_inset Flex Code
12429 \begin_layout Plain Layout
12435 ] The name of a style whose preamble should be output
12440 This allows to ensure some ordering of the preamble snippets when macros
12441 definitions depend on one another.
12445 \begin_layout Plain Layout
12446 Note that, besides that functionality, there is no way to ensure any ordering
12448 The ordering that you see in a given version of \SpecialChar LyX
12449 may change without warning
12458 \begin_layout Description
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12469 \begin_inset Flex Code
12472 \begin_layout Plain Layout
12477 , Box, Filled_Box, Static
12482 ] The type of label that stands at the end of the paragraph (or sequence
12484 \begin_inset Flex Code
12487 \begin_layout Plain Layout
12494 \begin_inset Newline newline
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12518 \begin_inset Flex Code
12521 \begin_layout Plain Layout
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12539 \begin_inset Quotes eld
12543 \begin_inset Quotes erd
12547 \begin_inset Flex Code
12550 \begin_layout Plain Layout
12557 \begin_inset space \space{}
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12570 ) is a white (resp.
12571 \begin_inset space ~
12574 black) square suitable for end of proof markers,
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12584 is an explicit text string.
12587 \begin_layout Description
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12598 \begin_inset Flex Code
12601 \begin_layout Plain Layout
12607 ] The string used for a label with a
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12618 \begin_inset Newline newline
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12635 \begin_layout Description
12636 \begin_inset Flex Code
12639 \begin_layout Plain Layout
12645 The font used for both the text body
12651 \begin_inset CommandInset ref
12653 reference "subsec:Font-description"
12658 Note that defining this font automatically defines the
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12669 So you should define this one first if you also want to define
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12682 \begin_layout Description
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12702 ] Used for backporting new styles to stable \SpecialChar LyX
12704 The first stable version that supports this tag is \SpecialChar LyX
12706 The argument is a number which may either be 0, -1 or any value greater
12709 \begin_inset Flex Code
12712 \begin_layout Plain Layout
12718 flag of a style is greater than zero, it will always be written to the
12720 If a .lyx file is read, the style definitions from the document header are
12721 added to the document class.
12722 Therefore even older \SpecialChar LyX
12723 versions can handle the style.
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12734 is a version number: if the style is read, and the version number is less
12735 than the version number of the already existing style in the document class,
12736 the new style is ignored.
12737 If the version number is greater, the new style replaces the existing style.
12738 A value of -1 means an infinite version number, i.
12739 \begin_inset space \thinspace{}
12743 \begin_inset space \space{}
12746 the style is always used.
12749 \begin_layout Description
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12760 \begin_inset Flex Code
12763 \begin_layout Plain Layout
12772 \begin_inset space \thinspace{}
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12785 ] Usually \SpecialChar LyX
12786 does not allow you to insert more than one space between words,
12787 since a space is considered as the separation between two words, not a
12788 character or symbol of its own.
12789 This is a very fine thing but sometimes annoying, for example, when typing
12790 program code or plain \SpecialChar LaTeX
12793 \begin_inset Flex Code
12796 \begin_layout Plain Layout
12803 Note that \SpecialChar LyX
12804 will create protected blanks for the additional blanks when
12805 in another mode than \SpecialChar LaTeX
12809 \begin_layout Description
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12819 These tags are used with XHTML output.
12821 \begin_inset CommandInset ref
12823 reference "subsec:Paragraph-Style-XHTML"
12830 \begin_layout Description
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12840 [FIXME] (Used only with XML-type formats.)
12843 \begin_layout Description
12844 \begin_inset Flex Code
12847 \begin_layout Plain Layout
12854 \begin_inset Flex Code
12857 \begin_layout Plain Layout
12866 \begin_inset space \thinspace{}
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12880 \begin_inset Flex Code
12883 \begin_layout Plain Layout
12889 , marks the style as to be included in the document preamble and not in
12891 This is useful for document classes that want such information as the title
12892 and author to appear in the preamble.
12893 Note that this works only for styles for which the
12894 \begin_inset Flex Code
12897 \begin_layout Plain Layout
12904 \begin_inset Flex Code
12907 \begin_layout Plain Layout
12914 \begin_inset Flex Code
12917 \begin_layout Plain Layout
12926 \begin_layout Description
12927 \begin_inset Flex Code
12930 \begin_layout Plain Layout
12937 \begin_inset Flex Code
12940 \begin_layout Plain Layout
12949 \begin_inset space \thinspace{}
12953 \begin_inset Flex Code
12956 \begin_layout Plain Layout
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12972 , marks the style as being part of a title block (see also the
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12995 \begin_layout Description
12996 \begin_inset Flex Code
12999 \begin_layout Plain Layout
13005 Includes a comma-separated list of layouts after which this one should
13007 Only makes sense with regard to nestable layouts (such as environments).
13009 \begin_inset Quotes eld
13013 \begin_inset Flex Code
13016 \begin_layout Plain Layout
13023 \begin_inset Quotes erd
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13040 \begin_layout Description
13041 \begin_inset Flex Code
13044 \begin_layout Plain Layout
13051 \begin_inset Flex Code
13054 \begin_layout Plain Layout
13063 \begin_inset space \thinspace{}
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13076 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13077 of its contents in its item in the table of contents.
13078 Otherwise, only the label, if it exists, appears.
13081 \begin_layout Description
13082 \begin_inset Flex Code
13085 \begin_layout Plain Layout
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13101 ] The \SpecialChar LaTeX
13102 command sequence declaring an item in a list.
13103 The command is to be defined without the preceding backslash (the default
13105 \begin_inset Quotes eld
13109 \begin_inset Quotes erd
13113 \begin_inset Flex Code
13116 \begin_layout Plain Layout
13124 in the \SpecialChar LaTeX
13128 \begin_layout Description
13129 \begin_inset Flex Code
13132 \begin_layout Plain Layout
13139 \begin_inset Flex Code
13142 \begin_layout Plain Layout
13148 ] This provides extra space between paragraphs that have the same style.
13149 If you put other styles into an environment, each is separated with the
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13161 But the whole items of the environment are additionally separated with
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13173 Note that this is a
13178 \begin_layout Description
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13188 [FIXME] (Used only with XML-type formats.)
13191 \begin_layout Description
13192 \begin_inset Flex Code
13195 \begin_layout Plain Layout
13202 \begin_inset Flex Code
13205 \begin_layout Plain Layout
13214 \begin_inset space \thinspace{}
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13227 ] Usually \SpecialChar LyX
13228 does not allow you to leave a paragraph empty, since it would
13229 lead to empty \SpecialChar LaTeX
13231 There are some cases where this could be desirable however: in a letter
13232 template, the required fields can be provided as empty fields, so that
13233 people do not forget them; in some special classes, a style can be used
13234 as some kind of break, which does not contain actual text.
13237 \begin_layout Description
13238 \begin_inset Flex Code
13241 \begin_layout Plain Layout
13248 \begin_inset Flex Code
13251 \begin_layout Plain Layout
13257 ] The vertical space between the label and the text body.
13258 Only used for labels that are above the text body (
13259 \begin_inset Flex Code
13262 \begin_layout Plain Layout
13269 \begin_inset Newline newline
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13277 Centered_Top_Environment
13285 \begin_layout Description
13286 \begin_inset Flex Code
13289 \begin_layout Plain Layout
13296 \begin_inset Flex Code
13299 \begin_layout Plain Layout
13305 ] The name of the counter for automatic numbering.
13306 In order to have the counter appear with your label, you will need to reference
13308 \begin_inset Flex Code
13311 \begin_layout Plain Layout
13320 This will work with
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13361 \begin_inset Newline newline
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13388 , though this case is a bit complicated.
13389 Suppose you declare
13390 \begin_inset Quotes eld
13394 \begin_inset Flex Code
13397 \begin_layout Plain Layout
13398 LabelCounter myenum
13404 \begin_inset Quotes erd
13408 Then the actual counters used are
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13448 , much as in \SpecialChar LaTeX
13450 These counters must all be declared separately.
13451 \begin_inset Newline newline
13455 \begin_inset CommandInset ref
13457 reference "subsec:Counters"
13461 for details on counters.
13464 \begin_layout Description
13465 \begin_inset Flex Code
13468 \begin_layout Plain Layout
13474 The font used for the label.
13476 \begin_inset CommandInset ref
13478 reference "subsec:Font-description"
13485 \begin_layout Description
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13496 \begin_inset Flex Code
13499 \begin_layout Plain Layout
13505 ] Text that indicates how far a label should be indented.
13508 \begin_layout Description
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13519 \begin_inset Flex Code
13522 \begin_layout Plain Layout
13528 ] Text that indicates the amount of horizontal space between the label and
13530 Only used for labels that are not above the text body.
13533 \begin_layout Description
13534 \begin_inset Flex Code
13537 \begin_layout Plain Layout
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13553 ] The string used for the label.
13555 \begin_inset Flex Code
13558 \begin_layout Plain Layout
13564 is set, this string can be contain the special formatting commands described
13566 \begin_inset CommandInset ref
13568 reference "subsec:Counters"
13575 \begin_layout Description
13576 \begin_inset Flex Code
13579 \begin_layout Plain Layout
13580 LabelStringAppendix
13586 \begin_inset Flex Code
13589 \begin_layout Plain Layout
13595 ] This is used inside the appendix instead of
13596 \begin_inset Newline newline
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13621 \begin_inset Newline newline
13625 \begin_inset Flex Code
13628 \begin_layout Plain Layout
13629 LabelStringAppendix
13637 \begin_layout Description
13638 \begin_inset Flex Code
13641 \begin_layout Plain Layout
13647 [FIXME] (Used only with XML-type formats.)
13650 \begin_layout Description
13651 \begin_inset Flex Code
13654 \begin_layout Plain Layout
13661 \begin_inset Flex Code
13664 \begin_layout Plain Layout
13669 , Manual, Static, Above,
13670 \begin_inset Newline newline
13673 Centered, Sensitive, Enumerate,
13674 \begin_inset Newline newline
13677 Itemize, Bibliography
13686 \begin_layout Description
13687 \begin_inset Flex Code
13690 \begin_layout Plain Layout
13696 means the label is the very first word (up to the first real blank).
13697 Use protected spaces if you want more than one word as the label.
13701 \begin_layout Description
13702 \begin_inset Flex Code
13705 \begin_layout Plain Layout
13711 means the label is simply what is declared as
13712 \begin_inset Flex Code
13715 \begin_layout Plain Layout
13722 This will be displayed
13723 \begin_inset Quotes eld
13727 \begin_inset Quotes erd
13730 , at the beginning of the paragraph.
13732 \begin_inset Flex Code
13735 \begin_layout Plain Layout
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13751 , then it will be displayed only in the first paragraph of any sequence
13752 of paragraphs with the same
13753 \begin_inset Flex Code
13756 \begin_layout Plain Layout
13765 \begin_layout Description
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13776 \begin_inset space ~
13780 \begin_inset space ~
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13793 are special cases of
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13804 The label will be printed above the paragraph either at the beginning of
13805 the line or centered.
13808 \begin_layout Description
13809 \begin_inset Flex Code
13812 \begin_layout Plain Layout
13818 is a special case for the caption-labels
13819 \begin_inset Quotes eld
13823 \begin_inset Quotes erd
13827 \begin_inset Quotes eld
13831 \begin_inset Quotes erd
13835 \begin_inset Newline newline
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13848 means the (hardcoded) label string depends on the kind of float: It is
13849 hardcoded to be `FloatType N', where N is the value of the counter associated
13851 For the case that a caption is inserted outside of a float the
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 \begin_inset Quotes eld
13866 \begin_inset Quotes erd
13872 \begin_layout Description
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13882 produces the usual sort of enumeration labels.
13883 The number type needs to be set in the
13888 \begin_inset CommandInset ref
13890 reference "subsec:Counters"
13897 \begin_layout Description
13898 \begin_inset Flex Code
13901 \begin_layout Plain Layout
13907 produces various bullets at the different levels.
13908 The bullet types displayed can be set via
13909 \begin_inset Flex Noun
13912 \begin_layout Plain Layout
13913 Document\SpecialChar menuseparator
13914 Settings\SpecialChar menuseparator
13923 \begin_layout Description
13924 \begin_inset Flex Code
13927 \begin_layout Plain Layout
13933 should be used only with
13934 \begin_inset Flex Code
13937 \begin_layout Plain Layout
13938 LatexType BibEnvironment
13947 \begin_layout Description
13948 \begin_inset Flex Code
13951 \begin_layout Plain Layout
13957 Note that this will completely override any prior
13958 \begin_inset Flex Code
13961 \begin_layout Plain Layout
13967 declaration for this style.
13969 \begin_inset Quotes eld
13973 \begin_inset Flex Code
13976 \begin_layout Plain Layout
13983 \begin_inset Quotes erd
13988 \begin_inset CommandInset ref
13990 reference "subsec:I18n"
13994 for details on its use.
13997 \begin_layout Description
13998 \begin_inset Flex Code
14001 \begin_layout Plain Layout
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14017 ] The name of the corresponding \SpecialChar LaTeX
14019 Either the environment or command name.
14022 \begin_layout Description
14023 \begin_inset Flex Code
14026 \begin_layout Plain Layout
14033 \begin_inset Flex Code
14036 \begin_layout Plain Layout
14042 ] An optional parameter for the corresponding
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14053 This parameter cannot be changed from within \SpecialChar LyX
14055 \begin_inset Flex Code
14058 \begin_layout Plain Layout
14064 for customizable parameters).
14065 This will be output as is after all \SpecialChar LaTeX
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14079 \begin_layout Description
14080 \begin_inset Flex Code
14083 \begin_layout Plain Layout
14090 \begin_inset Flex Code
14093 \begin_layout Plain Layout
14098 , Command, Environment, Item_Environment,
14099 \begin_inset Newline newline
14102 List_Environment, Bib_Environment
14107 ] How the style should be translated into \SpecialChar LaTeX
14112 \begin_layout Plain Layout
14113 \begin_inset Flex Code
14116 \begin_layout Plain Layout
14122 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14123 Visit the SGML class files for specific examples.
14132 \begin_layout Description
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14142 means nothing special.
14145 \begin_layout Description
14146 \begin_inset Flex Code
14149 \begin_layout Plain Layout
14156 \begin_inset Flex Code
14159 \begin_layout Plain Layout
14166 {\SpecialChar ldots
14175 \begin_layout Description
14176 \begin_inset Flex Code
14179 \begin_layout Plain Layout
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14196 }\SpecialChar ldots
14212 \begin_layout Description
14213 \begin_inset Flex Code
14216 \begin_layout Plain Layout
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14244 is generated for each paragraph of this environment.
14248 \begin_layout Description
14249 \begin_inset Flex Code
14252 \begin_layout Plain Layout
14259 \begin_inset Flex Code
14262 \begin_layout Plain Layout
14269 \begin_inset Newline newline
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14282 is passed as an argument to the environment.
14283 \begin_inset Newline newline
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14296 can be defined in the
14297 \begin_inset Flex Noun
14300 \begin_layout Plain Layout
14301 Edit\SpecialChar menuseparator
14303 \begin_inset space ~
14314 \begin_layout Description
14315 \begin_inset Flex Code
14318 \begin_layout Plain Layout
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14334 but adds the necessary mandatory argument (the longest label) to the begin
14335 statement of the bibliography environment:
14336 \begin_inset Newline newline
14340 \begin_inset Flex Code
14343 \begin_layout Plain Layout
14346 begin{thebibliography}{99}
14352 It is therefore only useful for bibliography environments.
14353 The default longest label
14354 \begin_inset Quotes eld
14358 \begin_inset Quotes erd
14361 can be changed by the user in the paragraph settings of a bibliography
14365 \begin_layout Standard
14366 Putting the last few things together, the \SpecialChar LaTeX
14367 output will be either:
14370 \begin_layout LyX-Code
14373 LatexName[LatexParam]{\SpecialChar ldots
14377 \begin_layout Standard
14381 \begin_layout LyX-Code
14384 begin{LatexName}[LatexParam] \SpecialChar ldots
14390 \begin_layout Standard
14391 depending upon the \SpecialChar LaTeX
14396 \begin_layout Description
14397 \begin_inset Flex Code
14400 \begin_layout Plain Layout
14407 \begin_inset Flex Code
14410 \begin_layout Plain Layout
14416 ] A string that is put at the beginning of the style content.
14417 A line break in the output can be indicated by
14418 \begin_inset Flex Code
14421 \begin_layout Plain Layout
14430 \begin_layout Description
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14450 ] If you put styles into environments, the different
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14460 are not simply added, but added with a factor
14461 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14465 Note that this parameter is also used when
14466 \begin_inset Flex Code
14469 \begin_layout Plain Layout
14476 \begin_inset Flex Code
14479 \begin_layout Plain Layout
14486 \begin_inset Flex Code
14489 \begin_layout Plain Layout
14496 Then it is added to the manual or dynamic margin.
14497 \begin_inset Newline newline
14501 \begin_inset Quotes eld
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14515 \begin_inset Quotes erd
14518 means that the paragraph is indented with the width of
14519 \begin_inset Quotes eld
14523 \begin_inset Flex Code
14526 \begin_layout Plain Layout
14533 \begin_inset Quotes erd
14536 in the normal font.
14537 You can get a negative width by prefixing the string with
14538 \begin_inset Quotes eld
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14552 \begin_inset Quotes erd
14556 This way was chosen so that the look is the same with each used screen
14560 \begin_layout Description
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14579 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14585 \begin_inset Newline newline
14588 The kind of margin that the style has on the left side.
14592 \begin_layout Description
14593 \begin_inset Flex Code
14596 \begin_layout Plain Layout
14602 just means a fixed margin.
14605 \begin_layout Description
14606 \begin_inset Flex Code
14609 \begin_layout Plain Layout
14615 means that the left margin depends on the string entered in the
14616 \begin_inset Flex Noun
14619 \begin_layout Plain Layout
14620 Edit\SpecialChar menuseparator
14622 \begin_inset space ~
14631 This is used to typeset nice lists without tabulators.
14634 \begin_layout Description
14635 \begin_inset Flex Code
14638 \begin_layout Plain Layout
14644 means that the margin depends on the size of the label.
14645 This is used for automatic enumerated headlines.
14646 It is obvious that the headline
14647 \begin_inset Quotes eld
14650 5.4.3.2.1 Very long headline
14651 \begin_inset Quotes erd
14654 must have a wider left margin (as wide as
14655 \begin_inset Quotes eld
14659 \begin_inset Quotes erd
14662 plus the space) than
14663 \begin_inset Quotes eld
14666 3.2 Very long headline
14667 \begin_inset Quotes erd
14671 \begin_inset Quotes eld
14675 \begin_inset Quotes erd
14678 are not able to do this.
14681 \begin_layout Description
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14691 is similar, but only the very first row of the paragraph is dynamic, while
14692 the others are static; this is used, for example, for descriptions.
14695 \begin_layout Description
14696 \begin_inset Flex Code
14699 \begin_layout Plain Layout
14705 means the margin is chosen in a way that the longest row of this paragraph
14706 fits to the right margin.
14707 This is used to typeset an address on the right edge of the page.
14711 \begin_layout Description
14712 \begin_inset Flex Code
14715 \begin_layout Plain Layout
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14734 \begin_inset space \thinspace{}
14738 \begin_inset Flex Code
14741 \begin_layout Plain Layout
14747 ] Whether fragile commands in this style should be
14748 \begin_inset Flex Code
14751 \begin_layout Plain Layout
14764 whether this command should itself be protected.)
14767 \begin_layout Description
14768 \begin_inset Flex Code
14771 \begin_layout Plain Layout
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14788 \begin_inset space \thinspace{}
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14803 ] Whether newlines are translated into \SpecialChar LaTeX
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14819 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14821 inside \SpecialChar LyX
14825 \begin_layout Description
14826 \begin_inset Flex Code
14829 \begin_layout Plain Layout
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14848 \begin_inset space \thinspace{}
14852 \begin_inset Flex Code
14855 \begin_layout Plain Layout
14861 ] If set to true, and if
14862 \begin_inset Flex Code
14865 \begin_layout Plain Layout
14872 \begin_inset Flex Code
14875 \begin_layout Plain Layout
14881 ) paragraphs are being indented, then the indentation of such a paragraph
14882 following one of this type will be suppressed.
14883 (So this will not affect the display of non-default paragraphs.)
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14906 ] Name of a style that has replaced this style.
14907 This is used to rename a style, while keeping backward compatibility.
14910 \begin_layout Description
14911 \begin_inset Flex Code
14914 \begin_layout Plain Layout
14921 \begin_inset Flex Code
14924 \begin_layout Plain Layout
14931 \begin_inset space \thinspace{}
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14944 ] Determines whether consecutive paragraphs of the same type are treated
14945 as belonging together.
14946 This has the effect that the
14947 \begin_inset Flex Code
14950 \begin_layout Plain Layout
14956 is only printed once before such a group.
14957 By default, this is true for
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14968 \begin_inset Flex Code
14971 \begin_layout Plain Layout
14978 \begin_inset Flex Code
14981 \begin_layout Plain Layout
14987 and false for all other types.
14990 \begin_layout Description
14991 \begin_inset Flex Code
14994 \begin_layout Plain Layout
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15013 \begin_inset space \thinspace{}
15017 \begin_inset Flex Code
15020 \begin_layout Plain Layout
15026 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15028 but only by a line break; together with
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15038 , this allows to emulate a plain text editor (like the ERT inset).
15041 \begin_layout Description
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15061 ] The indent of the very first line of a paragraph.
15063 \begin_inset Newline newline
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15076 will be fixed for a certain style.
15077 The exception is the default style, since the indentation for these paragraphs
15078 can be prohibited with
15079 \begin_inset Flex Code
15082 \begin_layout Plain Layout
15090 \begin_inset Flex Code
15093 \begin_layout Plain Layout
15099 style paragraphs inside environments use the
15100 \begin_inset Flex Code
15103 \begin_layout Plain Layout
15109 of the environment, not their native one.
15111 \begin_inset Flex Code
15114 \begin_layout Plain Layout
15120 paragraphs inside an enumeration are not indented.
15123 \begin_layout Description
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15134 \begin_inset Flex Code
15137 \begin_layout Plain Layout
15143 ] The vertical space between two paragraphs of this style.
15146 \begin_layout Description
15147 \begin_inset Flex Code
15150 \begin_layout Plain Layout
15157 \begin_inset Flex Code
15160 \begin_layout Plain Layout
15167 allows the user to choose either
15168 \begin_inset Quotes eld
15172 \begin_inset Quotes erd
15176 \begin_inset Quotes eld
15180 \begin_inset Quotes erd
15183 to separate paragraphs.
15185 \begin_inset Quotes eld
15189 \begin_inset Quotes erd
15193 \begin_inset Flex Code
15196 \begin_layout Plain Layout
15204 \begin_inset Quotes eld
15208 \begin_inset Quotes erd
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15221 is ignored and all paragraphs are separated by the
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15232 The vertical space is calculated with
15233 \begin_inset Flex Code
15236 \begin_layout Plain Layout
15238 \begin_inset space ~
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15256 is the height of a row with the normal font.
15257 This way, the look stays the same with different screen fonts.
15260 \begin_layout Description
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15283 \begin_inset space \thinspace{}
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15296 ] Whether the contents of this paragraph should be output in raw form, meaning
15297 without special translations that \SpecialChar LaTeX
15301 \begin_layout Description
15302 \begin_inset Flex Code
15305 \begin_layout Plain Layout
15312 \begin_inset Flex Code
15315 \begin_layout Plain Layout
15325 Defines individual characters that should be output in raw form, meaning
15326 without special translations that \SpecialChar LaTeX
15330 \begin_layout Description
15331 \begin_inset Flex Code
15334 \begin_layout Plain Layout
15340 Information to be included in the \SpecialChar LaTeX
15341 preamble when this style is used.
15342 Used to define macros, load packages, etc., required by this particular
15345 \begin_inset Quotes eld
15349 \begin_inset Flex Code
15352 \begin_layout Plain Layout
15359 \begin_inset Quotes erd
15365 \begin_layout Description
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15385 ] The prefix to use when creating labels referring to paragraphs of this
15387 This allows the use of formatted references.
15390 \begin_layout Description
15391 \begin_inset Flex Code
15394 \begin_layout Plain Layout
15401 \begin_inset Flex Code
15404 \begin_layout Plain Layout
15410 ] Whether the style requires the feature
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15421 \begin_inset CommandInset ref
15423 reference "chap:List-of-functions"
15427 for the list of features).
15428 If you require a package with specific options, you can additionally use
15430 \begin_inset Flex Code
15433 \begin_layout Plain Layout
15439 as a general text class parameter (see
15440 \begin_inset CommandInset ref
15442 reference "subsec:General-text-class"
15449 \begin_layout Description
15450 \begin_inset Flex Code
15453 \begin_layout Plain Layout
15460 \begin_inset Flex Code
15463 \begin_layout Plain Layout
15472 \begin_inset Flex Code
15475 \begin_layout Plain Layout
15481 ] Resets the \SpecialChar LaTeX
15482 arguments of this style (as defined via the
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15493 This is useful if you have copied a style via
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15503 , but you do not want to inherit its (required and optional) arguments.
15506 \begin_layout Description
15507 \begin_inset Flex Code
15510 \begin_layout Plain Layout
15517 \begin_inset Flex Code
15520 \begin_layout Plain Layout
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15538 ] Resumes a counter that is usually reset at each new sequence of layouts.
15539 This is currently only useful when
15540 \begin_inset Flex Code
15543 \begin_layout Plain Layout
15550 \begin_inset Flex Code
15553 \begin_layout Plain Layout
15562 \begin_layout Description
15563 \begin_inset Flex Code
15566 \begin_layout Plain Layout
15573 \begin_inset Flex Code
15576 \begin_layout Plain Layout
15582 ] A string that is put at the end of the layout content.
15583 A line break in the output can be indicated by
15584 \begin_inset Flex Code
15587 \begin_layout Plain Layout
15596 \begin_layout Description
15597 \begin_inset Flex Code
15600 \begin_layout Plain Layout
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15617 \begin_inset Flex Code
15620 \begin_layout Plain Layout
15629 \begin_layout Description
15630 \begin_inset Flex Code
15633 \begin_layout Plain Layout
15640 \begin_inset Flex Code
15643 \begin_layout Plain Layout
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15662 \begin_inset Flex Code
15665 \begin_layout Plain Layout
15672 \begin_inset Flex Code
15675 \begin_layout Plain Layout
15677 \begin_inset space ~
15685 ] This defines what the default spacing should be in the style.
15687 \begin_inset Flex Code
15690 \begin_layout Plain Layout
15697 \begin_inset Flex Code
15700 \begin_layout Plain Layout
15707 \begin_inset Flex Code
15710 \begin_layout Plain Layout
15716 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15717 If you specify the argument
15718 \begin_inset Flex Code
15721 \begin_layout Plain Layout
15727 , then you must also provide a value argument which will be the actual multiplie
15729 Note that, contrary to other parameters,
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15739 implies the generation of specific \SpecialChar LaTeX
15740 code, using the \SpecialChar LaTeX
15744 \begin_inset Flex Code
15747 \begin_layout Plain Layout
15756 \begin_layout Description
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15777 \begin_inset space \thinspace{}
15781 \begin_inset Flex Code
15784 \begin_layout Plain Layout
15792 ] Allow spell-checking paragraphs of this style.
15796 \begin_layout Description
15797 \begin_inset Flex Code
15800 \begin_layout Plain Layout
15807 \begin_inset Flex Code
15810 \begin_layout Plain Layout
15819 \begin_inset Flex Code
15822 \begin_layout Plain Layout
15828 ] Steps the master counter of a given counter at the beginning of a new
15829 sequence of layouts.
15830 This is currently only useful when
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15853 \begin_layout Description
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15863 The font used for the text body .
15865 \begin_inset CommandInset ref
15867 reference "subsec:Font-description"
15874 \begin_layout Description
15875 \begin_inset Flex Code
15878 \begin_layout Plain Layout
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15900 The level of the style in the table of contents.
15901 This is used for automatic numbering of section headings.
15904 \begin_layout Description
15905 \begin_inset Flex Code
15908 \begin_layout Plain Layout
15917 \begin_inset Flex Code
15920 \begin_layout Plain Layout
15931 \begin_inset Flex Code
15934 \begin_layout Plain Layout
15941 \begin_inset Flex Code
15944 \begin_layout Plain Layout
15950 ] This tag determines whether the first line indentation of this paragraph
15951 can be toggled via the Paragraph settings dialog.
15955 \begin_inset Flex Code
15958 \begin_layout Plain Layout
15968 is set, indentation can be toggled if the document settings use
15969 \begin_inset Quotes eld
15973 \begin_inset Quotes erd
15976 paragraph style, with
15977 \begin_inset Flex Code
15980 \begin_layout Plain Layout
15986 , indentation can always be toggled, notwithstanding the document settings,
15988 \begin_inset Flex Code
15991 \begin_layout Plain Layout
15997 , indentation can never be toggled.
16000 \begin_layout Description
16001 \begin_inset Flex Code
16004 \begin_layout Plain Layout
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16020 ] The vertical space with which the very first of a chain of paragraphs
16021 with this style is separated from the previous paragraph.
16022 If the previous paragraph has another style, the separations are not simply
16023 added, but the maximum is taken.
16026 \begin_layout Subsection
16027 \begin_inset CommandInset label
16033 Internationalization of Paragraph Styles
16036 \begin_layout Standard
16038 has long supported internationalization of layout information, but, until
16039 version 2.0, this applied only to the user interface and not to, say, PDF
16041 Thus, French authors were forced to resort to ugly hacks if they wanted
16046 1' instead of `Theorem 1'.
16047 Thanks to Georg Baum, that is no longer the case.
16050 \begin_layout Standard
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16061 defines text that is to appear in the typeset document, it may use
16062 \begin_inset Flex Code
16065 \begin_layout Plain Layout
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16081 to support non-English and even multi-language documents correctly.
16082 The following excerpt (from the
16083 \begin_inset Flex Code
16086 \begin_layout Plain Layout
16092 file) shows how this works:
16095 \begin_layout LyX-Code
16100 \begin_layout LyX-Code
16103 theoremstyle{remark}
16106 \begin_layout LyX-Code
16109 newtheorem{claim}[thm]{
16116 \begin_layout LyX-Code
16120 \begin_layout LyX-Code
16124 \begin_layout LyX-Code
16129 claimname}{_(Claim)}
16132 \begin_layout LyX-Code
16136 \begin_layout LyX-Code
16140 \begin_layout LyX-Code
16149 claimname}{_(Claim)}}
16152 \begin_layout LyX-Code
16157 \begin_layout Standard
16158 In principle, any legal \SpecialChar LaTeX
16160 \begin_inset Flex Code
16163 \begin_layout Plain Layout
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16179 tags, but in practice they will typically look as they do here.
16180 The key to correct translation of the typeset text is the definition of
16181 the \SpecialChar LaTeX
16183 \begin_inset Flex Code
16186 \begin_layout Plain Layout
16195 \begin_inset Flex Code
16198 \begin_layout Plain Layout
16210 \begin_layout Standard
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16221 tag provides for internationalization based upon the overall language of
16223 The contents of the tag will be included in the preamble, just as with
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16235 What makes it special is the use of the
16236 \begin_inset Quotes eld
16240 \begin_inset Quotes erd
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16253 , which will be replaced, when \SpecialChar LyX
16254 produces \SpecialChar LaTeX
16255 output, with the translation of
16256 its argument into the document language.
16259 \begin_layout Standard
16261 \begin_inset Flex Code
16264 \begin_layout Plain Layout
16270 tag is more complex, since it is meant to provide support for multi-language
16271 documents and so offers an interface to the
16272 \begin_inset Flex Code
16275 \begin_layout Plain Layout
16282 Its contents will be added to the preamble once for each language that
16283 appears in the document.
16284 In this case, the argument to
16285 \begin_inset Flex Code
16288 \begin_layout Plain Layout
16294 will be replaced with its translation into the language in question; the
16296 \begin_inset Flex Code
16299 \begin_layout Plain Layout
16305 is replaced by the language name (as used by the babel package).
16308 \begin_layout Standard
16309 A German document that also included a French section would thus have the
16310 following in the preamble:
16313 \begin_layout LyX-Code
16322 claimname}{Affirmation}}
16323 \begin_inset Newline newline
16334 claimname}{Behauptung}}
16335 \begin_inset Newline newline
16342 claimname}{Behauptung}
16345 \begin_layout Standard
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16357 will then conspire to produce the correct text in the output.
16360 \begin_layout Standard
16361 One important point to note here is that the translations are provided by
16363 itself, through the file
16364 \begin_inset Flex Code
16367 \begin_layout Plain Layout
16374 This means, in effect, that
16375 \begin_inset Flex Code
16378 \begin_layout Plain Layout
16385 \begin_inset Flex Code
16388 \begin_layout Plain Layout
16394 are really only of use in layout files that are provided with \SpecialChar LyX
16396 entered in user-created layout files will not be seen by \SpecialChar LyX
16397 's internationalizatio
16398 n routines unless the
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16408 file is modified accordingly.
16409 That said, however, any layout created with the intention that it will
16410 be included with \SpecialChar LyX
16411 should use these tags where appropriate.
16412 Please note that the paragraph style translations provided by \SpecialChar LyX
16414 change with a minor update (e.
16415 \begin_inset space \thinspace{}
16419 \begin_inset space \space{}
16422 from version 2.1.x to 2.1.y).
16423 It is however quite likely that a major update (e.
16424 \begin_inset space \thinspace{}
16428 \begin_inset space \space{}
16431 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16434 \begin_layout Subsection
16436 \begin_inset CommandInset label
16438 name "subsec:Floats"
16445 \begin_layout Standard
16446 It is necessary to define the floats (
16447 \begin_inset Flex Noun
16450 \begin_layout Plain Layout
16457 \begin_inset Flex Noun
16460 \begin_layout Plain Layout
16466 , \SpecialChar ldots
16467 ) in the text class itself.
16468 Standard floats are included in the file
16469 \begin_inset Flex Code
16472 \begin_layout Plain Layout
16478 , so you may have to do no more than add
16481 \begin_layout LyX-Code
16482 Input stdfloats.inc
16485 \begin_layout Standard
16486 to your layout file.
16487 If you want to implement a text class that proposes some other float types
16488 (like the AGU class bundled with \SpecialChar LyX
16489 ), the information below will hopefully
16493 \begin_layout Description
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16504 \begin_inset Flex Code
16507 \begin_layout Plain Layout
16513 =!htbpH] Allowed placement options for this float type.
16514 The value is a string of placement characters.
16515 Possible characters include:
16520 \begin_inset Quotes eld
16524 \begin_inset Quotes erd
16532 \begin_inset Quotes eld
16536 \begin_inset Quotes erd
16544 \begin_inset Quotes eld
16548 \begin_inset Quotes erd
16556 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16568 \begin_inset Quotes eld
16572 \begin_inset Quotes erd
16580 \begin_inset Quotes eld
16584 \begin_inset Quotes erd
16588 The order of the characters in the string does not matter.
16589 If no placement options are allowed, use the string
16596 \begin_layout Description
16597 \begin_inset Flex Code
16600 \begin_layout Plain Layout
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16619 \begin_inset space \thinspace{}
16625 \begin_inset Flex Code
16628 \begin_layout Plain Layout
16638 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16654 if the float does not support this feature.
16657 \begin_layout Description
16658 \begin_inset Flex Code
16661 \begin_layout Plain Layout
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16680 \begin_inset space \thinspace{}
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16699 ] Defines whether the float has a starred variant that spans columns in
16700 a two column paragraph.
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16711 if the float does not support this feature.
16714 \begin_layout Description
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16725 \begin_inset Flex Code
16728 \begin_layout Plain Layout
16735 \begin_inset Quotes erd
16739 \begin_inset Quotes erd
16742 ] The file name extension of an auxiliary file for the list of figures (or
16745 writes the captions to this file.
16748 \begin_layout Description
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16759 \begin_inset Flex Code
16762 \begin_layout Plain Layout
16769 \begin_inset Quotes erd
16773 \begin_inset Quotes erd
16776 ] The string that will be used in the menus and also for the caption.
16777 This is translated to the current language if babel is used.
16780 \begin_layout Description
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16790 These tags control the XHTML output.
16792 \begin_inset CommandInset ref
16794 reference "sec:Tags-for-XHTML"
16801 \begin_layout Description
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16814 \begin_inset Flex Code
16817 \begin_layout Plain Layout
16826 \begin_inset space \thinspace{}
16830 \begin_inset Flex Code
16833 \begin_layout Plain Layout
16839 ] Indicates whether the float is already defined in the document class or
16840 if instead the \SpecialChar LaTeX
16842 \begin_inset Flex Code
16845 \begin_layout Plain Layout
16851 needs to be loaded to define it on-the-fly.
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16863 \begin_inset Flex Code
16866 \begin_layout Plain Layout
16873 It should be set to
16874 \begin_inset Flex Code
16877 \begin_layout Plain Layout
16883 if the float is already defined by the \SpecialChar LaTeX
16887 \begin_layout Description
16888 \begin_inset Flex Code
16891 \begin_layout Plain Layout
16898 \begin_inset Flex Code
16901 \begin_layout Plain Layout
16908 \begin_inset Quotes erd
16912 \begin_inset Quotes erd
16915 ] The command used to generate a list of floats of this type; the leading
16924 \begin_inset Flex Code
16927 \begin_layout Plain Layout
16933 is false, since there is no standard way to generate this command.
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16944 is true, since in that case there is a standard way to define the command.
16947 \begin_layout Description
16948 \begin_inset Flex Code
16951 \begin_layout Plain Layout
16958 \begin_inset Flex Code
16961 \begin_layout Plain Layout
16968 \begin_inset Quotes erd
16972 \begin_inset Quotes erd
16975 ] A title for a list of floats of this kind (list of figures, tables, or
16977 It is used for the screen label within \SpecialChar LyX
16978 , it is used by \SpecialChar LaTeX
16980 it is used as the title in the XHTML output.
16981 It will be translated to the document language.
16984 \begin_layout Description
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17005 \begin_inset Quotes erd
17009 \begin_inset Quotes erd
17012 ] This (optional) argument determines whether floats of this class will
17013 be numbered within some sectional unit of the document.
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17025 \begin_inset Quotes eld
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17039 \begin_inset Quotes erd
17042 , the floats will be numbered within chapters.
17046 \begin_layout Description
17047 \begin_inset Flex Code
17050 \begin_layout Plain Layout
17057 \begin_inset Flex Code
17060 \begin_layout Plain Layout
17067 \begin_inset Quotes erd
17071 \begin_inset Quotes erd
17074 ] The default placement for the given class of floats.
17075 The string should be as in standard \SpecialChar LaTeX
17077 \begin_inset Flex Code
17080 \begin_layout Plain Layout
17087 \begin_inset Flex Code
17090 \begin_layout Plain Layout
17097 \begin_inset Flex Code
17100 \begin_layout Plain Layout
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17116 for top, bottom, page, and here, respectively.
17120 \begin_layout Plain Layout
17121 Note that the order of these letters in the string is irrelevant, like in
17128 On top of that there is a new type,
17129 \begin_inset Flex Code
17132 \begin_layout Plain Layout
17138 , which does not really correspond to a float, since it means: put it
17139 \begin_inset Quotes eld
17143 \begin_inset Quotes erd
17147 Note however that the
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 specifier is special and, because of implementation details, cannot be
17158 used in non-built in float types.
17159 If you do not understand what this means, just use
17160 \begin_inset Quotes eld
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17174 \begin_inset Quotes erd
17180 \begin_layout Description
17181 \begin_inset Flex Code
17184 \begin_layout Plain Layout
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17200 ] The prefix to use when creating labels referring to floats of this type.
17201 This allows the use of formatted references.
17202 Note that you can remove any
17203 \begin_inset Flex Code
17206 \begin_layout Plain Layout
17212 set by a copied style by using the special value
17213 \begin_inset Quotes eld
17217 \begin_inset Quotes erd
17220 , which must be all caps.
17223 \begin_layout Description
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17234 \begin_inset Flex Code
17237 \begin_layout Plain Layout
17244 \begin_inset Quotes erd
17248 \begin_inset Quotes erd
17251 ] The style used when defining the float using
17252 \begin_inset Flex Code
17255 \begin_layout Plain Layout
17266 \begin_layout Description
17267 \begin_inset Flex Code
17270 \begin_layout Plain Layout
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17287 \begin_inset Quotes erd
17291 \begin_inset Quotes erd
17295 \begin_inset Quotes eld
17299 \begin_inset Quotes erd
17302 of the new class of floats, like program or algorithm.
17303 After the appropriate
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17316 \begin_inset Flex Code
17319 \begin_layout Plain Layout
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17342 \begin_layout Description
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17353 \begin_inset Flex Code
17356 \begin_layout Plain Layout
17363 \begin_inset space \thinspace{}
17367 \begin_inset Flex Code
17370 \begin_layout Plain Layout
17378 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17389 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17393 \begin_layout Standard
17394 Note that defining a float with type
17395 \begin_inset Flex Code
17398 \begin_layout Plain Layout
17406 automatically defines the corresponding counter with name
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17421 \begin_layout Subsection
17422 Flex insets and InsetLayout
17423 \begin_inset CommandInset label
17425 name "subsec:Flex-insets-and"
17432 \begin_layout Standard
17433 Flex insets come in three different kinds:
17436 \begin_layout Itemize
17438 \begin_inset Flex Code
17441 \begin_layout Plain Layout
17447 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17461 \begin_inset Flex Code
17464 \begin_layout Plain Layout
17475 \begin_layout Itemize
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17486 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17488 footnote, and the like.
17489 An obvious example is an endnote inset, which is defined in the
17490 \begin_inset Flex Code
17493 \begin_layout Plain Layout
17502 \begin_layout Itemize
17504 \begin_inset Flex Code
17507 \begin_layout Plain Layout
17513 ): For use with DocBook classes.
17516 \begin_layout Standard
17517 Flex insets are defined using the
17518 \begin_inset Flex Code
17521 \begin_layout Plain Layout
17527 tag, which shall be explained in a moment.
17530 \begin_layout Standard
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17541 tag also serves another function: It can be used to customize the general
17542 layout of many different types of insets.
17544 \begin_inset Flex Code
17547 \begin_layout Plain Layout
17553 can be used to customize the layout parameters for footnotes, marginal
17554 notes, note insets, \SpecialChar TeX
17555 code (ERT) insets, branches, listings, indexes, boxes,
17556 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17559 \begin_layout Standard
17561 \begin_inset Flex Code
17564 \begin_layout Plain Layout
17570 definition must begin with a line of the form:
17573 \begin_layout LyX-Code
17577 \begin_layout Standard
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17588 indicates the inset whose layout is being defined, and here there are four
17592 \begin_layout Enumerate
17593 The layout for a pre-existing inset is being modified.
17594 In this case, can be
17595 \begin_inset Flex Code
17598 \begin_layout Plain Layout
17604 any one of the following:
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17615 \begin_inset Flex Code
17618 \begin_layout Plain Layout
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17685 \begin_inset Flex Code
17688 \begin_layout Plain Layout
17695 \begin_inset Flex Code
17698 \begin_layout Plain Layout
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17755 \begin_inset Flex Code
17758 \begin_layout Plain Layout
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17807 \begin_layout Enumerate
17808 The layout for a Flex inset is being defined.
17810 \begin_inset Flex Code
17813 \begin_layout Plain Layout
17819 must be of the form
17820 \begin_inset Quotes eld
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17834 \begin_inset Quotes erd
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17847 may be be any valid identifier not used by a pre-existing Flex inset.
17848 The identifier may include spaces, but in that case the whole thing must
17849 be wrapped in quotes.
17850 Note that the definition of a flex inset
17855 \begin_inset Flex Code
17858 \begin_layout Plain Layout
17864 entry, declaring which type of inset it defines.
17867 \begin_layout Enumerate
17868 The layout for user specific branch is being defined.
17870 \begin_inset Flex Code
17873 \begin_layout Plain Layout
17879 must be of the form
17880 \begin_inset Quotes eld
17884 \begin_inset Flex Code
17887 \begin_layout Plain Layout
17894 \begin_inset Quotes erd
17898 \begin_inset Flex Code
17901 \begin_layout Plain Layout
17907 may be be any valid identifier of branch defined in user's document.
17908 The identifier may include spaces, but in that case the whole thing must
17909 be wrapped in quotes.
17910 The main purpose of this feature is to allow \SpecialChar LaTeX
17911 wrapping around specific
17912 branches as user needs.
17915 \begin_layout Enumerate
17916 The layout of a user (or class) specific caption is being defined.
17918 \begin_inset Flex Code
17921 \begin_layout Plain Layout
17927 must be of the form
17928 \begin_inset Quotes eld
17932 \begin_inset Flex Code
17935 \begin_layout Plain Layout
17942 \begin_inset Quotes erd
17946 \begin_inset Flex Code
17949 \begin_layout Plain Layout
17955 specifies the name of the caption as it appears in the menu.
17956 Have a look at the standard caption (
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17966 ), the specific captions of the KOMA-Script classes (
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17977 \begin_inset Flex Code
17980 \begin_layout Plain Layout
17989 \begin_inset space ~
17993 \begin_inset Newline linebreak
17999 \begin_inset Flex Code
18002 \begin_layout Plain Layout
18008 ) for applications.
18011 \begin_layout Standard
18013 \begin_inset Flex Code
18016 \begin_layout Plain Layout
18022 definition can contain the following entries:
18025 \begin_layout Description
18026 \begin_inset Flex Code
18029 \begin_layout Plain Layout
18036 \begin_inset Flex Code
18039 \begin_layout Plain Layout
18045 =""] This inset will appear in the table of contents of the given type.
18046 An empty string disables.
18047 See also the OutlinerName and the IsTocCaption commands.
18048 This is only implemented for Flex insets.
18052 \begin_layout Description
18053 \begin_inset Flex Code
18056 \begin_layout Plain Layout
18063 \begin_inset Flex Code
18066 \begin_layout Plain Layout
18072 ] Defines argument number of a command\SpecialChar breakableslash
18073 environment associated with the current
18075 The definition must end with
18076 \begin_inset Flex Code
18079 \begin_layout Plain Layout
18087 \begin_inset CommandInset ref
18089 reference "subsec:Paragraph-Styles"
18096 \begin_layout Description
18097 \begin_inset Flex Code
18100 \begin_layout Plain Layout
18106 Preamble for changing language commands; see
18107 \begin_inset CommandInset ref
18109 reference "subsec:I18n"
18116 \begin_layout Description
18117 \begin_inset Flex Code
18120 \begin_layout Plain Layout
18127 \begin_inset Flex Code
18130 \begin_layout Plain Layout
18136 ] The color for the inset's background.
18138 \begin_inset CommandInset ref
18140 reference "chap:Names-of-colors"
18144 for a list of the available color names.
18147 \begin_layout Description
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18158 \begin_inset Flex Code
18161 \begin_layout Plain Layout
18170 \begin_inset space \thinspace{}
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18183 ] Whether to use the content of the inset as the label, when the inset is
18188 \begin_layout Description
18189 \begin_inset Flex Code
18192 \begin_layout Plain Layout
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18208 ] As with paragraph styles, see
18209 \begin_inset CommandInset ref
18211 reference "subsec:Paragraph-Styles"
18216 Note that you need to specify the complete type, e.
18217 \begin_inset space \thinspace{}
18221 \begin_inset space ~
18225 \begin_inset Flex Code
18228 \begin_layout Plain Layout
18229 CopyStyle Flex:<name>
18237 \begin_layout Description
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18248 \begin_inset Flex Code
18251 \begin_layout Plain Layout
18260 \begin_inset space \thinspace{}
18264 \begin_inset Flex Code
18267 \begin_layout Plain Layout
18273 ] Indicates whether the user may employ the Paragraph Settings dialog to
18274 customize the paragraph.
18277 \begin_layout Description
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18288 \begin_inset Flex Code
18291 \begin_layout Plain Layout
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18308 \begin_inset Flex Code
18311 \begin_layout Plain Layout
18317 , describing the rendering style used for the inset's frame and buttons.
18318 Footnotes generally use
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18328 , ERT insets generally
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18338 , and character styles
18339 \begin_inset Flex Code
18342 \begin_layout Plain Layout
18351 \begin_layout Description
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18374 \begin_inset space \thinspace{}
18380 \begin_inset Flex Code
18383 \begin_layout Plain Layout
18392 \begin_inset Flex Code
18395 \begin_layout Plain Layout
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 Indicates whether the environment will stand on its own in the output or
18413 will appear inline with the surrounding text.
18414 If set to false, it is supposed that the \SpecialChar LaTeX
18415 environment ignores white space
18416 (including one newline character) after the
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18433 \begin_inset Flex Code
18436 \begin_layout Plain Layout
18452 \begin_layout Description
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18462 Required at the end of the
18463 \begin_inset Flex Code
18466 \begin_layout Plain Layout
18475 \begin_layout Description
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 The font used for both the text body
18491 \begin_inset CommandInset ref
18493 reference "subsec:Font-description"
18498 Note that defining this font automatically defines the
18499 \begin_inset Flex Code
18502 \begin_layout Plain Layout
18508 to the same value, so define this first and define
18509 \begin_inset Flex Code
18512 \begin_layout Plain Layout
18518 later if you want them to be different.
18521 \begin_layout Description
18522 \begin_inset Flex Code
18525 \begin_layout Plain Layout
18526 FixedWidthPreambleEncoding
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18544 \begin_inset space \thinspace{}
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18557 ] Force a fixed width encoding for the translated contents of
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18568 \begin_inset Flex Code
18571 \begin_layout Plain Layout
18577 code generated by this layout.
18578 This is needed for special \SpecialChar LaTeX
18583 that do not work with variable width encodings such as
18588 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18589 backends such as Xe\SpecialChar TeX
18591 Lua\SpecialChar TeX
18595 \begin_layout Description
18596 \begin_inset Flex Code
18599 \begin_layout Plain Layout
18600 ForceLocalFontSwitch
18606 \begin_inset Flex Code
18609 \begin_layout Plain Layout
18618 \begin_inset space \thinspace{}
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18631 ] When using babel, always use a local font switch (
18632 \begin_inset Flex Code
18635 \begin_layout Plain Layout
18643 ), never a global one (such as
18644 \begin_inset Flex Code
18647 \begin_layout Plain Layout
18658 \begin_layout Description
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18681 \begin_inset space \thinspace{}
18685 \begin_inset Flex Code
18688 \begin_layout Plain Layout
18695 \begin_inset Quotes eld
18699 \begin_inset Quotes erd
18702 language, leading to Left-to-Right (Latin) output, e.
18703 \begin_inset space \thinspace{}
18707 \begin_inset space \space{}
18710 in \SpecialChar TeX
18715 \begin_layout Description
18716 \begin_inset Flex Code
18719 \begin_layout Plain Layout
18726 \begin_inset Flex Code
18729 \begin_layout Plain Layout
18738 \begin_inset space \thinspace{}
18742 \begin_inset Flex Code
18745 \begin_layout Plain Layout
18751 ] Force a a line break in the \SpecialChar LaTeX
18752 output before the inset starts and after
18754 This assures the inset itself is output on its own lines, for parsing purposes.
18757 \begin_layout Description
18758 \begin_inset Flex Code
18761 \begin_layout Plain Layout
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18780 \begin_inset space \thinspace{}
18784 \begin_inset Flex Code
18787 \begin_layout Plain Layout
18793 ] Indicates whether the
18794 \begin_inset Flex Code
18797 \begin_layout Plain Layout
18803 should be used or, instead, the user can change the paragraph style used
18808 \begin_layout Description
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18819 \begin_inset Flex Code
18822 \begin_layout Plain Layout
18831 \begin_inset space \thinspace{}
18835 \begin_inset Flex Code
18838 \begin_layout Plain Layout
18844 ] As with paragraph styles, see
18845 \begin_inset CommandInset ref
18847 reference "subsec:Paragraph-Styles"
18854 \begin_layout Description
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18864 These tags control the XHTML output.
18866 \begin_inset CommandInset ref
18868 reference "sec:Tags-for-XHTML"
18875 \begin_layout Description
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18886 \begin_inset Flex Code
18889 \begin_layout Plain Layout
18898 \begin_inset space \thinspace{}
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18911 ] Whether to include the contents of this inset in the strings generated
18912 for the `Outline' pane for all table of contents, regardless of the AddToToc
18914 One would not, for example, want the content of a footnote in a section
18915 header to be included in the TOC displayed in the outline, but one would
18916 normally want the content of a character style displayed.
18917 Default is false: not to include.
18920 \begin_layout Description
18921 \begin_inset Flex Code
18924 \begin_layout Plain Layout
18931 \begin_inset Flex Code
18934 \begin_layout Plain Layout
18943 \begin_inset space \thinspace{}
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18956 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18957 of its contents in its item in the table of contents.
18958 Otherwise, only the label appears.
18961 \begin_layout Description
18962 \begin_inset Flex Code
18965 \begin_layout Plain Layout
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18986 \begin_inset space \thinspace{}
18990 \begin_inset Flex Code
18993 \begin_layout Plain Layout
18999 ] As with paragraph styles, see
19000 \begin_inset CommandInset ref
19002 reference "subsec:Paragraph-Styles"
19009 \begin_layout Description
19010 \begin_inset Flex Code
19013 \begin_layout Plain Layout
19019 The font used for the label.
19021 \begin_inset CommandInset ref
19023 reference "subsec:Font-description"
19028 Note that this definition can never appear before
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19038 , lest it be ineffective.
19041 \begin_layout Description
19042 \begin_inset Flex Code
19045 \begin_layout Plain Layout
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19062 \begin_inset Quotes erd
19066 \begin_inset Quotes erd
19069 ] What will be displayed on the button or elsewhere as the inset label.
19071 \begin_inset Flex Code
19074 \begin_layout Plain Layout
19082 \begin_inset Flex Code
19085 \begin_layout Plain Layout
19091 ) modify this label on the fly.
19094 \begin_layout Description
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19104 Language dependent preamble; see
19105 \begin_inset CommandInset ref
19107 reference "subsec:I18n"
19114 \begin_layout Description
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19134 ] The name of the corresponding \SpecialChar LaTeX
19136 Either the environment or command name.
19139 \begin_layout Description
19140 \begin_inset Flex Code
19143 \begin_layout Plain Layout
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19159 ] The optional parameter for the corresponding
19160 \begin_inset Flex Code
19163 \begin_layout Plain Layout
19169 stuff, including possible bracket pairs like
19170 \begin_inset Flex Code
19173 \begin_layout Plain Layout
19180 This parameter cannot be changed from within \SpecialChar LyX
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19191 for customizable parameters).
19192 It will be output as is after all \SpecialChar LaTeX
19194 \begin_inset Flex Code
19197 \begin_layout Plain Layout
19206 \begin_layout Description
19207 \begin_inset Flex Code
19210 \begin_layout Plain Layout
19217 \begin_inset Flex Code
19220 \begin_layout Plain Layout
19221 Command, Environment, None
19226 ] How the style should be translated into \SpecialChar LaTeX
19231 \begin_layout Plain Layout
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19241 is perhaps a bit misleading, since these rules apply to SGML classes too.
19242 Visit the SGML class files for specific examples.
19251 \begin_layout Description
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19261 means nothing special
19264 \begin_layout Description
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19285 {\SpecialChar ldots
19294 \begin_layout Description
19295 \begin_inset Flex Code
19298 \begin_layout Plain Layout
19305 \begin_inset Flex Code
19308 \begin_layout Plain Layout
19315 }\SpecialChar ldots
19330 \begin_layout Standard
19331 Putting the last few things together, the \SpecialChar LaTeX
19332 output will be either:
19335 \begin_layout LyX-Code
19338 LatexName[LatexParam]{\SpecialChar ldots
19342 \begin_layout Standard
19346 \begin_layout LyX-Code
19349 begin{LatexName}[LatexParam] \SpecialChar ldots
19355 \begin_layout Standard
19356 depending upon the \SpecialChar LaTeX
19361 \begin_layout Description
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19372 \begin_inset Flex Code
19375 \begin_layout Plain Layout
19381 ] A string that is put at the beginning of the layout content.
19382 A line break in the output can be indicated by
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19395 \begin_layout Description
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19406 \begin_inset Flex Code
19409 \begin_layout Plain Layout
19416 \begin_inset Flex Code
19419 \begin_layout Plain Layout
19426 \begin_inset Flex Code
19429 \begin_layout Plain Layout
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19445 (indicating a dummy definition ending definitions of charstyles, etc).
19446 This entry is required in and is only meaningful for Flex insets.
19447 Among other things, it determines on which menu this inset will appear.
19449 \begin_inset Flex Code
19452 \begin_layout Plain Layout
19459 \begin_inset Flex Code
19462 \begin_layout Plain Layout
19468 will automatically set
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19490 \begin_inset Flex Code
19493 \begin_layout Plain Layout
19499 can be set to true, or
19500 \begin_inset Flex Code
19503 \begin_layout Plain Layout
19510 \begin_inset Flex Code
19513 \begin_layout Plain Layout
19519 insets by setting it
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19536 \begin_layout Description
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19559 \begin_inset space \thinspace{}
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19572 ] Whether multiple paragraphs are permitted in this inset.
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19583 to the same value and
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 to the opposite value.
19594 These can be reset to other values, if they are used
19599 \begin_inset Flex Code
19602 \begin_layout Plain Layout
19612 \begin_layout Description
19613 \begin_inset Flex Code
19616 \begin_layout Plain Layout
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19635 \begin_inset space \thinspace{}
19639 \begin_inset Flex Code
19642 \begin_layout Plain Layout
19648 ] Whether fragile commands in this inset should be
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19665 whether the command should itself be protected.) Default is false.
19666 \change_inserted -712698321 1523633958
19670 \begin_layout Description
19672 \change_inserted -712698321 1523634088
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19678 \change_inserted -712698321 1523633961
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19690 \change_inserted -712698321 1523633958
19699 \begin_inset space \thinspace{}
19703 \begin_inset Flex Code
19706 \begin_layout Plain Layout
19708 \change_inserted -712698321 1523633958
19714 ] This causes macros that contain this inset to be protected with
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19720 \change_inserted -712698321 1523634038
19735 ) if necessary and thus allows (some) verbatim stuff in macros.
19741 \begin_layout Description
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19752 \begin_inset Flex Code
19755 \begin_layout Plain Layout
19761 ] Deletes an existing
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19774 \begin_layout Description
19775 \begin_inset Flex Code
19778 \begin_layout Plain Layout
19785 \begin_inset Flex Code
19788 \begin_layout Plain Layout
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19804 that has replaced this
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 This is used to rename an
19816 \begin_inset Flex Code
19819 \begin_layout Plain Layout
19825 , while keeping backward compatibility.
19828 \begin_layout Description
19829 \begin_inset Flex Code
19832 \begin_layout Plain Layout
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19851 \begin_inset space \thinspace{}
19855 \begin_inset Flex Code
19858 \begin_layout Plain Layout
19864 ] As with paragraph styles, see
19865 \begin_inset CommandInset ref
19867 reference "subsec:Paragraph-Styles"
19875 \begin_layout Description
19876 \begin_inset Flex Code
19879 \begin_layout Plain Layout
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19898 \begin_inset space \thinspace{}
19902 \begin_inset Flex Code
19905 \begin_layout Plain Layout
19911 ] As with paragraph styles, see
19912 \begin_inset CommandInset ref
19914 reference "subsec:Paragraph-Styles"
19922 \begin_layout Description
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19932 As with paragraph styles, see
19933 \begin_inset CommandInset ref
19935 reference "subsec:Paragraph-Styles"
19942 \begin_layout Description
19943 \begin_inset Flex Code
19946 \begin_layout Plain Layout
19953 \begin_inset Flex Code
19956 \begin_layout Plain Layout
19962 ] The prefix to use when creating labels referring to insets of this type.
19963 This allows the use of formatted references.
19966 \begin_layout Description
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19986 ] As with paragraph styles, see
19987 \begin_inset CommandInset ref
19989 reference "subsec:Paragraph-Styles"
19996 \begin_layout Description
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20019 \begin_inset space \thinspace{}
20023 \begin_inset Flex Code
20026 \begin_layout Plain Layout
20032 ] Resets the \SpecialChar LaTeX
20033 arguments of this layout (as defined via the
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20044 This is useful if you have copied a style via
20045 \begin_inset Flex Code
20048 \begin_layout Plain Layout
20054 , but you do not want to inherit its (required and optional) arguments.
20057 \begin_layout Description
20058 \begin_inset Flex Code
20061 \begin_layout Plain Layout
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20078 \begin_inset space \thinspace{}
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20093 ] Whether this inset should use the font of its surrounding environment
20095 Default is false: use the font of the surrounding environment.
20098 \begin_layout Description
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20109 \begin_inset Flex Code
20112 \begin_layout Plain Layout
20118 ] A string that is put at the end of the layout content.
20119 A line break in the output can be indicated by
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20132 \begin_layout Description
20133 \begin_inset Flex Code
20136 \begin_layout Plain Layout
20143 \begin_inset Flex Code
20146 \begin_layout Plain Layout
20153 \begin_inset space \thinspace{}
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20168 ] Allow spell-checking the contents of this inset.
20172 \begin_layout Subsection
20174 \begin_inset CommandInset label
20176 name "subsec:Counters"
20183 \begin_layout Standard
20184 It is necessary to define the counters (
20185 \begin_inset Flex Noun
20188 \begin_layout Plain Layout
20195 \begin_inset Flex Noun
20198 \begin_layout Plain Layout
20204 , \SpecialChar ldots
20205 ) in the text class itself.
20206 The standard counters are defined in the file
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20216 , so you may have to do no more than add
20219 \begin_layout LyX-Code
20220 Input stdcounters.inc
20223 \begin_layout Standard
20224 to your layout file to get them to work.
20225 But if you want to define custom counters, then you can do so.
20226 The counter declaration must begin with:
20229 \begin_layout LyX-Code
20230 Counter CounterName
20233 \begin_layout Standard
20235 \begin_inset Flex Code
20238 \begin_layout Plain Layout
20244 ' is replaced by the name of the counter.
20245 And it must end with
20246 \begin_inset Quotes eld
20250 \begin_inset Flex Code
20253 \begin_layout Plain Layout
20260 \begin_inset Quotes erd
20264 The following parameters can also be used:
20267 \begin_layout Description
20268 \begin_inset Flex Code
20271 \begin_layout Plain Layout
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20287 ] Sets the initial value for the counter, to which it will be reset whenever
20289 Normally, one will want the default, 1.
20292 \begin_layout Description
20293 \begin_inset Flex Code
20296 \begin_layout Plain Layout
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20313 \begin_inset Quotes erd
20317 \begin_inset Quotes erd
20320 ] When defined, this string defines how the counter is displayed.
20321 Setting this value sets
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20326 LabelStringAppendix
20332 The following special constructs can be used in the string:
20336 \begin_layout Itemize
20337 \begin_inset Flex Code
20340 \begin_layout Plain Layout
20348 will be replaced by the expansion of the
20349 \begin_inset Flex Code
20352 \begin_layout Plain Layout
20359 \begin_inset Flex Code
20362 \begin_layout Plain Layout
20363 LabelStringAppendix
20369 \begin_inset Flex Code
20372 \begin_layout Plain Layout
20382 \begin_layout Itemize
20383 counter values can be expressed using \SpecialChar LaTeX
20385 \begin_inset Newline newline
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20424 \begin_layout Plain Layout
20434 Actually, the situation is a bit more complicated: any
20453 other than those described below will produce arabic numerals.
20454 It would not be surprising to see this change in the future.
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20469 : 1, 2, 3,\SpecialChar ldots
20471 \begin_inset Flex Code
20474 \begin_layout Plain Layout
20480 for lower-case letters: a, b, c, \SpecialChar ldots
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20491 for upper-case letters: A, B, C, \SpecialChar ldots
20493 \begin_inset Flex Code
20496 \begin_layout Plain Layout
20502 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20513 for upper-case roman numerals: I, II, III\SpecialChar ldots
20515 \begin_inset Flex Code
20518 \begin_layout Plain Layout
20524 for hebrew numerals.
20528 \begin_layout Standard
20529 If LabelString is not defined, a default value is constructed as follows:
20530 if the counter has a master counter
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20551 \begin_inset Newline newline
20555 \begin_inset Flex Code
20558 \begin_layout Plain Layout
20568 is used; otherwise the string
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20583 \begin_layout Description
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20588 LabelStringAppendix
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20604 \begin_inset Quotes erd
20608 \begin_inset Quotes erd
20612 \begin_inset Flex Code
20615 \begin_layout Plain Layout
20621 , but for use in the Appendix.
20624 \begin_layout Description
20625 \begin_inset Flex Code
20628 \begin_layout Plain Layout
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20645 \begin_inset Quotes erd
20649 \begin_inset Quotes erd
20652 ] A format for use with formatted references to this counter.
20653 For example, one might want to have references to section numbers appear
20655 \begin_inset Quotes eld
20659 \begin_inset Quotes erd
20663 The string should contain
20664 \begin_inset Quotes eld
20668 \begin_inset Quotes erd
20672 This will be replaced by the counter number itself.
20673 So, for sections, it would be: Section ##.
20676 \begin_layout Description
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20687 \begin_inset Flex Code
20690 \begin_layout Plain Layout
20697 \begin_inset Quotes erd
20701 \begin_inset Quotes erd
20704 ] If this is set to the name of another counter, the present counter will
20705 be reset every time the other one is increased.
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20729 \begin_layout Subsection
20731 \begin_inset CommandInset label
20733 name "subsec:Font-description"
20740 \begin_layout Standard
20741 A font description looks like this:
20744 \begin_layout LyX-Code
20761 \begin_layout LyX-Code
20765 \begin_layout LyX-Code
20769 \begin_layout Standard
20770 The following commands are available:
20773 \begin_layout Description
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20784 \begin_inset Flex Code
20787 \begin_layout Plain Layout
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20826 \begin_inset Flex Code
20829 \begin_layout Plain Layout
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20846 \begin_inset Flex Code
20849 \begin_layout Plain Layout
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20876 \begin_inset Flex Code
20879 \begin_layout Plain Layout
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20896 \begin_inset Flex Code
20899 \begin_layout Plain Layout
20906 \begin_inset Flex Code
20909 \begin_layout Plain Layout
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20946 \begin_inset Flex Code
20949 \begin_layout Plain Layout
20956 \begin_inset Flex Code
20959 \begin_layout Plain Layout
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20988 \begin_layout Description
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20999 \begin_inset Flex Code
21002 \begin_layout Plain Layout
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21021 \begin_inset Flex Code
21024 \begin_layout Plain Layout
21033 \begin_layout Description
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21044 \begin_inset Flex Code
21047 \begin_layout Plain Layout
21053 ] Valid arguments are:
21054 \begin_inset Flex Code
21057 \begin_layout Plain Layout
21064 \begin_inset Flex Code
21067 \begin_layout Plain Layout
21074 \begin_inset Flex Code
21077 \begin_layout Plain Layout
21084 \begin_inset Flex Code
21087 \begin_layout Plain Layout
21094 \begin_inset Flex Code
21097 \begin_layout Plain Layout
21104 \begin_inset Flex Code
21107 \begin_layout Plain Layout
21114 \begin_inset Flex Code
21117 \begin_layout Plain Layout
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21144 \begin_inset Flex Code
21147 \begin_layout Plain Layout
21154 \begin_inset Flex Code
21157 \begin_layout Plain Layout
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21174 Each of these turns on or off the corresponding attribute.
21176 \begin_inset Flex Code
21179 \begin_layout Plain Layout
21185 turns on emphasis, and
21186 \begin_inset Flex Code
21189 \begin_layout Plain Layout
21197 \begin_inset Newline newline
21200 If the latter seems puzzling, remember that the font settings for the present
21201 context are generally inherited from the surrounding context.
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21212 would turn off the emphasis that was anyway in effect, say, in a theorem
21216 \begin_layout Description
21217 \begin_inset Flex Code
21220 \begin_layout Plain Layout
21227 \begin_inset Flex Code
21230 \begin_layout Plain Layout
21239 \begin_inset Flex Code
21242 \begin_layout Plain Layout
21251 \begin_layout Description
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21262 \begin_inset Flex Code
21265 \begin_layout Plain Layout
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21294 \begin_inset Flex Code
21297 \begin_layout Plain Layout
21306 \begin_layout Description
21307 \begin_inset Flex Code
21310 \begin_layout Plain Layout
21317 \begin_inset Flex Code
21320 \begin_layout Plain Layout
21327 \begin_inset Flex Code
21330 \begin_layout Plain Layout
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21359 \begin_inset Flex Code
21362 \begin_layout Plain Layout
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21379 \begin_inset Flex Code
21382 \begin_layout Plain Layout
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21401 \begin_layout Subsection
21402 \begin_inset CommandInset label
21404 name "subsec:Citation-engine-description"
21408 Cite engine description
21411 \begin_layout Standard
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21422 blocks, as used mainly in cite engine files (see
21423 \begin_inset CommandInset ref
21425 reference "subsec:Cite-Engine-Files"
21432 ), define the citation commands provided by a specific
21433 \begin_inset Quotes eld
21437 \begin_inset Quotes erd
21441 A cite engine, in \SpecialChar LyX
21442 terms, is way specific way to format citations, using
21443 numbers, author names and/or years.
21444 Currently, \SpecialChar LyX
21445 supports three such engine types, namely:
21448 \begin_layout Enumerate
21449 \begin_inset Flex Code
21452 \begin_layout Plain Layout
21458 : the default Bib\SpecialChar TeX
21459 way to format citations, a simple numeric style (e.
21460 \begin_inset space \thinspace{}
21464 \begin_inset Quotes eld
21468 \begin_inset Quotes erd
21474 \begin_layout Enumerate
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21484 : Harvard-styled citations using author names and publication year (e.
21485 \begin_inset space \thinspace{}
21489 \begin_inset Quotes eld
21492 Smith and Miller (2017b)
21493 \begin_inset Quotes erd
21499 \begin_layout Enumerate
21500 \begin_inset Flex Code
21503 \begin_layout Plain Layout
21509 : extended numerical citations that also allow for author or title next
21511 \begin_inset space \thinspace{}
21515 \begin_inset Quotes eld
21518 Smith and Miller [1]
21519 \begin_inset Quotes erd
21525 \begin_layout Standard
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21535 blocks look like this:
21538 \begin_layout LyX-Code
21542 \begin_layout LyX-Code
21546 \begin_layout LyX-Code
21550 \begin_layout LyX-Code
21551 citeyearpar[][]=parencite*
21554 \begin_layout LyX-Code
21558 \begin_layout LyX-Code
21562 \begin_layout Standard
21564 \begin_inset Flex Code
21567 \begin_layout Plain Layout
21573 denotes the engine.
21574 The individual lines respectively define a cite command or cite command
21575 paradigm supported by this engine.
21576 The line can be as simple as a cite command that is used both to name the
21577 respective \SpecialChar LyX
21578 command and the \SpecialChar LaTeX
21579 output or more complex in order to differentiate
21581 The full syntax is:
21584 \begin_layout LyX-Code
21585 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21588 \begin_layout Itemize
21589 \begin_inset Flex Code
21592 \begin_layout Plain Layout
21598 : The name as used in the
21599 \begin_inset Flex Code
21602 \begin_layout Plain Layout
21612 \begin_layout Standard
21613 For portability reasons, we try to use the same name for same-formatted
21614 commands in different cite packages (thus many names stem from natbib,
21615 and thus we need to differentiate a
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21625 sometimes, if the \SpecialChar LaTeX
21626 command names differ).
21630 \begin_layout Itemize
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21640 : a (comma-separated) list of commands that fall back to the given
21641 \begin_inset Flex Code
21644 \begin_layout Plain Layout
21650 in the current engine.
21651 This eases the switch of citation packages and engines.
21653 \begin_inset Flex Code
21656 \begin_layout Plain Layout
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21672 in layout definitions.
21675 \begin_layout Itemize
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21685 : The actual \SpecialChar LaTeX
21686 command that is output.
21690 \begin_layout Standard
21691 \begin_inset Flex Code
21694 \begin_layout Plain Layout
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21731 will be output to \SpecialChar LaTeX
21735 \begin_layout Standard
21739 \begin_layout Itemize
21740 Capitalization indicates that the command also has a capitalized form (
21741 \begin_inset Flex Code
21744 \begin_layout Plain Layout
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21766 These usually enforce up-casing of name prefixes (
21771 \begin_inset Formula $\Rightarrow$
21781 \begin_layout Itemize
21783 \begin_inset Flex Code
21786 \begin_layout Plain Layout
21792 indicate the number of optional arguments (there can be 0–2).
21795 \begin_layout Itemize
21797 \begin_inset Flex Code
21800 \begin_layout Plain Layout
21806 indicates there is a starred version of the command (
21807 \begin_inset Flex Code
21810 \begin_layout Plain Layout
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21836 \begin_layout Standard
21837 By default, the starred version means: Output all authors even if it should
21839 \begin_inset Quotes eld
21843 \begin_inset Quotes erd
21847 \begin_inset Flex Code
21850 \begin_layout Plain Layout
21859 \begin_layout Standard
21860 If the star has a different meaning for a given command, it can be specified
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21866 <!_stardesc!_stardesctooltip>
21872 Maximal two translatable macro keywords, marked by the prefix
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21883 The first points to the string that replaces the
21884 \begin_inset Quotes eld
21888 \begin_inset Quotes erd
21891 checkbox label in the citation dialog, the second one to an optional tool
21892 tip for this checkbox.
21896 \begin_layout Standard
21897 Note that these two macros have to be defined in a
21898 \begin_inset Flex Code
21901 \begin_layout Plain Layout
21907 (see next section), dropping the
21908 \begin_inset Flex Code
21911 \begin_layout Plain Layout
21917 from the prefix, like this:
21920 \begin_layout LyX-Code
21921 _stardesc Sta&rred command label
21924 \begin_layout LyX-Code
21925 _stardesctooltip Tooltip for the starred command checkbox.
21929 \begin_layout Itemize
21931 \begin_inset Flex Code
21934 \begin_layout Plain Layout
21940 indicates that this command features
21941 \begin_inset Quotes eld
21944 qualified citation lists
21945 \begin_inset Quotes erd
21953 -specific feature for multi-reference citations where an individual pre-
21954 and postnote can be given to each reference in the list.
21955 Please refer to the
21959 manual for details.
21962 \begin_layout Subsection
21963 \begin_inset CommandInset label
21965 name "subsec:Citation-format-description"
21969 Cite format description
21972 \begin_layout Standard
21974 \begin_inset Flex Code
21977 \begin_layout Plain Layout
21983 blocks are used to describe how bibliographic information should be displayed,
21984 both within \SpecialChar LyX
21985 itself (in the citation dialog and in tooltips, for example)
21986 and in XHTML output.
21987 Such a block might look like this:
21990 \begin_layout LyX-Code
21994 \begin_layout LyX-Code
21998 \begin_layout LyX-Code
22002 \begin_layout LyX-Code
22006 \begin_layout Standard
22010 \begin_layout LyX-Code
22014 \begin_layout LyX-Code
22018 \begin_layout LyX-Code
22022 \begin_layout LyX-Code
22026 \begin_layout Standard
22027 In the first case, the individual lines define how the bibliographic information
22028 associated with an article or book, respectively, is to be displayed, and
22029 such a definition can be given for any
22030 \begin_inset Quotes els
22034 \begin_inset Quotes ers
22037 that might be present in a Bib\SpecialChar TeX
22040 defines a default format in the source code that will be used if no specific
22041 definition has been given.
22043 predefines several formats in the file
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22053 , which is included in most of \SpecialChar LyX
22054 's document classes.
22057 \begin_layout Standard
22058 In the second case, the lines define how a specific citation command (in
22060 \begin_inset Flex Code
22063 \begin_layout Plain Layout
22072 \begin_inset Flex Code
22075 \begin_layout Plain Layout
22083 ) is to be displayed on the citation inset label, in the citation dialog,
22084 menu or XHTML output.
22086 defines such formats for the citation style variants it supports via
22088 Document\SpecialChar menuseparator
22089 Setting\SpecialChar menuseparator
22090 Bibliography\SpecialChar ldots
22094 \begin_inset Flex Code
22097 \begin_layout Plain Layout
22103 files that are shipped with \SpecialChar LyX
22105 \begin_inset CommandInset ref
22107 reference "subsec:Cite-Engine-Files"
22117 \begin_layout Standard
22118 The definitions use a simple language that allows Bib\SpecialChar TeX
22119 keys to be replaced
22121 Keys should be enclosed in
22122 \begin_inset Flex Code
22125 \begin_layout Plain Layout
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22142 So a simple definition might look like this:
22145 \begin_layout LyX-Code
22147 \begin_inset Quotes eld
22151 \begin_inset Quotes erd
22157 \begin_layout Standard
22158 This would print the author, followed by a comma, followed by the title,
22159 in quotes, followed by a period.
22162 \begin_layout Standard
22163 Of course, sometimes you may want to print a key only if it exists.
22164 This can be done by using a conditional construction, such as:
22165 \begin_inset Flex Code
22168 \begin_layout Plain Layout
22170 \begin_inset space ~
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22189 key exists, then print
22190 \begin_inset Quotes eld
22194 \begin_inset space ~
22198 \begin_inset Quotes erd
22201 followed by the volume key.
22202 It is also possible to have an else clause in the conditional, such as:
22203 \begin_inset Newline newline
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22211 {%author%[[%author%]][[%editor%, ed.]]}
22217 \begin_inset Newline newline
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22230 key is printed if it exists; otherwise, the editor key is printed, followed
22232 \begin_inset Quotes eld
22236 \begin_inset space ~
22240 \begin_inset Quotes erd
22243 Note that the key is again enclosed in
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22253 signs; the entire conditional is enclosed in braces; and the if and else
22254 clauses are enclosed in double brackets,
22255 \begin_inset Quotes eld
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22269 \begin_inset Quotes eld
22273 \begin_inset Quotes eld
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22287 \begin_inset Quotes erd
22291 There must be no space between any of these.
22294 \begin_layout Standard
22295 Next to the entry keys, there are some special keys that can be used for
22296 these conditionals:
22299 \begin_layout Itemize
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22304 {%dialog%[[true]][[false]]}
22310 \begin_inset Quotes eld
22314 \begin_inset Quotes erd
22317 part for dialogs and menus, the
22318 \begin_inset Quotes eld
22322 \begin_inset Quotes erd
22325 part for other contexts (workarea, export)
22328 \begin_layout Itemize
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22333 {%export%[[true]][[false]]}
22339 \begin_inset Quotes eld
22343 \begin_inset Quotes erd
22346 part for export and menus, the
22347 \begin_inset Quotes eld
22351 \begin_inset Quotes erd
22354 part for other contexts (workarea, dialog)
22357 \begin_layout Itemize
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22368 \begin_inset Quotes eld
22372 \begin_inset Quotes erd
22375 part if another item follows (e.
22376 \begin_inset space \thinspace{}
22379 g., in a citation with multiple keys)
22382 \begin_layout Itemize
22383 \begin_inset Flex Code
22386 \begin_layout Plain Layout
22387 {%second%[[true]][[false]]}
22393 \begin_inset Quotes eld
22397 \begin_inset Quotes erd
22400 if this is the second of multiple items, else the
22401 \begin_inset Quotes eld
22405 \begin_inset Quotes erd
22411 \begin_layout Itemize
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22416 {%ifstar%[[true]][[false]]}
22422 \begin_inset Quotes eld
22426 \begin_inset Quotes erd
22429 part for starred citation commands (such as
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22441 ), the false part for unstarred
22444 \begin_layout Itemize
22445 \begin_inset Flex Code
22448 \begin_layout Plain Layout
22449 {%ifentrytype:<type>%[[true]][[false]]}
22455 \begin_inset Quotes eld
22459 \begin_inset Quotes erd
22462 if the current entry type matches
22463 \begin_inset Flex Code
22466 \begin_layout Plain Layout
22472 , else the false part (e.g., in a citation definition:
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22477 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22485 \begin_layout Itemize
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22490 {%ifmultiple:<authortype>%[[true]][[false]]}
22496 \begin_inset Quotes eld
22500 \begin_inset Quotes erd
22503 if the current author type (author, editor etc.) has multiple authors, else
22504 the false part (e.g., in a bibliography definition:
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22509 {%ifmultiple:editor%[[eds.]][[ed.]]}
22517 \begin_layout Itemize
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22522 {%ifqualified%[[true]][[false]]}
22528 \begin_inset Quotes eld
22532 \begin_inset Quotes erd
22535 part if the current citation is a qualified citation list (a specific
22539 format for multi-reference citations), the false part if this is not the
22543 \begin_layout Standard
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22554 prints the author key as it is recorded in the bibliography file.
22555 This might not be what you want, since it will result in a string such
22557 \begin_inset Quotes eld
22560 Miller, Peter and Smith, Mary and White, Jane
22561 \begin_inset Quotes erd
22565 \begin_inset Quotes eld
22569 \begin_inset Quotes erd
22572 is used by Bib\SpecialChar TeX
22573 to delimit authors).
22575 therefore provides some methods to get properly formatted name lists (which
22576 will also get translated).
22577 The following keys are provided:
22580 \begin_layout Enumerate
22581 For name lists with pre- and surname, suitable for the main authors/editors
22582 of a bibliography item.
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22593 part denotes the kind of list that is requested (e.g.
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22608 \begin_layout Itemize
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22613 %abbrvnames:<nametype>%
22618 : Provides a name list which is abbreviated (with
22619 \begin_inset Quotes eld
22623 \begin_inset Quotes erd
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22639 \begin_layout Itemize
22640 \begin_inset Flex Code
22643 \begin_layout Plain Layout
22644 %fullnames:<nametype>%
22649 : Provides a full name list (never abbreviated with
22650 \begin_inset Quotes eld
22654 \begin_inset Quotes erd
22660 \begin_layout Itemize
22661 \begin_inset Flex Code
22664 \begin_layout Plain Layout
22665 %forceabbrvnames:<nametype>%
22670 : Provides a name list which is always abbreviated (with
22671 \begin_inset Quotes eld
22675 \begin_inset Quotes erd
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22692 \begin_layout Enumerate
22693 Alternative name lists with pre- and surname, if the order of pre- and surname
22694 inside the bibliography item differs (as in:
22695 \begin_inset Quotes eld
22698 Miller, John: Some text, in: Mary Smith, ed.: A volume
22699 \begin_inset Quotes erd
22706 \begin_layout Itemize
22707 \begin_inset Flex Code
22710 \begin_layout Plain Layout
22711 %abbrvbynames:<nametype>%
22716 : Provides a name list which is abbreviated (with
22717 \begin_inset Quotes eld
22721 \begin_inset Quotes erd
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22737 \begin_layout Itemize
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22742 %fullbynames:<nametype>%
22747 : Provides a full name list (never abbreviated with
22748 \begin_inset Quotes eld
22752 \begin_inset Quotes erd
22758 \begin_layout Itemize
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22763 %forceabbrvbynames:<nametype>%
22768 : Provides a name list which is always abbreviated (with
22769 \begin_inset Quotes eld
22773 \begin_inset Quotes erd
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22790 \begin_layout Enumerate
22791 And finally name lists which consist of family names only, as used in author-yea
22793 These do not take a
22794 \begin_inset Flex Code
22797 \begin_layout Plain Layout
22803 part, but always return either an author list or, if this does not exist,
22804 an editor list (as common in author-year labels):
22808 \begin_layout Itemize
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22818 : Provides a name list which is abbreviated (with
22819 \begin_inset Quotes eld
22823 \begin_inset Quotes erd
22827 \begin_inset Flex Code
22830 \begin_layout Plain Layout
22839 \begin_layout Itemize
22840 \begin_inset Flex Code
22843 \begin_layout Plain Layout
22849 : Provides a full name list (never abbreviated with
22850 \begin_inset Quotes eld
22854 \begin_inset Quotes erd
22860 \begin_layout Itemize
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22865 %forceabbrvciteauthor%
22870 : Provides a name list which is always abbreviated (with
22871 \begin_inset Quotes eld
22875 \begin_inset Quotes erd
22879 \begin_inset Flex Code
22882 \begin_layout Plain Layout
22892 \begin_layout Standard
22893 The order of pre- and surname in the former two lists can be adjusted by
22897 \begin_layout Itemize
22898 \begin_inset Flex Code
22901 \begin_layout Plain Layout
22902 !firstnameform %surname%, %prename%
22907 (first author in lists of type 1)
22910 \begin_layout Itemize
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22915 !othernameform %surname%, %prename%
22920 (other authors in lists of type 1)
22923 \begin_layout Itemize
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22928 !firstbynameform %prename% %surname%
22933 (first author in lists of type 2)
22936 \begin_layout Itemize
22937 \begin_inset Flex Code
22940 \begin_layout Plain Layout
22941 !otherbynameform %prename% %surname%
22946 (other authors in lists of type 2)
22949 \begin_layout Standard
22950 This allows you to configure namings like
22951 \begin_inset Quotes eld
22954 Miller, Peter and Mary Smith: \SpecialChar ldots
22955 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22957 \begin_inset Quotes erd
22963 \begin_layout Standard
22964 There is one other piece of syntax available in definitions, which looks
22966 \begin_inset Flex Code
22969 \begin_layout Plain Layout
22976 This defines a piece of formatting information that is to be used when
22978 \begin_inset Quotes eld
22982 \begin_inset Quotes erd
22986 Obviously, we do not want to output HTML tags when writing plain text,
22987 so they should be wrapped in
22988 \begin_inset Quotes eld
22992 \begin_inset Quotes erd
22996 \begin_inset Quotes eld
23000 \begin_inset Quotes erd
23006 \begin_layout Standard
23007 Two special sorts of definitions are also possible in a
23008 \begin_inset Flex Code
23011 \begin_layout Plain Layout
23018 An example of the first would be:
23021 \begin_layout LyX-Code
23023 \begin_inset Quotes eld
23027 \begin_inset Quotes erd
23033 \begin_layout Standard
23034 This is an abbreviation, or macro, and it can be used by treating it as
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23057 exactly as it would treat its definition.
23058 So, let us issue the obvious
23066 \begin_layout LyX-Code
23070 \begin_layout Standard
23071 or anything like it.
23073 shouldn't go into an infinite loop, but it may go into a long one before
23077 \begin_layout Standard
23078 The second sort of special definition might look like this:
23081 \begin_layout LyX-Code
23085 \begin_layout Standard
23086 This defines a translatable piece of text, which allows relevant parts of
23087 the bibliography or citation to be translated.
23088 It can be included in a definition by treating it as a key:
23089 \begin_inset Flex Code
23092 \begin_layout Plain Layout
23099 Note that there are two different translation paths: All definitions starting
23101 \begin_inset Flex Code
23104 \begin_layout Plain Layout
23110 , such as in the example above, will be translated to the currently active
23111 buffer language (so the translation will match the generated document).
23112 All definitions starting with underscore only will be translated to the
23114 This is the proper translation for strings that only occur in the dialogs
23115 or on buttons, such as this one:
23118 \begin_layout LyX-Code
23119 _addtobib Add to bibliography only.
23122 \begin_layout Standard
23123 Several of these translatable strings are predefined in
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23144 Note that these are not macros, in the sense just defined.
23145 They will not be expanded.
23148 \begin_layout Standard
23149 So here then is an example that uses several of these features:
23150 \begin_inset VSpace defskip
23156 \begin_layout Standard
23160 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23163 \begin_layout Standard
23164 \begin_inset VSpace defskip
23167 This defines a macro that prints the author, followed by a comma, if the
23169 \begin_inset Flex Code
23172 \begin_layout Plain Layout
23178 key is defined, or else prints the name of the editor, followed by the
23180 \begin_inset Flex Code
23183 \begin_layout Plain Layout
23189 or its translation (it is by default
23190 \begin_inset Quotes eld
23194 \begin_inset Quotes erd
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23208 Note that this is in fact defined in
23209 \begin_inset Flex Code
23212 \begin_layout Plain Layout
23218 , so you can use it in your own definitions, or re-definitions, if you load
23222 \begin_layout Section
23223 \begin_inset CommandInset label
23225 name "sec:Tags-for-XHTML"
23229 Tags for XHTML output
23232 \begin_layout Standard
23233 As with \SpecialChar LaTeX
23234 or DocBook, the format of \SpecialChar LyX
23235 's XHTML output is also controlled by
23236 layout information.
23237 In general, \SpecialChar LyX
23238 provides sensible defaults and, as mentioned earlier, it will
23239 even construct default CSS style rules from the other layout tags.
23240 For example, \SpecialChar LyX
23241 will attempt to use the information provided in the
23242 \begin_inset Flex Code
23245 \begin_layout Plain Layout
23251 declaration for the Chapter style to write CSS that will appropriately
23252 format chapter headings.
23255 \begin_layout Standard
23256 In many cases, then, you may not have to do anything at all to get acceptable
23257 XHTML output for your own environments, custom insets, and so forth.
23258 But in some cases you will, and so \SpecialChar LyX
23259 provides a number of layout tags that
23260 can be used to customize the XHTML and CSS that are generated.
23263 \begin_layout Standard
23264 Note that there are two tags,
23265 \begin_inset Flex Code
23268 \begin_layout Plain Layout
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23284 that may appear outside style and inset declarations.
23286 \begin_inset CommandInset ref
23288 reference "subsec:General-text-class"
23292 for details on these.
23295 \begin_layout Subsection
23296 \begin_inset CommandInset label
23298 name "subsec:Paragraph-Style-XHTML"
23305 \begin_layout Standard
23306 The sort of XHTML \SpecialChar LyX
23307 outputs for a paragraph depends upon whether we are dealing
23308 with a normal paragraph, a command, or an environment, where this is itself
23309 determined by the contents of the corresponding
23310 \begin_inset Flex Code
23313 \begin_layout Plain Layout
23324 \begin_layout Standard
23325 For a command or normal paragraph, the output XHTML has the following form:
23328 \begin_layout LyX-Code
23332 \begin_inset Quotes erd
23336 \begin_inset Quotes erd
23342 \begin_layout LyX-Code
23346 \begin_inset Quotes erd
23350 \begin_inset Quotes erd
23356 \begin_layout LyX-Code
23359 Contents of the paragraph.
23362 \begin_layout LyX-Code
23368 \begin_layout Standard
23369 The label tags are of course omitted if the paragraph does not have a label.
23372 \begin_layout Standard
23373 For an environment that is not some sort of list, the XHTML takes this form:
23376 \begin_layout LyX-Code
23380 \begin_inset Quotes erd
23384 \begin_inset Quotes erd
23390 \begin_layout LyX-Code
23394 \begin_inset Quotes erd
23398 \begin_inset Quotes erd
23402 \begin_inset Quotes erd
23406 \begin_inset Quotes erd
23409 >Environment Label</labeltag>First paragraph.</itemtag>
23412 \begin_layout LyX-Code
23415 <itemtag>Second paragraph.</itemtag>
23418 \begin_layout LyX-Code
23424 \begin_layout Standard
23425 Note that the label is output only for the first paragraph, as it should
23426 be for a theorem, for example.
23430 \begin_layout Standard
23431 For a list, we have one of these forms:
23434 \begin_layout LyX-Code
23438 \begin_inset Quotes erd
23442 \begin_inset Quotes erd
23448 \begin_layout LyX-Code
23452 \begin_inset Quotes erd
23456 \begin_inset Quotes erd
23460 \begin_inset Quotes erd
23464 \begin_inset Quotes erd
23467 >List Label</labeltag>First item.</itemtag>
23470 \begin_layout LyX-Code
23474 \begin_inset Quotes erd
23478 \begin_inset Quotes erd
23482 \begin_inset Quotes erd
23486 \begin_inset Quotes erd
23489 >List Label</labeltag>Second item.</itemtag>
23492 \begin_layout LyX-Code
23498 \begin_layout LyX-Code
23502 \begin_layout LyX-Code
23506 \begin_inset Quotes erd
23510 \begin_inset Quotes erd
23516 \begin_layout LyX-Code
23520 \begin_inset Quotes erd
23524 \begin_inset Quotes erd
23527 >List Label</labeltag><itemtag attr=
23528 \begin_inset Quotes erd
23532 \begin_inset Quotes erd
23535 >First item.</itemtag>
23538 \begin_layout LyX-Code
23542 \begin_inset Quotes erd
23546 \begin_inset Quotes erd
23549 >List Label</labeltag><itemtag attr=
23550 \begin_inset Quotes erd
23554 \begin_inset Quotes erd
23557 >Second item.</itemtag>
23560 \begin_layout LyX-Code
23566 \begin_layout Standard
23567 Note the different orders of
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23588 Which order we get depends upon the setting of
23589 \begin_inset Flex Code
23592 \begin_layout Plain Layout
23599 \begin_inset Flex Code
23602 \begin_layout Plain Layout
23608 is false (the default), you get the first of these, with the label within
23609 the item; if true, you get the second, with the label outside the item.
23612 \begin_layout Standard
23613 The specific tags and attributes output for each paragraph type can be controlle
23614 d by means of the layout tags we are about to describe.
23615 As mentioned earlier, however, \SpecialChar LyX
23616 uses sensible defaults for many of these,
23617 so you often may not need to do very much to get good XHTML output.
23618 Think of the available tags as there so you can tweak things to your liking.
23621 \begin_layout Description
23622 \begin_inset Flex Code
23625 \begin_layout Plain Layout
23632 \begin_inset Flex Code
23635 \begin_layout Plain Layout
23641 ] Specifies attribute information to be output with the main tag.
23643 \begin_inset Quotes eld
23647 \begin_inset Flex Code
23650 \begin_layout Plain Layout
23657 \begin_inset Quotes erd
23661 By default, \SpecialChar LyX
23663 \begin_inset Quotes eld
23667 \begin_inset Flex Code
23670 \begin_layout Plain Layout
23677 \begin_inset Quotes erd
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23690 is the \SpecialChar LyX
23691 name of the layout, made lowercase, for example: chapter.
23696 contain any style information.
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23710 \begin_layout Description
23711 \begin_inset Flex Code
23714 \begin_layout Plain Layout
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23734 ] Whether to output the default CSS information \SpecialChar LyX
23735 generates for this layout,
23736 even if additional information is explicitly provided via
23737 \begin_inset Flex Code
23740 \begin_layout Plain Layout
23748 \begin_inset Flex Code
23751 \begin_layout Plain Layout
23757 allows you to alter or augment the generated CSS, rather than to override
23760 \begin_inset Flex Code
23763 \begin_layout Plain Layout
23772 \begin_layout Description
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23792 ] The tag to be used for individual paragraphs of environments, replacing
23794 \begin_inset Flex Code
23797 \begin_layout Plain Layout
23803 in the examples above.
23805 \begin_inset Flex Code
23808 \begin_layout Plain Layout
23817 \begin_layout Description
23818 \begin_inset Flex Code
23821 \begin_layout Plain Layout
23828 \begin_inset Flex Code
23831 \begin_layout Plain Layout
23837 ] Attributes for the item tag.
23839 \begin_inset Newline newline
23843 \begin_inset Quotes eld
23847 \begin_inset Flex Code
23850 \begin_layout Plain Layout
23851 class=`layoutname_item'
23857 \begin_inset Quotes erd
23865 contain any style information.
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23879 \begin_layout Description
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23899 ] The tag to be used for paragraph and item labels, replacing
23900 \begin_inset Flex Code
23903 \begin_layout Plain Layout
23909 in the examples above.
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23921 \begin_inset Flex Code
23924 \begin_layout Plain Layout
23931 \begin_inset Flex Code
23934 \begin_layout Plain Layout
23941 \begin_inset Flex Code
23944 \begin_layout Plain Layout
23945 Centered_Top_Environment
23950 , in which case it defaults to
23951 \begin_inset Flex Code
23954 \begin_layout Plain Layout
23963 \begin_layout Description
23964 \begin_inset Flex Code
23967 \begin_layout Plain Layout
23974 \begin_inset Flex Code
23977 \begin_layout Plain Layout
23983 ] Attributes for the label tag.
23985 \begin_inset Newline newline
23989 \begin_inset Quotes eld
23993 \begin_inset Flex Code
23996 \begin_layout Plain Layout
23997 class=`layoutname_label'
24003 \begin_inset Quotes erd
24011 contain any style information.
24013 \begin_inset Flex Code
24016 \begin_layout Plain Layout
24025 \begin_layout Description
24026 \begin_inset Flex Code
24029 \begin_layout Plain Layout
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24049 ] Meaningful only for list-like environments, this tag controls whether
24050 the label tag is output before or inside the item tag.
24051 This is used, for example, in the description environment, where we want
24053 \begin_inset Flex Code
24056 \begin_layout Plain Layout
24057 <dt>\SpecialChar ldots
24058 </dt><dd>\SpecialChar ldots
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24075 : The label tag is output inside the item tag.
24078 \begin_layout Description
24079 \begin_inset Flex Code
24082 \begin_layout Plain Layout
24088 Information to be output in the
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24098 section when this style is used.
24099 This might, for example, be used to include a
24100 \begin_inset Flex Code
24103 \begin_layout Plain Layout
24110 \begin_inset Flex Code
24113 \begin_layout Plain Layout
24122 \begin_layout Description
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24132 CSS style information to be included when this style is used.
24133 Note that this will automatically be wrapped in a layout-generated
24134 \begin_inset Flex Code
24137 \begin_layout Plain Layout
24143 block, so only the CSS itself need be included.
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24157 \begin_layout Description
24158 \begin_inset Flex Code
24161 \begin_layout Plain Layout
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24177 ] The tag to be used for the main label, replacing
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24187 in the examples above.
24189 \begin_inset Flex Code
24192 \begin_layout Plain Layout
24201 \begin_layout Description
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24212 \begin_inset Flex Code
24215 \begin_layout Plain Layout
24225 ] Marks this style as the one to be used to generate the
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24235 tag for the XHTML file.
24236 By default, it is false.
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24247 file sets it to true for the
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24261 \begin_layout Subsection
24265 \begin_layout Standard
24266 The XHTML output of insets can also be controlled by information in layout
24271 \begin_layout Plain Layout
24272 At present, this is true only for
24273 \begin_inset Quotes eld
24277 \begin_inset Quotes erd
24280 insets (insets you can type into) and is not true for
24281 \begin_inset Quotes eld
24285 \begin_inset Quotes erd
24288 insets (insets that are associated with dialog boxes).
24293 Here, too, \SpecialChar LyX
24294 tries to provide sensible defaults, and it constructs default
24296 But everything can be customized.
24299 \begin_layout Standard
24300 The XHTML \SpecialChar LyX
24301 outputs for an inset has the following form:
24304 \begin_layout LyX-Code
24306 \begin_inset Quotes erd
24310 \begin_inset Quotes erd
24316 \begin_layout LyX-Code
24317 <labeltag>Label</labeltag>
24320 \begin_layout LyX-Code
24322 \begin_inset Quotes erd
24326 \begin_inset Quotes erd
24329 >Contents of the inset.</innertag>
24332 \begin_layout LyX-Code
24336 \begin_layout Standard
24337 If the inset permits multiple paragraphs—that is, if
24338 \begin_inset Flex Code
24341 \begin_layout Plain Layout
24347 is true—then the contents of the inset will itself be output as paragraphs
24348 formatted according to the styles used for those paragraphs (standard,
24349 quote, and the like).
24350 The label tag is of course omitted if the paragraph does not have a label
24351 and, at present, is always
24352 \begin_inset Flex Code
24355 \begin_layout Plain Layout
24362 The inner tag is optional and, by default, does not appear.
24365 \begin_layout Standard
24366 The specific tags and attributes output for each inset can be controlled
24367 by means of the following layout tags.
24370 \begin_layout Description
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24381 \begin_inset Flex Code
24384 \begin_layout Plain Layout
24390 ] Specifies attribute information to be output with the main tag.
24392 \begin_inset Quotes eld
24396 \begin_inset Flex Code
24399 \begin_layout Plain Layout
24400 class=`myinset' onclick=`\SpecialChar ldots
24407 \begin_inset Quotes erd
24411 By default, \SpecialChar LyX
24413 \begin_inset Quotes eld
24417 \begin_inset Flex Code
24420 \begin_layout Plain Layout
24427 \begin_inset Quotes erd
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24440 is the \SpecialChar LyX
24441 name of the inset, made lowercase and with non-alphanumeric characters
24442 converted to underscores, for example: footnote.
24445 \begin_layout Description
24446 \begin_inset Flex Code
24449 \begin_layout Plain Layout
24456 \begin_inset Flex Code
24459 \begin_layout Plain Layout
24469 ] Whether to output the default CSS information \SpecialChar LyX
24470 generates for this layout,
24471 even if additional information is explicitly provided via
24472 \begin_inset Flex Code
24475 \begin_layout Plain Layout
24483 \begin_inset Flex Code
24486 \begin_layout Plain Layout
24492 allows you to alter or augment the generated CSS, rather than to override
24497 \begin_layout Description
24498 \begin_inset Flex Code
24501 \begin_layout Plain Layout
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24517 ] Attributes for the inner tag.
24519 \begin_inset Newline newline
24523 \begin_inset Quotes eld
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24531 class=`insetname_inner'
24537 \begin_inset Quotes erd
24543 \begin_layout Description
24544 \begin_inset Flex Code
24547 \begin_layout Plain Layout
24554 \begin_inset Flex Code
24557 \begin_layout Plain Layout
24563 ] The inner tag, replacing
24564 \begin_inset Flex Code
24567 \begin_layout Plain Layout
24573 in the examples above.
24574 By default, there is none.
24577 \begin_layout Description
24578 \begin_inset Flex Code
24581 \begin_layout Plain Layout
24588 \begin_inset Flex Code
24591 \begin_layout Plain Layout
24599 ] Whether this inset represents a standalone block of text (such as a footnote)
24600 or instead represents material that is included in the surrounding text
24601 (such as a branch).
24605 \begin_layout Description
24606 \begin_inset Flex Code
24609 \begin_layout Plain Layout
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24625 ] A label for this inset, possibly including a reference to a counter.
24626 For example, for footnote, it might be:
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24639 This is optional, and there is no default.
24642 \begin_layout Description
24643 \begin_inset Flex Code
24646 \begin_layout Plain Layout
24652 Information to be output in the
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24662 section when this style is used.
24663 This might, for example, be used to include a
24664 \begin_inset Flex Code
24667 \begin_layout Plain Layout
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24686 \begin_layout Description
24687 \begin_inset Flex Code
24690 \begin_layout Plain Layout
24696 CSS style information to be included when this style is used.
24697 Note that this will automatically be wrapped in a layout-generated
24698 \begin_inset Flex Code
24701 \begin_layout Plain Layout
24707 block, so only the CSS itself need be included.
24710 \begin_layout Description
24711 \begin_inset Flex Code
24714 \begin_layout Plain Layout
24721 \begin_inset Flex Code
24724 \begin_layout Plain Layout
24730 ] The tag to be used for the main label, replacing
24731 \begin_inset Flex Code
24734 \begin_layout Plain Layout
24740 in the examples above.
24741 The default depends upon the setting of
24742 \begin_inset Flex Code
24745 \begin_layout Plain Layout
24752 \begin_inset Flex Code
24755 \begin_layout Plain Layout
24761 is true, the default is
24762 \begin_inset Flex Code
24765 \begin_layout Plain Layout
24771 ; if it is false, the default is
24772 \begin_inset Flex Code
24775 \begin_layout Plain Layout
24784 \begin_layout Subsection
24788 \begin_layout Standard
24789 The XHTML output for floats too can be controlled by layout information.
24790 The output has the following form:
24793 \begin_layout LyX-Code
24795 \begin_inset Quotes erd
24799 \begin_inset Quotes erd
24805 \begin_layout LyX-Code
24806 Contents of the float.
24809 \begin_layout LyX-Code
24813 \begin_layout Standard
24814 The caption, if there is one, is a separate inset and will be output as
24816 Its appearance can be controlled via the InsetLayout for caption insets.
24820 \begin_layout Description
24821 \begin_inset Flex Code
24824 \begin_layout Plain Layout
24831 \begin_inset Flex Code
24834 \begin_layout Plain Layout
24840 ] Specifies attribute information to be output with the main tag.
24842 \begin_inset Quotes eld
24846 \begin_inset Flex Code
24849 \begin_layout Plain Layout
24850 class=`myfloat' onclick=`\SpecialChar ldots
24857 \begin_inset Quotes erd
24861 By default, \SpecialChar LyX
24863 \begin_inset Quotes eld
24867 \begin_inset Flex Code
24870 \begin_layout Plain Layout
24871 class=`float float-floattype'
24877 \begin_inset Quotes erd
24881 \begin_inset Flex Code
24884 \begin_layout Plain Layout
24890 is \SpecialChar LyX
24891 's name for this type of float, as determined by the float declaration
24893 \begin_inset CommandInset ref
24895 reference "subsec:Floats"
24899 ), though made lowercase and with non-alphanumeric characters converted
24900 to underscores, for example: float-table.
24903 \begin_layout Description
24904 \begin_inset Flex Code
24907 \begin_layout Plain Layout
24913 CSS style information to be included when this float is used.
24914 Note that this will automatically be wrapped in a layout-generated
24915 \begin_inset Flex Code
24918 \begin_layout Plain Layout
24924 block, so only the CSS itself need be included.
24927 \begin_layout Description
24928 \begin_inset Flex Code
24931 \begin_layout Plain Layout
24938 \begin_inset Flex Code
24941 \begin_layout Plain Layout
24947 ] The tag to be used for this float, replacing
24948 \begin_inset Quotes eld
24952 \begin_inset Flex Code
24955 \begin_layout Plain Layout
24962 \begin_inset Quotes erd
24965 in the example above.
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24976 and will rarely need changing.
24979 \begin_layout Subsection
24980 Bibliography formatting
24983 \begin_layout Standard
24984 The bibliography can be formatted using
24985 \begin_inset Flex Code
24988 \begin_layout Plain Layout
24996 \begin_inset CommandInset ref
24998 reference "subsec:Citation-format-description"
25005 \begin_layout Subsection
25010 \begin_layout Standard
25011 We have several times mentioned that \SpecialChar LyX
25012 will generate default CSS style rules
25013 for both insets and paragraph styles, based upon the other layout information
25015 In this section, we shall say a word about which layout information \SpecialChar LyX
25020 \begin_layout Standard
25021 At present, \SpecialChar LyX
25022 auto-generates CSS only for font information, making use of
25024 \begin_inset Flex Code
25027 \begin_layout Plain Layout
25034 \begin_inset Flex Code
25037 \begin_layout Plain Layout
25044 \begin_inset Flex Code
25047 \begin_layout Plain Layout
25054 \begin_inset Flex Code
25057 \begin_layout Plain Layout
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25074 \begin_inset CommandInset ref
25076 reference "subsec:Font-description"
25081 The translation is mostly straightforward and obvious.
25083 \begin_inset Quotes eld
25087 \begin_inset Flex Code
25090 \begin_layout Plain Layout
25097 \begin_inset Quotes erd
25101 \begin_inset Quotes eld
25105 \begin_inset Flex Code
25108 \begin_layout Plain Layout
25109 font-family: sans-serif;
25115 \begin_inset Quotes erd
25119 The correspondence of \SpecialChar LyX
25120 sizes and CSS sizes is a little less obvious but
25121 nonetheless intuitive.
25123 \begin_inset Flex Code
25126 \begin_layout Plain Layout
25133 \begin_inset Flex URL
25136 \begin_layout Plain Layout
25146 \begin_layout Chapter
25147 Including External Material
25148 \begin_inset CommandInset label
25150 name "chap:Including-External-Material"
25157 \begin_layout Standard
25158 \begin_inset Box Shadowbox
25168 height_special "totalheight"
25173 backgroundcolor "none"
25176 \begin_layout Plain Layout
25177 WARNING: This portion of the documentation has not been updated for some
25179 We certainly hope that it is still accurate, but there are no guarantees.
25187 \begin_layout Standard
25188 The use of material from sources external to \SpecialChar LyX
25189 is covered in detail in the
25195 This part of the manual covers what needs to happen behind the scenes for
25196 new sorts of material to be included.
25199 \begin_layout Section
25203 \begin_layout Standard
25204 The external material feature is based on the concept of a
25209 A template is a specification of how \SpecialChar LyX
25210 should interface with a certain kind
25212 As bundled, \SpecialChar LyX
25213 comes with predefined templates for Xfig figures, various
25214 raster format images, chess diagrams, and LilyPond music notation.
25215 You can check the actual list by using the menu
25216 \begin_inset Flex Noun
25219 \begin_layout Plain Layout
25220 Insert\SpecialChar menuseparator
25221 File\SpecialChar menuseparator
25228 Furthermore, it is possible to roll your own template to support a specific
25230 Later we'll describe in more detail what is involved, and hopefully you
25231 will submit all the templates you create so we can include them in a later
25236 \begin_layout Standard
25237 Another basic idea of the external material feature is to distinguish between
25238 the original file that serves as a base for final material and the produced
25239 file that is included in your exported or printed document.
25240 For example, consider the case of a figure produced with
25241 \begin_inset Flex Code
25244 \begin_layout Plain Layout
25251 The Xfig application itself works on an original file with the
25252 \begin_inset Flex Code
25255 \begin_layout Plain Layout
25262 Within Xfig, you create and change your figure, and when you are done,
25264 \begin_inset Flex Code
25267 \begin_layout Plain Layout
25274 When you want to include the figure in your document, you invoke
25275 \begin_inset Flex Code
25278 \begin_layout Plain Layout
25284 in order to create a PostScript file that can readily be included in your
25288 \begin_inset Flex Code
25291 \begin_layout Plain Layout
25297 file is the original file, and the PostScript file is the produced file.
25300 \begin_layout Standard
25301 This distinction is important in order to allow updating of the material
25302 while you are in the process of writing the document.
25303 Furthermore, it provides us with the flexibility that is needed to support
25304 multiple export formats.
25305 For instance, in the case of a plain text file, it is not exactly an award-winn
25306 ing idea to include the figure as raw PostScript.
25307 Instead, you would either prefer to just include a reference to the figure
25308 or try to invoke some graphics to ASCII converter to make the final result
25309 look similar to the real graphics.
25310 The external material management allows you to do this, because it is parametri
25311 zed on the different export formats that \SpecialChar LyX
25315 \begin_layout Standard
25316 Besides supporting the production of different products according to the
25317 exported format, it supports tight integration with editing and viewing
25319 In the case of an Xfig figure, you are able to invoke Xfig on the original
25320 file with a single click from within the external material dialog in \SpecialChar LyX
25322 and also preview the produced PostScript file with Ghostview with another
25324 No more fiddling around with the command line and/or file browsers to locate
25325 and manipulate the original or produced files.
25326 In this way, you are finally able to take full advantage of the many different
25327 applications that are relevant to use when you write your documents, and
25328 ultimately be more productive.
25331 \begin_layout Section
25332 The external template configuration files
25335 \begin_layout Standard
25336 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25338 However, be aware that doing this in an careless manner most probably
25342 introduce an easily exploitable security hole.
25343 So before you do this, please read the discussion about security in
25344 \begin_inset CommandInset ref
25346 reference "sec:Security-discussion"
25353 \begin_layout Standard
25354 Having said that, we encourage you to submit any interesting templates that
25359 \begin_layout Standard
25360 The external templates are defined in the
25361 \begin_inset Flex Code
25364 \begin_layout Plain Layout
25370 files that are stored in the
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25375 LyXDir/lib/xtemplates/
25381 Each template is defined in a file of its own.
25382 You can place your own templates in
25383 \begin_inset Flex Code
25386 \begin_layout Plain Layout
25387 UserDir/xtemplates/
25392 or copy existing templates to that directory in order to modify them.
25395 \begin_layout Standard
25396 A typical template looks like this:
25399 \begin_layout LyX-Code
25403 \begin_layout LyX-Code
25404 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25407 \begin_layout LyX-Code
25411 \begin_layout LyX-Code
25415 \begin_layout LyX-Code
25419 \begin_layout LyX-Code
25423 \begin_layout LyX-Code
25427 \begin_layout LyX-Code
25428 AutomaticProduction true
25431 \begin_layout LyX-Code
25435 \begin_layout LyX-Code
25439 \begin_layout LyX-Code
25443 \begin_layout LyX-Code
25444 TransformCommand Rotate RotationLatexCommand
25447 \begin_layout LyX-Code
25448 TransformCommand Resize ResizeLatexCommand
25451 \begin_layout LyX-Code
25452 Product "$$RotateFront$$ResizeFront
25455 \begin_layout LyX-Code
25460 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25463 \begin_layout LyX-Code
25464 $$ResizeBack$$RotateBack"
25467 \begin_layout LyX-Code
25471 \begin_layout LyX-Code
25472 UpdateResult "$$AbsPath$$Basename.pstex_t"
25475 \begin_layout LyX-Code
25476 Requirement "graphicx"
25479 \begin_layout LyX-Code
25480 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25483 \begin_layout LyX-Code
25484 ReferencedFile latex "$$AbsPath$$Basename.eps"
25487 \begin_layout LyX-Code
25488 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25491 \begin_layout LyX-Code
25495 \begin_layout LyX-Code
25499 \begin_layout LyX-Code
25500 TransformCommand Rotate RotationLatexCommand
25503 \begin_layout LyX-Code
25504 TransformCommand Resize ResizeLatexCommand
25507 \begin_layout LyX-Code
25508 Product "$$RotateFront$$ResizeFront
25511 \begin_layout LyX-Code
25516 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25519 \begin_layout LyX-Code
25520 $$ResizeBack$$RotateBack"
25523 \begin_layout LyX-Code
25524 UpdateFormat pdftex
25527 \begin_layout LyX-Code
25528 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25531 \begin_layout LyX-Code
25532 Requirement "graphicx"
25535 \begin_layout LyX-Code
25536 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25539 \begin_layout LyX-Code
25540 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25543 \begin_layout LyX-Code
25547 \begin_layout LyX-Code
25551 \begin_layout LyX-Code
25552 Product "[XFig: $$FName]"
25555 \begin_layout LyX-Code
25559 \begin_layout LyX-Code
25563 \begin_layout LyX-Code
25564 Product "<graphic fileref=
25566 "$$AbsOrRelPathMaster$$Basename.eps
25571 \begin_layout LyX-Code
25575 \begin_layout LyX-Code
25579 \begin_layout LyX-Code
25580 UpdateResult "$$AbsPath$$Basename.eps"
25583 \begin_layout LyX-Code
25584 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25587 \begin_layout LyX-Code
25588 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25591 \begin_layout LyX-Code
25595 \begin_layout LyX-Code
25599 \begin_layout Standard
25600 As you can see, the template is enclosed in
25601 \begin_inset Flex Code
25604 \begin_layout Plain Layout
25612 \begin_inset Flex Code
25615 \begin_layout Plain Layout
25622 It contains a header specifying some general settings and, for each supported
25623 primary document file format, a section
25624 \begin_inset Flex Code
25627 \begin_layout Plain Layout
25635 \begin_inset Flex Code
25638 \begin_layout Plain Layout
25647 \begin_layout Subsection
25648 The template header
25651 \begin_layout Description
25652 \begin_inset Flex Code
25655 \begin_layout Plain Layout
25656 AutomaticProduction
25657 \begin_inset space ~
25665 Whether the file represented by the template must be generated by \SpecialChar LyX
25667 This command must occur exactly once.
25670 \begin_layout Description
25671 \begin_inset Flex Code
25674 \begin_layout Plain Layout
25676 \begin_inset space ~
25684 A glob pattern that is used in the file dialog to filter out the desired
25686 If there is more than one possible file extension (e.
25687 \begin_inset space \thinspace{}
25691 \begin_inset space \space{}
25695 \begin_inset Flex Code
25698 \begin_layout Plain Layout
25705 \begin_inset Flex Code
25708 \begin_layout Plain Layout
25714 ), use something like
25715 \begin_inset Flex Code
25718 \begin_layout Plain Layout
25725 This command must occur exactly once.
25728 \begin_layout Description
25729 \begin_inset Flex Code
25732 \begin_layout Plain Layout
25734 \begin_inset space ~
25742 The text that is displayed on the button.
25743 This command must occur exactly once.
25746 \begin_layout Description
25747 \begin_inset Flex Code
25750 \begin_layout Plain Layout
25752 \begin_inset space ~
25756 \begin_inset space ~
25764 The help text that is used in the External dialog.
25765 Provide enough information to explain to the user just what the template
25766 can provide him with.
25767 This command must occur exactly once.
25770 \begin_layout Description
25771 \begin_inset Flex Code
25774 \begin_layout Plain Layout
25776 \begin_inset space ~
25784 The file format of the original file.
25785 This must be the name of a format that is known to \SpecialChar LyX
25787 \begin_inset CommandInset ref
25789 reference "sec:Formats"
25795 \begin_inset Quotes eld
25799 \begin_inset Flex Code
25802 \begin_layout Plain Layout
25809 \begin_inset Quotes erd
25812 if the template can handle original files of more than one format.
25814 will attempt to interrogate the file itself in order to deduce its format
25816 This command must occur exactly once.
25819 \begin_layout Description
25820 \begin_inset Flex Code
25823 \begin_layout Plain Layout
25825 \begin_inset space ~
25833 A unique name for the template.
25834 It must not contain substitution macros (see below).
25837 \begin_layout Description
25838 \begin_inset Flex Code
25841 \begin_layout Plain Layout
25843 \begin_inset space ~
25846 Rotate|Resize|Clip|Extra
25851 This command specifies which transformations are supported by this template.
25852 It may occur zero or more times.
25853 This command enables the corresponding tabs in the external dialog.
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25864 command must have either a corresponding
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25885 \begin_inset Flex Code
25888 \begin_layout Plain Layout
25895 Otherwise the transformation will not be supported by that format.
25898 \begin_layout Subsection
25902 \begin_layout Description
25903 \begin_inset Flex Code
25906 \begin_layout Plain Layout
25908 \begin_inset space ~
25911 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25916 The primary document file format that this format definition is for.
25917 Not every template has a sensible representation in all document file formats.
25918 Please define nevertheless a
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25928 section for all templates.
25929 Use a dummy text when no representation is available.
25930 Then you can at least see a reference to the external material in the exported
25934 \begin_layout Description
25935 \begin_inset Flex Code
25938 \begin_layout Plain Layout
25940 \begin_inset space ~
25944 \begin_inset space ~
25952 This command defines an additional macro
25953 \begin_inset Flex Code
25956 \begin_layout Plain Layout
25962 for substitution in
25963 \begin_inset Flex Code
25966 \begin_layout Plain Layout
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25983 itself may contain substitution macros.
25984 The advantage over using
25985 \begin_inset Flex Code
25988 \begin_layout Plain Layout
25995 \begin_inset Flex Code
25998 \begin_layout Plain Layout
26004 is that the substituted value of
26005 \begin_inset Flex Code
26008 \begin_layout Plain Layout
26014 is sanitized so that it is a valid optional argument in the document format.
26015 This command may occur zero or more times.
26018 \begin_layout Description
26019 \begin_inset Flex Code
26022 \begin_layout Plain Layout
26024 \begin_inset space ~
26032 The text that is inserted in the exported document.
26033 This is actually the most important command and can be quite complex.
26034 This command must occur exactly once.
26037 \begin_layout Description
26038 \begin_inset Flex Code
26041 \begin_layout Plain Layout
26043 \begin_inset space ~
26051 This command specifies a preamble snippet that will be included in the
26054 It has to be defined using
26055 \begin_inset Flex Code
26058 \begin_layout Plain Layout
26066 \begin_inset Flex Code
26069 \begin_layout Plain Layout
26076 This command may occur zero or more times.
26079 \begin_layout Description
26080 \begin_inset Flex Code
26083 \begin_layout Plain Layout
26085 \begin_inset space ~
26089 \begin_inset space ~
26097 This command denotes files that are created by the conversion process and
26098 are needed for a particular export format.
26099 If the filename is relative, it is interpreted relative to the master document.
26100 This command may be given zero or more times.
26103 \begin_layout Description
26104 \begin_inset Flex Code
26107 \begin_layout Plain Layout
26109 \begin_inset space ~
26117 The name of a required \SpecialChar LaTeX
26119 The package is included via
26120 \begin_inset Flex Code
26123 \begin_layout Plain Layout
26131 in the \SpecialChar LaTeX
26133 This command may occur zero or more times.
26136 \begin_layout Description
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26142 \begin_inset space ~
26146 \begin_inset space ~
26149 RotationLatexCommand
26154 This command specifies that the built in \SpecialChar LaTeX
26155 command should be used for rotation.
26156 This command may occur once or not at all.
26159 \begin_layout Description
26160 \begin_inset Flex Code
26163 \begin_layout Plain Layout
26165 \begin_inset space ~
26169 \begin_inset space ~
26177 This command specifies that the built in \SpecialChar LaTeX
26178 command should be used for resizing.
26179 This command may occur once or not at all.
26182 \begin_layout Description
26183 \begin_inset Flex Code
26186 \begin_layout Plain Layout
26188 \begin_inset space ~
26192 \begin_inset space ~
26195 RotationLatexOption
26200 This command specifies that rotation is done via an optional argument.
26201 This command may occur once or not at all.
26204 \begin_layout Description
26205 \begin_inset Flex Code
26208 \begin_layout Plain Layout
26210 \begin_inset space ~
26214 \begin_inset space ~
26222 This command specifies that resizing is done via an optional argument.
26223 This command may occur once or not at all.
26226 \begin_layout Description
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26232 \begin_inset space ~
26236 \begin_inset space ~
26244 This command specifies that clipping is done via an optional argument.
26245 This command may occur once or not at all.
26248 \begin_layout Description
26249 \begin_inset Flex Code
26252 \begin_layout Plain Layout
26254 \begin_inset space ~
26258 \begin_inset space ~
26266 This command specifies that an extra optional argument is used.
26267 This command may occur once or not at all.
26270 \begin_layout Description
26271 \begin_inset Flex Code
26274 \begin_layout Plain Layout
26276 \begin_inset space ~
26284 The file format of the converted file.
26285 This must be the name of a format that is known to \SpecialChar LyX
26287 \begin_inset Flex Noun
26290 \begin_layout Plain Layout
26291 Tools\SpecialChar menuseparator
26292 Preferences\SpecialChar menuseparator
26293 File Handling\SpecialChar menuseparator
26300 This command must occur exactly once.
26301 If the resulting file format is PDF, you need to specify the format
26302 \begin_inset Flex Code
26305 \begin_layout Plain Layout
26312 This is the PDF format used for including graphics.
26313 The other defined PDF formats are for document export.
26316 \begin_layout Description
26317 \begin_inset Flex Code
26320 \begin_layout Plain Layout
26322 \begin_inset space ~
26330 The file name of the converted file.
26331 The file name must be absolute.
26332 This command must occur exactly once.
26335 \begin_layout Subsection
26336 Preamble definitions
26339 \begin_layout Standard
26340 The external template configuration file may contain additional preamble
26341 definitions enclosed by
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26353 \begin_inset Flex Code
26356 \begin_layout Plain Layout
26363 They can be used by the templates in the
26364 \begin_inset Flex Code
26367 \begin_layout Plain Layout
26376 \begin_layout Section
26377 The substitution mechanism
26380 \begin_layout Standard
26381 When the external material facility invokes an external program, it is done
26382 on the basis of a command defined in the template configuration file.
26383 These commands can contain various macros that are expanded before execution.
26384 Execution always take place in the directory of the containing document.
26387 \begin_layout Standard
26388 Also, whenever external material is to be displayed, the name will be produced
26389 by the substitution mechanism, and most other commands in the template
26390 definition support substitution as well.
26393 \begin_layout Standard
26394 The available macros are the following:
26397 \begin_layout Description
26398 \begin_inset Flex Code
26401 \begin_layout Plain Layout
26402 $$AbsOrRelPathMaster
26407 The file path, absolute or relative to the master \SpecialChar LyX
26411 \begin_layout Description
26412 \begin_inset Flex Code
26415 \begin_layout Plain Layout
26416 $$AbsOrRelPathParent
26421 The file path, absolute or relative to the \SpecialChar LyX
26425 \begin_layout Description
26426 \begin_inset Flex Code
26429 \begin_layout Plain Layout
26435 The absolute file path.
26438 \begin_layout Description
26439 \begin_inset Flex Code
26442 \begin_layout Plain Layout
26448 The filename without path and without the extension.
26451 \begin_layout Description
26452 \begin_inset Flex Code
26455 \begin_layout Plain Layout
26457 \begin_inset Quotes eld
26461 \begin_inset Quotes erd
26469 This macro will expand to the contents of the file with the name
26470 \begin_inset Flex Code
26473 \begin_layout Plain Layout
26482 \begin_layout Description
26483 \begin_inset Flex Code
26486 \begin_layout Plain Layout
26492 The file extension (including the dot).
26495 \begin_layout Description
26496 \begin_inset Flex Code
26499 \begin_layout Plain Layout
26505 This will be the string
26506 \begin_inset Quotes eld
26510 \begin_inset Quotes erd
26513 if the file is in JPEG format, otherwise it will be the string
26514 \begin_inset Quotes eld
26518 \begin_inset Quotes erd
26522 This is useful to avoid uneeded conversions for output formats that support
26523 both PNG and JPEG fomats.
26524 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26529 \begin_layout Description
26530 \begin_inset Flex Code
26533 \begin_layout Plain Layout
26539 The filename of the file specified in the external material dialog.
26540 This is either an absolute name, or it is relative to the \SpecialChar LyX
26544 \begin_layout Description
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26555 \begin_inset Flex Code
26558 \begin_layout Plain Layout
26564 (absolute name or relative to the \SpecialChar LyX
26568 \begin_layout Description
26569 \begin_inset Flex Code
26572 \begin_layout Plain Layout
26578 The file path, relative to the master \SpecialChar LyX
26582 \begin_layout Description
26583 \begin_inset Flex Code
26586 \begin_layout Plain Layout
26592 The file path, relative to the \SpecialChar LyX
26596 \begin_layout Description
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26606 This macro will expand to the absolute path of the system directory.
26607 This is typically used to point to the various helper scripts that are
26608 bundled with \SpecialChar LyX
26612 \begin_layout Description
26613 \begin_inset Flex Code
26616 \begin_layout Plain Layout
26622 A name and full path to a temporary file which will be automatically deleted
26623 whenever the containing document is closed, or the external material insertion
26627 \begin_layout Standard
26628 All path macros contain a trailing directory separator, so you can construct
26630 \begin_inset space \thinspace{}
26634 \begin_inset space \space{}
26637 the absolute filename with
26638 \begin_inset Flex Code
26641 \begin_layout Plain Layout
26642 $$AbsPath$$Basename$$Extension
26650 \begin_layout Standard
26651 The macros above are substituted in all commands unless otherwise noted.
26653 \begin_inset Flex Code
26656 \begin_layout Plain Layout
26662 supports additionally the following substitutions if they are enabled by
26664 \begin_inset Flex Code
26667 \begin_layout Plain Layout
26674 \begin_inset Flex Code
26677 \begin_layout Plain Layout
26686 \begin_layout Description
26687 \begin_inset Flex Code
26690 \begin_layout Plain Layout
26696 The front part of the resize command.
26699 \begin_layout Description
26700 \begin_inset Flex Code
26703 \begin_layout Plain Layout
26709 The back part of the resize command.
26712 \begin_layout Description
26713 \begin_inset Flex Code
26716 \begin_layout Plain Layout
26722 The front part of the rotation command.
26725 \begin_layout Description
26726 \begin_inset Flex Code
26729 \begin_layout Plain Layout
26735 The back part of the rotation command.
26738 \begin_layout Standard
26739 The value string of the
26740 \begin_inset Flex Code
26743 \begin_layout Plain Layout
26749 command supports additionally the following substitutions if they are enabled
26751 \begin_inset Flex Code
26754 \begin_layout Plain Layout
26761 \begin_inset Flex Code
26764 \begin_layout Plain Layout
26773 \begin_layout Description
26774 \begin_inset Flex Code
26777 \begin_layout Plain Layout
26786 \begin_layout Description
26787 \begin_inset Flex Code
26790 \begin_layout Plain Layout
26799 \begin_layout Description
26800 \begin_inset Flex Code
26803 \begin_layout Plain Layout
26812 \begin_layout Description
26813 \begin_inset Flex Code
26816 \begin_layout Plain Layout
26822 The rotation option.
26825 \begin_layout Standard
26826 You may ask why there are so many path macros.
26827 There are mainly two reasons:
26830 \begin_layout Enumerate
26831 Relative and absolute file names should remain relative or absolute, respectivel
26833 Users may have reasons to prefer either form.
26834 Relative names are useful for portable documents that should work on different
26835 machines, for example.
26836 Absolute names may be required by some programs.
26839 \begin_layout Enumerate
26841 treats relative file names differently than \SpecialChar LyX
26842 and other programs in nested
26844 For \SpecialChar LyX
26845 , a relative file name is always relative to the document that contains
26847 For \SpecialChar LaTeX
26848 , it is always relative to the master document.
26849 These two definitions are identical if you have only one document, but
26850 differ if you have a master document that includes part documents.
26851 That means that relative filenames must be transformed when presented to
26854 Fortunately \SpecialChar LyX
26855 does this automatically for you if you choose the right macros.
26858 \begin_layout Standard
26859 So which path macro should be used in new template definitions? The rule
26863 \begin_layout Itemize
26865 \begin_inset Flex Code
26868 \begin_layout Plain Layout
26874 if an absolute path is required.
26877 \begin_layout Itemize
26879 \begin_inset Flex Code
26882 \begin_layout Plain Layout
26883 $$AbsOrRelPathMaster
26888 if the substituted string is some kind of \SpecialChar LaTeX
26892 \begin_layout Itemize
26894 \begin_inset Flex Code
26897 \begin_layout Plain Layout
26898 $$AbsOrRelPathParent
26903 in order to preserve the user's choice.
26906 \begin_layout Standard
26907 There are special cases where this rule does not work and e.
26908 \begin_inset space \thinspace{}
26912 \begin_inset space \space{}
26915 relative names are needed, but normally it will work just fine.
26916 One example for such a case is the command
26917 \begin_inset Flex Code
26920 \begin_layout Plain Layout
26921 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26926 in the XFig template above: We can't use the absolute name because the
26928 \begin_inset Flex Code
26931 \begin_layout Plain Layout
26937 files needs the relative name in order to rewrite the file content.
26940 \begin_layout Section
26941 Security discussion
26942 \begin_inset CommandInset label
26944 name "sec:Security-discussion"
26951 \begin_layout Standard
26952 The external material feature interfaces with a lot of external programs
26953 and does so automatically, so we have to consider the security implications
26955 In particular, since you have the option of including your own filenames
26956 and/or parameter strings and those are expanded into a command, it seems
26957 that it would be possible to create a malicious document which executes
26958 arbitrary commands when a user views or prints the document.
26959 This is something we definitely want to avoid.
26962 \begin_layout Standard
26963 However, since the external program commands are specified in the template
26964 configuration file only, there are no security issues if \SpecialChar LyX
26965 is properly configure
26966 d with safe templates only.
26967 This is so because the external programs are invoked with the
26968 \begin_inset Flex Code
26971 \begin_layout Plain Layout
26977 -system call rather than the
26978 \begin_inset Flex Code
26981 \begin_layout Plain Layout
26987 system-call, so it's not possible to execute arbitrary commands from the
26988 filename or parameter section via the shell.
26991 \begin_layout Standard
26992 This also implies that you are restricted in what command strings you can
26993 use in the external material templates.
26994 In particular, pipes and redirection are not readily available.
26995 This has to be so if \SpecialChar LyX
26996 should remain safe.
26997 If you want to use some of the shell features, you should write a safe
26998 script to do this in a controlled manner, and then invoke the script from
26999 the command string.
27003 \begin_layout Standard
27004 It is possible to design a template that interacts directly with the shell,
27005 but since this would allow a malicious user to execute arbitrary commands
27006 by writing clever filenames and/or parameters, we generally recommend that
27007 you only use safe scripts that work with the
27008 \begin_inset Flex Code
27011 \begin_layout Plain Layout
27017 system call in a controlled manner.
27018 Of course, for use in a controlled environment, it can be tempting to just
27019 fall back to use ordinary shell scripts.
27020 If you do so, be aware that you
27024 provide an easily exploitable security hole in your system.
27025 Of course it stands to reason that such unsafe templates will never be
27026 included in the standard \SpecialChar LyX
27027 distribution, although we do encourage people
27028 to submit new templates in the open source tradition.
27029 But \SpecialChar LyX
27030 as shipped from the official distribution channels will never have
27034 \begin_layout Standard
27035 Including external material provides a lot of power, and you have to be
27036 careful not to introduce security hazards with this power.
27037 A subtle error in a single line in an innocent looking script can open
27038 the door to huge security problems.
27039 So if you do not fully understand the issues, we recommend that you consult
27040 a knowledgeable security professional or the \SpecialChar LyX
27041 development team if you have
27042 any questions about whether a given template is safe or not.
27043 And do this before you use it in an uncontrolled environment.
27046 \begin_layout Chapter
27048 List of supported \SpecialChar LyX
27049 functions to be used in layouts
27050 \begin_inset CommandInset label
27052 name "chap:List-of-functions"
27059 \begin_layout Standard
27061 \begin_inset Tabular
27062 <lyxtabular version="3" rows="11" columns="8">
27063 <features tabularvalignment="middle">
27064 <column alignment="left" valignment="top">
27065 <column alignment="left" valignment="top">
27066 <column alignment="left" valignment="top">
27067 <column alignment="left" valignment="top">
27068 <column alignment="left" valignment="top">
27069 <column alignment="left" valignment="top">
27070 <column alignment="left" valignment="top">
27071 <column alignment="left" valignment="top">
27073 <cell alignment="left" valignment="top" usebox="none">
27076 \begin_layout Plain Layout
27082 <cell alignment="left" valignment="top" usebox="none">
27085 \begin_layout Plain Layout
27091 <cell alignment="left" valignment="top" usebox="none">
27094 \begin_layout Plain Layout
27100 <cell alignment="left" valignment="top" usebox="none">
27103 \begin_layout Plain Layout
27109 <cell alignment="center" valignment="top" usebox="none">
27112 \begin_layout Plain Layout
27118 <cell alignment="center" valignment="top" usebox="none">
27121 \begin_layout Plain Layout
27127 <cell alignment="center" valignment="top" usebox="none">
27130 \begin_layout Plain Layout
27136 <cell alignment="center" valignment="top" usebox="none">
27139 \begin_layout Plain Layout
27147 <cell alignment="left" valignment="top" usebox="none">
27150 \begin_layout Plain Layout
27156 <cell alignment="left" valignment="top" usebox="none">
27159 \begin_layout Plain Layout
27165 <cell alignment="left" valignment="top" usebox="none">
27168 \begin_layout Plain Layout
27174 <cell alignment="left" valignment="top" usebox="none">
27177 \begin_layout Plain Layout
27183 <cell alignment="center" valignment="top" usebox="none">
27186 \begin_layout Plain Layout
27192 <cell alignment="center" valignment="top" usebox="none">
27195 \begin_layout Plain Layout
27201 <cell alignment="center" valignment="top" usebox="none">
27204 \begin_layout Plain Layout
27210 <cell alignment="center" valignment="top" usebox="none">
27213 \begin_layout Plain Layout
27221 <cell alignment="left" valignment="top" usebox="none">
27224 \begin_layout Plain Layout
27230 <cell alignment="left" valignment="top" usebox="none">
27233 \begin_layout Plain Layout
27239 <cell alignment="left" valignment="top" usebox="none">
27242 \begin_layout Plain Layout
27248 <cell alignment="left" valignment="top" usebox="none">
27251 \begin_layout Plain Layout
27257 <cell alignment="center" valignment="top" usebox="none">
27260 \begin_layout Plain Layout
27266 <cell alignment="center" valignment="top" usebox="none">
27269 \begin_layout Plain Layout
27275 <cell alignment="center" valignment="top" usebox="none">
27278 \begin_layout Plain Layout
27284 <cell alignment="center" valignment="top" usebox="none">
27287 \begin_layout Plain Layout
27295 <cell alignment="left" valignment="top" usebox="none">
27298 \begin_layout Plain Layout
27304 <cell alignment="left" valignment="top" usebox="none">
27307 \begin_layout Plain Layout
27313 <cell alignment="left" valignment="top" usebox="none">
27316 \begin_layout Plain Layout
27322 <cell alignment="left" valignment="top" usebox="none">
27325 \begin_layout Plain Layout
27331 <cell alignment="center" valignment="top" usebox="none">
27334 \begin_layout Plain Layout
27340 <cell alignment="center" valignment="top" usebox="none">
27343 \begin_layout Plain Layout
27349 <cell alignment="center" valignment="top" usebox="none">
27352 \begin_layout Plain Layout
27358 <cell alignment="center" valignment="top" usebox="none">
27361 \begin_layout Plain Layout
27369 <cell alignment="left" valignment="top" usebox="none">
27372 \begin_layout Plain Layout
27378 <cell alignment="left" valignment="top" usebox="none">
27381 \begin_layout Plain Layout
27387 <cell alignment="left" valignment="top" usebox="none">
27390 \begin_layout Plain Layout
27396 <cell alignment="left" valignment="top" usebox="none">
27399 \begin_layout Plain Layout
27405 <cell alignment="center" valignment="top" usebox="none">
27408 \begin_layout Plain Layout
27414 <cell alignment="center" valignment="top" usebox="none">
27417 \begin_layout Plain Layout
27423 <cell alignment="center" valignment="top" usebox="none">
27426 \begin_layout Plain Layout
27432 <cell alignment="center" valignment="top" usebox="none">
27435 \begin_layout Plain Layout
27443 <cell alignment="left" valignment="top" usebox="none">
27446 \begin_layout Plain Layout
27452 <cell alignment="left" valignment="top" usebox="none">
27455 \begin_layout Plain Layout
27461 <cell alignment="left" valignment="top" usebox="none">
27464 \begin_layout Plain Layout
27470 <cell alignment="left" valignment="top" usebox="none">
27473 \begin_layout Plain Layout
27479 <cell alignment="center" valignment="top" usebox="none">
27482 \begin_layout Plain Layout
27488 <cell alignment="center" valignment="top" usebox="none">
27491 \begin_layout Plain Layout
27497 <cell alignment="center" valignment="top" usebox="none">
27500 \begin_layout Plain Layout
27506 <cell alignment="center" valignment="top" usebox="none">
27509 \begin_layout Plain Layout
27517 <cell alignment="left" valignment="top" usebox="none">
27520 \begin_layout Plain Layout
27526 <cell alignment="left" valignment="top" usebox="none">
27529 \begin_layout Plain Layout
27535 <cell alignment="left" valignment="top" usebox="none">
27538 \begin_layout Plain Layout
27544 <cell alignment="left" valignment="top" usebox="none">
27547 \begin_layout Plain Layout
27553 <cell alignment="center" valignment="top" usebox="none">
27556 \begin_layout Plain Layout
27562 <cell alignment="center" valignment="top" usebox="none">
27565 \begin_layout Plain Layout
27571 <cell alignment="center" valignment="top" usebox="none">
27574 \begin_layout Plain Layout
27580 <cell alignment="center" valignment="top" usebox="none">
27583 \begin_layout Plain Layout
27591 <cell alignment="left" valignment="top" usebox="none">
27594 \begin_layout Plain Layout
27600 <cell alignment="left" valignment="top" usebox="none">
27603 \begin_layout Plain Layout
27609 <cell alignment="left" valignment="top" usebox="none">
27612 \begin_layout Plain Layout
27618 <cell alignment="left" valignment="top" usebox="none">
27621 \begin_layout Plain Layout
27627 <cell alignment="center" valignment="top" usebox="none">
27630 \begin_layout Plain Layout
27636 <cell alignment="center" valignment="top" usebox="none">
27639 \begin_layout Plain Layout
27645 <cell alignment="center" valignment="top" usebox="none">
27648 \begin_layout Plain Layout
27654 <cell alignment="center" valignment="top" usebox="none">
27657 \begin_layout Plain Layout
27665 <cell alignment="left" valignment="top" usebox="none">
27668 \begin_layout Plain Layout
27674 <cell alignment="left" valignment="top" usebox="none">
27677 \begin_layout Plain Layout
27683 <cell alignment="left" valignment="top" usebox="none">
27686 \begin_layout Plain Layout
27692 <cell alignment="left" valignment="top" usebox="none">
27695 \begin_layout Plain Layout
27701 <cell alignment="center" valignment="top" usebox="none">
27704 \begin_layout Plain Layout
27710 <cell alignment="center" valignment="top" usebox="none">
27713 \begin_layout Plain Layout
27719 <cell alignment="center" valignment="top" usebox="none">
27722 \begin_layout Plain Layout
27728 <cell alignment="center" valignment="top" usebox="none">
27731 \begin_layout Plain Layout
27739 <cell alignment="left" valignment="top" usebox="none">
27742 \begin_layout Plain Layout
27748 <cell alignment="left" valignment="top" usebox="none">
27751 \begin_layout Plain Layout
27757 <cell alignment="left" valignment="top" usebox="none">
27760 \begin_layout Plain Layout
27766 <cell alignment="left" valignment="top" usebox="none">
27769 \begin_layout Plain Layout
27775 <cell alignment="center" valignment="top" usebox="none">
27778 \begin_layout Plain Layout
27784 <cell alignment="center" valignment="top" usebox="none">
27787 \begin_layout Plain Layout
27793 <cell alignment="center" valignment="top" usebox="none">
27796 \begin_layout Plain Layout
27802 <cell alignment="center" valignment="top" usebox="none">
27805 \begin_layout Plain Layout
27813 <cell alignment="center" valignment="top" usebox="none">
27816 \begin_layout Plain Layout
27822 <cell alignment="center" valignment="top" usebox="none">
27825 \begin_layout Plain Layout
27831 <cell alignment="center" valignment="top" usebox="none">
27834 \begin_layout Plain Layout
27840 <cell alignment="center" valignment="top" usebox="none">
27843 \begin_layout Plain Layout
27849 <cell alignment="center" valignment="top" usebox="none">
27852 \begin_layout Plain Layout
27858 <cell alignment="center" valignment="top" usebox="none">
27861 \begin_layout Plain Layout
27867 <cell alignment="center" valignment="top" usebox="none">
27870 \begin_layout Plain Layout
27876 <cell alignment="center" valignment="top" usebox="none">
27879 \begin_layout Plain Layout
27893 \begin_layout Chapter
27894 Names of available colors to be used in layouts
27895 \begin_inset CommandInset label
27897 name "chap:Names-of-colors"
27904 \begin_layout Standard
27905 The colors listed below are the standard colors and those that you can adjust
27906 in the \SpecialChar LyX
27910 \begin_layout Section
27914 \begin_layout Standard
27915 The following are no real colors, but rather act on color definitions:
27918 \begin_layout Description
27919 ignore The color is ignored
27922 \begin_layout Description
27923 inherit The color is inherited
27926 \begin_layout Description
27939 No particular color – clear or default
27942 \begin_layout Section
27946 \begin_layout Standard
27947 These are fixed colors that cannot me customized:
27950 \begin_layout Description
27954 \begin_layout Description
27958 \begin_layout Description
27962 \begin_layout Description
27966 \begin_layout Description
27970 \begin_layout Description
27974 \begin_layout Description
27978 \begin_layout Description
27982 \begin_layout Description
27986 \begin_layout Description
27990 \begin_layout Description
27994 \begin_layout Description
27998 \begin_layout Description
28002 \begin_layout Description
28006 \begin_layout Description
28010 \begin_layout Description
28014 \begin_layout Description
28018 \begin_layout Description
28022 \begin_layout Description
28026 \begin_layout Section
28030 \begin_layout Standard
28031 These are the colors allocated to specific elements in
28034 arg "dialog-show prefs"
28040 \begin_layout Description
28041 added_space Added space color
28044 \begin_layout Description
28045 addedtext Added text color
28048 \begin_layout Description
28049 appendix Appendix marker color
28052 \begin_layout Description
28053 background Background color
28056 \begin_layout Description
28057 bottomarea Bottom area color
28060 \begin_layout Description
28061 branchlabel Label color for branches
28064 \begin_layout Description
28065 buttonbg Color used for button background
28068 \begin_layout Description
28069 buttonframe Color for inset button frames
28072 \begin_layout Description
28073 buttonhoverbg Color used for button background under focus
28076 \begin_layout Description
28077 changebar Changebar color
28080 \begin_layout Description
28081 changedtextauthor1 Changed text color author 1
28084 \begin_layout Description
28085 changedtextauthor2 Changed text color author 2
28088 \begin_layout Description
28089 changedtextauthor3 Changed text color author 3
28092 \begin_layout Description
28093 changedtextauthor4 Changed text color author 4
28096 \begin_layout Description
28097 changedtextauthor5 Changed text color author 5
28100 \begin_layout Description
28101 collapsible Collapsible insets text color
28104 \begin_layout Description
28105 collapsibleframe Collapsible insets framecolor
28108 \begin_layout Description
28109 command Text color for command insets
28112 \begin_layout Description
28113 commandbg Background color for command insets
28116 \begin_layout Description
28117 commandframe Frame color for command insets
28120 \begin_layout Description
28121 comment Label color for comments
28124 \begin_layout Description
28125 commentbg Background color of comments
28128 \begin_layout Description
28129 cursor Cursor color
28132 \begin_layout Description
28133 deletedtext Deleted text color
28136 \begin_layout Description
28137 deletedtextmodifier Deleted text modifying color
28140 \begin_layout Description
28141 depthbar Color for the depth bars in the margin
28144 \begin_layout Description
28145 eolmarker End of line marker color
28148 \begin_layout Description
28149 error Color of the \SpecialChar LaTeX
28153 \begin_layout Description
28154 footlabel Label color for footnotes
28157 \begin_layout Description
28158 foreground Foreground color
28161 \begin_layout Description
28162 graphicsbg Graphics inset background color
28165 \begin_layout Description
28166 greyedoutbg Background color of greyedout inset
28169 \begin_layout Description
28170 greyedoutlabel Label color for greyedout insets
28173 \begin_layout Description
28174 greyedouttext Color for greyedout inset text
28177 \begin_layout Description
28178 indexlabel Label color for index insets
28181 \begin_layout Description
28182 inlinecompletion Inline completion color
28185 \begin_layout Description
28186 insetbg Inset marker background color
28189 \begin_layout Description
28190 insetframe Inset marker frame color
28193 \begin_layout Description
28194 language Color for marking foreign language words
28197 \begin_layout Description
28198 latex Text color in \SpecialChar LaTeX
28202 \begin_layout Description
28203 listingsbg Background color of listings inset
28206 \begin_layout Description
28207 marginlabel Label color for margin notes
28210 \begin_layout Description
28211 math Math inset text color
28214 \begin_layout Description
28215 mathbg Math inset background color
28218 \begin_layout Description
28219 mathcorners Math inset frame color not under focus
28222 \begin_layout Description
28223 mathframe Math inset frame color under focus
28226 \begin_layout Description
28227 mathline Math line color
28230 \begin_layout Description
28231 mathmacrobg Macro math inset background color
28234 \begin_layout Description
28235 mathmacroblend Macro math blended color
28238 \begin_layout Description
28239 mathmacroframe Macro math frame color
28242 \begin_layout Description
28243 mathmacrohoverbg Macro math inset background color hovered
28246 \begin_layout Description
28247 mathmacrolabel Macro math label color
28250 \begin_layout Description
28251 mathmacronewarg Macro template color for new parameters
28254 \begin_layout Description
28255 mathmacrooldarg Macro template color for old parameters
28258 \begin_layout Description
28259 newpage New page color
28262 \begin_layout Description
28263 nonunique_inlinecompletion Inline completion color for the non-unique part
28266 \begin_layout Description
28267 note Label color for notes
28270 \begin_layout Description
28271 notebg Background color of notes
28274 \begin_layout Description
28275 pagebreak Page break/line break color
28278 \begin_layout Description
28279 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28282 \begin_layout Description
28283 phantomtext Text color for phantom insets
28286 \begin_layout Description
28287 preview The color used for previews
28290 \begin_layout Description
28291 previewframe Preview frame color
28294 \begin_layout Description
28295 regexpframe Color for regexp frame
28298 \begin_layout Description
28299 scroll Color that indicates when a row can be scrolled
28302 \begin_layout Description
28303 selection Background color of selected text
28306 \begin_layout Description
28307 selectiontext Foreground color of selected text
28310 \begin_layout Description
28311 shadedbg Background color of shaded box
28314 \begin_layout Description
28315 special Special chars text color
28318 \begin_layout Description
28319 tabularline Table line color
28322 \begin_layout Description
28323 tabularonoffline Table line color
28326 \begin_layout Description
28327 urllabel Label color for URL insets
28330 \begin_layout Description
28331 urltext Color for URL inset text