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
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 If set, the converter's standard error will be redirected to a file
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2540 , and the script given as argument will be run as:
2541 \begin_inset Flex Code
2544 \begin_layout Plain Layout
2545 script < infile.out > infile.log
2551 The argument may contain
2552 \begin_inset Flex Code
2555 \begin_layout Plain Layout
2564 \begin_layout Labeling
2565 \labelwidthstring 00.00.0000
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2575 The name of the directory in which the converter will dump the generated
2578 will not create this directory, and it does not copy anything into it,
2579 though it will copy this directory to the destination.
2580 The argument may contain
2581 \begin_inset Flex Code
2584 \begin_layout Plain Layout
2590 , which will be replaced by the base name of the input and output files,
2591 respectively, when the directory is copied.
2592 \begin_inset Newline newline
2595 Note that resultdir and usetempdir make no sense together.
2596 The latter will be ignored if the former is given.
2599 \begin_layout Labeling
2600 \labelwidthstring 00.00.0000
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2610 Determines the output file name and may, contain
2611 \begin_inset Flex Code
2614 \begin_layout Plain Layout
2621 Sensible only with resultdir and optional even then; if not given, it defaults
2625 \begin_layout Standard
2626 None of these last three are presently used in any of the converters that
2627 are installed with \SpecialChar LyX
2632 \begin_layout Standard
2633 You do not have to define converters for all formats between which you want
2635 For example, you will note that there is no `\SpecialChar LyX
2636 to PostScript' converter,
2637 but \SpecialChar LyX
2638 will export PostScript.
2639 It does so by first creating a \SpecialChar LaTeX
2640 file (no converter needs to be defined
2641 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2643 and finally converting the resulting DVI file to PostScript.
2645 finds such `chains' of converters automatically, and it will always choose
2646 the shortest possible chain.
2647 You can, though, still define multiple conversion methods between file
2649 For example, the standard \SpecialChar LyX
2650 configuration provides five ways to convert
2655 \begin_layout Enumerate
2657 \begin_inset Flex Noun
2660 \begin_layout Plain Layout
2669 \begin_layout Enumerate
2670 via (DVI and) PostScript, using
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2683 \begin_layout Enumerate
2685 \begin_inset Flex Noun
2688 \begin_layout Plain Layout
2697 \begin_layout Enumerate
2699 \begin_inset Flex Noun
2702 \begin_layout Plain Layout
2712 \begin_layout Enumerate
2714 \begin_inset Flex Noun
2717 \begin_layout Plain Layout
2727 \begin_layout Standard
2728 To define such alternate chains, you must define multiple target `file formats',
2730 \begin_inset CommandInset ref
2732 reference "sec:Formats"
2737 For example, in the standard configuration, the formats named
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2748 \begin_inset Flex Noun
2751 \begin_layout Plain Layout
2758 \begin_inset Flex Noun
2761 \begin_layout Plain Layout
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2778 \begin_inset Flex Noun
2781 \begin_layout Plain Layout
2788 \begin_inset Flex Noun
2791 \begin_layout Plain Layout
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2808 \begin_inset Flex Noun
2811 \begin_layout Plain Layout
2819 \begin_inset Flex Noun
2822 \begin_layout Plain Layout
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2839 ) are defined, all of which share the extension
2840 \begin_inset Flex Noun
2843 \begin_layout Plain Layout
2849 , and which correspond to the conversion methods just mentioned.
2852 \begin_layout Chapter
2853 Internationalizing \SpecialChar LyX
2855 \begin_inset CommandInset label
2857 name "cha:Internationalizing-LyX"
2864 \begin_layout Standard
2866 supports using a translated interface.
2867 Last time we checked, \SpecialChar LyX
2868 provided text in thirty languages.
2869 The language of choice is called your
2874 (For further reading on locale settings, see also the documentation for
2875 locale that comes with your operating system.
2876 For Linux, the manual page for
2877 \begin_inset Flex Code
2880 \begin_layout Plain Layout
2886 could be a good place to start).
2889 \begin_layout Standard
2890 Notice that these translations will work, but do contain a few flaws.
2891 In particular, all dialogs have been designed with the English text in
2892 mind, which means that some of the translated text will be too large to
2893 fit within the space allocated.
2894 This is only a display problem and will not cause any harm.
2895 Also, you will find that some of the translations do not define shortcut
2896 keys for everything.
2897 Sometimes, there are simply not enough free letters to do it.
2898 Other times, the translator just hasn't got around to doing it yet.
2899 Our localization team, which you may wish to join,
2903 \begin_layout Plain Layout
2904 If you are a fluent speaker of a language other than English, joining these
2905 teams is a great way to give back to the \SpecialChar LyX
2911 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2915 \begin_layout Section
2916 Translating \SpecialChar LyX
2920 \begin_layout Subsection
2921 Translating the graphical user interface (text messages).
2924 \begin_layout Standard
2927 \begin_inset Flex Code
2930 \begin_layout Plain Layout
2936 library to handle the internationalization of the interface.
2937 To have \SpecialChar LyX
2938 speak your favorite language in all menus and dialogs, you need
2940 \begin_inset Flex Code
2943 \begin_layout Plain Layout
2949 -file for that language.
2950 When this is available, you'll have to generate a
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2960 -file from it and install the
2961 \begin_inset Flex Code
2964 \begin_layout Plain Layout
2971 The process of doing all of this is explained in the documentation for
2973 \begin_inset Flex Code
2976 \begin_layout Plain Layout
2983 It is possible to do this just for yourself, but if you're going to do
2984 it, you might as well share the results of your labors with the rest of
2985 the \SpecialChar LyX
2987 Send a message to the \SpecialChar LyX
2988 developers' list for more information about how
2992 \begin_layout Standard
2993 In short, this is what you should do (xx denotes the language code):
2996 \begin_layout Itemize
2997 Check out the \SpecialChar LyX
3000 \begin_inset CommandInset href
3002 name "information on the web"
3003 target "https://www.lyx.org/HowToUseGIT"
3011 \begin_layout Itemize
3013 \begin_inset Flex Code
3016 \begin_layout Plain Layout
3022 to the folder of the
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3054 doesn't exist anywhere, it can be remade with the console command
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3064 in that directory, or you can use an existing po-file for some other language
3068 \begin_layout Itemize
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3083 \begin_layout Plain Layout
3084 This is just a text file, so it can be edited in any text editor.
3085 But there are also specialized programs that support such editing, such
3090 (for all platforms) or
3099 contains a `mode' for editing
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3110 \begin_inset Flex URL
3113 \begin_layout Plain Layout
3115 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3127 For some menu- and widget-labels, there are also shortcut keys that should
3129 Those keys are marked after a `|', and should be translated according to
3130 the words and phrases of the language.
3131 You should also fill also out the information at the beginning of the new
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3142 -file with your email-address, etc., so people know where to reach you with
3143 suggestions and entertaining flames.
3146 \begin_layout Standard
3147 If you are just doing this on your own, then:
3150 \begin_layout Itemize
3152 \begin_inset Flex Code
3155 \begin_layout Plain Layout
3162 This can be done with
3163 \begin_inset Flex Code
3166 \begin_layout Plain Layout
3167 msgfmt -o xx.mo < xx.po
3175 \begin_layout Itemize
3177 \begin_inset Flex Code
3180 \begin_layout Plain Layout
3186 -file to your locale-tree, at the correct directory for application messages
3191 xx, and under the name
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3202 \begin_inset space \thinspace{}
3206 \begin_inset space \space{}
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3214 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3224 \begin_layout Standard
3225 As said, however, it would be best if the new
3226 \begin_inset Flex Code
3229 \begin_layout Plain Layout
3235 file could be added to the \SpecialChar LyX
3236 distribution, so others can use it.
3237 Adding it involves making additional changes to \SpecialChar LyX
3239 So send an email to the developers' mailing list if you're interested in
3243 \begin_layout Subsubsection
3247 \begin_layout Standard
3248 Sometimes it turns out that one English message needs to be translated into
3249 different messages in the target language.
3250 One example is the message
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3260 which has the German translation
3268 , depending upon exactly what the English
3269 \begin_inset Quotes eld
3273 \begin_inset Quotes erd
3278 \begin_inset Flex Code
3281 \begin_layout Plain Layout
3287 does not handle such ambiguous translations.
3288 Therefore you have to add some context information to the message: Instead
3290 \begin_inset Flex Code
3293 \begin_layout Plain Layout
3300 \begin_inset Flex Code
3303 \begin_layout Plain Layout
3304 To[[as in 'From format x to format y']]
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3314 To[[as in 'From page x to page y']].
3319 Now the two occurrences of
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3339 and can be translated correctly to
3350 \begin_layout Standard
3351 Of course the context information needs to be stripped off the original
3352 message when no translation is used.
3353 Therefore you have to put it in double square brackets at the end of the
3354 message (see the example above).
3355 The translation mechanism of \SpecialChar LyX
3356 ensures that everything in double square
3357 brackets at the end of messages is removed before displaying the message.
3360 \begin_layout Subsection
3361 Translating the documentation.
3364 \begin_layout Standard
3365 The online documentation (in the
3366 \begin_inset Flex Noun
3369 \begin_layout Plain Layout
3375 -menu) can (and should!) be translated.
3376 If there are translated versions of the documentation available
3380 \begin_layout Plain Layout
3381 As of March 2008, at least some of the documents have been translated into
3382 fourteen languages, with the Tutorial available in a few more.
3387 and the locale is set accordingly, these will be used automagically by
3391 looks for translated versions as
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3396 LyXDir/doc/xx/DocName.lyx
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 is the code for the language currently in use.
3412 If there are no translated documents, the default English versions will
3414 Note that the translated versions must have the same filenames (
3415 \begin_inset Flex Code
3418 \begin_layout Plain Layout
3424 above) as the original.
3425 If you feel up to translating the documentation (an excellent way to proof-read
3426 the original documentation by the way!), there are a few things you should
3430 \begin_layout Itemize
3431 Check out the documentation translation web page at
3432 \begin_inset CommandInset href
3434 name "https://www.lyx.org/Translation"
3435 target "https://www.lyx.org/Translation"
3441 That way, you can find out which (if any) documents have already been translate
3442 d into your language.
3443 You can also find out who (if anyone) is organizing the effort to translate
3444 the documentation into your language.
3445 If no one is organizing the effort, please let us know that you're interested.
3448 \begin_layout Standard
3449 Once you get to actually translating, here's a few hints for you that may
3453 \begin_layout Itemize
3454 Join the documentation team! There is information on how to do that in
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 \begin_inset Flex Noun
3468 \begin_layout Plain Layout
3469 Help\SpecialChar menuseparator
3475 ), which by the way is the first document you should translate.
3478 \begin_layout Itemize
3479 Learn the typographic conventions for the language you are translating to.
3480 Typography is an ancient art and over the centuries, a great variety of
3481 conventions have developed throughout different parts of the world.
3482 Also study the professional terminology amongst typographers in your country.
3483 Inventing your own terminology will only confuse the users.
3486 (Warning! Typography is addictive!)
3489 \begin_layout Itemize
3490 Make a copy of the document.
3491 This will be your working copy.
3492 You can use this as your personal translated help-file by placing it in
3494 \begin_inset Flex Code
3497 \begin_layout Plain Layout
3504 \begin_inset Note Greyedout
3507 \begin_layout Plain Layout
3512 For a complex document with external material (images, etc.), if you make
3514 \begin_inset space \thinspace{}
3518 \begin_inset space \space{}
3521 in a temp dir, beware that the links to external material may be broken
3522 when the document is moved to a different place.
3523 The best way is to retrieve the \SpecialChar LyX
3525 \begin_inset Flex URL
3528 \begin_layout Plain Layout
3530 https://www.lyx.org/HowToUseGIT
3535 ) and to edit the doc file in place.
3543 \begin_layout Itemize
3544 Sometimes the original document (from the \SpecialChar LyX
3545 team) will be updated.
3546 Use the source viewer at
3547 \begin_inset CommandInset href
3549 name "https://www.lyx.org/trac/timeline"
3550 target "https://www.lyx.org/trac/timeline"
3555 to see what has been changed.
3556 That way you can easily see which parts of the translated document need
3560 \begin_layout Standard
3561 If you ever find an error in the original document, fix it and notify the
3562 rest of the documentation team of the changes! (You didn't forget to join
3563 the documentation team, did you?)
3566 \begin_layout Standard
3567 \begin_inset Branch OutDated
3571 \begin_layout Section
3572 International Keyboard Support
3575 \begin_layout Standard
3578 [Editor's Note: The following section is by
3586 It needs to be fixed to conform to the new Documentation Style sheet and
3587 to make use of the new v1.0 features.
3588 The whole thing also needs to be merged with the section following it.-jw
3589 It may also be badly out of date.-rh (2008)]
3592 \begin_layout Subsection
3593 Defining Own Keymaps: Keymap File Format
3596 \begin_layout Standard
3597 Let's look at a keyboard definition file a little closer.
3598 It is a plain text file defining
3601 \begin_layout Itemize
3602 key-to-key or key-to-string translations
3605 \begin_layout Itemize
3609 \begin_layout Itemize
3610 dead keys exceptions
3613 \begin_layout Standard
3614 To define key-to-key or key-to-string translation, use this command:
3617 \begin_layout Quotation
3618 \begin_inset Flex Code
3621 \begin_layout Plain Layout
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3642 \begin_layout Standard
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 is the key to be translated and
3654 \begin_inset Flex Code
3657 \begin_layout Plain Layout
3663 is the string to be inserted into the document.
3664 To define dead keys, use:
3667 \begin_layout Quotation
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3680 \begin_inset Flex Code
3683 \begin_layout Plain Layout
3692 \begin_layout Standard
3694 \begin_inset Flex Code
3697 \begin_layout Plain Layout
3703 is a keyboard key and
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3714 The following dead keys are supported (shortcut name is in parentheses):
3717 \begin_layout Quotation
3721 \begin_inset space \hfill{}
3727 \begin_layout Quotation
3729 \begin_inset space \hfill{}
3735 \begin_layout Quotation
3737 \begin_inset space \hfill{}
3743 \begin_layout Quotation
3745 \begin_inset space \hfill{}
3751 \begin_layout Quotation
3753 \begin_inset space \hfill{}
3759 \begin_layout Quotation
3761 \begin_inset space \hfill{}
3768 \begin_layout Plain Layout
3780 \begin_layout Quotation
3782 \begin_inset space \hfill{}
3788 \begin_layout Quotation
3790 \begin_inset space \hfill{}
3797 \begin_layout Plain Layout
3809 \begin_layout Quotation
3811 \begin_inset space \hfill{}
3817 \begin_layout Quotation
3819 \begin_inset space \hfill{}
3825 \begin_layout Quotation
3827 \begin_inset space \hfill{}
3834 \begin_layout Plain Layout
3846 \begin_layout Quotation
3848 \begin_inset space \hfill{}
3855 \begin_layout Plain Layout
3867 \begin_layout Quotation
3869 \begin_inset space \hfill{}
3875 \begin_layout Quotation
3876 hungarian umlaut (hug)
3877 \begin_inset space \hfill{}
3883 \begin_layout Quotation
3885 \begin_inset space \hfill{}
3891 \begin_layout Quotation
3893 \begin_inset space \hfill{}
3900 \begin_layout Plain Layout
3912 \begin_layout Standard
3913 Since in many international keyboards there are exceptions to what some
3914 dead keys should do, you can define them using
3917 \begin_layout Quotation
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3929 deadkey key outstring
3932 \begin_layout Standard
3933 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3937 \begin_layout Quotation
3938 \begin_inset Flex Code
3941 \begin_layout Plain Layout
3954 \begin_layout Standard
3955 to make it work correctly.
3956 Also, you have to define as exceptions dead keys over i and j, to remove
3957 the dot from them before inserting an accent mark.
3958 I will change this when the time comes, but so far I haven't had time.
3961 \begin_layout Standard
3962 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3965 \begin_inset Flex Code
3968 \begin_layout Plain Layout
3974 have different meaning.
3976 \begin_inset Flex Code
3979 \begin_layout Plain Layout
3985 marks comments, quotes start and end \SpecialChar LaTeX
3987 To enter quote, you'll need to use
3988 \begin_inset Flex Code
3991 \begin_layout Plain Layout
4000 \begin_inset Flex Code
4003 \begin_layout Plain Layout
4010 \begin_inset Flex Code
4013 \begin_layout Plain Layout
4024 \begin_layout Standard
4025 If you make a keyboard description file that works for your language, please
4026 mail it to me, so I can include it in the next keymap distribution.
4029 \begin_layout Standard
4030 More keywords will be supported in keymap configuration file in future,
4034 \begin_layout Itemize
4035 \begin_inset Flex Code
4038 \begin_layout Plain Layout
4049 \begin_inset space \hfill{}
4053 \begin_inset Flex Code
4056 \begin_layout Plain Layout
4065 \begin_layout Itemize
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4080 \begin_inset space \hfill{}
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4093 an external keymap translation program
4096 \begin_layout Standard
4097 Also, it should look into
4098 \begin_inset Flex Code
4101 \begin_layout Plain Layout
4107 file for defaults, too (for example, a
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4119 option to include default keyboard).
4127 \begin_layout Section
4128 International Keymap Stuff
4129 \begin_inset CommandInset label
4131 name "sec:International-Keymap-Stuff"
4138 \begin_layout Standard
4139 \begin_inset Note Note
4142 \begin_layout Plain Layout
4143 In doing the revisions on this document in March 2008, I did not look over
4144 this stuff, as I do not understand it.
4145 It would be good if someone else could do so.
4154 \begin_layout Standard
4155 The next two sections describe the
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4179 file syntax in detail.
4180 These sections should help you design your own key map if the ones provided
4181 do not meet your needs.
4184 \begin_layout Subsection
4188 \begin_layout Standard
4192 \begin_inset Flex Code
4195 \begin_layout Plain Layout
4201 file maps keystrokes to characters or strings.
4202 As the name suggests, it sets a keyboard mapping.
4204 \begin_inset Flex Code
4207 \begin_layout Plain Layout
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4236 \begin_inset Flex Code
4239 \begin_layout Plain Layout
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4264 \begin_inset Flex Code
4267 \begin_layout Plain Layout
4275 are described in this section.
4278 \begin_layout Labeling
4279 \labelwidthstring 00.00.0000
4280 \begin_inset Flex Code
4283 \begin_layout Plain Layout
4291 Map a character to a string
4294 \begin_layout LyX-Code
4309 \begin_layout Standard
4342 the double-quote (")
4359 must be escaped with a preceding backslash (
4370 \begin_layout Standard
4372 \begin_inset Flex Noun
4375 \begin_layout Plain Layout
4383 statement to cause the symbol
4384 \begin_inset Flex Noun
4387 \begin_layout Plain Layout
4395 to be output for the keystroke
4396 \begin_inset Flex Noun
4399 \begin_layout Plain Layout
4410 \begin_layout LyX-Code
4416 \begin_layout Labeling
4417 \labelwidthstring 00.00.0000
4418 \begin_inset Flex Code
4421 \begin_layout Plain Layout
4429 Specify an accent character
4432 \begin_layout LyX-Code
4441 \begin_layout Standard
4442 This will make the cha
4480 This is the dead key
4484 \begin_layout Plain Layout
4491 refers to a key that does not produce a character by itself, but when followed
4492 with another key, produces the desired accent character.
4493 For example, a German characte
4495 r with an umlaut like
4505 can be produced in this manner.
4514 \begin_layout Standard
4527 and then another key not in
4544 followed by the other, not allowed key, as output.
4548 \begin_inset Flex Noun
4551 \begin_layout Plain Layout
4559 cancels a dead key, so if
4570 \begin_inset Flex Noun
4573 \begin_layout Plain Layout
4582 , the cursor will not go one position backwards but will instead cancel
4598 might have had on the next keystroke.
4602 \begin_layout Standard
4603 The following example specifies that the character ' is to be an acute accent,
4604 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4607 \begin_layout LyX-Code
4610 kmod ' acute aeiouAEIOU
4613 \begin_layout Labeling
4614 \labelwidthstring 00.00.0000
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4624 Specify an exception to the accent character
4627 \begin_layout LyX-Code
4636 \begin_layout Standard
4637 This defines an exce
4678 have been assigned a keystroke with a previous
4681 \begin_inset Flex Code
4684 \begin_layout Plain Layout
4708 must not belong in the
4755 If such a declaration does not exist in
4763 \begin_inset Flex Code
4766 \begin_layout Plain Layout
4800 \begin_inset Flex Code
4803 \begin_layout Plain Layout
4817 \begin_layout Standard
4818 The following command produces causes äi to be produced when you enter acute-i
4822 \begin_layout LyX-Code
4836 \begin_layout Labeling
4837 \labelwidthstring 00.00.0000
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4847 Combine two accent characters
4850 \begin_layout LyX-Code
4856 accent1 accent2 allowed
4859 \begin_layout Standard
4860 This one is getting pretty esoteric.
4861 It allows you to combine the effect
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4948 \begin_layout Standard
4949 Consider this example from the
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4964 \begin_layout LyX-Code
4967 kmod ; acute aeioyvhAEIOYVH
4971 kcomb acute umlaut iyIY
4974 \begin_layout Standard
4975 This allows you to press
4976 \begin_inset Flex Noun
4979 \begin_layout Plain Layout
4987 and get the effect of
4988 \begin_inset Flex Code
4991 \begin_layout Plain Layout
5010 in this case cancels the last dead key, so if you press
5011 \begin_inset Flex Noun
5014 \begin_layout Plain Layout
5023 \begin_inset Flex Code
5026 \begin_layout Plain Layout
5039 \begin_layout Subsection
5043 \begin_layout Standard
5045 \begin_inset Flex Code
5048 \begin_layout Plain Layout
5056 mapping is performed, a
5057 \begin_inset Flex Code
5060 \begin_layout Plain Layout
5070 file maps the strings that the symbols generate to characters in the current
5072 The \SpecialChar LyX
5073 distribution currently includes at least the
5074 \begin_inset Flex Code
5077 \begin_layout Plain Layout
5086 \begin_inset Flex Code
5089 \begin_layout Plain Layout
5100 \begin_layout Standard
5102 \begin_inset Flex Code
5105 \begin_layout Plain Layout
5113 file is a sequence of declarations of the form
5116 \begin_layout LyX-Code
5129 \begin_layout Standard
5130 For example, in order to map
5131 \begin_inset Flex Noun
5134 \begin_layout Plain Layout
5144 to the corresponding character in the iso-8859-1 set (233), the following
5148 \begin_layout LyX-Code
5156 \begin_layout Standard
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5170 \begin_inset Flex Code
5173 \begin_layout Plain Layout
5191 the same character can apply to more than one string.
5193 \begin_inset Flex Code
5196 \begin_layout Plain Layout
5207 \begin_layout LyX-Code
5219 \begin_inset Newline newline
5235 \begin_layout Standard
5237 cannot find a mapping for the string produced by the keystroke or a
5238 deadkey sequence, it will check if it looks like an accented char and try
5239 to draw an accent over the character on screen.
5242 \begin_layout Subsection
5246 \begin_layout Standard
5247 There is a second way to add support for international characters through
5248 so-called dead-keys.
5249 A dead-key works in combination with a letter to produce an accented character.
5250 Here, we'll explain how to create a really simple dead-key to illustrate
5254 \begin_layout Standard
5255 Suppose you happen to need the circumflex character,
5256 \begin_inset Quotes eld
5260 \begin_inset Quotes erd
5265 \begin_inset Flex Noun
5268 \begin_layout Plain Layout
5275 \begin_inset space ~
5279 \begin_inset Flex Noun
5282 \begin_layout Plain Layout
5288 ] to the \SpecialChar LyX
5290 \begin_inset Flex Code
5293 \begin_layout Plain Layout
5300 \begin_inset Flex Code
5303 \begin_layout Plain Layout
5310 Now, whenever you type the
5311 \begin_inset Flex Noun
5314 \begin_layout Plain Layout
5320 -key followed by a letter, that letter will have a circumflex accent on
5322 For example, the sequence
5323 \begin_inset Quotes eld
5327 \begin_inset Flex Noun
5330 \begin_layout Plain Layout
5337 \begin_inset Quotes erd
5340 produces the letter:
5341 \begin_inset Quotes eld
5345 \begin_inset Quotes erd
5349 If you tried to type
5350 \begin_inset Quotes eld
5354 \begin_inset Flex Noun
5357 \begin_layout Plain Layout
5364 \begin_inset Quotes erd
5367 , however, \SpecialChar LyX
5368 will complain with a beep, since a
5369 \begin_inset Quotes eld
5373 \begin_inset Flex Noun
5376 \begin_layout Plain Layout
5383 \begin_inset Quotes erd
5386 never takes a circumflex accent.
5388 \begin_inset Flex Noun
5391 \begin_layout Plain Layout
5397 after a dead-key produces the bare-accent.
5398 Please note this last point! If you bind a key to a dead-key, you'll need
5399 to rebind the character on that key to yet another key.
5401 \begin_inset Flex Noun
5404 \begin_layout Plain Layout
5410 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5413 \begin_layout Standard
5414 One common way to bind dead-keys is to use
5415 \begin_inset Flex Noun
5418 \begin_layout Plain Layout
5425 \begin_inset Flex Noun
5428 \begin_layout Plain Layout
5435 \begin_inset Flex Noun
5438 \begin_layout Plain Layout
5444 in combination with an accent, like
5445 \begin_inset Quotes eld
5449 \begin_inset Flex Noun
5452 \begin_layout Plain Layout
5459 \begin_inset Quotes erd
5463 \begin_inset Quotes eld
5467 \begin_inset Flex Noun
5470 \begin_layout Plain Layout
5477 \begin_inset Quotes erd
5481 \begin_inset Quotes eld
5485 \begin_inset Flex Noun
5488 \begin_layout Plain Layout
5495 \begin_inset Quotes erd
5499 Another way involves using
5500 \begin_inset Flex Code
5503 \begin_layout Plain Layout
5510 \begin_inset Flex Code
5513 \begin_layout Plain Layout
5519 to set up the special
5520 \begin_inset Flex Code
5523 \begin_layout Plain Layout
5531 \begin_inset Flex Code
5534 \begin_layout Plain Layout
5540 acts in some ways just like
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5550 and permits you to bind keys to accented characters.
5551 You can also turn keys into dead-keys by binding them to something like
5553 \begin_inset Flex Code
5556 \begin_layout Plain Layout
5562 and then binding this symbolic key to the corresponding \SpecialChar LyX
5567 \begin_layout Plain Layout
5572 : This is exactly what I do in my
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5583 \begin_inset Flex Code
5586 \begin_layout Plain Layout
5594 \begin_inset Flex Noun
5597 \begin_layout Plain Layout
5599 \begin_inset space ~
5608 \begin_inset Flex Code
5611 \begin_layout Plain Layout
5617 and a bunch of these
5618 \begin_inset Quotes eld
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5632 \begin_inset Quotes erd
5635 symbolic keys bound such things as
5636 \begin_inset Flex Noun
5639 \begin_layout Plain Layout
5641 \begin_inset space ~
5650 \begin_inset Flex Noun
5653 \begin_layout Plain Layout
5655 \begin_inset space ~
5664 This is how I produce my accented characters.
5669 You can make just about anything into the
5670 \begin_inset Flex Code
5673 \begin_layout Plain Layout
5680 \begin_inset Flex Noun
5683 \begin_layout Plain Layout
5689 keys, a spare function key, etc.
5690 As for the \SpecialChar LyX
5691 commands that produce accents, check the entry for
5692 \begin_inset Flex Code
5695 \begin_layout Plain Layout
5706 You'll find the complete list there.
5709 \begin_layout Subsection
5710 Saving your Language Configuration
5713 \begin_layout Standard
5714 You can edit your preferences so that your desired language environment
5715 is automatically configured when \SpecialChar LyX
5717 \begin_inset Flex Noun
5720 \begin_layout Plain Layout
5721 Edit\SpecialChar menuseparator
5730 \begin_layout Chapter
5731 Installing New Document Classes, Layouts, and Templates
5732 \begin_inset CommandInset label
5734 name "cha:Installing-New-Document"
5739 \begin_inset Argument 1
5742 \begin_layout Plain Layout
5743 Installing New Document Classes
5751 \begin_layout Standard
5752 In this chapter, we describe the procedures for creating and installing
5753 new \SpecialChar LyX
5754 layout and template files, as well as offer a refresher on correctly
5755 installing new \SpecialChar LaTeX
5760 \begin_layout Standard
5761 First, let us a say a few words about how one ought to think about the relation
5762 between \SpecialChar LyX
5763 and \SpecialChar LaTeX
5765 The thing to understand is that, in a certain sense, \SpecialChar LyX
5766 doesn't know anything
5767 about \SpecialChar LaTeX
5769 Indeed, from \SpecialChar LyX
5770 's point of view, \SpecialChar LaTeX
5771 is just one of several
5772 \begin_inset Quotes eld
5776 \begin_inset Quotes erd
5779 in which it is capable of producing output.
5780 Other such formats are DocBook, plaintext, and XHTML.
5782 is, of course, a particularly important format, but very little of the
5783 information \SpecialChar LyX
5784 has about \SpecialChar LaTeX
5785 is actually contained in the program itself.
5789 \begin_layout Plain Layout
5790 Some commands are sufficiently complex that they are
5791 \begin_inset Quotes eld
5795 \begin_inset Quotes erd
5798 into \SpecialChar LyX
5800 But the developers generally regard this as a Bad Thing.
5805 Rather, that information, even for the standard classes like
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5815 , is contained in `layout files'.
5816 Similarly, \SpecialChar LyX
5817 itself does not know much about DocBook or XHTML.
5818 What it knows is contained in layout files.
5821 \begin_layout Standard
5822 You can think of the layout file for a given document class as a translation
5823 manual between \SpecialChar LyX
5824 constructs—paragraphs with their corresponding styles,
5825 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5828 Almost everything \SpecialChar LyX
5830 \begin_inset Flex Code
5833 \begin_layout Plain Layout
5839 , for example, is contained in the file
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 and in various other files it includes.
5850 For this reason, anyone intending to write layout files should plan to
5851 study the existing files.
5852 A good place to start is with
5853 \begin_inset Flex Code
5856 \begin_layout Plain Layout
5862 , which is included in
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5873 \begin_inset Flex Code
5876 \begin_layout Plain Layout
5882 , and many of the other layout files for document classes.
5883 This file is where sections and the like are defined:
5884 \begin_inset Flex Code
5887 \begin_layout Plain Layout
5893 tells \SpecialChar LyX
5894 how paragraphs that are marked with the Section, Subsection, etc,
5895 styles can be translated into corresponding \SpecialChar LaTeX
5896 , DocBook, and XHTML commands
5899 \begin_inset Flex Code
5902 \begin_layout Plain Layout
5908 file basically just includes several of these
5909 \begin_inset Flex Code
5912 \begin_layout Plain Layout
5921 \begin_layout Standard
5922 Defining the \SpecialChar LyX
5924 correspondence is not the only thing layout files do, though.
5925 Their other job is to define how the \SpecialChar LyX
5926 constructs themselves will appear
5928 The fact that layout files have these two jobs is often a source of confusion,
5929 because they are completely separate.
5930 Telling \SpecialChar LyX
5931 how to translate a certain paragraph style into \SpecialChar LaTeX
5934 how to display it; conversely, telling \SpecialChar LyX
5935 how to display a certain paragraph
5936 style does not tell \SpecialChar LyX
5937 how to translate it into \SpecialChar LaTeX
5938 (let alone tell \SpecialChar LaTeX
5941 So, in general, when you define a new \SpecialChar LyX
5942 construct, you must always do two
5943 quite separate things: (i)
5944 \begin_inset space ~
5947 tell \SpecialChar LyX
5948 how to translate it into \SpecialChar LaTeX
5950 \begin_inset space ~
5953 tell \SpecialChar LyX
5957 \begin_layout Standard
5958 Much the same is true, of course, as regards \SpecialChar LyX
5959 's other backend formats, though
5960 XHTML is in some ways different, because in that case \SpecialChar LyX
5965 able, to some extent, to use information about how it should display a
5966 paragraph on the screen to output information (in the form of CSS) about
5967 how the paragraph should be displayed in a browser.
5968 Even in this case, however, the distinction between what \SpecialChar LyX
5970 and how things are rendered externally remains in force, and the two can
5971 be controlled separately.
5973 \begin_inset CommandInset ref
5975 reference "sec:Tags-for-XHTML"
5982 \begin_layout Section
5983 Installing new \SpecialChar LaTeX
5987 \begin_layout Standard
5988 Some installations may not include a \SpecialChar LaTeX
5989 package or class file that you would
5990 like to use within \SpecialChar LyX
5992 For example, you might need Foil\SpecialChar TeX
5993 , a package for preparing slides for overhead
5995 Modern \SpecialChar LaTeX
5996 distributions like \SpecialChar TeX
5997 Live (2008 or newer) or MiK\SpecialChar TeX
5998 provide a user interface
5999 for installing such packages.
6000 For example, with MiK\SpecialChar TeX
6001 , you start the program
6002 \begin_inset Quotes eld
6006 \begin_inset space ~
6010 \begin_inset Quotes erd
6013 to get a list of available packages.
6014 To install one of them, right click on it or use the corresponding toolbar
6018 \begin_layout Standard
6019 If your \SpecialChar LaTeX
6020 distribution does not provide such a `package manager', or if the
6021 package is not available from your distribution, then follow these steps
6022 to install it manually:
6025 \begin_layout Enumerate
6026 Get the package from
6027 \begin_inset CommandInset href
6030 target "http://www.ctan.org/"
6038 \begin_layout Enumerate
6039 If the package contains a file with the ending
6040 \begin_inset Quotes eld
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6054 \begin_inset Quotes erd
6057 (is the case for Foil\SpecialChar TeX
6058 ) then open a console, change to the folder of this
6059 file and execute the command
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6070 You have now unpacked the package and have all files to install it.
6071 Most \SpecialChar LaTeX
6072 -packages are not packed and you can skip this step.
6075 \begin_layout Enumerate
6076 Now you need to decide if the package should be available for all users
6081 \begin_layout Enumerate
6082 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6083 for all users on your system, then install it in your `local' \SpecialChar TeX
6085 install it in your own `user' \SpecialChar TeX
6087 Where these trees should be created, if they do not already exist, depends
6089 To find this out, look in the file
6090 \begin_inset Flex Code
6093 \begin_layout Plain Layout
6103 \begin_layout Plain Layout
6104 This is usually in the directory
6105 \begin_inset Flex Code
6108 \begin_layout Plain Layout
6114 , though you can execute the command
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6129 The location of the `local' \SpecialChar TeX
6130 tree is defined by the
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6140 variable; this is usually somewhere like
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6145 /usr/local/share/texmf
6150 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6153 The location of the `user' \SpecialChar TeX
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6187 (If these variables are not predefined, you have to define them.) You'll
6188 probably need root permissions to create or modify the `local' tree, but
6189 not for your `user' tree.
6190 \begin_inset Newline newline
6193 In general, it is recommended to install in the user tree because your user
6194 will not be modified or even overwritten when you upgrade your system.
6195 It will typically also be backed up together with everything else when
6196 you backup your home directory (which, of course, you do on a regular basis).
6199 \begin_layout Enumerate
6200 On Windows, if you want the new package to be available for all users on
6201 your system, change to the folder where \SpecialChar LaTeX
6202 is installed and then change to
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6218 (For MiK\SpecialChar TeX
6219 , this would be by default the folder
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6241 \begin_layout Plain Layout
6242 Note that this will be the correct path only on English installations.
6243 On a German one, it would be
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6261 , and similarly for other languages.
6266 Create there a new folder
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6276 and copy all files of the package into it.
6278 \begin_inset Newline newline
6281 If the package should only available for you or you don't have admin permissions
6282 , do the same, but in the local \SpecialChar LaTeX
6285 \begin_inset space \thinspace{}
6288 g., for MiK\SpecialChar TeX
6290 \begin_inset space ~
6293 2.8 under Windows XP, this would be the folder:
6294 \begin_inset Newline newline
6300 \begin_inset Flex Code
6303 \begin_layout Plain Layout
6306 Documents and Settings
6318 \begin_inset Newline newline
6324 \begin_inset Phantom HPhantom
6327 \begin_layout Plain Layout
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6354 \begin_inset Newline newline
6357 On Vista, it would be:
6358 \begin_inset Newline newline
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6391 \begin_layout Enumerate
6392 Now one only need to tell \SpecialChar LaTeX
6393 that there are new files.
6394 This depends on the used \SpecialChar LaTeX
6399 \begin_layout Enumerate
6400 For \SpecialChar TeX
6401 Live execute the command
6402 \begin_inset Flex Code
6405 \begin_layout Plain Layout
6412 If you installed the package for all users, then you will probably need
6413 to have root permissions for that.
6416 \begin_layout Enumerate
6417 For MiK\SpecialChar TeX
6418 , if you have installed the package for all users, start the program
6420 \begin_inset Quotes eld
6424 \begin_inset space ~
6428 \begin_inset Quotes erd
6431 and press the button marked
6432 \begin_inset Quotes eld
6436 \begin_inset Quotes erd
6440 Otherwise start the program
6441 \begin_inset Quotes eld
6445 \begin_inset Quotes erd
6452 \begin_layout Enumerate
6453 Finally, you need to tell \SpecialChar LyX
6454 that there are new packages available.
6455 So, in \SpecialChar LyX
6457 \begin_inset Flex Noun
6460 \begin_layout Plain Layout
6463 \SpecialChar menuseparator
6469 and then restart \SpecialChar LyX
6473 \begin_layout Standard
6474 Now the package is installed.
6475 In our example, the document class
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6485 will now be available under
6486 \begin_inset Flex Noun
6489 \begin_layout Plain Layout
6490 Document\SpecialChar menuseparator
6491 Settings\SpecialChar menuseparator
6498 \begin_inset Quotes eld
6502 \begin_inset Quotes erd
6509 \begin_layout Standard
6510 If you would like to use a \SpecialChar LaTeX
6511 document class that is not even listed in the
6513 \begin_inset Flex Noun
6516 \begin_layout Plain Layout
6517 Document\SpecialChar menuseparator
6518 Settings\SpecialChar menuseparator
6524 , then you need to create a `layout' file for it.
6525 That is the topic of the next section.
6528 \begin_layout Section
6529 Types of layout files
6532 \begin_layout Standard
6533 This section describes the various sorts of \SpecialChar LyX
6534 files that contain layout informati
6536 These files describe various paragraph and character styles, determining
6537 how \SpecialChar LyX
6538 should display them and how they should be translated into \SpecialChar LaTeX
6540 XHTML, or whatever output format is being used.
6544 \begin_layout Standard
6545 We shall try to provide a thorough description of the process of writing
6547 However, there are so many different types of documents supported even
6548 by just \SpecialChar LaTeX
6549 that we can't hope to cover every different possibility or problem
6550 you might encounter.
6551 The \SpecialChar LyX
6552 users' list is frequented by people with lots of experience with layout
6553 design who are willing to share what they've learned, so please feel free
6554 to ask questions there.
6557 \begin_layout Standard
6558 As you prepare to write a new layout, it is extremely helpful to look at
6559 the layouts distributed with \SpecialChar LyX
6561 If you write a \SpecialChar LyX
6562 layout for a \SpecialChar LaTeX
6563 document class that might also be used by
6564 others, or write a module that might be useful to others, then you should
6565 consider posting your layout to the
6566 \begin_inset CommandInset href
6568 name "layout section on the LyX wiki"
6569 target "https://wiki.lyx.org/Layouts/Layouts"
6574 or even to the \SpecialChar LyX
6575 developers' list, so that it might be included in \SpecialChar LyX
6580 \begin_layout Plain Layout
6581 Note that \SpecialChar LyX
6582 is licensed under the General Public License, so any material
6583 that is contributed to \SpecialChar LyX
6584 must be similarly licensed.
6592 \begin_layout Subsection
6594 \begin_inset CommandInset label
6596 name "subsec:Layout-modules"
6603 \begin_layout Standard
6604 We have spoken to this point about `layout files'.
6605 But there are different sorts of files that contain layout information.
6606 Layout files, strictly so called, have the
6607 \begin_inset Flex Code
6610 \begin_layout Plain Layout
6616 extension and provide \SpecialChar LyX
6617 with information about document classes.
6618 Since \SpecialChar LyX
6619 1.6 layout information can also be contained in layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6634 Modules are to \SpecialChar LaTeX
6635 packages much as layouts are to \SpecialChar LaTeX
6636 classes, and some modules—such
6638 \begin_inset Flex Code
6641 \begin_layout Plain Layout
6647 module—specifically provide support for one package.
6648 In a sense, layout modules are similar to included
6652 \begin_layout Plain Layout
6653 These can have any extension, but by convention have the
6654 \begin_inset Flex Code
6657 \begin_layout Plain Layout
6669 \begin_inset Flex Code
6672 \begin_layout Plain Layout
6678 —in that modules are not specific to a given document class but may be used
6679 with many different classes.
6680 The difference is that using an included file with
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6690 requires editing that file.
6691 Modules, by contrast, are selected in the
6692 \begin_inset Flex Noun
6695 \begin_layout Plain Layout
6696 Document\SpecialChar menuseparator
6705 \begin_layout Standard
6706 Building modules is the easiest way to get started with layout editing,
6707 since it can be as simple as adding a single new paragraph style or flex
6709 But modules may, in principle, contain anything a layout file can contain.
6712 \begin_layout Standard
6713 After creating a new module and copying it to the
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6723 folder, you will need to reconfigure and then restart \SpecialChar LyX
6726 However, changes you make to the module will be seen immediately, if you
6728 \begin_inset Flex Noun
6731 \begin_layout Plain Layout
6732 Document\SpecialChar menuseparator
6738 , highlight something, and then hit
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6749 It is strongly recommended that you save your work before doing this
6754 it is strongly recommended that you not attempt to edit modules while simultaneo
6755 usly working on actual documents
6758 Though of course the developers strive to keep \SpecialChar LyX
6759 stable in such situations,
6760 syntax errors and the like in your module file could cause strange behavior.
6763 \begin_layout Subsubsection
6767 \begin_layout Standard
6768 Modules are to \SpecialChar LyX
6769 as packages are to \SpecialChar LaTeX
6771 Sometimes, however, you find yourself wanting a specific inset or character
6772 style just for one document and writing a module that will also be available
6773 to other documents makes little sense.
6774 What you need is \SpecialChar LyX
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6786 \begin_layout Standard
6787 You will find it under
6789 Document\SpecialChar menuseparator
6790 Settings\SpecialChar menuseparator
6794 The large text box allows you to enter anything that you might enter in
6795 a layout file or module.
6796 You can think of a document's local layout, in fact, as a module that belongs
6798 So, in particular, you must enter a
6799 \begin_inset Flex Code
6802 \begin_layout Plain Layout
6809 Any format is acceptable, but one would normally use the format current
6811 (In \SpecialChar LyX
6812 2.3, the current layout format is 63.)
6815 \begin_layout Standard
6816 When you have entered something in the
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 pane, \SpecialChar LyX
6828 \begin_inset Quotes eld
6832 \begin_inset Quotes erd
6835 button at the bottom.
6836 Clicking this button will cause \SpecialChar LyX
6837 to determine whether what you have entered
6838 is valid layout information for the chosen format.
6840 will report the result but, unfortunately, will not tell you what errors
6841 there might have been.
6842 These will be written to the terminal, however, if \SpecialChar LyX
6843 is started from a terminal.
6844 You will not be permitted to save your local layout until you have entered
6848 \begin_layout Standard
6849 The warnings at the end of the previous section apply here, too.
6850 Do not play with local layout while you are actually working, especially
6851 if you have not saved your document.
6852 That said, using local layout with a test document can be a very convenient
6853 way to try out layout ideas, or even to start developing a module.
6856 \begin_layout Subsection
6858 \begin_inset Flex Noun
6861 \begin_layout Plain Layout
6870 \begin_layout Standard
6871 There are two situations you are likely to encounter when wanting to support
6872 a new \SpecialChar LaTeX
6873 document class, involving style (
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 ) files and \SpecialChar LaTeX2e
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6895 Supporting a style file is usually fairly easy.
6896 Supporting a new class file is a bit harder.
6897 We'll discuss the former in this section and the latter in the next.
6898 Similar remarks apply, of course, if you want to support a new DocBook
6902 \begin_layout Standard
6903 The easier case is the one in which your new document class is provided
6904 as a style file that is to be used in conjunction with an already supported
6906 For the sake of the example, we'll assume that the style file is called
6908 \begin_inset Flex Noun
6911 \begin_layout Plain Layout
6917 and that it is meant to be used with
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6927 , which is a standard class.
6931 \begin_layout Standard
6932 Start by copying the existing class's layout file into your local directory:
6936 \begin_layout Plain Layout
6937 Of course, which directory is your local directory will vary by platform,
6938 and \SpecialChar LyX
6939 allows you to specify your local directory on startup, too, using
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6958 \begin_layout LyX-Code
6959 cp report.layout ~/.lyx/layouts/myclass.layout
6962 \begin_layout Standard
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6973 and change the line:
6976 \begin_layout LyX-Code
6979 DeclareLaTeXClass{Report (Standard Class)}
6982 \begin_layout Standard
6986 \begin_layout LyX-Code
6989 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6992 \begin_layout Standard
6996 \begin_layout LyX-Code
6998 \begin_inset Newline newline
7004 \begin_inset Newline newline
7010 \begin_layout Standard
7011 near the top of the file.
7014 \begin_layout Standard
7015 Start \SpecialChar LyX
7017 \begin_inset Flex Noun
7020 \begin_layout Plain Layout
7021 Tools\SpecialChar menuseparator
7028 Then restart \SpecialChar LyX
7029 and try creating a new document.
7031 \begin_inset Flex Noun
7034 \begin_layout Plain Layout
7040 " as a document class option in the
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7045 Document\SpecialChar menuseparator
7052 It is likely that some of the sectioning commands and such in your new
7053 class will work differently from how they worked in the base class—
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 in this example—so you can fiddle around with the settings for the different
7064 sections if you wish.
7065 The layout information for sections is contained in
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7075 , but you do not need to copy and change this file.
7076 Instead, you can simply add your changes to your layout file, after the
7078 \begin_inset Flex Code
7081 \begin_layout Plain Layout
7087 , which itself includes
7088 \begin_inset Flex Code
7091 \begin_layout Plain Layout
7098 For example, you might add these lines:
7101 \begin_layout LyX-Code
7105 \begin_layout LyX-Code
7109 \begin_layout LyX-Code
7113 \begin_layout LyX-Code
7117 \begin_layout LyX-Code
7121 \begin_layout Standard
7122 to change the font for chapter headings to sans-serif.
7123 This will override (or, in this case, add to) the existing declaration
7124 for the Chapter style.
7128 \begin_layout Standard
7129 Your new package may also provide commands or environments not present in
7131 In this case, you will want to add these to the layout file.
7133 \begin_inset CommandInset ref
7135 reference "sec:TextClass"
7139 for information on how to do so.
7142 \begin_layout Standard
7144 \begin_inset Flex Noun
7147 \begin_layout Plain Layout
7153 can be used with several different document classes, and even if it cannot,
7154 you might find it easiest just to write a module that you can load with
7156 The simplest possible such module would be:
7159 \begin_layout LyX-Code
7162 DeclareLyXModule{My Class}
7165 \begin_layout LyX-Code
7169 \begin_layout LyX-Code
7170 #Support for myclass.sty.
7173 \begin_layout LyX-Code
7175 \begin_inset Newline newline
7181 \begin_layout LyX-Code
7183 \begin_inset Newline newline
7189 \begin_layout LyX-Code
7191 \begin_inset Newline newline
7197 \begin_inset Newline newline
7203 \begin_layout Standard
7204 A more complex module might modify the behavior of some existing constructs
7205 or define some new ones.
7207 \begin_inset CommandInset ref
7209 reference "sec:TextClass"
7216 \begin_layout Subsection
7218 \begin_inset Flex Noun
7221 \begin_layout Plain Layout
7230 \begin_layout Standard
7231 There are two possibilities here.
7232 One is that the class file is itself based upon an existing document class.
7233 For example, many thesis classes are based upon
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7244 To see whether yours is, look for a line like
7247 \begin_layout LyX-Code
7253 \begin_layout Standard
7255 If so, then you may proceed largely as in the previous section, though
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7261 Declare\SpecialChar LaTeX
7267 line will be different.
7268 If your new class is
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 and it is based upon
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7288 , then the line should read:
7292 \begin_layout Plain Layout
7293 And it will be easiest if you save the file to
7294 \begin_inset Flex Code
7297 \begin_layout Plain Layout
7304 assumes that the document class has the same name as the layout file.
7313 \begin_layout LyX-Code
7316 DeclareLaTeXClass[thesis,book]{thesis}
7319 \begin_layout Standard
7320 If, on the other hand, the new class is not based upon an existing class,
7321 you will probably have to
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 We strongly suggest copying an existing layout file which uses a similar
7332 class and then modifying it, if you can do so.
7333 At least use an existing file as a starting point so you can find out what
7334 items you need to worry about.
7335 Again, the specifics are covered below.
7338 \begin_layout Subsection
7340 \begin_inset CommandInset label
7342 name "subsec:Creating-Templates"
7349 \begin_layout Standard
7350 Once you have written a layout file for a new document class, you might
7351 want to consider writing a
7356 A template acts as a kind of tutorial for your layout, showing how it might
7357 be used, though containing dummy content.
7358 You can of course look at the various templates included with \SpecialChar LyX
7362 \begin_layout Standard
7363 Templates are created just like usual documents: using \SpecialChar LyX
7365 The only difference is that usual documents contain all possible settings,
7366 including the font scheme and the paper size.
7367 Usually a user doesn't want a template to overwrite his preferred settings
7368 for such parameters.
7369 For that reason, the designer of a template should remove the corresponding
7371 \begin_inset Flex Code
7374 \begin_layout Plain Layout
7383 \begin_inset Flex Code
7386 \begin_layout Plain Layout
7394 from the template \SpecialChar LyX
7396 This can be done with any simple text-editor, for example
7397 \begin_inset Flex Code
7400 \begin_layout Plain Layout
7407 \begin_inset Flex Code
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 Put the edited template files you create in
7421 \begin_inset Flex Code
7424 \begin_layout Plain Layout
7430 , copy the ones you use from the global template directory in
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 to the same place, and redefine the template path in the
7441 \begin_inset Flex Noun
7444 \begin_layout Plain Layout
7445 Tools\SpecialChar menuseparator
7446 Preferences\SpecialChar menuseparator
7455 \begin_layout Standard
7456 Note, by the way, that there is a template which has a particular meaning:
7457 \begin_inset Newline linebreak
7461 \begin_inset Flex Code
7464 \begin_layout Plain Layout
7471 This template is loaded every time you create a new document with
7472 \begin_inset Flex Noun
7475 \begin_layout Plain Layout
7476 File\SpecialChar menuseparator
7482 in order to provide useful defaults.
7483 To create this template from inside \SpecialChar LyX
7484 , all you have to do is to open a document
7485 with the correct settings, and use the
7486 \begin_inset Flex Noun
7489 \begin_layout Plain Layout
7490 Save as Document Defaults
7498 \begin_layout Subsection
7499 Upgrading old layout files
7502 \begin_layout Standard
7503 The format of layout files changes with each \SpecialChar LyX
7504 release, so old layout files
7505 need to be converted to the new format.
7507 reads a layout file in an older format, it automatically calls the
7509 \begin_inset Flex Code
7512 \begin_layout Plain Layout
7518 to convert it to a temporary file in current format.
7519 The original file is left untouched.
7520 If you use the layout file often, then, you may want to convert it permanently,
7521 so that \SpecialChar LyX
7522 does not have to do so itself every time.
7523 To do this, you can call the converter manually:
7526 \begin_layout Enumerate
7528 \begin_inset Flex Code
7531 \begin_layout Plain Layout
7538 \begin_inset Flex Code
7541 \begin_layout Plain Layout
7550 \begin_layout Enumerate
7552 \begin_inset Newline newline
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7560 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7566 \begin_inset Newline newline
7570 \begin_inset Flex Code
7573 \begin_layout Plain Layout
7579 is the name of your \SpecialChar LyX
7583 \begin_layout Standard
7584 Note that manual conversion does not affect included files, so these will
7585 have to be converted separately.
7588 \begin_layout Subsection
7589 \begin_inset CommandInset label
7591 name "subsec:Cite-Engine-Files"
7598 \begin_layout Standard
7599 A specific form of layout files are the so-called
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7609 files that are located in the
7610 \begin_inset Flex Code
7613 \begin_layout Plain Layout
7620 Their purpose is to define the specifics of \SpecialChar LaTeX
7621 packages aimed at bibliography
7634 , but also the way how normal Bib\SpecialChar TeX
7635 citations (without additional packages)
7636 are handled in \SpecialChar LyX
7637 is defined in such a file.
7641 \begin_layout Standard
7642 More specifically, it is defined which packages \SpecialChar LyX
7643 needs to load, which citation
7644 commands are available, how these are to be displayed in \SpecialChar LyX
7646 the dialogs, the context menus) as well as in the XHTML and plain text
7648 Furthermore, the files specify available style variants (author-year, numerical
7649 , etc.) and their specifics.
7650 The cite engine files are also used to generate the options that are available
7653 Document\SpecialChar menuseparator
7654 Settings\SpecialChar menuseparator
7655 Bibliography\SpecialChar menuseparator
7661 \begin_layout Standard
7662 Even though a cite engine file is essentially a normal layout file that
7663 could theoretically include any layout information, it usually primarily
7664 includes some specific parameters such as
7665 \begin_inset Flex Code
7668 \begin_layout Plain Layout
7675 \begin_inset Flex Code
7678 \begin_layout Plain Layout
7685 \begin_inset Flex Code
7688 \begin_layout Plain Layout
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7705 The syntax of the latter two is described in
7706 \begin_inset CommandInset ref
7708 reference "subsec:Citation-engine-description"
7716 \begin_inset CommandInset ref
7718 reference "subsec:Citation-format-description"
7722 , as well as in the files themselves.
7725 \begin_layout Section
7726 \begin_inset CommandInset label
7728 name "sec:TextClass"
7732 The layout file format
7735 \begin_layout Standard
7736 The following sections describe how layout files are structured and written.
7737 Our advice is to go slowly, save and test often.
7738 It is really not that hard, except that the multitude of options can become
7739 overwhelming, especially if you try to check out too many at once.
7740 It becomes easier if you use existing layouts of \SpecialChar LyX
7741 as examples/reference
7742 or if you modify an existing layout to your needs.
7745 \begin_layout Standard
7746 Note that all the tags used in layout files are case-insensitive.
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7758 \begin_inset Flex Code
7761 \begin_layout Plain Layout
7768 \begin_inset Flex Code
7771 \begin_layout Plain Layout
7777 are really the same tag.
7778 The possible arguments are printed in brackets after the tag's name.
7779 The default argument is typeset
7780 \begin_inset Flex Code
7783 \begin_layout Plain Layout
7792 If the argument has a data type like
7793 \begin_inset Quotes eld
7797 \begin_inset Quotes erd
7801 \begin_inset Quotes eld
7805 \begin_inset Quotes erd
7808 , the default is shown like this:
7809 \begin_inset Flex Code
7812 \begin_layout Plain Layout
7823 \begin_layout Subsection
7824 The document class declaration and classification
7827 \begin_layout Standard
7828 Lines in a layout file which begin with
7829 \begin_inset Flex Code
7832 \begin_layout Plain Layout
7839 There is one exception to this rule.
7841 \begin_inset Flex Code
7844 \begin_layout Plain Layout
7850 files should begin with lines like:
7853 \begin_layout LyX-Code
7856 #% Do not delete the line below; configure depends on this
7859 \begin_layout LyX-Code
7864 DeclareLaTeXClass{Article (Standard Class)}
7867 \begin_layout LyX-Code
7872 DeclareCategory{Articles}
7875 \begin_layout Standard
7876 The second and third lines are used when you (re)configure \SpecialChar LyX
7878 The layout file is read by the \SpecialChar LaTeX
7880 \begin_inset Flex Code
7883 \begin_layout Plain Layout
7889 , in a special mode where
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7900 The first line is just a \SpecialChar LaTeX
7901 comment, the second one contains the mandatory
7902 declaration of the text class and the third line contains the optional
7903 classification of the class.
7904 If these lines appear in a file named
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 , then they define a text class of name
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7924 (the name of the layout file) which uses the \SpecialChar LaTeX
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7935 (the default is to use the same name as the layout).
7937 \begin_inset Quotes eld
7940 Article (Standard Class)
7941 \begin_inset Quotes erd
7944 that appears above is used as a description of the text class in the
7945 \begin_inset Flex Noun
7948 \begin_layout Plain Layout
7949 Document\SpecialChar menuseparator
7957 \begin_inset Quotes eld
7961 \begin_inset Quotes erd
7964 in the example) is also used in the
7965 \begin_inset Flex Noun
7968 \begin_layout Plain Layout
7969 Document\SpecialChar menuseparator
7975 dialog: the text classes are grouped by these categories (which are usually
7976 genres, so typical categories are
7977 \begin_inset Quotes eld
7981 \begin_inset Quotes erd
7985 \begin_inset Quotes eld
7989 \begin_inset Quotes erd
7993 \begin_inset Quotes eld
7997 \begin_inset Quotes erd
8001 \begin_inset Quotes eld
8005 \begin_inset Quotes erd
8009 \begin_inset Quotes eld
8013 \begin_inset Quotes erd
8017 \begin_inset Quotes eld
8021 \begin_inset Quotes erd
8025 If no category has been declared, the class will be put in the
8026 \begin_inset Quotes eld
8030 \begin_inset Quotes erd
8036 \begin_layout Standard
8037 Let's assume that you wrote your own text class that uses the
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8047 document class, but where you changed the appearance of the section headings.
8048 If you put it in a file
8049 \begin_inset Flex Code
8052 \begin_layout Plain Layout
8058 , the header of this file should be:
8061 \begin_layout LyX-Code
8064 #% Do not delete the line below; configure depends on this
8067 \begin_layout LyX-Code
8072 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8075 \begin_layout LyX-Code
8080 DeclareCategory{Articles}
8083 \begin_layout Standard
8084 This declares a text class
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8094 , associated with the \SpecialChar LaTeX
8096 \begin_inset Flex Code
8099 \begin_layout Plain Layout
8106 \begin_inset Quotes eld
8109 Article (with My Own Headings)
8110 \begin_inset Quotes erd
8114 If your text class depends on several packages, you can declare it as:
8117 \begin_layout LyX-Code
8120 #% Do not delete the line below; configure depends on this
8123 \begin_layout LyX-Code
8128 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8131 \begin_layout LyX-Code
8136 DeclareCategory{Articles}
8139 \begin_layout Standard
8140 This indicates that your text class uses the
8141 \begin_inset Flex Code
8144 \begin_layout Plain Layout
8151 Finally, it is also possible to declare classes for DocBook code.
8152 Typical declarations will look like:
8155 \begin_layout LyX-Code
8158 #% Do not delete the line below; configure depends on this
8161 \begin_layout LyX-Code
8166 DeclareDocBookClass[article]{SGML (DocBook Article)}
8169 \begin_layout LyX-Code
8174 DeclareCategory{Articles (DocBook)}
8177 \begin_layout Standard
8178 Note that these declarations can also be given an optional parameter declaring
8179 the name of the document class (but not a list).
8182 \begin_layout Standard
8183 So, to be as explicit as possible, the form of the layout declaration is:
8186 \begin_layout LyX-Code
8191 DeclareLaTeXClass[class,package.sty]{layout description}
8194 \begin_layout LyX-Code
8199 DeclareCategory{category}
8202 \begin_layout Standard
8203 The class need only be specified if the name of the \SpecialChar LaTeX
8205 name of the layout file are different or if there are packages to load.
8206 If the name of the class file is not specified, then \SpecialChar LyX
8208 that it is the same as the name of the layout file.
8211 \begin_layout Standard
8212 When the text class has been modified to your taste, all you have to do
8213 is to copy it either to
8214 \begin_inset Flex Code
8217 \begin_layout Plain Layout
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8234 \begin_inset Flex Noun
8237 \begin_layout Plain Layout
8238 Tools\SpecialChar menuseparator
8244 , exit \SpecialChar LyX
8246 Then your new text class should be available along with the others.
8249 \begin_layout Standard
8250 Once the layout file is installed, you can edit it and see your changes
8251 without having to reconfigure or to restart \SpecialChar LyX
8256 \begin_layout Plain Layout
8257 In versions of \SpecialChar LyX
8258 prior to 1.6, this was not true.
8259 As a result, editing layout files was very time consuming, since you had
8260 constantly to restart \SpecialChar LyX
8266 You can force a reload of the current layout by using the \SpecialChar LyX
8268 \begin_inset Flex Noun
8271 \begin_layout Plain Layout
8278 There is no default binding for this function—though, of course, you can
8279 bind it to a key yourself.
8280 But you will normally use this function simply by entering it in the mini-buffe
8285 \begin_layout Standard
8291 \begin_inset Flex Noun
8294 \begin_layout Plain Layout
8300 is very much an `advanced feature'.
8305 recommended that you save your work before using this function.
8310 recommended that you not attempt to edit layout information while simultaneousl
8311 y working on a document that you care about.
8312 Use a test document.
8313 Syntax errors and the like in your layout file could cause peculiar behavior.
8314 In particular, such errors could cause \SpecialChar LyX
8315 to regard the current layout as
8316 invalid and to attempt to switch to some other layout.
8320 \begin_layout Plain Layout
8321 Really bad syntax errors may even caused \SpecialChar LyX
8323 This is because certain sorts of errors may make \SpecialChar LyX
8334 The \SpecialChar LyX
8335 team strives to keep \SpecialChar LyX
8336 stable in such situations, but safe is better
8341 \begin_layout Plain Layout
8342 While we're giving advice: make regular backups.
8343 And be nice to your mother.
8351 \begin_layout Subsection
8352 The Module declaration
8355 \begin_layout Standard
8356 A module must begin with a line like the following:
8359 \begin_layout LyX-Code
8362 DeclareLyXModule[endnotes.sty]{Endnotes}
8365 \begin_layout Standard
8366 The mandatory argument, in curly brackets, is the name of the module, as
8368 \begin_inset Flex Noun
8371 \begin_layout Plain Layout
8372 Document\SpecialChar menuseparator
8373 Settings\SpecialChar menuseparator
8380 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8382 on which the module depends.
8383 It is also possible to use the form
8384 \begin_inset Flex Noun
8387 \begin_layout Plain Layout
8393 as an optional argument, which declares that the module can only be used
8394 when there exists a conversion chain between the formats `
8395 \begin_inset Flex Code
8398 \begin_layout Plain Layout
8405 \begin_inset Flex Code
8408 \begin_layout Plain Layout
8417 \begin_layout Standard
8418 The module declaration should then be followed by lines like the following:
8422 \begin_layout Plain Layout
8423 Preferably in English if the module should be published with \SpecialChar LyX
8425 This description will appear in the list of messages to be translated and
8426 will be thus translated with the next interface update.
8434 \begin_layout LyX-Code
8438 \begin_layout LyX-Code
8439 #Adds an endnote command, in addition to footnotes.
8443 \begin_layout LyX-Code
8444 #You will need to add
8446 theendnotes in TeX code where you
8449 \begin_layout LyX-Code
8450 #want the endnotes to appear.
8454 \begin_layout LyX-Code
8458 \begin_layout LyX-Code
8459 #Requires: somemodule | othermodule
8462 \begin_layout LyX-Code
8463 #Excludes: badmodule
8466 \begin_layout Standard
8467 The description is used in
8468 \begin_inset Flex Noun
8471 \begin_layout Plain Layout
8472 Document\SpecialChar menuseparator
8473 Settings\SpecialChar menuseparator
8479 to provide the user with information about what the module does.
8481 \begin_inset Flex Code
8484 \begin_layout Plain Layout
8490 line is used to identify other modules with which this one must be used;
8492 \begin_inset Flex Code
8495 \begin_layout Plain Layout
8501 line is used to identify modules with which this one may not be used.
8502 Both are optional, and, as shown, multiple modules should be separated
8503 with the pipe symbol: |.
8504 Note that the required modules are treated disjunctively:
8508 of the required modules must be used.
8513 excluded module may be used.
8514 Note that modules are identified here by their filenames without the
8515 \begin_inset Flex Code
8518 \begin_layout Plain Layout
8526 \begin_inset Flex Code
8529 \begin_layout Plain Layout
8536 \begin_inset Flex Code
8539 \begin_layout Plain Layout
8548 \begin_layout Subsection
8549 The CiteEngine file declaration
8552 \begin_layout Standard
8553 A cite engine file must begin with a line like the following:
8556 \begin_layout LyX-Code
8559 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8562 \begin_layout Standard
8563 The mandatory argument, in curly brackets, is the name of the cite style,
8564 as it should appear in
8565 \begin_inset Flex Noun
8568 \begin_layout Plain Layout
8569 Document\SpecialChar menuseparator
8570 Settings\SpecialChar menuseparator
8577 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8579 on which the cite engine depends.
8582 \begin_layout Standard
8583 The cite engine declaration should then be followed by lines like the following:
8587 \begin_layout Plain Layout
8588 Preferably in English if the module should be published with \SpecialChar LyX
8590 This description will appear in the list of messages to be translated and
8591 will be thus translated with the next interface update.
8599 \begin_layout LyX-Code
8603 \begin_layout LyX-Code
8604 # Biblatex supports many author-year and numerical styles.
8607 \begin_layout LyX-Code
8608 # It is mainly aimed at the Humanities.
8612 \begin_layout LyX-Code
8613 # customizable, fully localized and provides many features
8616 \begin_layout LyX-Code
8617 # that are not possible with BibTeX.
8618 The use of 'biber' as
8621 \begin_layout LyX-Code
8622 # bibliography processor is advised.
8625 \begin_layout LyX-Code
8629 \begin_layout Standard
8630 The description is used in
8631 \begin_inset Flex Noun
8634 \begin_layout Plain Layout
8635 Document\SpecialChar menuseparator
8636 Settings\SpecialChar menuseparator
8642 to provide the user with information about the cite engine.
8645 \begin_layout Subsection
8649 \begin_layout Standard
8650 The first non-comment line of any layout file, included file, or module
8655 contain the file format number:
8658 \begin_layout Description
8659 \begin_inset Flex Code
8662 \begin_layout Plain Layout
8669 \begin_inset Flex Code
8672 \begin_layout Plain Layout
8678 ] The format number of the layout file.
8681 \begin_layout Standard
8682 This tag was introduced with \SpecialChar LyX
8684 \begin_inset space ~
8688 Layout files from older \SpecialChar LyX
8689 versions do not have an explicit file format and
8690 are considered to have
8691 \begin_inset Flex Code
8694 \begin_layout Plain Layout
8696 \begin_inset space ~
8705 The format for the present version of \SpecialChar LyX
8707 But each version of \SpecialChar LyX
8708 is capable of reading earlier versions' layout files,
8709 just as they are capable of reading files produced by earlier versions
8712 There is, however, no provision for converting to earlier formats.
8715 \begin_layout Subsection
8716 \begin_inset CommandInset label
8718 name "subsec:General-text-class"
8722 General text class parameters
8725 \begin_layout Standard
8726 These are general parameters that govern the behavior of an entire document
8732 mean that they must appear in
8733 \begin_inset Flex Code
8736 \begin_layout Plain Layout
8742 files rather than in modules.
8743 A module can contain any layout tag.)
8746 \begin_layout Description
8747 \begin_inset Flex Code
8750 \begin_layout Plain Layout
8756 Adds information that will be output in the
8757 \begin_inset Flex Code
8760 \begin_layout Plain Layout
8766 block when the document is output to XHTML.
8767 Typically, this would be used to output CSS style information, but it can
8768 be used for anything that can appear in
8769 \begin_inset Flex Code
8772 \begin_layout Plain Layout
8780 \begin_inset Quotes eld
8784 \begin_inset Flex Code
8787 \begin_layout Plain Layout
8794 \begin_inset Quotes erd
8800 \begin_layout Description
8801 \begin_inset Flex Code
8804 \begin_layout Plain Layout
8810 Adds information to the document preamble.
8812 \begin_inset Newline newline
8816 \begin_inset Quotes eld
8820 \begin_inset Flex Code
8823 \begin_layout Plain Layout
8830 \begin_inset Quotes erd
8836 \begin_layout Description
8837 \begin_inset Flex Code
8840 \begin_layout Plain Layout
8846 Defines the possibilities for displaying citation references.
8848 \begin_inset CommandInset ref
8850 reference "subsec:Citation-engine-description"
8859 \begin_inset Quotes eld
8863 \begin_inset Flex Code
8866 \begin_layout Plain Layout
8873 \begin_inset Quotes erd
8877 Primarily used in cite engine files (see
8878 \begin_inset CommandInset ref
8880 reference "subsec:Cite-Engine-Files"
8890 \begin_layout Description
8891 \begin_inset Flex Code
8894 \begin_layout Plain Layout
8900 Defines formats for use in the display of bibliographic information.
8902 \begin_inset CommandInset ref
8904 reference "subsec:Citation-format-description"
8910 \begin_inset Quotes eld
8914 \begin_inset Flex Code
8917 \begin_layout Plain Layout
8924 \begin_inset Quotes erd
8928 Primarily used in cite engine files (see
8929 \begin_inset CommandInset ref
8931 reference "subsec:Cite-Engine-Files"
8941 \begin_layout Description
8942 \begin_inset Flex Code
8945 \begin_layout Plain Layout
8952 \begin_inset Flex Code
8955 \begin_layout Plain Layout
8964 \begin_inset Flex Code
8967 \begin_layout Plain Layout
8973 ] Determines whether
8977 or Bib\SpecialChar TeX
8978 is used to generate a Bibliography.
8979 Primarily used in cite engine files (see
8980 \begin_inset CommandInset ref
8982 reference "subsec:Cite-Engine-Files"
8992 \begin_layout Description
8993 \begin_inset Flex Code
8996 \begin_layout Plain Layout
9002 Describes various global options supported by the document class.
9004 \begin_inset CommandInset ref
9006 reference "subsec:ClassOptions"
9012 \begin_inset Quotes eld
9016 \begin_inset Flex Code
9019 \begin_layout Plain Layout
9026 \begin_inset Quotes erd
9032 \begin_layout Description
9033 \begin_inset Flex Code
9036 \begin_layout Plain Layout
9043 \begin_inset Flex Code
9046 \begin_layout Plain Layout
9055 \begin_inset space \thinspace{}
9059 \begin_inset Flex Code
9062 \begin_layout Plain Layout
9068 ] Whether the class should
9072 to having one or two columns.
9073 Can be changed in the
9074 \begin_inset Flex Noun
9077 \begin_layout Plain Layout
9078 Document\SpecialChar menuseparator
9087 \begin_layout Description
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9098 \begin_inset Flex Code
9101 \begin_layout Plain Layout
9107 ] This sequence defines the properties for a counter.
9108 If the counter does not yet exist, it is created; if it does exist, it
9111 \begin_inset Quotes eld
9115 \begin_inset Flex Code
9118 \begin_layout Plain Layout
9125 \begin_inset Quotes erd
9129 \begin_inset Newline newline
9133 \begin_inset CommandInset ref
9135 reference "subsec:Counters"
9139 for details on counters.
9142 \begin_layout Description
9143 \begin_inset Flex Code
9146 \begin_layout Plain Layout
9152 Sets the default font used to display the document.
9154 \begin_inset CommandInset ref
9156 reference "subsec:Font-description"
9160 for how to declare fonts.
9162 \begin_inset Quotes eld
9166 \begin_inset Flex Code
9169 \begin_layout Plain Layout
9176 \begin_inset Quotes erd
9182 \begin_layout Description
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9202 ] Specifies a module to be included by default with this document class.
9203 The module is specified as filename without the
9204 \begin_inset Flex Code
9207 \begin_layout Plain Layout
9214 The user can still remove the module, but it will be active at the outset.
9215 (This applies only when new files are created, or when this class is chosen
9216 for an existing document.)
9219 \begin_layout Description
9220 \begin_inset Flex Code
9223 \begin_layout Plain Layout
9230 \begin_inset Flex Code
9233 \begin_layout Plain Layout
9239 ] This is the style that will be assigned to new paragraphs, usually
9240 \begin_inset Flex Noun
9243 \begin_layout Plain Layout
9250 This will default to the first defined style if not given, but you are
9251 encouraged to use this directive.
9254 \begin_layout Description
9255 \begin_inset Flex Code
9258 \begin_layout Plain Layout
9265 \begin_inset Flex Code
9268 \begin_layout Plain Layout
9274 ] This tag indicates that the module (which is specified by filename without
9276 \begin_inset Flex Code
9279 \begin_layout Plain Layout
9285 extension) cannot be used with this document class.
9286 This might be used in a journal-specific layout file to prevent, say, the
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9297 module that numbers theorems by section.
9302 be used in a module.
9303 Modules have their own way of excluding other modules (see
9304 \begin_inset CommandInset ref
9306 reference "subsec:Layout-modules"
9313 \begin_layout Description
9314 \begin_inset Flex Code
9317 \begin_layout Plain Layout
9323 Defines a new float.
9325 \begin_inset CommandInset ref
9327 reference "subsec:Floats"
9333 \begin_inset Quotes eld
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9347 \begin_inset Quotes erd
9353 \begin_layout Description
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 Sets the information that will be output in the
9364 \begin_inset Flex Code
9367 \begin_layout Plain Layout
9373 block when this document class is output to XHTML.
9374 Note that this will completely override any prior
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9385 \begin_inset Flex Code
9388 \begin_layout Plain Layout
9396 \begin_inset Newline newline
9400 \begin_inset Flex Code
9403 \begin_layout Plain Layout
9409 if you just want to add material to the preamble.) Must end with
9410 \begin_inset Quotes eld
9414 \begin_inset Flex Code
9417 \begin_layout Plain Layout
9424 \begin_inset Quotes erd
9430 \begin_layout Description
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9441 \begin_inset Flex Code
9444 \begin_layout Plain Layout
9450 ] The style to use for the table of contents, bibliography, and so forth,
9451 when the document is output to HTML.
9452 For articles, this should normally be
9453 \begin_inset Flex Code
9456 \begin_layout Plain Layout
9463 \begin_inset Flex Code
9466 \begin_layout Plain Layout
9473 If it is not given, then \SpecialChar LyX
9474 will attempt to figure out which layout to use.
9477 \begin_layout Description
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9488 \begin_inset Flex Code
9491 \begin_layout Plain Layout
9497 ] Modifies the properties of the given counter.
9498 If the counter does not exist, the statement is ignored.
9500 \begin_inset Quotes eld
9504 \begin_inset Flex Code
9507 \begin_layout Plain Layout
9514 \begin_inset Quotes erd
9518 \begin_inset Newline newline
9522 \begin_inset CommandInset ref
9524 reference "subsec:Counters"
9528 for details on counters.
9531 \begin_layout Description
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9551 ] This allows you to include another layout definition file within yours
9552 to avoid duplicating commands.
9553 Common examples are the standard layout files, for example,
9554 \begin_inset Flex Code
9557 \begin_layout Plain Layout
9563 , which contains most of the basic layouts.
9566 \begin_layout Description
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9577 \begin_inset Flex Code
9580 \begin_layout Plain Layout
9586 ] This section (re-)defines the layout of an inset.
9587 It can be applied to an existing inset or to a new, user-defined inset,
9588 e.g., a new character style.
9590 \begin_inset Quotes eld
9594 \begin_inset Flex Code
9597 \begin_layout Plain Layout
9604 \begin_inset Quotes erd
9608 \begin_inset Newline newline
9612 \begin_inset CommandInset ref
9614 reference "subsec:Flex-insets-and"
9618 for more information.
9622 \begin_layout Description
9623 \begin_inset Flex Code
9626 \begin_layout Plain Layout
9633 \begin_inset Flex Code
9636 \begin_layout Plain Layout
9642 ] A string that indicates the width of the left margin on the screen, for
9644 \begin_inset Quotes eld
9648 \begin_inset Flex Code
9651 \begin_layout Plain Layout
9658 \begin_inset Quotes erd
9662 (Note that this is not a `length', like
9663 \begin_inset Quotes eld
9667 \begin_inset Quotes erd
9673 \begin_layout Description
9674 \begin_inset Flex Code
9677 \begin_layout Plain Layout
9684 \begin_inset Flex Code
9687 \begin_layout Plain Layout
9693 ] An integer that determines the maximal number of names displayed in an
9694 author-year citation before the citation switches to
9695 \begin_inset Quotes eld
9699 \begin_inset Quotes erd
9703 Primarily used in cite engine files (see
9704 \begin_inset CommandInset ref
9706 reference "subsec:Cite-Engine-Files"
9716 \begin_layout Description
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9727 \begin_inset Flex Code
9730 \begin_layout Plain Layout
9736 ] Modifies the properties of the given paragraph style.
9737 If the style does not exist, this section is ignored.
9739 \begin_inset Quotes eld
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9753 \begin_inset Quotes erd
9759 \begin_layout Description
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9779 ] Deletes an existing counter, usually one defined in an included file.
9782 \begin_layout Description
9783 \begin_inset Flex Code
9786 \begin_layout Plain Layout
9793 \begin_inset Flex Code
9796 \begin_layout Plain Layout
9802 ] Deletes an existing float.
9803 This is particularly useful when you want to suppress a float that has
9804 been defined in an input file.
9807 \begin_layout Description
9808 \begin_inset Flex Code
9811 \begin_layout Plain Layout
9818 \begin_inset Flex Code
9821 \begin_layout Plain Layout
9827 ] Deletes an existing style.
9830 \begin_layout Description
9831 \begin_inset Flex Code
9834 \begin_layout Plain Layout
9841 \begin_inset Flex Code
9844 \begin_layout Plain Layout
9851 \begin_inset Flex Code
9854 \begin_layout Plain Layout
9860 ] Define a new table of contents with type
9861 \begin_inset Flex Code
9864 \begin_layout Plain Layout
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9881 See also the AddToToc commands.
9884 \begin_layout Description
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Flex Code
9898 \begin_layout Plain Layout
9904 ] The file format (as defined in the \SpecialChar LyX
9905 preferences) produced by this document
9907 It is mainly useful when
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9918 \begin_inset Flex Code
9921 \begin_layout Plain Layout
9927 and one wants to define a new type of literate document.
9928 The format is reset to
9929 \begin_inset Quotes eld
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9943 \begin_inset Quotes erd
9947 \begin_inset Quotes eld
9951 \begin_inset Flex Code
9954 \begin_layout Plain Layout
9961 \begin_inset Quotes erd
9964 when the corresponding
9965 \begin_inset Flex Code
9968 \begin_layout Plain Layout
9974 parameter is encountered.
9977 \begin_layout Description
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
10002 \begin_inset Flex Code
10005 \begin_layout Plain Layout
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10021 ] Specifies what sort of output documents using this class will produce.
10024 \begin_layout Description
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10035 \begin_inset Flex Code
10038 \begin_layout Plain Layout
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10054 ] Specifies options, given in the second string, for the package named by
10057 \begin_inset Quotes eld
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10065 PackageOptions natbib square
10071 \begin_inset Quotes erd
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 to be loaded with the
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 (For \SpecialChar TeX
10096 perts, this causes \SpecialChar LyX
10098 \begin_inset Flex Code
10101 \begin_layout Plain Layout
10104 PassOptionsToPackage{natbib}{square}
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10122 \begin_layout Description
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10164 ] The default pagestyle.
10165 Can be changed in the
10166 \begin_inset Flex Noun
10169 \begin_layout Plain Layout
10170 Document\SpecialChar menuseparator
10179 \begin_layout Description
10180 \begin_inset Flex Code
10183 \begin_layout Plain Layout
10189 Sets the preamble for the \SpecialChar LaTeX
10191 Note that this will completely override any prior
10192 \begin_inset Flex Code
10195 \begin_layout Plain Layout
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10213 \begin_inset Flex Code
10216 \begin_layout Plain Layout
10222 if you just want to add material to the preamble.) Must end with
10223 \begin_inset Quotes eld
10227 \begin_inset Flex Code
10230 \begin_layout Plain Layout
10237 \begin_inset Quotes erd
10243 \begin_layout Description
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10264 \begin_inset Flex Code
10267 \begin_layout Plain Layout
10276 \begin_inset space \thinspace{}
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] Whether the class already provides the feature
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10300 A feature is in general the name of a package (e.
10301 \begin_inset space \thinspace{}
10305 \begin_inset space \space{}
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10329 \begin_inset space \thinspace{}
10333 \begin_inset space \space{}
10337 \begin_inset Flex Code
10340 \begin_layout Plain Layout
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10358 \begin_inset CommandInset ref
10360 reference "chap:List-of-functions"
10364 for the list of features.
10367 \begin_layout Description
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10387 ] Indicates that this layout provides the functionality of the module mentioned,
10388 which should be specified by the filename without the
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10399 This will typically be used if the layout includes the module directly,
10400 rather than using the
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10410 tag to indicate that it ought to be used.
10411 It could also be used in a module that provided an alternate implementation
10412 of the same functionality.
10415 \begin_layout Description
10416 \begin_inset Flex Code
10419 \begin_layout Plain Layout
10426 \begin_inset Flex Code
10429 \begin_layout Plain Layout
10435 ] Creates a new paragraph style if it does not already exist.
10436 If the style does exist, this section is ignored.
10438 \begin_inset Quotes eld
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10452 \begin_inset Quotes erd
10458 \begin_layout Description
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10469 \begin_inset Flex Code
10472 \begin_layout Plain Layout
10478 ] Whether the class requires the feature
10479 \begin_inset Flex Code
10482 \begin_layout Plain Layout
10489 Multiple features must be separated by commas.
10490 Note that you can only request supported features.
10492 \begin_inset CommandInset ref
10494 reference "chap:List-of-functions"
10498 for the list of features.).
10499 If you require a package with specific options, you can additionally use
10501 \begin_inset Flex Code
10504 \begin_layout Plain Layout
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 ] A string that indicates the width of the right margin on the screen, for
10535 \begin_inset Quotes eld
10539 \begin_inset Flex Code
10542 \begin_layout Plain Layout
10549 \begin_inset Quotes erd
10555 \begin_layout Description
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10575 ] Sets which divisions get numbered.
10577 \begin_inset Newline newline
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10590 counter in \SpecialChar LaTeX
10594 \begin_layout Description
10595 \begin_inset Flex Code
10598 \begin_layout Plain Layout
10605 \begin_inset Flex Code
10608 \begin_layout Plain Layout
10617 \begin_inset space \thinspace{}
10621 \begin_inset Flex Code
10624 \begin_layout Plain Layout
10630 ] Whether the class-default should be printing on one or both sides of the
10632 Can be changed in the
10633 \begin_inset Flex Noun
10636 \begin_layout Plain Layout
10637 Document\SpecialChar menuseparator
10646 \begin_layout Description
10647 \begin_inset Flex Code
10650 \begin_layout Plain Layout
10657 \begin_inset Flex Code
10660 \begin_layout Plain Layout
10666 ] This sequence defines a paragraph style.
10667 If the style does not yet exist, it is created; if it does exist, its parameter
10670 \begin_inset Quotes eld
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10684 \begin_inset Quotes erd
10688 \begin_inset Newline newline
10692 \begin_inset CommandInset ref
10694 reference "subsec:Paragraph-Styles"
10698 for details on paragraph styles.
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 ] The name of the command or environment to be used with
10722 \begin_inset Flex Code
10725 \begin_layout Plain Layout
10734 \begin_layout Description
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10766 ] Indicates what kind of markup is used to define the title of a document.
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 means that the macro with name
10778 \begin_inset Flex Code
10781 \begin_layout Plain Layout
10787 will be inserted after the last layout which has
10788 \begin_inset Quotes eld
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10797 \begin_inset space ~
10806 \begin_inset Quotes erd
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10820 corresponds to the case where all layouts which have
10821 \begin_inset Quotes eld
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10830 \begin_inset space ~
10839 \begin_inset Quotes erd
10842 should be enclosed into the
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10855 \begin_layout Description
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10875 ] Sets which divisions are included in the table of contents.
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10886 counter in \SpecialChar LaTeX
10890 \begin_layout Subsection
10891 \begin_inset Flex Code
10894 \begin_layout Plain Layout
10901 \begin_inset CommandInset label
10903 name "subsec:ClassOptions"
10910 \begin_layout Standard
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10921 section can contain the following entries:
10924 \begin_layout Description
10925 \begin_inset Flex Code
10928 \begin_layout Plain Layout
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10944 ] The list of available font sizes for the document's main font, separated
10946 \begin_inset Quotes eld
10950 \begin_inset Flex Code
10953 \begin_layout Plain Layout
10960 \begin_inset Quotes erd
10966 \begin_layout Description
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 Used to set the DTD line with XML-based output classes.
10978 \begin_inset space \thinspace{}
10982 \begin_inset Quotes eld
10985 -//OASIS//DTD DocBook V4.2//EN
10986 \begin_inset Quotes erd
10992 \begin_layout Description
10993 \begin_inset Flex Code
10996 \begin_layout Plain Layout
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11007 string="empty|plain|headings|fancy"
11012 ] The list of available page sty\SpecialChar softhyphen
11014 \begin_inset Quotes eld
11018 \begin_inset Flex Code
11021 \begin_layout Plain Layout
11028 \begin_inset Quotes erd
11034 \begin_layout Description
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11054 ] Some document class options, separated by a comma, that will be added
11055 to the optional part of the
11056 \begin_inset Flex Code
11059 \begin_layout Plain Layout
11070 \begin_layout Standard
11072 \begin_inset Flex Code
11075 \begin_layout Plain Layout
11081 section must end with
11082 \begin_inset Quotes eld
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11096 \begin_inset Quotes erd
11102 \begin_layout Subsection
11104 \begin_inset CommandInset label
11106 name "subsec:Paragraph-Styles"
11113 \begin_layout Standard
11114 A paragraph style description looks like this:
11118 \begin_layout Plain Layout
11119 Note that this will either define a new style or modify an existing one.
11127 \begin_layout LyX-Code
11134 \begin_layout LyX-Code
11138 \begin_layout LyX-Code
11142 \begin_layout Standard
11143 where the following commands are allowed:
11146 \begin_layout Description
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11157 \begin_inset Flex Code
11160 \begin_layout Plain Layout
11166 =""] This paragraph will appear in the table of contents of the given type.
11167 An empty string disables.
11168 See also the OutlinerName and the IsTocCaption commands.
11172 \begin_layout Description
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11191 , left, right, center
11196 ] Paragraph alignment.
11199 \begin_layout Description
11200 \begin_inset Flex Code
11203 \begin_layout Plain Layout
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11218 , left, right, center
11223 ] A comma separated list of permitted alignments.
11224 (Some \SpecialChar LaTeX
11225 styles prohibit certain alignments, since those wouldn't make sense.
11226 For example a right-aligned or centered enumeration isn't possible.)
11229 \begin_layout Description
11230 \begin_inset Flex Code
11233 \begin_layout Plain Layout
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11249 ] Defines argument number <int> of a command\SpecialChar breakableslash
11250 environment associated with
11252 This is useful for things like section headings, and only makes sense with
11255 Every (optional or required) argument of a command or environment – except
11256 for the required argument that is associated with the content of the paragraph
11257 itself – has a separate definition, where the number specifies the order
11259 The definition must end with
11260 \begin_inset Flex Code
11263 \begin_layout Plain Layout
11270 So a command with two optional arguments has:
11274 \begin_layout Quote
11280 \begin_layout Quote
11286 \begin_layout Quote
11292 \begin_layout Quote
11298 \begin_layout Quote
11304 \begin_layout Quote
11310 \begin_layout Standard
11312 \begin_inset Flex Code
11315 \begin_layout Plain Layout
11321 definition, the following specifications are possible:
11324 \begin_layout Itemize
11325 \begin_inset Flex Code
11328 \begin_layout Plain Layout
11335 \begin_inset Flex Code
11338 \begin_layout Plain Layout
11344 The string that will appear both in the menu (to insert this argument)
11345 and on the argument inset button (unless you also specify a separate
11346 \begin_inset Flex Code
11349 \begin_layout Plain Layout
11356 For the menu, you can define an accelerator by appending the respective
11357 character to the string, divided by
11358 \begin_inset Quotes eld
11362 \begin_inset Quotes erd
11366 \begin_inset space \thinspace{}
11370 \begin_inset space \space{}
11374 \begin_inset Quotes eld
11378 \begin_inset Flex Code
11381 \begin_layout Plain Layout
11388 \begin_inset Quotes erd
11394 \begin_layout Itemize
11395 \begin_inset Flex Code
11398 \begin_layout Plain Layout
11405 \begin_inset Flex Code
11408 \begin_layout Plain Layout
11414 A separate string for the menu.
11415 You can define an accelerator by appending the respective character to
11416 the string, divided by
11417 \begin_inset Quotes eld
11421 \begin_inset Quotes erd
11425 \begin_inset space \thinspace{}
11429 \begin_inset space \space{}
11433 \begin_inset Quotes eld
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11447 \begin_inset Quotes erd
11451 This specification is optional.
11452 If it is not given the
11453 \begin_inset Flex Code
11456 \begin_layout Plain Layout
11462 will be used instead for the menu.
11465 \begin_layout Itemize
11466 \begin_inset Flex Code
11469 \begin_layout Plain Layout
11476 \begin_inset Flex Code
11479 \begin_layout Plain Layout
11485 A longer explanatory text that appears in the tooltip when hovering over
11486 the argument inset.
11489 \begin_layout Itemize
11490 \begin_inset Flex Code
11493 \begin_layout Plain Layout
11500 \begin_inset Flex Code
11503 \begin_layout Plain Layout
11512 \begin_inset space \thinspace{}
11516 \begin_inset Flex Code
11519 \begin_layout Plain Layout
11525 ] Declare if this is a mandatory (1) or an optional (0) argument.
11526 Mandatory arguments will be output empty if not given, while optional arguments
11527 will not be output at all.
11528 By default, mandatory arguments are delimited by
11529 \begin_inset Flex Code
11532 \begin_layout Plain Layout
11538 , while optional arguments are delimited by
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11551 \begin_layout Itemize
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11571 defines another argument (by its number) which this argument requires to
11572 be output if it is itself output.
11574 \begin_inset space \thinspace{}
11577 g., in \SpecialChar LaTeX
11578 commands, optional arguments often require previous optional arguments
11579 to be output (at least empty), as in
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11586 command[][argument]{text}
11592 This can be achieved by the statement
11593 \begin_inset Flex Code
11596 \begin_layout Plain Layout
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11615 \begin_layout Itemize
11616 \begin_inset Flex Code
11619 \begin_layout Plain Layout
11626 \begin_inset Flex Code
11629 \begin_layout Plain Layout
11635 defines a custom left delimiter (instead of
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11646 \begin_inset Flex Code
11649 \begin_layout Plain Layout
11656 A line break in the output can be indicated by
11657 \begin_inset Flex Code
11660 \begin_layout Plain Layout
11669 \begin_layout Itemize
11670 \begin_inset Flex Code
11673 \begin_layout Plain Layout
11680 \begin_inset Flex Code
11683 \begin_layout Plain Layout
11689 defines a custom right delimiter (instead of
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11700 \begin_inset Flex Code
11703 \begin_layout Plain Layout
11710 A line break in the output can be indicated by
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11723 \begin_layout Itemize
11724 \begin_inset Flex Code
11727 \begin_layout Plain Layout
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11743 defines an argument that is inserted if and only if no user-specified arguments
11745 \begin_inset space \thinspace{}
11749 \begin_inset space \space{}
11752 if no argument inset has been inserted (note that also an empty argument
11753 inset omits the DefaultArg).
11754 Multiple arguments need to be separated by comma.
11757 \begin_layout Itemize
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11777 defines an argument that is inserted in any case (alone or in addition
11778 to user-specified arguments).
11779 Multiple arguments need to be separated by comma.
11782 \begin_layout Itemize
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11792 The font used for the argument content, see
11793 \begin_inset CommandInset ref
11795 reference "subsec:Font-description"
11802 \begin_layout Itemize
11803 \begin_inset Flex Code
11806 \begin_layout Plain Layout
11812 The font used for the label; see
11813 \begin_inset CommandInset ref
11815 reference "subsec:Font-description"
11822 \begin_layout Itemize
11823 \begin_inset Flex Code
11826 \begin_layout Plain Layout
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11841 , Minimalistic, Conglomerate
11846 ] describes the rendering style used for the inset's frame and buttons.
11849 \begin_layout Itemize
11850 \begin_inset Flex Code
11853 \begin_layout Plain Layout
11860 \begin_inset Flex Code
11863 \begin_layout Plain Layout
11870 \begin_inset Flex Code
11873 \begin_layout Plain Layout
11879 , this argument is automatically inserted when the respective style is selected.
11880 Currently, only one argument per style\SpecialChar breakableslash
11881 layout can be automatically inserted.
11884 \begin_layout Itemize
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11914 , this argument will be inserted with a copy of the co-text (either selected
11915 text or the whole paragraph) as content.
11918 \begin_layout Itemize
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11929 \begin_inset Flex Code
11932 \begin_layout Plain Layout
11942 ] Whether the contents of this argument should be output in raw form, meaning
11943 without special translations that \SpecialChar LaTeX
11946 \begin_inset Flex Code
11949 \begin_layout Plain Layout
11955 status is inherited by the inset or paragraph layout the argument belongs
11956 to, true and false change the status for the given argument only.
11959 \begin_layout Itemize
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11970 \begin_inset Flex Code
11973 \begin_layout Plain Layout
11974 string of characters
11983 Defines individual characters
11984 \begin_inset Newline linebreak
11987 that should be output in raw form, meaning without special translations
11988 that \SpecialChar LaTeX
11990 Note that, contrary to PassThru, this needs to be explicitly defined for
11992 That is, arguments do not inherit PassThruChars from their parent inset
11996 \begin_layout Itemize
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12019 \begin_inset space \thinspace{}
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12032 ] If this is set to 1, the argument will output its content in the corresponding
12033 item in the table of contents.
12037 \begin_layout Standard
12038 By default, the text entered in the \SpecialChar LyX
12039 workarea in the respective layout is
12040 the last (mandatory) argument of a command if the
12041 \begin_inset Flex Code
12044 \begin_layout Plain Layout
12051 \begin_inset Flex Code
12054 \begin_layout Plain Layout
12061 However, arguments with the prefix
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12071 are output after this workarea argument.
12072 Note that post-argument numbering restarts at 1, so the first argument
12073 following the workarea argument is
12074 \begin_inset Flex Code
12077 \begin_layout Plain Layout
12084 Post-arguments are ignored in any other
12085 \begin_inset Flex Code
12088 \begin_layout Plain Layout
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12107 \begin_layout Standard
12109 \begin_inset Flex Code
12112 \begin_layout Plain Layout
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12142 followed by the number (e.
12143 \begin_inset space \thinspace{}
12147 \begin_inset space \space{}
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12164 \begin_layout Description
12165 \begin_inset Flex Code
12168 \begin_layout Plain Layout
12174 Includes a comma-separated list of layouts that should be nested in and
12175 after the current layout.
12176 Only makes sense for nestable layouts (such as environments).
12178 \begin_inset Quotes eld
12182 \begin_inset Flex Code
12185 \begin_layout Plain Layout
12192 \begin_inset Quotes erd
12197 \begin_inset Flex Code
12200 \begin_layout Plain Layout
12209 \begin_layout Description
12210 \begin_inset Flex Code
12213 \begin_layout Plain Layout
12219 Note that this will completely override any prior
12220 \begin_inset Flex Code
12223 \begin_layout Plain Layout
12229 declaration for this style.
12231 \begin_inset Quotes eld
12235 \begin_inset Flex Code
12238 \begin_layout Plain Layout
12245 \begin_inset Quotes erd
12250 \begin_inset CommandInset ref
12252 reference "subsec:I18n"
12256 for details on its use.
12259 \begin_layout Description
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12270 \begin_inset Flex Code
12273 \begin_layout Plain Layout
12283 \begin_layout Plain Layout
12284 Note that a `float' here is a real number, such as: 1.5.
12289 The vertical space with which the last of a chain of paragraphs with this
12290 style is separated from the following paragraph.
12291 If the next paragraph has another style, the separations are not simply
12292 added, but the maximum is taken.
12295 \begin_layout Description
12296 \begin_inset Flex Code
12299 \begin_layout Plain Layout
12306 \begin_inset Flex Code
12309 \begin_layout Plain Layout
12315 ] The category for this style.
12316 This is used to group related styles in the style combobox on the toolbar.
12317 Any string can be used, but you may want to use existing categories with
12322 \begin_layout Description
12323 \begin_inset Flex Code
12326 \begin_layout Plain Layout
12332 Depth of XML command.
12333 Used only with XML-type formats.
12336 \begin_layout Description
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12347 \begin_inset Flex Code
12350 \begin_layout Plain Layout
12356 ] Copies all the features of an existing style into the current one.
12360 \begin_layout Description
12361 \begin_inset Flex Code
12364 \begin_layout Plain Layout
12371 \begin_inset Flex Code
12374 \begin_layout Plain Layout
12380 ] The name of a style whose preamble should be output
12385 This allows to ensure some ordering of the preamble snippets when macros
12386 definitions depend on one another.
12390 \begin_layout Plain Layout
12391 Note that, besides that functionality, there is no way to ensure any ordering
12393 The ordering that you see in a given version of \SpecialChar LyX
12394 may change without warning
12403 \begin_layout Description
12404 \begin_inset Flex Code
12407 \begin_layout Plain Layout
12414 \begin_inset Flex Code
12417 \begin_layout Plain Layout
12422 , Box, Filled_Box, Static
12427 ] The type of label that stands at the end of the paragraph (or sequence
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12439 \begin_inset Newline newline
12443 \begin_inset Flex Code
12446 \begin_layout Plain Layout
12453 \begin_inset Flex Code
12456 \begin_layout Plain Layout
12463 \begin_inset Flex Code
12466 \begin_layout Plain Layout
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12484 \begin_inset Quotes eld
12488 \begin_inset Quotes erd
12492 \begin_inset Flex Code
12495 \begin_layout Plain Layout
12502 \begin_inset space \space{}
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12515 ) is a white (resp.
12516 \begin_inset space ~
12519 black) square suitable for end of proof markers,
12520 \begin_inset Flex Code
12523 \begin_layout Plain Layout
12529 is an explicit text string.
12532 \begin_layout Description
12533 \begin_inset Flex Code
12536 \begin_layout Plain Layout
12543 \begin_inset Flex Code
12546 \begin_layout Plain Layout
12552 ] The string used for a label with a
12553 \begin_inset Flex Code
12556 \begin_layout Plain Layout
12563 \begin_inset Newline newline
12567 \begin_inset Flex Code
12570 \begin_layout Plain Layout
12580 \begin_layout Description
12581 \begin_inset Flex Code
12584 \begin_layout Plain Layout
12590 The font used for both the text body
12596 \begin_inset CommandInset ref
12598 reference "subsec:Font-description"
12603 Note that defining this font automatically defines the
12604 \begin_inset Flex Code
12607 \begin_layout Plain Layout
12614 So you should define this one first if you also want to define
12615 \begin_inset Flex Code
12618 \begin_layout Plain Layout
12627 \begin_layout Description
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12647 ] Used for backporting new styles to stable \SpecialChar LyX
12649 The first stable version that supports this tag is \SpecialChar LyX
12651 The argument is a number which may either be 0, -1 or any value greater
12654 \begin_inset Flex Code
12657 \begin_layout Plain Layout
12663 flag of a style is greater than zero, it will always be written to the
12665 If a .lyx file is read, the style definitions from the document header are
12666 added to the document class.
12667 Therefore even older \SpecialChar LyX
12668 versions can handle the style.
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12679 is a version number: if the style is read, and the version number is less
12680 than the version number of the already existing style in the document class,
12681 the new style is ignored.
12682 If the version number is greater, the new style replaces the existing style.
12683 A value of -1 means an infinite version number, i.
12684 \begin_inset space \thinspace{}
12688 \begin_inset space \space{}
12691 the style is always used.
12694 \begin_layout Description
12695 \begin_inset Flex Code
12698 \begin_layout Plain Layout
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12717 \begin_inset space \thinspace{}
12721 \begin_inset Flex Code
12724 \begin_layout Plain Layout
12730 ] Usually \SpecialChar LyX
12731 does not allow you to insert more than one space between words,
12732 since a space is considered as the separation between two words, not a
12733 character or symbol of its own.
12734 This is a very fine thing but sometimes annoying, for example, when typing
12735 program code or plain \SpecialChar LaTeX
12738 \begin_inset Flex Code
12741 \begin_layout Plain Layout
12748 Note that \SpecialChar LyX
12749 will create protected blanks for the additional blanks when
12750 in another mode than \SpecialChar LaTeX
12754 \begin_layout Description
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12764 These tags are used with XHTML output.
12766 \begin_inset CommandInset ref
12768 reference "subsec:Paragraph-Style-XHTML"
12775 \begin_layout Description
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12785 [FIXME] (Used only with XML-type formats.)
12788 \begin_layout Description
12789 \begin_inset Flex Code
12792 \begin_layout Plain Layout
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12811 \begin_inset space \thinspace{}
12815 \begin_inset Flex Code
12818 \begin_layout Plain Layout
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12834 , marks the style as to be included in the document preamble and not in
12836 This is useful for document classes that want such information as the title
12837 and author to appear in the preamble.
12838 Note that this works only for styles for which the
12839 \begin_inset Flex Code
12842 \begin_layout Plain Layout
12849 \begin_inset Flex Code
12852 \begin_layout Plain Layout
12859 \begin_inset Flex Code
12862 \begin_layout Plain Layout
12871 \begin_layout Description
12872 \begin_inset Flex Code
12875 \begin_layout Plain Layout
12882 \begin_inset Flex Code
12885 \begin_layout Plain Layout
12894 \begin_inset space \thinspace{}
12898 \begin_inset Flex Code
12901 \begin_layout Plain Layout
12908 \begin_inset Flex Code
12911 \begin_layout Plain Layout
12917 , marks the style as being part of a title block (see also the
12918 \begin_inset Flex Code
12921 \begin_layout Plain Layout
12928 \begin_inset Flex Code
12931 \begin_layout Plain Layout
12940 \begin_layout Description
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12950 Includes a comma-separated list of layouts after which this one should
12952 Only makes sense with regard to nestable layouts (such as environments).
12954 \begin_inset Quotes eld
12958 \begin_inset Flex Code
12961 \begin_layout Plain Layout
12968 \begin_inset Quotes erd
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12985 \begin_layout Description
12986 \begin_inset Flex Code
12989 \begin_layout Plain Layout
12996 \begin_inset Flex Code
12999 \begin_layout Plain Layout
13008 \begin_inset space \thinspace{}
13012 \begin_inset Flex Code
13015 \begin_layout Plain Layout
13021 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13022 of its contents in its item in the table of contents.
13023 Otherwise, only the label, if it exists, appears.
13026 \begin_layout Description
13027 \begin_inset Flex Code
13030 \begin_layout Plain Layout
13037 \begin_inset Flex Code
13040 \begin_layout Plain Layout
13046 ] The \SpecialChar LaTeX
13047 command sequence declaring an item in a list.
13048 The command is to be defined without the preceding backslash (the default
13050 \begin_inset Quotes eld
13054 \begin_inset Quotes erd
13058 \begin_inset Flex Code
13061 \begin_layout Plain Layout
13069 in the \SpecialChar LaTeX
13073 \begin_layout Description
13074 \begin_inset Flex Code
13077 \begin_layout Plain Layout
13084 \begin_inset Flex Code
13087 \begin_layout Plain Layout
13093 ] This provides extra space between paragraphs that have the same style.
13094 If you put other styles into an environment, each is separated with the
13096 \begin_inset Flex Code
13099 \begin_layout Plain Layout
13106 But the whole items of the environment are additionally separated with
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13118 Note that this is a
13123 \begin_layout Description
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13133 [FIXME] (Used only with XML-type formats.)
13136 \begin_layout Description
13137 \begin_inset Flex Code
13140 \begin_layout Plain Layout
13147 \begin_inset Flex Code
13150 \begin_layout Plain Layout
13159 \begin_inset space \thinspace{}
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13172 ] Usually \SpecialChar LyX
13173 does not allow you to leave a paragraph empty, since it would
13174 lead to empty \SpecialChar LaTeX
13176 There are some cases where this could be desirable however: in a letter
13177 template, the required fields can be provided as empty fields, so that
13178 people do not forget them; in some special classes, a style can be used
13179 as some kind of break, which does not contain actual text.
13182 \begin_layout Description
13183 \begin_inset Flex Code
13186 \begin_layout Plain Layout
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13202 ] The vertical space between the label and the text body.
13203 Only used for labels that are above the text body (
13204 \begin_inset Flex Code
13207 \begin_layout Plain Layout
13214 \begin_inset Newline newline
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13222 Centered_Top_Environment
13230 \begin_layout Description
13231 \begin_inset Flex Code
13234 \begin_layout Plain Layout
13241 \begin_inset Flex Code
13244 \begin_layout Plain Layout
13250 ] The name of the counter for automatic numbering.
13251 In order to have the counter appear with your label, you will need to reference
13253 \begin_inset Flex Code
13256 \begin_layout Plain Layout
13265 This will work with
13266 \begin_inset Flex Code
13269 \begin_layout Plain Layout
13276 \begin_inset Flex Code
13279 \begin_layout Plain Layout
13286 \begin_inset Flex Code
13289 \begin_layout Plain Layout
13296 \begin_inset Flex Code
13299 \begin_layout Plain Layout
13306 \begin_inset Newline newline
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13324 \begin_inset Flex Code
13327 \begin_layout Plain Layout
13333 , though this case is a bit complicated.
13334 Suppose you declare
13335 \begin_inset Quotes eld
13339 \begin_inset Flex Code
13342 \begin_layout Plain Layout
13343 LabelCounter myenum
13349 \begin_inset Quotes erd
13353 Then the actual counters used are
13354 \begin_inset Flex Code
13357 \begin_layout Plain Layout
13364 \begin_inset Flex Code
13367 \begin_layout Plain Layout
13374 \begin_inset Flex Code
13377 \begin_layout Plain Layout
13384 \begin_inset Flex Code
13387 \begin_layout Plain Layout
13393 , much as in \SpecialChar LaTeX
13395 These counters must all be declared separately.
13396 \begin_inset Newline newline
13400 \begin_inset CommandInset ref
13402 reference "subsec:Counters"
13406 for details on counters.
13409 \begin_layout Description
13410 \begin_inset Flex Code
13413 \begin_layout Plain Layout
13419 The font used for the label.
13421 \begin_inset CommandInset ref
13423 reference "subsec:Font-description"
13430 \begin_layout Description
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13450 ] Text that indicates how far a label should be indented.
13453 \begin_layout Description
13454 \begin_inset Flex Code
13457 \begin_layout Plain Layout
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13473 ] Text that indicates the amount of horizontal space between the label and
13475 Only used for labels that are not above the text body.
13478 \begin_layout Description
13479 \begin_inset Flex Code
13482 \begin_layout Plain Layout
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13498 ] The string used for the label.
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13509 is set, this string can be contain the special formatting commands described
13511 \begin_inset CommandInset ref
13513 reference "subsec:Counters"
13520 \begin_layout Description
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13525 LabelStringAppendix
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13540 ] This is used inside the appendix instead of
13541 \begin_inset Newline newline
13545 \begin_inset Flex Code
13548 \begin_layout Plain Layout
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13566 \begin_inset Newline newline
13570 \begin_inset Flex Code
13573 \begin_layout Plain Layout
13574 LabelStringAppendix
13582 \begin_layout Description
13583 \begin_inset Flex Code
13586 \begin_layout Plain Layout
13592 [FIXME] (Used only with XML-type formats.)
13595 \begin_layout Description
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13606 \begin_inset Flex Code
13609 \begin_layout Plain Layout
13614 , Manual, Static, Above,
13615 \begin_inset Newline newline
13618 Centered, Sensitive, Enumerate,
13619 \begin_inset Newline newline
13622 Itemize, Bibliography
13631 \begin_layout Description
13632 \begin_inset Flex Code
13635 \begin_layout Plain Layout
13641 means the label is the very first word (up to the first real blank).
13642 Use protected spaces if you want more than one word as the label.
13646 \begin_layout Description
13647 \begin_inset Flex Code
13650 \begin_layout Plain Layout
13656 means the label is simply what is declared as
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13667 This will be displayed
13668 \begin_inset Quotes eld
13672 \begin_inset Quotes erd
13675 , at the beginning of the paragraph.
13677 \begin_inset Flex Code
13680 \begin_layout Plain Layout
13687 \begin_inset Flex Code
13690 \begin_layout Plain Layout
13696 , then it will be displayed only in the first paragraph of any sequence
13697 of paragraphs with the same
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13710 \begin_layout Description
13711 \begin_inset Flex Code
13714 \begin_layout Plain Layout
13721 \begin_inset space ~
13725 \begin_inset space ~
13729 \begin_inset Flex Code
13732 \begin_layout Plain Layout
13738 are special cases of
13739 \begin_inset Flex Code
13742 \begin_layout Plain Layout
13749 The label will be printed above the paragraph either at the beginning of
13750 the line or centered.
13753 \begin_layout Description
13754 \begin_inset Flex Code
13757 \begin_layout Plain Layout
13763 is a special case for the caption-labels
13764 \begin_inset Quotes eld
13768 \begin_inset Quotes erd
13772 \begin_inset Quotes eld
13776 \begin_inset Quotes erd
13780 \begin_inset Newline newline
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13793 means the (hardcoded) label string depends on the kind of float: It is
13794 hardcoded to be `FloatType N', where N is the value of the counter associated
13796 For the case that a caption is inserted outside of a float the
13797 \begin_inset Flex Code
13800 \begin_layout Plain Layout
13807 \begin_inset Quotes eld
13811 \begin_inset Quotes erd
13817 \begin_layout Description
13818 \begin_inset Flex Code
13821 \begin_layout Plain Layout
13827 produces the usual sort of enumeration labels.
13828 The number type needs to be set in the
13833 \begin_inset CommandInset ref
13835 reference "subsec:Counters"
13842 \begin_layout Description
13843 \begin_inset Flex Code
13846 \begin_layout Plain Layout
13852 produces various bullets at the different levels.
13853 The bullet types displayed can be set via
13854 \begin_inset Flex Noun
13857 \begin_layout Plain Layout
13858 Document\SpecialChar menuseparator
13859 Settings\SpecialChar menuseparator
13868 \begin_layout Description
13869 \begin_inset Flex Code
13872 \begin_layout Plain Layout
13878 should be used only with
13879 \begin_inset Flex Code
13882 \begin_layout Plain Layout
13883 LatexType BibEnvironment
13892 \begin_layout Description
13893 \begin_inset Flex Code
13896 \begin_layout Plain Layout
13902 Note that this will completely override any prior
13903 \begin_inset Flex Code
13906 \begin_layout Plain Layout
13912 declaration for this style.
13914 \begin_inset Quotes eld
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13928 \begin_inset Quotes erd
13933 \begin_inset CommandInset ref
13935 reference "subsec:I18n"
13939 for details on its use.
13942 \begin_layout Description
13943 \begin_inset Flex Code
13946 \begin_layout Plain Layout
13953 \begin_inset Flex Code
13956 \begin_layout Plain Layout
13962 ] The name of the corresponding \SpecialChar LaTeX
13964 Either the environment or command name.
13967 \begin_layout Description
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13978 \begin_inset Flex Code
13981 \begin_layout Plain Layout
13987 ] An optional parameter for the corresponding
13988 \begin_inset Flex Code
13991 \begin_layout Plain Layout
13998 This parameter cannot be changed from within \SpecialChar LyX
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14009 for customizable parameters).
14010 This will be output as is after all \SpecialChar LaTeX
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14024 \begin_layout Description
14025 \begin_inset Flex Code
14028 \begin_layout Plain Layout
14035 \begin_inset Flex Code
14038 \begin_layout Plain Layout
14043 , Command, Environment, Item_Environment,
14044 \begin_inset Newline newline
14047 List_Environment, Bib_Environment
14052 ] How the style should be translated into \SpecialChar LaTeX
14057 \begin_layout Plain Layout
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14067 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14068 Visit the SGML class files for specific examples.
14077 \begin_layout Description
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14087 means nothing special.
14090 \begin_layout Description
14091 \begin_inset Flex Code
14094 \begin_layout Plain Layout
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14111 {\SpecialChar ldots
14120 \begin_layout Description
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14131 \begin_inset Flex Code
14134 \begin_layout Plain Layout
14141 }\SpecialChar ldots
14157 \begin_layout Description
14158 \begin_inset Flex Code
14161 \begin_layout Plain Layout
14168 \begin_inset Flex Code
14171 \begin_layout Plain Layout
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14189 is generated for each paragraph of this environment.
14193 \begin_layout Description
14194 \begin_inset Flex Code
14197 \begin_layout Plain Layout
14204 \begin_inset Flex Code
14207 \begin_layout Plain Layout
14214 \begin_inset Newline newline
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14227 is passed as an argument to the environment.
14228 \begin_inset Newline newline
14232 \begin_inset Flex Code
14235 \begin_layout Plain Layout
14241 can be defined in the
14242 \begin_inset Flex Noun
14245 \begin_layout Plain Layout
14246 Edit\SpecialChar menuseparator
14248 \begin_inset space ~
14259 \begin_layout Description
14260 \begin_inset Flex Code
14263 \begin_layout Plain Layout
14270 \begin_inset Flex Code
14273 \begin_layout Plain Layout
14279 but adds the necessary mandatory argument (the longest label) to the begin
14280 statement of the bibliography environment:
14281 \begin_inset Newline newline
14285 \begin_inset Flex Code
14288 \begin_layout Plain Layout
14291 begin{thebibliography}{99}
14297 It is therefore only useful for bibliography environments.
14298 The default longest label
14299 \begin_inset Quotes eld
14303 \begin_inset Quotes erd
14306 can be changed by the user in the paragraph settings of a bibliography
14310 \begin_layout Standard
14311 Putting the last few things together, the \SpecialChar LaTeX
14312 output will be either:
14315 \begin_layout LyX-Code
14318 LatexName[LatexParam]{\SpecialChar ldots
14322 \begin_layout Standard
14326 \begin_layout LyX-Code
14329 begin{LatexName}[LatexParam] \SpecialChar ldots
14335 \begin_layout Standard
14336 depending upon the \SpecialChar LaTeX
14341 \begin_layout Description
14342 \begin_inset Flex Code
14345 \begin_layout Plain Layout
14352 \begin_inset Flex Code
14355 \begin_layout Plain Layout
14361 ] A string that is put at the beginning of the style content.
14362 A line break in the output can be indicated by
14363 \begin_inset Flex Code
14366 \begin_layout Plain Layout
14375 \begin_layout Description
14376 \begin_inset Flex Code
14379 \begin_layout Plain Layout
14386 \begin_inset Flex Code
14389 \begin_layout Plain Layout
14395 ] If you put styles into environments, the different
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14405 are not simply added, but added with a factor
14406 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14410 Note that this parameter is also used when
14411 \begin_inset Flex Code
14414 \begin_layout Plain Layout
14421 \begin_inset Flex Code
14424 \begin_layout Plain Layout
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14441 Then it is added to the manual or dynamic margin.
14442 \begin_inset Newline newline
14446 \begin_inset Quotes eld
14450 \begin_inset Flex Code
14453 \begin_layout Plain Layout
14460 \begin_inset Quotes erd
14463 means that the paragraph is indented with the width of
14464 \begin_inset Quotes eld
14468 \begin_inset Flex Code
14471 \begin_layout Plain Layout
14478 \begin_inset Quotes erd
14481 in the normal font.
14482 You can get a negative width by prefixing the string with
14483 \begin_inset Quotes eld
14487 \begin_inset Flex Code
14490 \begin_layout Plain Layout
14497 \begin_inset Quotes erd
14501 This way was chosen so that the look is the same with each used screen
14505 \begin_layout Description
14506 \begin_inset Flex Code
14509 \begin_layout Plain Layout
14516 \begin_inset Flex Code
14519 \begin_layout Plain Layout
14524 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14530 \begin_inset Newline newline
14533 The kind of margin that the style has on the left side.
14537 \begin_layout Description
14538 \begin_inset Flex Code
14541 \begin_layout Plain Layout
14547 just means a fixed margin.
14550 \begin_layout Description
14551 \begin_inset Flex Code
14554 \begin_layout Plain Layout
14560 means that the left margin depends on the string entered in the
14561 \begin_inset Flex Noun
14564 \begin_layout Plain Layout
14565 Edit\SpecialChar menuseparator
14567 \begin_inset space ~
14576 This is used to typeset nice lists without tabulators.
14579 \begin_layout Description
14580 \begin_inset Flex Code
14583 \begin_layout Plain Layout
14589 means that the margin depends on the size of the label.
14590 This is used for automatic enumerated headlines.
14591 It is obvious that the headline
14592 \begin_inset Quotes eld
14595 5.4.3.2.1 Very long headline
14596 \begin_inset Quotes erd
14599 must have a wider left margin (as wide as
14600 \begin_inset Quotes eld
14604 \begin_inset Quotes erd
14607 plus the space) than
14608 \begin_inset Quotes eld
14611 3.2 Very long headline
14612 \begin_inset Quotes erd
14616 \begin_inset Quotes eld
14620 \begin_inset Quotes erd
14623 are not able to do this.
14626 \begin_layout Description
14627 \begin_inset Flex Code
14630 \begin_layout Plain Layout
14636 is similar, but only the very first row of the paragraph is dynamic, while
14637 the others are static; this is used, for example, for descriptions.
14640 \begin_layout Description
14641 \begin_inset Flex Code
14644 \begin_layout Plain Layout
14650 means the margin is chosen in a way that the longest row of this paragraph
14651 fits to the right margin.
14652 This is used to typeset an address on the right edge of the page.
14656 \begin_layout Description
14657 \begin_inset Flex Code
14660 \begin_layout Plain Layout
14667 \begin_inset Flex Code
14670 \begin_layout Plain Layout
14679 \begin_inset space \thinspace{}
14683 \begin_inset Flex Code
14686 \begin_layout Plain Layout
14692 ] Whether fragile commands in this style should be
14693 \begin_inset Flex Code
14696 \begin_layout Plain Layout
14709 whether this command should itself be protected.)
14712 \begin_layout Description
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14733 \begin_inset space \thinspace{}
14737 \begin_inset Flex Code
14740 \begin_layout Plain Layout
14748 ] Whether newlines are translated into \SpecialChar LaTeX
14750 \begin_inset Flex Code
14753 \begin_layout Plain Layout
14764 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14766 inside \SpecialChar LyX
14770 \begin_layout Description
14771 \begin_inset Flex Code
14774 \begin_layout Plain Layout
14781 \begin_inset Flex Code
14784 \begin_layout Plain Layout
14793 \begin_inset space \thinspace{}
14797 \begin_inset Flex Code
14800 \begin_layout Plain Layout
14806 ] If set to true, and if
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14826 ) paragraphs are being indented, then the indentation of such a paragraph
14827 following one of this type will be suppressed.
14828 (So this will not affect the display of non-default paragraphs.)
14831 \begin_layout Description
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14842 \begin_inset Flex Code
14845 \begin_layout Plain Layout
14851 ] Name of a style that has replaced this style.
14852 This is used to rename a style, while keeping backward compatibility.
14855 \begin_layout Description
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset space \thinspace{}
14880 \begin_inset Flex Code
14883 \begin_layout Plain Layout
14889 ] Determines whether consecutive paragraphs of the same type are treated
14890 as belonging together.
14891 This has the effect that the
14892 \begin_inset Flex Code
14895 \begin_layout Plain Layout
14901 is only printed once before such a group.
14902 By default, this is true for
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14932 and false for all other types.
14935 \begin_layout Description
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14958 \begin_inset space \thinspace{}
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14971 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14973 but only by a line break; together with
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14983 , this allows to emulate a plain text editor (like the ERT inset).
14986 \begin_layout Description
14987 \begin_inset Flex Code
14990 \begin_layout Plain Layout
14997 \begin_inset Flex Code
15000 \begin_layout Plain Layout
15006 ] The indent of the very first line of a paragraph.
15008 \begin_inset Newline newline
15012 \begin_inset Flex Code
15015 \begin_layout Plain Layout
15021 will be fixed for a certain style.
15022 The exception is the default style, since the indentation for these paragraphs
15023 can be prohibited with
15024 \begin_inset Flex Code
15027 \begin_layout Plain Layout
15035 \begin_inset Flex Code
15038 \begin_layout Plain Layout
15044 style paragraphs inside environments use the
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15054 of the environment, not their native one.
15056 \begin_inset Flex Code
15059 \begin_layout Plain Layout
15065 paragraphs inside an enumeration are not indented.
15068 \begin_layout Description
15069 \begin_inset Flex Code
15072 \begin_layout Plain Layout
15079 \begin_inset Flex Code
15082 \begin_layout Plain Layout
15088 ] The vertical space between two paragraphs of this style.
15091 \begin_layout Description
15092 \begin_inset Flex Code
15095 \begin_layout Plain Layout
15102 \begin_inset Flex Code
15105 \begin_layout Plain Layout
15112 allows the user to choose either
15113 \begin_inset Quotes eld
15117 \begin_inset Quotes erd
15121 \begin_inset Quotes eld
15125 \begin_inset Quotes erd
15128 to separate paragraphs.
15130 \begin_inset Quotes eld
15134 \begin_inset Quotes erd
15138 \begin_inset Flex Code
15141 \begin_layout Plain Layout
15149 \begin_inset Quotes eld
15153 \begin_inset Quotes erd
15157 \begin_inset Flex Code
15160 \begin_layout Plain Layout
15166 is ignored and all paragraphs are separated by the
15167 \begin_inset Flex Code
15170 \begin_layout Plain Layout
15177 The vertical space is calculated with
15178 \begin_inset Flex Code
15181 \begin_layout Plain Layout
15183 \begin_inset space ~
15192 \begin_inset Flex Code
15195 \begin_layout Plain Layout
15201 is the height of a row with the normal font.
15202 This way, the look stays the same with different screen fonts.
15205 \begin_layout Description
15206 \begin_inset Flex Code
15209 \begin_layout Plain Layout
15216 \begin_inset Flex Code
15219 \begin_layout Plain Layout
15228 \begin_inset space \thinspace{}
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15241 ] Whether the contents of this paragraph should be output in raw form, meaning
15242 without special translations that \SpecialChar LaTeX
15246 \begin_layout Description
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15257 \begin_inset Flex Code
15260 \begin_layout Plain Layout
15270 Defines individual characters that should be output in raw form, meaning
15271 without special translations that \SpecialChar LaTeX
15275 \begin_layout Description
15276 \begin_inset Flex Code
15279 \begin_layout Plain Layout
15285 Information to be included in the \SpecialChar LaTeX
15286 preamble when this style is used.
15287 Used to define macros, load packages, etc., required by this particular
15290 \begin_inset Quotes eld
15294 \begin_inset Flex Code
15297 \begin_layout Plain Layout
15304 \begin_inset Quotes erd
15310 \begin_layout Description
15311 \begin_inset Flex Code
15314 \begin_layout Plain Layout
15321 \begin_inset Flex Code
15324 \begin_layout Plain Layout
15330 ] The prefix to use when creating labels referring to paragraphs of this
15332 This allows the use of formatted references.
15335 \begin_layout Description
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15355 ] Whether the style requires the feature
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15366 \begin_inset CommandInset ref
15368 reference "chap:List-of-functions"
15372 for the list of features).
15373 If you require a package with specific options, you can additionally use
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15384 as a general text class parameter (see
15385 \begin_inset CommandInset ref
15387 reference "subsec:General-text-class"
15394 \begin_layout Description
15395 \begin_inset Flex Code
15398 \begin_layout Plain Layout
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15426 ] Resets the \SpecialChar LaTeX
15427 arguments of this style (as defined via the
15428 \begin_inset Flex Code
15431 \begin_layout Plain Layout
15438 This is useful if you have copied a style via
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15448 , but you do not want to inherit its (required and optional) arguments.
15451 \begin_layout Description
15452 \begin_inset Flex Code
15455 \begin_layout Plain Layout
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15483 ] Resumes a counter that is usually reset at each new sequence of layouts.
15484 This is currently only useful when
15485 \begin_inset Flex Code
15488 \begin_layout Plain Layout
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15507 \begin_layout Description
15508 \begin_inset Flex Code
15511 \begin_layout Plain Layout
15518 \begin_inset Flex Code
15521 \begin_layout Plain Layout
15527 ] A string that is put at the end of the layout content.
15528 A line break in the output can be indicated by
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15541 \begin_layout Description
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15574 \begin_layout Description
15575 \begin_inset Flex Code
15578 \begin_layout Plain Layout
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
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
15622 \begin_inset space ~
15630 ] This defines what the default spacing should be in the style.
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15642 \begin_inset Flex Code
15645 \begin_layout Plain Layout
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15661 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15662 If you specify the argument
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15672 , then you must also provide a value argument which will be the actual multiplie
15674 Note that, contrary to other parameters,
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15684 implies the generation of specific \SpecialChar LaTeX
15685 code, using the \SpecialChar LaTeX
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15701 \begin_layout Description
15702 \begin_inset Flex Code
15705 \begin_layout Plain Layout
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15722 \begin_inset space \thinspace{}
15726 \begin_inset Flex Code
15729 \begin_layout Plain Layout
15737 ] Allow spell-checking paragraphs of this style.
15741 \begin_layout Description
15742 \begin_inset Flex Code
15745 \begin_layout Plain Layout
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15773 ] Steps the master counter of a given counter at the beginning of a new
15774 sequence of layouts.
15775 This is currently only useful when
15776 \begin_inset Flex Code
15779 \begin_layout Plain Layout
15786 \begin_inset Flex Code
15789 \begin_layout Plain Layout
15798 \begin_layout Description
15799 \begin_inset Flex Code
15802 \begin_layout Plain Layout
15808 The font used for the text body .
15810 \begin_inset CommandInset ref
15812 reference "subsec:Font-description"
15819 \begin_layout Description
15820 \begin_inset Flex Code
15823 \begin_layout Plain Layout
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15845 The level of the style in the table of contents.
15846 This is used for automatic numbering of section headings.
15849 \begin_layout Description
15850 \begin_inset Flex Code
15853 \begin_layout Plain Layout
15862 \begin_inset Flex Code
15865 \begin_layout Plain Layout
15876 \begin_inset Flex Code
15879 \begin_layout Plain Layout
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15895 ] This tag determines whether the first line indentation of this paragraph
15896 can be toggled via the Paragraph settings dialog.
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15913 is set, indentation can be toggled if the document settings use
15914 \begin_inset Quotes eld
15918 \begin_inset Quotes erd
15921 paragraph style, with
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15931 , indentation can always be toggled, notwithstanding the document settings,
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15942 , indentation can never be toggled.
15945 \begin_layout Description
15946 \begin_inset Flex Code
15949 \begin_layout Plain Layout
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15965 ] The vertical space with which the very first of a chain of paragraphs
15966 with this style is separated from the previous paragraph.
15967 If the previous paragraph has another style, the separations are not simply
15968 added, but the maximum is taken.
15971 \begin_layout Subsection
15972 \begin_inset CommandInset label
15978 Internationalization of Paragraph Styles
15981 \begin_layout Standard
15983 has long supported internationalization of layout information, but, until
15984 version 2.0, this applied only to the user interface and not to, say, PDF
15986 Thus, French authors were forced to resort to ugly hacks if they wanted
15991 1' instead of `Theorem 1'.
15992 Thanks to Georg Baum, that is no longer the case.
15995 \begin_layout Standard
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16006 defines text that is to appear in the typeset document, it may use
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16017 \begin_inset Flex Code
16020 \begin_layout Plain Layout
16026 to support non-English and even multi-language documents correctly.
16027 The following excerpt (from the
16028 \begin_inset Flex Code
16031 \begin_layout Plain Layout
16037 file) shows how this works:
16040 \begin_layout LyX-Code
16045 \begin_layout LyX-Code
16048 theoremstyle{remark}
16051 \begin_layout LyX-Code
16054 newtheorem{claim}[thm]{
16061 \begin_layout LyX-Code
16065 \begin_layout LyX-Code
16069 \begin_layout LyX-Code
16074 claimname}{_(Claim)}
16077 \begin_layout LyX-Code
16081 \begin_layout LyX-Code
16085 \begin_layout LyX-Code
16094 claimname}{_(Claim)}}
16097 \begin_layout LyX-Code
16102 \begin_layout Standard
16103 In principle, any legal \SpecialChar LaTeX
16105 \begin_inset Flex Code
16108 \begin_layout Plain Layout
16115 \begin_inset Flex Code
16118 \begin_layout Plain Layout
16124 tags, but in practice they will typically look as they do here.
16125 The key to correct translation of the typeset text is the definition of
16126 the \SpecialChar LaTeX
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16155 \begin_layout Standard
16157 \begin_inset Flex Code
16160 \begin_layout Plain Layout
16166 tag provides for internationalization based upon the overall language of
16168 The contents of the tag will be included in the preamble, just as with
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16180 What makes it special is the use of the
16181 \begin_inset Quotes eld
16185 \begin_inset Quotes erd
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16198 , which will be replaced, when \SpecialChar LyX
16199 produces \SpecialChar LaTeX
16200 output, with the translation of
16201 its argument into the document language.
16204 \begin_layout Standard
16206 \begin_inset Flex Code
16209 \begin_layout Plain Layout
16215 tag is more complex, since it is meant to provide support for multi-language
16216 documents and so offers an interface to the
16217 \begin_inset Flex Code
16220 \begin_layout Plain Layout
16227 Its contents will be added to the preamble once for each language that
16228 appears in the document.
16229 In this case, the argument to
16230 \begin_inset Flex Code
16233 \begin_layout Plain Layout
16239 will be replaced with its translation into the language in question; the
16241 \begin_inset Flex Code
16244 \begin_layout Plain Layout
16250 is replaced by the language name (as used by the babel package).
16253 \begin_layout Standard
16254 A German document that also included a French section would thus have the
16255 following in the preamble:
16258 \begin_layout LyX-Code
16267 claimname}{Affirmation}}
16268 \begin_inset Newline newline
16279 claimname}{Behauptung}}
16280 \begin_inset Newline newline
16287 claimname}{Behauptung}
16290 \begin_layout Standard
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16302 will then conspire to produce the correct text in the output.
16305 \begin_layout Standard
16306 One important point to note here is that the translations are provided by
16308 itself, through the file
16309 \begin_inset Flex Code
16312 \begin_layout Plain Layout
16319 This means, in effect, that
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16330 \begin_inset Flex Code
16333 \begin_layout Plain Layout
16339 are really only of use in layout files that are provided with \SpecialChar LyX
16341 entered in user-created layout files will not be seen by \SpecialChar LyX
16342 's internationalizatio
16343 n routines unless the
16344 \begin_inset Flex Code
16347 \begin_layout Plain Layout
16353 file is modified accordingly.
16354 That said, however, any layout created with the intention that it will
16355 be included with \SpecialChar LyX
16356 should use these tags where appropriate.
16357 Please note that the paragraph style translations provided by \SpecialChar LyX
16359 change with a minor update (e.
16360 \begin_inset space \thinspace{}
16364 \begin_inset space \space{}
16367 from version 2.1.x to 2.1.y).
16368 It is however quite likely that a major update (e.
16369 \begin_inset space \thinspace{}
16373 \begin_inset space \space{}
16376 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16379 \begin_layout Subsection
16381 \begin_inset CommandInset label
16383 name "subsec:Floats"
16390 \begin_layout Standard
16391 It is necessary to define the floats (
16392 \begin_inset Flex Noun
16395 \begin_layout Plain Layout
16402 \begin_inset Flex Noun
16405 \begin_layout Plain Layout
16411 , \SpecialChar ldots
16412 ) in the text class itself.
16413 Standard floats are included in the file
16414 \begin_inset Flex Code
16417 \begin_layout Plain Layout
16423 , so you may have to do no more than add
16426 \begin_layout LyX-Code
16427 Input stdfloats.inc
16430 \begin_layout Standard
16431 to your layout file.
16432 If you want to implement a text class that proposes some other float types
16433 (like the AGU class bundled with \SpecialChar LyX
16434 ), the information below will hopefully
16438 \begin_layout Description
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16449 \begin_inset Flex Code
16452 \begin_layout Plain Layout
16458 =!htbpH] Allowed placement options for this float type.
16459 The value is a string of placement characters.
16460 Possible characters include:
16465 \begin_inset Quotes eld
16469 \begin_inset Quotes erd
16477 \begin_inset Quotes eld
16481 \begin_inset Quotes erd
16489 \begin_inset Quotes eld
16493 \begin_inset Quotes erd
16501 \begin_inset Quotes eld
16505 \begin_inset Quotes erd
16513 \begin_inset Quotes eld
16517 \begin_inset Quotes erd
16525 \begin_inset Quotes eld
16529 \begin_inset Quotes erd
16533 The order of the characters in the string does not matter.
16534 If no placement options are allowed, use the string
16541 \begin_layout Description
16542 \begin_inset Flex Code
16545 \begin_layout Plain Layout
16552 \begin_inset Flex Code
16555 \begin_layout Plain Layout
16564 \begin_inset space \thinspace{}
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16583 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16599 if the float does not support this feature.
16602 \begin_layout Description
16603 \begin_inset Flex Code
16606 \begin_layout Plain Layout
16613 \begin_inset Flex Code
16616 \begin_layout Plain Layout
16625 \begin_inset space \thinspace{}
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16644 ] Defines whether the float has a starred variant that spans columns in
16645 a two column paragraph.
16647 \begin_inset Flex Code
16650 \begin_layout Plain Layout
16656 if the float does not support this feature.
16659 \begin_layout Description
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16670 \begin_inset Flex Code
16673 \begin_layout Plain Layout
16680 \begin_inset Quotes erd
16684 \begin_inset Quotes erd
16687 ] The file name extension of an auxiliary file for the list of figures (or
16690 writes the captions to this file.
16693 \begin_layout Description
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16714 \begin_inset Quotes erd
16718 \begin_inset Quotes erd
16721 ] The string that will be used in the menus and also for the caption.
16722 This is translated to the current language if babel is used.
16725 \begin_layout Description
16726 \begin_inset Flex Code
16729 \begin_layout Plain Layout
16735 These tags control the XHTML output.
16737 \begin_inset CommandInset ref
16739 reference "sec:Tags-for-XHTML"
16746 \begin_layout Description
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16759 \begin_inset Flex Code
16762 \begin_layout Plain Layout
16771 \begin_inset space \thinspace{}
16775 \begin_inset Flex Code
16778 \begin_layout Plain Layout
16784 ] Indicates whether the float is already defined in the document class or
16785 if instead the \SpecialChar LaTeX
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16796 needs to be loaded to define it on-the-fly.
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16808 \begin_inset Flex Code
16811 \begin_layout Plain Layout
16818 It should be set to
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16828 if the float is already defined by the \SpecialChar LaTeX
16832 \begin_layout Description
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Quotes erd
16857 \begin_inset Quotes erd
16860 ] The command used to generate a list of floats of this type; the leading
16869 \begin_inset Flex Code
16872 \begin_layout Plain Layout
16878 is false, since there is no standard way to generate this command.
16880 \begin_inset Flex Code
16883 \begin_layout Plain Layout
16889 is true, since in that case there is a standard way to define the command.
16892 \begin_layout Description
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16903 \begin_inset Flex Code
16906 \begin_layout Plain Layout
16913 \begin_inset Quotes erd
16917 \begin_inset Quotes erd
16920 ] A title for a list of floats of this kind (list of figures, tables, or
16922 It is used for the screen label within \SpecialChar LyX
16923 , it is used by \SpecialChar LaTeX
16925 it is used as the title in the XHTML output.
16926 It will be translated to the document language.
16929 \begin_layout Description
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16950 \begin_inset Quotes erd
16954 \begin_inset Quotes erd
16957 ] This (optional) argument determines whether floats of this class will
16958 be numbered within some sectional unit of the document.
16960 \begin_inset Flex Code
16963 \begin_layout Plain Layout
16970 \begin_inset Quotes eld
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16984 \begin_inset Quotes erd
16987 , the floats will be numbered within chapters.
16991 \begin_layout Description
16992 \begin_inset Flex Code
16995 \begin_layout Plain Layout
17002 \begin_inset Flex Code
17005 \begin_layout Plain Layout
17012 \begin_inset Quotes erd
17016 \begin_inset Quotes erd
17019 ] The default placement for the given class of floats.
17020 The string should be as in standard \SpecialChar LaTeX
17022 \begin_inset Flex Code
17025 \begin_layout Plain Layout
17032 \begin_inset Flex Code
17035 \begin_layout Plain Layout
17042 \begin_inset Flex Code
17045 \begin_layout Plain Layout
17052 \begin_inset Flex Code
17055 \begin_layout Plain Layout
17061 for top, bottom, page, and here, respectively.
17065 \begin_layout Plain Layout
17066 Note that the order of these letters in the string is irrelevant, like in
17073 On top of that there is a new type,
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17083 , which does not really correspond to a float, since it means: put it
17084 \begin_inset Quotes eld
17088 \begin_inset Quotes erd
17092 Note however that the
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17102 specifier is special and, because of implementation details, cannot be
17103 used in non-built in float types.
17104 If you do not understand what this means, just use
17105 \begin_inset Quotes eld
17109 \begin_inset Flex Code
17112 \begin_layout Plain Layout
17119 \begin_inset Quotes erd
17125 \begin_layout Description
17126 \begin_inset Flex Code
17129 \begin_layout Plain Layout
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17145 ] The prefix to use when creating labels referring to floats of this type.
17146 This allows the use of formatted references.
17147 Note that you can remove any
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 set by a copied style by using the special value
17158 \begin_inset Quotes eld
17162 \begin_inset Quotes erd
17165 , which must be all caps.
17168 \begin_layout Description
17169 \begin_inset Flex Code
17172 \begin_layout Plain Layout
17179 \begin_inset Flex Code
17182 \begin_layout Plain Layout
17189 \begin_inset Quotes erd
17193 \begin_inset Quotes erd
17196 ] The style used when defining the float using
17197 \begin_inset Flex Code
17200 \begin_layout Plain Layout
17211 \begin_layout Description
17212 \begin_inset Flex Code
17215 \begin_layout Plain Layout
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17232 \begin_inset Quotes erd
17236 \begin_inset Quotes erd
17240 \begin_inset Quotes eld
17244 \begin_inset Quotes erd
17247 of the new class of floats, like program or algorithm.
17248 After the appropriate
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17261 \begin_inset Flex Code
17264 \begin_layout Plain Layout
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17287 \begin_layout Description
17288 \begin_inset Flex Code
17291 \begin_layout Plain Layout
17298 \begin_inset Flex Code
17301 \begin_layout Plain Layout
17308 \begin_inset space \thinspace{}
17312 \begin_inset Flex Code
17315 \begin_layout Plain Layout
17323 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17334 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17338 \begin_layout Standard
17339 Note that defining a float with type
17340 \begin_inset Flex Code
17343 \begin_layout Plain Layout
17351 automatically defines the corresponding counter with name
17352 \begin_inset Flex Code
17355 \begin_layout Plain Layout
17366 \begin_layout Subsection
17367 Flex insets and InsetLayout
17368 \begin_inset CommandInset label
17370 name "subsec:Flex-insets-and"
17377 \begin_layout Standard
17378 Flex insets come in three different kinds:
17381 \begin_layout Itemize
17383 \begin_inset Flex Code
17386 \begin_layout Plain Layout
17392 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17420 \begin_layout Itemize
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17431 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17433 footnote, and the like.
17434 An obvious example is an endnote inset, which is defined in the
17435 \begin_inset Flex Code
17438 \begin_layout Plain Layout
17447 \begin_layout Itemize
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17458 ): For use with DocBook classes.
17461 \begin_layout Standard
17462 Flex insets are defined using the
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17472 tag, which shall be explained in a moment.
17475 \begin_layout Standard
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17486 tag also serves another function: It can be used to customize the general
17487 layout of many different types of insets.
17489 \begin_inset Flex Code
17492 \begin_layout Plain Layout
17498 can be used to customize the layout parameters for footnotes, marginal
17499 notes, note insets, \SpecialChar TeX
17500 code (ERT) insets, branches, listings, indexes, boxes,
17501 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17504 \begin_layout Standard
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17515 definition must begin with a line of the form:
17518 \begin_layout LyX-Code
17522 \begin_layout Standard
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 indicates the inset whose layout is being defined, and here there are four
17537 \begin_layout Enumerate
17538 The layout for a pre-existing inset is being modified.
17539 In this case, can be
17540 \begin_inset Flex Code
17543 \begin_layout Plain Layout
17549 any one of the following:
17550 \begin_inset Flex Code
17553 \begin_layout Plain Layout
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17570 \begin_inset Flex Code
17573 \begin_layout Plain Layout
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17640 \begin_inset Flex Code
17643 \begin_layout Plain Layout
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17660 \begin_inset Flex Code
17663 \begin_layout Plain Layout
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17680 \begin_inset Flex Code
17683 \begin_layout Plain Layout
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17700 \begin_inset Flex Code
17703 \begin_layout Plain Layout
17710 \begin_inset Flex Code
17713 \begin_layout Plain Layout
17720 \begin_inset Flex Code
17723 \begin_layout Plain Layout
17730 \begin_inset Flex Code
17733 \begin_layout Plain Layout
17740 \begin_inset Flex Code
17743 \begin_layout Plain Layout
17752 \begin_layout Enumerate
17753 The layout for a Flex inset is being defined.
17755 \begin_inset Flex Code
17758 \begin_layout Plain Layout
17764 must be of the form
17765 \begin_inset Quotes eld
17769 \begin_inset Flex Code
17772 \begin_layout Plain Layout
17779 \begin_inset Quotes erd
17783 \begin_inset Flex Code
17786 \begin_layout Plain Layout
17792 may be be any valid identifier not used by a pre-existing Flex inset.
17793 The identifier may include spaces, but in that case the whole thing must
17794 be wrapped in quotes.
17795 Note that the definition of a flex inset
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17809 entry, declaring which type of inset it defines.
17812 \begin_layout Enumerate
17813 The layout for user specific branch is being defined.
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17824 must be of the form
17825 \begin_inset Quotes eld
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17839 \begin_inset Quotes erd
17843 \begin_inset Flex Code
17846 \begin_layout Plain Layout
17852 may be be any valid identifier of branch defined in user's document.
17853 The identifier may include spaces, but in that case the whole thing must
17854 be wrapped in quotes.
17855 The main purpose of this feature is to allow \SpecialChar LaTeX
17856 wrapping around specific
17857 branches as user needs.
17860 \begin_layout Enumerate
17861 The layout of a user (or class) specific caption is being defined.
17863 \begin_inset Flex Code
17866 \begin_layout Plain Layout
17872 must be of the form
17873 \begin_inset Quotes eld
17877 \begin_inset Flex Code
17880 \begin_layout Plain Layout
17887 \begin_inset Quotes erd
17891 \begin_inset Flex Code
17894 \begin_layout Plain Layout
17900 specifies the name of the caption as it appears in the menu.
17901 Have a look at the standard caption (
17902 \begin_inset Flex Code
17905 \begin_layout Plain Layout
17911 ), the specific captions of the KOMA-Script classes (
17912 \begin_inset Flex Code
17915 \begin_layout Plain Layout
17922 \begin_inset Flex Code
17925 \begin_layout Plain Layout
17934 \begin_inset space ~
17938 \begin_inset Newline linebreak
17944 \begin_inset Flex Code
17947 \begin_layout Plain Layout
17953 ) for applications.
17956 \begin_layout Standard
17958 \begin_inset Flex Code
17961 \begin_layout Plain Layout
17967 definition can contain the following entries:
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17990 =""] This inset will appear in the table of contents of the given type.
17991 An empty string disables.
17992 See also the OutlinerName and the IsTocCaption commands.
17993 This is only implemented for Flex insets.
17997 \begin_layout Description
17998 \begin_inset Flex Code
18001 \begin_layout Plain Layout
18008 \begin_inset Flex Code
18011 \begin_layout Plain Layout
18017 ] Defines argument number of a command\SpecialChar breakableslash
18018 environment associated with the current
18020 The definition must end with
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18032 \begin_inset CommandInset ref
18034 reference "subsec:Paragraph-Styles"
18041 \begin_layout Description
18042 \begin_inset Flex Code
18045 \begin_layout Plain Layout
18051 Preamble for changing language commands; see
18052 \begin_inset CommandInset ref
18054 reference "subsec:I18n"
18061 \begin_layout Description
18062 \begin_inset Flex Code
18065 \begin_layout Plain Layout
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18081 ] The color for the inset's background.
18083 \begin_inset CommandInset ref
18085 reference "chap:Names-of-colors"
18089 for a list of the available color names.
18092 \begin_layout Description
18093 \begin_inset Flex Code
18096 \begin_layout Plain Layout
18103 \begin_inset Flex Code
18106 \begin_layout Plain Layout
18115 \begin_inset space \thinspace{}
18119 \begin_inset Flex Code
18122 \begin_layout Plain Layout
18128 ] Whether to use the content of the inset as the label, when the inset is
18133 \begin_layout Description
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18144 \begin_inset Flex Code
18147 \begin_layout Plain Layout
18153 ] As with paragraph styles, see
18154 \begin_inset CommandInset ref
18156 reference "subsec:Paragraph-Styles"
18161 Note that you need to specify the complete type, e.
18162 \begin_inset space \thinspace{}
18166 \begin_inset space ~
18170 \begin_inset Flex Code
18173 \begin_layout Plain Layout
18174 CopyStyle Flex:<name>
18182 \begin_layout Description
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18205 \begin_inset space \thinspace{}
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18218 ] Indicates whether the user may employ the Paragraph Settings dialog to
18219 customize the paragraph.
18222 \begin_layout Description
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18253 \begin_inset Flex Code
18256 \begin_layout Plain Layout
18262 , describing the rendering style used for the inset's frame and buttons.
18263 Footnotes generally use
18264 \begin_inset Flex Code
18267 \begin_layout Plain Layout
18273 , ERT insets generally
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18283 , and character styles
18284 \begin_inset Flex Code
18287 \begin_layout Plain Layout
18296 \begin_layout Description
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18319 \begin_inset space \thinspace{}
18325 \begin_inset Flex Code
18328 \begin_layout Plain Layout
18337 \begin_inset Flex Code
18340 \begin_layout Plain Layout
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18357 Indicates whether the environment will stand on its own in the output or
18358 will appear inline with the surrounding text.
18359 If set to false, it is supposed that the \SpecialChar LaTeX
18360 environment ignores white space
18361 (including one newline character) after the
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18378 \begin_inset Flex Code
18381 \begin_layout Plain Layout
18397 \begin_layout Description
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18407 Required at the end of the
18408 \begin_inset Flex Code
18411 \begin_layout Plain Layout
18420 \begin_layout Description
18421 \begin_inset Flex Code
18424 \begin_layout Plain Layout
18430 The font used for both the text body
18436 \begin_inset CommandInset ref
18438 reference "subsec:Font-description"
18443 Note that defining this font automatically defines the
18444 \begin_inset Flex Code
18447 \begin_layout Plain Layout
18453 to the same value, so define this first and define
18454 \begin_inset Flex Code
18457 \begin_layout Plain Layout
18463 later if you want them to be different.
18466 \begin_layout Description
18467 \begin_inset Flex Code
18470 \begin_layout Plain Layout
18471 FixedWidthPreambleEncoding
18477 \begin_inset Flex Code
18480 \begin_layout Plain Layout
18489 \begin_inset space \thinspace{}
18493 \begin_inset Flex Code
18496 \begin_layout Plain Layout
18502 ] Force a fixed width encoding for the translated contents of
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18522 code generated by this layout.
18523 This is needed for special \SpecialChar LaTeX
18528 that do not work with variable width encodings such as
18533 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18534 backends such as Xe\SpecialChar TeX
18536 Lua\SpecialChar TeX
18540 \begin_layout Description
18541 \begin_inset Flex Code
18544 \begin_layout Plain Layout
18545 ForceLocalFontSwitch
18551 \begin_inset Flex Code
18554 \begin_layout Plain Layout
18563 \begin_inset space \thinspace{}
18567 \begin_inset Flex Code
18570 \begin_layout Plain Layout
18576 ] When using babel, always use a local font switch (
18577 \begin_inset Flex Code
18580 \begin_layout Plain Layout
18588 ), never a global one (such as
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18603 \begin_layout Description
18604 \begin_inset Flex Code
18607 \begin_layout Plain Layout
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18626 \begin_inset space \thinspace{}
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18640 \begin_inset Quotes eld
18644 \begin_inset Quotes erd
18647 language, leading to Left-to-Right (Latin) output, e.
18648 \begin_inset space \thinspace{}
18652 \begin_inset space \space{}
18655 in \SpecialChar TeX
18660 \begin_layout Description
18661 \begin_inset Flex Code
18664 \begin_layout Plain Layout
18671 \begin_inset Flex Code
18674 \begin_layout Plain Layout
18683 \begin_inset space \thinspace{}
18687 \begin_inset Flex Code
18690 \begin_layout Plain Layout
18696 ] Force a a line break in the \SpecialChar LaTeX
18697 output before the inset starts and after
18699 This assures the inset itself is output on its own lines, for parsing purposes.
18702 \begin_layout Description
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18725 \begin_inset space \thinspace{}
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18738 ] Indicates whether the
18739 \begin_inset Flex Code
18742 \begin_layout Plain Layout
18748 should be used or, instead, the user can change the paragraph style used
18753 \begin_layout Description
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18776 \begin_inset space \thinspace{}
18780 \begin_inset Flex Code
18783 \begin_layout Plain Layout
18789 ] As with paragraph styles, see
18790 \begin_inset CommandInset ref
18792 reference "subsec:Paragraph-Styles"
18799 \begin_layout Description
18800 \begin_inset Flex Code
18803 \begin_layout Plain Layout
18809 These tags control the XHTML output.
18811 \begin_inset CommandInset ref
18813 reference "sec:Tags-for-XHTML"
18820 \begin_layout Description
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18843 \begin_inset space \thinspace{}
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18856 ] Whether to include the contents of this inset in the strings generated
18857 for the `Outline' pane for all table of contents, regardless of the AddToToc
18859 One would not, for example, want the content of a footnote in a section
18860 header to be included in the TOC displayed in the outline, but one would
18861 normally want the content of a character style displayed.
18862 Default is false: not to include.
18865 \begin_layout Description
18866 \begin_inset Flex Code
18869 \begin_layout Plain Layout
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18888 \begin_inset space \thinspace{}
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18901 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18902 of its contents in its item in the table of contents.
18903 Otherwise, only the label appears.
18906 \begin_layout Description
18907 \begin_inset Flex Code
18910 \begin_layout Plain Layout
18919 \begin_inset Flex Code
18922 \begin_layout Plain Layout
18931 \begin_inset space \thinspace{}
18935 \begin_inset Flex Code
18938 \begin_layout Plain Layout
18944 ] As with paragraph styles, see
18945 \begin_inset CommandInset ref
18947 reference "subsec:Paragraph-Styles"
18954 \begin_layout Description
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18964 The font used for the label.
18966 \begin_inset CommandInset ref
18968 reference "subsec:Font-description"
18973 Note that this definition can never appear before
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18983 , lest it be ineffective.
18986 \begin_layout Description
18987 \begin_inset Flex Code
18990 \begin_layout Plain Layout
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 \begin_inset Quotes erd
19011 \begin_inset Quotes erd
19014 ] What will be displayed on the button or elsewhere as the inset label.
19016 \begin_inset Flex Code
19019 \begin_layout Plain Layout
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19036 ) modify this label on the fly.
19039 \begin_layout Description
19040 \begin_inset Flex Code
19043 \begin_layout Plain Layout
19049 Language dependent preamble; see
19050 \begin_inset CommandInset ref
19052 reference "subsec:I18n"
19059 \begin_layout Description
19060 \begin_inset Flex Code
19063 \begin_layout Plain Layout
19070 \begin_inset Flex Code
19073 \begin_layout Plain Layout
19079 ] The name of the corresponding \SpecialChar LaTeX
19081 Either the environment or command name.
19084 \begin_layout Description
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19104 ] The optional parameter for the corresponding
19105 \begin_inset Flex Code
19108 \begin_layout Plain Layout
19114 stuff, including possible bracket pairs like
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 This parameter cannot be changed from within \SpecialChar LyX
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19136 for customizable parameters).
19137 It will be output as is after all \SpecialChar LaTeX
19139 \begin_inset Flex Code
19142 \begin_layout Plain Layout
19151 \begin_layout Description
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19166 Command, Environment, None
19171 ] How the style should be translated into \SpecialChar LaTeX
19176 \begin_layout Plain Layout
19177 \begin_inset Flex Code
19180 \begin_layout Plain Layout
19186 is perhaps a bit misleading, since these rules apply to SGML classes too.
19187 Visit the SGML class files for specific examples.
19196 \begin_layout Description
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19206 means nothing special
19209 \begin_layout Description
19210 \begin_inset Flex Code
19213 \begin_layout Plain Layout
19220 \begin_inset Flex Code
19223 \begin_layout Plain Layout
19230 {\SpecialChar ldots
19239 \begin_layout Description
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19260 }\SpecialChar ldots
19275 \begin_layout Standard
19276 Putting the last few things together, the \SpecialChar LaTeX
19277 output will be either:
19280 \begin_layout LyX-Code
19283 LatexName[LatexParam]{\SpecialChar ldots
19287 \begin_layout Standard
19291 \begin_layout LyX-Code
19294 begin{LatexName}[LatexParam] \SpecialChar ldots
19300 \begin_layout Standard
19301 depending upon the \SpecialChar LaTeX
19306 \begin_layout Description
19307 \begin_inset Flex Code
19310 \begin_layout Plain Layout
19317 \begin_inset Flex Code
19320 \begin_layout Plain Layout
19326 ] A string that is put at the beginning of the layout content.
19327 A line break in the output can be indicated by
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19340 \begin_layout Description
19341 \begin_inset Flex Code
19344 \begin_layout Plain Layout
19351 \begin_inset Flex Code
19354 \begin_layout Plain Layout
19361 \begin_inset Flex Code
19364 \begin_layout Plain Layout
19371 \begin_inset Flex Code
19374 \begin_layout Plain Layout
19381 \begin_inset Flex Code
19384 \begin_layout Plain Layout
19390 (indicating a dummy definition ending definitions of charstyles, etc).
19391 This entry is required in and is only meaningful for Flex insets.
19392 Among other things, it determines on which menu this inset will appear.
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19404 \begin_inset Flex Code
19407 \begin_layout Plain Layout
19413 will automatically set
19414 \begin_inset Flex Code
19417 \begin_layout Plain Layout
19424 \begin_inset Flex Code
19427 \begin_layout Plain Layout
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19444 can be set to true, or
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19464 insets by setting it
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19481 \begin_layout Description
19482 \begin_inset Flex Code
19485 \begin_layout Plain Layout
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19504 \begin_inset space \thinspace{}
19508 \begin_inset Flex Code
19511 \begin_layout Plain Layout
19517 ] Whether multiple paragraphs are permitted in this inset.
19519 \begin_inset Flex Code
19522 \begin_layout Plain Layout
19528 to the same value and
19529 \begin_inset Flex Code
19532 \begin_layout Plain Layout
19538 to the opposite value.
19539 These can be reset to other values, if they are used
19544 \begin_inset Flex Code
19547 \begin_layout Plain Layout
19557 \begin_layout Description
19558 \begin_inset Flex Code
19561 \begin_layout Plain Layout
19568 \begin_inset Flex Code
19571 \begin_layout Plain Layout
19580 \begin_inset space \thinspace{}
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 ] Whether fragile commands in this inset should be
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19610 whether the command should itself be protected.) Default is false.
19613 \begin_layout Description
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19633 ] Deletes an existing
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19646 \begin_layout Description
19647 \begin_inset Flex Code
19650 \begin_layout Plain Layout
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19676 that has replaced this
19677 \begin_inset Flex Code
19680 \begin_layout Plain Layout
19687 This is used to rename an
19688 \begin_inset Flex Code
19691 \begin_layout Plain Layout
19697 , while keeping backward compatibility.
19700 \begin_layout Description
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19723 \begin_inset space \thinspace{}
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19736 ] As with paragraph styles, see
19737 \begin_inset CommandInset ref
19739 reference "subsec:Paragraph-Styles"
19747 \begin_layout Description
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19770 \begin_inset space \thinspace{}
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19783 ] As with paragraph styles, see
19784 \begin_inset CommandInset ref
19786 reference "subsec:Paragraph-Styles"
19794 \begin_layout Description
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19804 As with paragraph styles, see
19805 \begin_inset CommandInset ref
19807 reference "subsec:Paragraph-Styles"
19814 \begin_layout Description
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19834 ] The prefix to use when creating labels referring to insets of this type.
19835 This allows the use of formatted references.
19838 \begin_layout Description
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19858 ] As with paragraph styles, see
19859 \begin_inset CommandInset ref
19861 reference "subsec:Paragraph-Styles"
19868 \begin_layout Description
19869 \begin_inset Flex Code
19872 \begin_layout Plain Layout
19879 \begin_inset Flex Code
19882 \begin_layout Plain Layout
19891 \begin_inset space \thinspace{}
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19904 ] Resets the \SpecialChar LaTeX
19905 arguments of this layout (as defined via the
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19916 This is useful if you have copied a style via
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 , but you do not want to inherit its (required and optional) arguments.
19929 \begin_layout Description
19930 \begin_inset Flex Code
19933 \begin_layout Plain Layout
19940 \begin_inset Flex Code
19943 \begin_layout Plain Layout
19950 \begin_inset space \thinspace{}
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19965 ] Whether this inset should use the font of its surrounding environment
19967 Default is false: use the font of the surrounding environment.
19970 \begin_layout Description
19971 \begin_inset Flex Code
19974 \begin_layout Plain Layout
19981 \begin_inset Flex Code
19984 \begin_layout Plain Layout
19990 ] A string that is put at the end of the layout content.
19991 A line break in the output can be indicated by
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20004 \begin_layout Description
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20025 \begin_inset space \thinspace{}
20029 \begin_inset Flex Code
20032 \begin_layout Plain Layout
20040 ] Allow spell-checking the contents of this inset.
20044 \begin_layout Subsection
20046 \begin_inset CommandInset label
20048 name "subsec:Counters"
20055 \begin_layout Standard
20056 It is necessary to define the counters (
20057 \begin_inset Flex Noun
20060 \begin_layout Plain Layout
20067 \begin_inset Flex Noun
20070 \begin_layout Plain Layout
20076 , \SpecialChar ldots
20077 ) in the text class itself.
20078 The standard counters are defined in the file
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20088 , so you may have to do no more than add
20091 \begin_layout LyX-Code
20092 Input stdcounters.inc
20095 \begin_layout Standard
20096 to your layout file to get them to work.
20097 But if you want to define custom counters, then you can do so.
20098 The counter declaration must begin with:
20101 \begin_layout LyX-Code
20102 Counter CounterName
20105 \begin_layout Standard
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20116 ' is replaced by the name of the counter.
20117 And it must end with
20118 \begin_inset Quotes eld
20122 \begin_inset Flex Code
20125 \begin_layout Plain Layout
20132 \begin_inset Quotes erd
20136 The following parameters can also be used:
20139 \begin_layout Description
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20159 ] Sets the initial value for the counter, to which it will be reset whenever
20161 Normally, one will want the default, 1.
20164 \begin_layout Description
20165 \begin_inset Flex Code
20168 \begin_layout Plain Layout
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20185 \begin_inset Quotes erd
20189 \begin_inset Quotes erd
20192 ] When defined, this string defines how the counter is displayed.
20193 Setting this value sets
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20198 LabelStringAppendix
20204 The following special constructs can be used in the string:
20208 \begin_layout Itemize
20209 \begin_inset Flex Code
20212 \begin_layout Plain Layout
20220 will be replaced by the expansion of the
20221 \begin_inset Flex Code
20224 \begin_layout Plain Layout
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20235 LabelStringAppendix
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20254 \begin_layout Itemize
20255 counter values can be expressed using \SpecialChar LaTeX
20257 \begin_inset Newline newline
20261 \begin_inset Flex Code
20264 \begin_layout Plain Layout
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20296 \begin_layout Plain Layout
20306 Actually, the situation is a bit more complicated: any
20325 other than those described below will produce arabic numerals.
20326 It would not be surprising to see this change in the future.
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20341 : 1, 2, 3,\SpecialChar ldots
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20352 for lower-case letters: a, b, c, \SpecialChar ldots
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20363 for upper-case letters: A, B, C, \SpecialChar ldots
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20374 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20376 \begin_inset Flex Code
20379 \begin_layout Plain Layout
20385 for upper-case roman numerals: I, II, III\SpecialChar ldots
20387 \begin_inset Flex Code
20390 \begin_layout Plain Layout
20396 for hebrew numerals.
20400 \begin_layout Standard
20401 If LabelString is not defined, a default value is constructed as follows:
20402 if the counter has a master counter
20403 \begin_inset Flex Code
20406 \begin_layout Plain Layout
20413 \begin_inset Flex Code
20416 \begin_layout Plain Layout
20423 \begin_inset Newline newline
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20440 is used; otherwise the string
20441 \begin_inset Flex Code
20444 \begin_layout Plain Layout
20455 \begin_layout Description
20456 \begin_inset Flex Code
20459 \begin_layout Plain Layout
20460 LabelStringAppendix
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20476 \begin_inset Quotes erd
20480 \begin_inset Quotes erd
20484 \begin_inset Flex Code
20487 \begin_layout Plain Layout
20493 , but for use in the Appendix.
20496 \begin_layout Description
20497 \begin_inset Flex Code
20500 \begin_layout Plain Layout
20507 \begin_inset Flex Code
20510 \begin_layout Plain Layout
20517 \begin_inset Quotes erd
20521 \begin_inset Quotes erd
20524 ] A format for use with formatted references to this counter.
20525 For example, one might want to have references to section numbers appear
20527 \begin_inset Quotes eld
20531 \begin_inset Quotes erd
20535 The string should contain
20536 \begin_inset Quotes eld
20540 \begin_inset Quotes erd
20544 This will be replaced by the counter number itself.
20545 So, for sections, it would be: Section ##.
20548 \begin_layout Description
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20569 \begin_inset Quotes erd
20573 \begin_inset Quotes erd
20576 ] If this is set to the name of another counter, the present counter will
20577 be reset every time the other one is increased.
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20601 \begin_layout Subsection
20603 \begin_inset CommandInset label
20605 name "subsec:Font-description"
20612 \begin_layout Standard
20613 A font description looks like this:
20616 \begin_layout LyX-Code
20633 \begin_layout LyX-Code
20637 \begin_layout LyX-Code
20641 \begin_layout Standard
20642 The following commands are available:
20645 \begin_layout Description
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20668 \begin_inset Flex Code
20671 \begin_layout Plain Layout
20678 \begin_inset Flex Code
20681 \begin_layout Plain Layout
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20768 \begin_inset Flex Code
20771 \begin_layout Plain Layout
20778 \begin_inset Flex Code
20781 \begin_layout Plain Layout
20788 \begin_inset Flex Code
20791 \begin_layout Plain Layout
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Flex Code
20851 \begin_layout Plain Layout
20860 \begin_layout Description
20861 \begin_inset Flex Code
20864 \begin_layout Plain Layout
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20905 \begin_layout Description
20906 \begin_inset Flex Code
20909 \begin_layout Plain Layout
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20925 ] Valid arguments are:
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
20986 \begin_inset Flex Code
20989 \begin_layout Plain Layout
20996 \begin_inset Flex Code
20999 \begin_layout Plain Layout
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21016 \begin_inset Flex Code
21019 \begin_layout Plain Layout
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21036 \begin_inset Flex Code
21039 \begin_layout Plain Layout
21046 Each of these turns on or off the corresponding attribute.
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21057 turns on emphasis, and
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21069 \begin_inset Newline newline
21072 If the latter seems puzzling, remember that the font settings for the present
21073 context are generally inherited from the surrounding context.
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21084 would turn off the emphasis that was anyway in effect, say, in a theorem
21088 \begin_layout Description
21089 \begin_inset Flex Code
21092 \begin_layout Plain Layout
21099 \begin_inset Flex Code
21102 \begin_layout Plain Layout
21111 \begin_inset Flex Code
21114 \begin_layout Plain Layout
21123 \begin_layout Description
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21146 \begin_inset Flex Code
21149 \begin_layout Plain Layout
21156 \begin_inset Flex Code
21159 \begin_layout Plain Layout
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21178 \begin_layout Description
21179 \begin_inset Flex Code
21182 \begin_layout Plain Layout
21189 \begin_inset Flex Code
21192 \begin_layout Plain Layout
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21209 \begin_inset Flex Code
21212 \begin_layout Plain Layout
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21231 \begin_inset Flex Code
21234 \begin_layout Plain Layout
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21251 \begin_inset Flex Code
21254 \begin_layout Plain Layout
21261 \begin_inset Flex Code
21264 \begin_layout Plain Layout
21273 \begin_layout Subsection
21274 \begin_inset CommandInset label
21276 name "subsec:Citation-engine-description"
21280 Cite engine description
21283 \begin_layout Standard
21285 \begin_inset Flex Code
21288 \begin_layout Plain Layout
21294 blocks, as used mainly in cite engine files (see
21295 \begin_inset CommandInset ref
21297 reference "subsec:Cite-Engine-Files"
21304 ), define the citation commands provided by a specific
21305 \begin_inset Quotes eld
21309 \begin_inset Quotes erd
21313 A cite engine, in \SpecialChar LyX
21314 terms, is way specific way to format citations, using
21315 numbers, author names and/or years.
21316 Currently, \SpecialChar LyX
21317 supports three such engine types, namely:
21320 \begin_layout Enumerate
21321 \begin_inset Flex Code
21324 \begin_layout Plain Layout
21330 : the default Bib\SpecialChar TeX
21331 way to format citations, a simple numeric style (e.
21332 \begin_inset space \thinspace{}
21336 \begin_inset Quotes eld
21340 \begin_inset Quotes erd
21346 \begin_layout Enumerate
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21356 : Harvard-styled citations using author names and publication year (e.
21357 \begin_inset space \thinspace{}
21361 \begin_inset Quotes eld
21364 Smith and Miller (2017b)
21365 \begin_inset Quotes erd
21371 \begin_layout Enumerate
21372 \begin_inset Flex Code
21375 \begin_layout Plain Layout
21381 : extended numerical citations that also allow for author or title next
21383 \begin_inset space \thinspace{}
21387 \begin_inset Quotes eld
21390 Smith and Miller [1]
21391 \begin_inset Quotes erd
21397 \begin_layout Standard
21398 \begin_inset Flex Code
21401 \begin_layout Plain Layout
21407 blocks look like this:
21410 \begin_layout LyX-Code
21414 \begin_layout LyX-Code
21418 \begin_layout LyX-Code
21422 \begin_layout LyX-Code
21423 citeyearpar[][]=parencite*
21426 \begin_layout LyX-Code
21430 \begin_layout LyX-Code
21434 \begin_layout Standard
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21445 denotes the engine.
21446 The individual lines respectively define a cite command or cite command
21447 paradigm supported by this engine.
21448 The line can be as simple as a cite command that is used both to name the
21449 respective \SpecialChar LyX
21450 command and the \SpecialChar LaTeX
21451 output or more complex in order to differentiate
21453 The full syntax is:
21456 \begin_layout LyX-Code
21457 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21460 \begin_layout Itemize
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21470 : The name as used in the
21471 \begin_inset Flex Code
21474 \begin_layout Plain Layout
21484 \begin_layout Standard
21485 For portability reasons, we try to use the same name for same-formatted
21486 commands in different cite packages (thus many names stem from natbib,
21487 and thus we need to differentiate a
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21497 sometimes, if the \SpecialChar LaTeX
21498 command names differ).
21502 \begin_layout Itemize
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21512 : a (comma-separated) list of commands that fall back to the given
21513 \begin_inset Flex Code
21516 \begin_layout Plain Layout
21522 in the current engine.
21523 This eases the switch of citation packages and engines.
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21535 \begin_inset Flex Code
21538 \begin_layout Plain Layout
21544 in layout definitions.
21547 \begin_layout Itemize
21548 \begin_inset Flex Code
21551 \begin_layout Plain Layout
21557 : The actual \SpecialChar LaTeX
21558 command that is output.
21562 \begin_layout Standard
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21603 will be output to \SpecialChar LaTeX
21607 \begin_layout Standard
21611 \begin_layout Itemize
21612 Capitalization indicates that the command also has a capitalized form (
21613 \begin_inset Flex Code
21616 \begin_layout Plain Layout
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21638 These usually enforce up-casing of name prefixes (
21643 \begin_inset Formula $\Rightarrow$
21653 \begin_layout Itemize
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21664 indicate the number of optional arguments (there can be 0–2).
21667 \begin_layout Itemize
21669 \begin_inset Flex Code
21672 \begin_layout Plain Layout
21678 indicates there is a starred version of the command (
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21692 \begin_inset Flex Code
21695 \begin_layout Plain Layout
21708 \begin_layout Standard
21709 By default, the starred version means: Output all authors even if it should
21711 \begin_inset Quotes eld
21715 \begin_inset Quotes erd
21719 \begin_inset Flex Code
21722 \begin_layout Plain Layout
21731 \begin_layout Standard
21732 If the star has a different meaning for a given command, it can be specified
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21738 <!_stardesc!_stardesctooltip>
21744 Maximal two translatable macro keywords, marked by the prefix
21745 \begin_inset Flex Code
21748 \begin_layout Plain Layout
21755 The first points to the string that replaces the
21756 \begin_inset Quotes eld
21760 \begin_inset Quotes erd
21763 checkbox label in the citation dialog, the second one to an optional tool
21764 tip for this checkbox.
21768 \begin_layout Standard
21769 Note that these two macros have to be defined in a
21770 \begin_inset Flex Code
21773 \begin_layout Plain Layout
21779 (see next section), dropping the
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21789 from the prefix, like this:
21792 \begin_layout LyX-Code
21793 _stardesc Sta&rred command label
21796 \begin_layout LyX-Code
21797 _stardesctooltip Tooltip for the starred command checkbox.
21801 \begin_layout Itemize
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21812 indicates that this command features
21813 \begin_inset Quotes eld
21816 qualified citation lists
21817 \begin_inset Quotes erd
21825 -specific feature for multi-reference citations where an individual pre-
21826 and postnote can be given to each reference in the list.
21827 Please refer to the
21831 manual for details.
21834 \begin_layout Subsection
21835 \begin_inset CommandInset label
21837 name "subsec:Citation-format-description"
21841 Cite format description
21844 \begin_layout Standard
21846 \begin_inset Flex Code
21849 \begin_layout Plain Layout
21855 blocks are used to describe how bibliographic information should be displayed,
21856 both within \SpecialChar LyX
21857 itself (in the citation dialog and in tooltips, for example)
21858 and in XHTML output.
21859 Such a block might look like this:
21862 \begin_layout LyX-Code
21866 \begin_layout LyX-Code
21870 \begin_layout LyX-Code
21874 \begin_layout LyX-Code
21878 \begin_layout Standard
21882 \begin_layout LyX-Code
21886 \begin_layout LyX-Code
21890 \begin_layout LyX-Code
21894 \begin_layout LyX-Code
21898 \begin_layout Standard
21899 In the first case, the individual lines define how the bibliographic information
21900 associated with an article or book, respectively, is to be displayed, and
21901 such a definition can be given for any
21902 \begin_inset Quotes els
21906 \begin_inset Quotes ers
21909 that might be present in a Bib\SpecialChar TeX
21912 defines a default format in the source code that will be used if no specific
21913 definition has been given.
21915 predefines several formats in the file
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21925 , which is included in most of \SpecialChar LyX
21926 's document classes.
21929 \begin_layout Standard
21930 In the second case, the lines define how a specific citation command (in
21932 \begin_inset Flex Code
21935 \begin_layout Plain Layout
21944 \begin_inset Flex Code
21947 \begin_layout Plain Layout
21955 ) is to be displayed on the citation inset label, in the citation dialog,
21956 menu or XHTML output.
21958 defines such formats for the citation style variants it supports via
21960 Document\SpecialChar menuseparator
21961 Setting\SpecialChar menuseparator
21962 Bibliography\SpecialChar ldots
21966 \begin_inset Flex Code
21969 \begin_layout Plain Layout
21975 files that are shipped with \SpecialChar LyX
21977 \begin_inset CommandInset ref
21979 reference "subsec:Cite-Engine-Files"
21989 \begin_layout Standard
21990 The definitions use a simple language that allows Bib\SpecialChar TeX
21991 keys to be replaced
21993 Keys should be enclosed in
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22004 \begin_inset Flex Code
22007 \begin_layout Plain Layout
22014 So a simple definition might look like this:
22017 \begin_layout LyX-Code
22019 \begin_inset Quotes eld
22023 \begin_inset Quotes erd
22029 \begin_layout Standard
22030 This would print the author, followed by a comma, followed by the title,
22031 in quotes, followed by a period.
22034 \begin_layout Standard
22035 Of course, sometimes you may want to print a key only if it exists.
22036 This can be done by using a conditional construction, such as:
22037 \begin_inset Flex Code
22040 \begin_layout Plain Layout
22042 \begin_inset space ~
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22061 key exists, then print
22062 \begin_inset Quotes eld
22066 \begin_inset space ~
22070 \begin_inset Quotes erd
22073 followed by the volume key.
22074 It is also possible to have an else clause in the conditional, such as:
22075 \begin_inset Newline newline
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22083 {%author%[[%author%]][[%editor%, ed.]]}
22089 \begin_inset Newline newline
22093 \begin_inset Flex Code
22096 \begin_layout Plain Layout
22102 key is printed if it exists; otherwise, the editor key is printed, followed
22104 \begin_inset Quotes eld
22108 \begin_inset space ~
22112 \begin_inset Quotes erd
22115 Note that the key is again enclosed in
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22125 signs; the entire conditional is enclosed in braces; and the if and else
22126 clauses are enclosed in double brackets,
22127 \begin_inset Quotes eld
22131 \begin_inset Flex Code
22134 \begin_layout Plain Layout
22141 \begin_inset Quotes eld
22145 \begin_inset Quotes eld
22149 \begin_inset Flex Code
22152 \begin_layout Plain Layout
22159 \begin_inset Quotes erd
22163 There must be no space between any of these.
22166 \begin_layout Standard
22167 Next to the entry keys, there are some special keys that can be used for
22168 these conditionals:
22171 \begin_layout Itemize
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22176 {%dialog%[[true]][[false]]}
22182 \begin_inset Quotes eld
22186 \begin_inset Quotes erd
22189 part for dialogs and menus, the
22190 \begin_inset Quotes eld
22194 \begin_inset Quotes erd
22197 part for other contexts (workarea, export)
22200 \begin_layout Itemize
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22205 {%export%[[true]][[false]]}
22211 \begin_inset Quotes eld
22215 \begin_inset Quotes erd
22218 part for export and menus, the
22219 \begin_inset Quotes eld
22223 \begin_inset Quotes erd
22226 part for other contexts (workarea, dialog)
22229 \begin_layout Itemize
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22240 \begin_inset Quotes eld
22244 \begin_inset Quotes erd
22247 part if another item follows (e.
22248 \begin_inset space \thinspace{}
22251 g., in a citation with multiple keys)
22254 \begin_layout Itemize
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22259 {%second%[[true]][[false]]}
22265 \begin_inset Quotes eld
22269 \begin_inset Quotes erd
22272 if this is the second of multiple items, else the
22273 \begin_inset Quotes eld
22277 \begin_inset Quotes erd
22283 \begin_layout Itemize
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22288 {%ifstar%[[true]][[false]]}
22294 \begin_inset Quotes eld
22298 \begin_inset Quotes erd
22301 part for starred citation commands (such as
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22313 ), the false part for unstarred
22316 \begin_layout Itemize
22317 \begin_inset Flex Code
22320 \begin_layout Plain Layout
22321 {%ifentrytype:<type>%[[true]][[false]]}
22327 \begin_inset Quotes eld
22331 \begin_inset Quotes erd
22334 if the current entry type matches
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22344 , else the false part (e.g., in a citation definition:
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22349 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22357 \begin_layout Itemize
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22362 {%ifmultiple:<authortype>%[[true]][[false]]}
22368 \begin_inset Quotes eld
22372 \begin_inset Quotes erd
22375 if the current author type (author, editor etc.) has multiple authors, else
22376 the false part (e.g., in a bibliography definition:
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22381 {%ifmultiple:editor%[[eds.]][[ed.]]}
22389 \begin_layout Itemize
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22394 {%ifqualified%[[true]][[false]]}
22400 \begin_inset Quotes eld
22404 \begin_inset Quotes erd
22407 part if the current citation is a qualified citation list (a specific
22411 format for multi-reference citations), the false part if this is not the
22415 \begin_layout Standard
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22426 prints the author key as it is recorded in the bibliography file.
22427 This might not be what you want, since it will result in a string such
22429 \begin_inset Quotes eld
22432 Miller, Peter and Smith, Mary and White, Jane
22433 \begin_inset Quotes erd
22437 \begin_inset Quotes eld
22441 \begin_inset Quotes erd
22444 is used by Bib\SpecialChar TeX
22445 to delimit authors).
22447 therefore provides some methods to get properly formatted name lists (which
22448 will also get translated).
22449 The following keys are provided:
22452 \begin_layout Enumerate
22453 For name lists with pre- and surname, suitable for the main authors/editors
22454 of a bibliography item.
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22465 part denotes the kind of list that is requested (e.g.
22467 \begin_inset Flex Code
22470 \begin_layout Plain Layout
22480 \begin_layout Itemize
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22485 %abbrvnames:<nametype>%
22490 : Provides a name list which is abbreviated (with
22491 \begin_inset Quotes eld
22495 \begin_inset Quotes erd
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22511 \begin_layout Itemize
22512 \begin_inset Flex Code
22515 \begin_layout Plain Layout
22516 %fullnames:<nametype>%
22521 : Provides a full name list (never abbreviated with
22522 \begin_inset Quotes eld
22526 \begin_inset Quotes erd
22532 \begin_layout Itemize
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22537 %forceabbrvnames:<nametype>%
22542 : Provides a name list which is always abbreviated (with
22543 \begin_inset Quotes eld
22547 \begin_inset Quotes erd
22551 \begin_inset Flex Code
22554 \begin_layout Plain Layout
22564 \begin_layout Enumerate
22565 Alternative name lists with pre- and surname, if the order of pre- and surname
22566 inside the bibliography item differs (as in:
22567 \begin_inset Quotes eld
22570 Miller, John: Some text, in: Mary Smith, ed.: A volume
22571 \begin_inset Quotes erd
22578 \begin_layout Itemize
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22583 %abbrvbynames:<nametype>%
22588 : Provides a name list which is abbreviated (with
22589 \begin_inset Quotes eld
22593 \begin_inset Quotes erd
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22609 \begin_layout Itemize
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22614 %fullbynames:<nametype>%
22619 : Provides a full name list (never abbreviated with
22620 \begin_inset Quotes eld
22624 \begin_inset Quotes erd
22630 \begin_layout Itemize
22631 \begin_inset Flex Code
22634 \begin_layout Plain Layout
22635 %forceabbrvbynames:<nametype>%
22640 : Provides a name list which is always abbreviated (with
22641 \begin_inset Quotes eld
22645 \begin_inset Quotes erd
22649 \begin_inset Flex Code
22652 \begin_layout Plain Layout
22662 \begin_layout Enumerate
22663 And finally name lists which consist of family names only, as used in author-yea
22665 These do not take a
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22675 part, but always return either an author list or, if this does not exist,
22676 an editor list (as common in author-year labels):
22680 \begin_layout Itemize
22681 \begin_inset Flex Code
22684 \begin_layout Plain Layout
22690 : Provides a name list which is abbreviated (with
22691 \begin_inset Quotes eld
22695 \begin_inset Quotes erd
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22711 \begin_layout Itemize
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22721 : Provides a full name list (never abbreviated with
22722 \begin_inset Quotes eld
22726 \begin_inset Quotes erd
22732 \begin_layout Itemize
22733 \begin_inset Flex Code
22736 \begin_layout Plain Layout
22737 %forceabbrvciteauthor%
22742 : Provides a name list which is always abbreviated (with
22743 \begin_inset Quotes eld
22747 \begin_inset Quotes erd
22751 \begin_inset Flex Code
22754 \begin_layout Plain Layout
22764 \begin_layout Standard
22765 The order of pre- and surname in the former two lists can be adjusted by
22769 \begin_layout Itemize
22770 \begin_inset Flex Code
22773 \begin_layout Plain Layout
22774 !firstnameform %surname%, %prename%
22779 (first author in lists of type 1)
22782 \begin_layout Itemize
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22787 !othernameform %surname%, %prename%
22792 (other authors in lists of type 1)
22795 \begin_layout Itemize
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22800 !firstbynameform %prename% %surname%
22805 (first author in lists of type 2)
22808 \begin_layout Itemize
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22813 !otherbynameform %prename% %surname%
22818 (other authors in lists of type 2)
22821 \begin_layout Standard
22822 This allows you to configure namings like
22823 \begin_inset Quotes eld
22826 Miller, Peter and Mary Smith: \SpecialChar ldots
22827 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22829 \begin_inset Quotes erd
22835 \begin_layout Standard
22836 There is one other piece of syntax available in definitions, which looks
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22848 This defines a piece of formatting information that is to be used when
22850 \begin_inset Quotes eld
22854 \begin_inset Quotes erd
22858 Obviously, we do not want to output HTML tags when writing plain text,
22859 so they should be wrapped in
22860 \begin_inset Quotes eld
22864 \begin_inset Quotes erd
22868 \begin_inset Quotes eld
22872 \begin_inset Quotes erd
22878 \begin_layout Standard
22879 Two special sorts of definitions are also possible in a
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22890 An example of the first would be:
22893 \begin_layout LyX-Code
22895 \begin_inset Quotes eld
22899 \begin_inset Quotes erd
22905 \begin_layout Standard
22906 This is an abbreviation, or macro, and it can be used by treating it as
22908 \begin_inset Flex Code
22911 \begin_layout Plain Layout
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22929 exactly as it would treat its definition.
22930 So, let us issue the obvious
22938 \begin_layout LyX-Code
22942 \begin_layout Standard
22943 or anything like it.
22945 shouldn't go into an infinite loop, but it may go into a long one before
22949 \begin_layout Standard
22950 The second sort of special definition might look like this:
22953 \begin_layout LyX-Code
22955 \change_inserted -712698321 1517060160
22961 \begin_layout Standard
22962 This defines a translatable piece of text, which allows relevant parts of
22963 the bibliography or citation to be translated.
22964 It can be included in a definition by treating it as a key:
22965 \begin_inset Flex Code
22968 \begin_layout Plain Layout
22970 \change_inserted -712698321 1517060167
22980 \change_inserted -712698321 1517060791
22981 Note that there are two different translation paths: All definitions starting
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22988 \change_inserted -712698321 1517060380
22996 , such as in the example above, will be translated to the currently active
22997 buffer language (so the translation will match the generated document).
22998 All definitions starting with underscore only will be translated to the
23000 This is the proper translation for strings that only occur in the dialogs
23001 or on buttons, such as this one:
23004 \begin_layout LyX-Code
23006 \change_inserted -712698321 1517060574
23007 _addtobib Add to bibliography only.
23012 \begin_layout Standard
23014 \change_inserted -712698321 1517060688
23015 translatable strings
23018 \begin_inset Flex Code
23021 \begin_layout Plain Layout
23028 \begin_inset Flex Code
23031 \begin_layout Plain Layout
23038 Note that these are not macros, in the sense just defined.
23039 They will not be expanded.
23042 \begin_layout Standard
23043 So here then is an example that use
23044 \change_inserted -712698321 1517061156
23048 \change_deleted -712698321 1517061147
23050 \change_inserted -712698321 1517061148
23054 \begin_inset VSpace defskip
23060 \begin_layout Standard
23064 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %
23065 \change_inserted -712698321 1517060173
23071 \begin_layout Standard
23072 \begin_inset VSpace defskip
23075 This defines a macro that prints the author, followed by a comma, if the
23077 \begin_inset Flex Code
23080 \begin_layout Plain Layout
23086 key is defined, or else prints the name of the editor, followed by the
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23093 \change_inserted -712698321 1517060231
23101 or its translation (it is by default
23102 \begin_inset Quotes eld
23106 \begin_inset Quotes erd
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23120 Note that this is in fact defined in
23121 \begin_inset Flex Code
23124 \begin_layout Plain Layout
23130 , so you can use it in your own definitions, or re-definitions, if you load
23134 \begin_layout Section
23135 \begin_inset CommandInset label
23137 name "sec:Tags-for-XHTML"
23141 Tags for XHTML output
23144 \begin_layout Standard
23145 As with \SpecialChar LaTeX
23146 or DocBook, the format of \SpecialChar LyX
23147 's XHTML output is also controlled by
23148 layout information.
23149 In general, \SpecialChar LyX
23150 provides sensible defaults and, as mentioned earlier, it will
23151 even construct default CSS style rules from the other layout tags.
23152 For example, \SpecialChar LyX
23153 will attempt to use the information provided in the
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23163 declaration for the Chapter style to write CSS that will appropriately
23164 format chapter headings.
23167 \begin_layout Standard
23168 In many cases, then, you may not have to do anything at all to get acceptable
23169 XHTML output for your own environments, custom insets, and so forth.
23170 But in some cases you will, and so \SpecialChar LyX
23171 provides a number of layout tags that
23172 can be used to customize the XHTML and CSS that are generated.
23175 \begin_layout Standard
23176 Note that there are two tags,
23177 \begin_inset Flex Code
23180 \begin_layout Plain Layout
23187 \begin_inset Flex Code
23190 \begin_layout Plain Layout
23196 that may appear outside style and inset declarations.
23198 \begin_inset CommandInset ref
23200 reference "subsec:General-text-class"
23204 for details on these.
23207 \begin_layout Subsection
23208 \begin_inset CommandInset label
23210 name "subsec:Paragraph-Style-XHTML"
23217 \begin_layout Standard
23218 The sort of XHTML \SpecialChar LyX
23219 outputs for a paragraph depends upon whether we are dealing
23220 with a normal paragraph, a command, or an environment, where this is itself
23221 determined by the contents of the corresponding
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23236 \begin_layout Standard
23237 For a command or normal paragraph, the output XHTML has the following form:
23240 \begin_layout LyX-Code
23244 \begin_inset Quotes erd
23248 \begin_inset Quotes erd
23254 \begin_layout LyX-Code
23258 \begin_inset Quotes erd
23262 \begin_inset Quotes erd
23268 \begin_layout LyX-Code
23271 Contents of the paragraph.
23274 \begin_layout LyX-Code
23280 \begin_layout Standard
23281 The label tags are of course omitted if the paragraph does not have a label.
23284 \begin_layout Standard
23285 For an environment that is not some sort of list, the XHTML takes this form:
23288 \begin_layout LyX-Code
23292 \begin_inset Quotes erd
23296 \begin_inset Quotes erd
23302 \begin_layout LyX-Code
23306 \begin_inset Quotes erd
23310 \begin_inset Quotes erd
23314 \begin_inset Quotes erd
23318 \begin_inset Quotes erd
23321 >Environment Label</labeltag>First paragraph.</itemtag>
23324 \begin_layout LyX-Code
23327 <itemtag>Second paragraph.</itemtag>
23330 \begin_layout LyX-Code
23336 \begin_layout Standard
23337 Note that the label is output only for the first paragraph, as it should
23338 be for a theorem, for example.
23342 \begin_layout Standard
23343 For a list, we have one of these forms:
23346 \begin_layout LyX-Code
23350 \begin_inset Quotes erd
23354 \begin_inset Quotes erd
23360 \begin_layout LyX-Code
23364 \begin_inset Quotes erd
23368 \begin_inset Quotes erd
23372 \begin_inset Quotes erd
23376 \begin_inset Quotes erd
23379 >List Label</labeltag>First item.</itemtag>
23382 \begin_layout LyX-Code
23386 \begin_inset Quotes erd
23390 \begin_inset Quotes erd
23394 \begin_inset Quotes erd
23398 \begin_inset Quotes erd
23401 >List Label</labeltag>Second item.</itemtag>
23404 \begin_layout LyX-Code
23410 \begin_layout LyX-Code
23414 \begin_layout LyX-Code
23418 \begin_inset Quotes erd
23422 \begin_inset Quotes erd
23428 \begin_layout LyX-Code
23432 \begin_inset Quotes erd
23436 \begin_inset Quotes erd
23439 >List Label</labeltag><itemtag attr=
23440 \begin_inset Quotes erd
23444 \begin_inset Quotes erd
23447 >First item.</itemtag>
23450 \begin_layout LyX-Code
23454 \begin_inset Quotes erd
23458 \begin_inset Quotes erd
23461 >List Label</labeltag><itemtag attr=
23462 \begin_inset Quotes erd
23466 \begin_inset Quotes erd
23469 >Second item.</itemtag>
23472 \begin_layout LyX-Code
23478 \begin_layout Standard
23479 Note the different orders of
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23490 \begin_inset Flex Code
23493 \begin_layout Plain Layout
23500 Which order we get depends upon the setting of
23501 \begin_inset Flex Code
23504 \begin_layout Plain Layout
23511 \begin_inset Flex Code
23514 \begin_layout Plain Layout
23520 is false (the default), you get the first of these, with the label within
23521 the item; if true, you get the second, with the label outside the item.
23524 \begin_layout Standard
23525 The specific tags and attributes output for each paragraph type can be controlle
23526 d by means of the layout tags we are about to describe.
23527 As mentioned earlier, however, \SpecialChar LyX
23528 uses sensible defaults for many of these,
23529 so you often may not need to do very much to get good XHTML output.
23530 Think of the available tags as there so you can tweak things to your liking.
23533 \begin_layout Description
23534 \begin_inset Flex Code
23537 \begin_layout Plain Layout
23544 \begin_inset Flex Code
23547 \begin_layout Plain Layout
23553 ] Specifies attribute information to be output with the main tag.
23555 \begin_inset Quotes eld
23559 \begin_inset Flex Code
23562 \begin_layout Plain Layout
23569 \begin_inset Quotes erd
23573 By default, \SpecialChar LyX
23575 \begin_inset Quotes eld
23579 \begin_inset Flex Code
23582 \begin_layout Plain Layout
23589 \begin_inset Quotes erd
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23602 is the \SpecialChar LyX
23603 name of the layout, made lowercase, for example: chapter.
23608 contain any style information.
23610 \begin_inset Flex Code
23613 \begin_layout Plain Layout
23622 \begin_layout Description
23623 \begin_inset Flex Code
23626 \begin_layout Plain Layout
23633 \begin_inset Flex Code
23636 \begin_layout Plain Layout
23646 ] Whether to output the default CSS information \SpecialChar LyX
23647 generates for this layout,
23648 even if additional information is explicitly provided via
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23660 \begin_inset Flex Code
23663 \begin_layout Plain Layout
23669 allows you to alter or augment the generated CSS, rather than to override
23672 \begin_inset Flex Code
23675 \begin_layout Plain Layout
23684 \begin_layout Description
23685 \begin_inset Flex Code
23688 \begin_layout Plain Layout
23695 \begin_inset Flex Code
23698 \begin_layout Plain Layout
23704 ] The tag to be used for individual paragraphs of environments, replacing
23706 \begin_inset Flex Code
23709 \begin_layout Plain Layout
23715 in the examples above.
23717 \begin_inset Flex Code
23720 \begin_layout Plain Layout
23729 \begin_layout Description
23730 \begin_inset Flex Code
23733 \begin_layout Plain Layout
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23749 ] Attributes for the item tag.
23751 \begin_inset Newline newline
23755 \begin_inset Quotes eld
23759 \begin_inset Flex Code
23762 \begin_layout Plain Layout
23763 class=`layoutname_item'
23769 \begin_inset Quotes erd
23777 contain any style information.
23779 \begin_inset Flex Code
23782 \begin_layout Plain Layout
23791 \begin_layout Description
23792 \begin_inset Flex Code
23795 \begin_layout Plain Layout
23802 \begin_inset Flex Code
23805 \begin_layout Plain Layout
23811 ] The tag to be used for paragraph and item labels, replacing
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23821 in the examples above.
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23833 \begin_inset Flex Code
23836 \begin_layout Plain Layout
23843 \begin_inset Flex Code
23846 \begin_layout Plain Layout
23853 \begin_inset Flex Code
23856 \begin_layout Plain Layout
23857 Centered_Top_Environment
23862 , in which case it defaults to
23863 \begin_inset Flex Code
23866 \begin_layout Plain Layout
23875 \begin_layout Description
23876 \begin_inset Flex Code
23879 \begin_layout Plain Layout
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23895 ] Attributes for the label tag.
23897 \begin_inset Newline newline
23901 \begin_inset Quotes eld
23905 \begin_inset Flex Code
23908 \begin_layout Plain Layout
23909 class=`layoutname_label'
23915 \begin_inset Quotes erd
23923 contain any style information.
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23937 \begin_layout Description
23938 \begin_inset Flex Code
23941 \begin_layout Plain Layout
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23961 ] Meaningful only for list-like environments, this tag controls whether
23962 the label tag is output before or inside the item tag.
23963 This is used, for example, in the description environment, where we want
23965 \begin_inset Flex Code
23968 \begin_layout Plain Layout
23969 <dt>\SpecialChar ldots
23970 </dt><dd>\SpecialChar ldots
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23987 : The label tag is output inside the item tag.
23990 \begin_layout Description
23991 \begin_inset Flex Code
23994 \begin_layout Plain Layout
24000 Information to be output in the
24001 \begin_inset Flex Code
24004 \begin_layout Plain Layout
24010 section when this style is used.
24011 This might, for example, be used to include a
24012 \begin_inset Flex Code
24015 \begin_layout Plain Layout
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24034 \begin_layout Description
24035 \begin_inset Flex Code
24038 \begin_layout Plain Layout
24044 CSS style information to be included when this style is used.
24045 Note that this will automatically be wrapped in a layout-generated
24046 \begin_inset Flex Code
24049 \begin_layout Plain Layout
24055 block, so only the CSS itself need be included.
24057 \begin_inset Flex Code
24060 \begin_layout Plain Layout
24069 \begin_layout Description
24070 \begin_inset Flex Code
24073 \begin_layout Plain Layout
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24089 ] The tag to be used for the main label, replacing
24090 \begin_inset Flex Code
24093 \begin_layout Plain Layout
24099 in the examples above.
24101 \begin_inset Flex Code
24104 \begin_layout Plain Layout
24113 \begin_layout Description
24114 \begin_inset Flex Code
24117 \begin_layout Plain Layout
24124 \begin_inset Flex Code
24127 \begin_layout Plain Layout
24137 ] Marks this style as the one to be used to generate the
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24147 tag for the XHTML file.
24148 By default, it is false.
24150 \begin_inset Flex Code
24153 \begin_layout Plain Layout
24159 file sets it to true for the
24160 \begin_inset Flex Code
24163 \begin_layout Plain Layout
24173 \begin_layout Subsection
24177 \begin_layout Standard
24178 The XHTML output of insets can also be controlled by information in layout
24183 \begin_layout Plain Layout
24184 At present, this is true only for
24185 \begin_inset Quotes eld
24189 \begin_inset Quotes erd
24192 insets (insets you can type into) and is not true for
24193 \begin_inset Quotes eld
24197 \begin_inset Quotes erd
24200 insets (insets that are associated with dialog boxes).
24205 Here, too, \SpecialChar LyX
24206 tries to provide sensible defaults, and it constructs default
24208 But everything can be customized.
24211 \begin_layout Standard
24212 The XHTML \SpecialChar LyX
24213 outputs for an inset has the following form:
24216 \begin_layout LyX-Code
24218 \begin_inset Quotes erd
24222 \begin_inset Quotes erd
24228 \begin_layout LyX-Code
24229 <labeltag>Label</labeltag>
24232 \begin_layout LyX-Code
24234 \begin_inset Quotes erd
24238 \begin_inset Quotes erd
24241 >Contents of the inset.</innertag>
24244 \begin_layout LyX-Code
24248 \begin_layout Standard
24249 If the inset permits multiple paragraphs—that is, if
24250 \begin_inset Flex Code
24253 \begin_layout Plain Layout
24259 is true—then the contents of the inset will itself be output as paragraphs
24260 formatted according to the styles used for those paragraphs (standard,
24261 quote, and the like).
24262 The label tag is of course omitted if the paragraph does not have a label
24263 and, at present, is always
24264 \begin_inset Flex Code
24267 \begin_layout Plain Layout
24274 The inner tag is optional and, by default, does not appear.
24277 \begin_layout Standard
24278 The specific tags and attributes output for each inset can be controlled
24279 by means of the following layout tags.
24282 \begin_layout Description
24283 \begin_inset Flex Code
24286 \begin_layout Plain Layout
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24302 ] Specifies attribute information to be output with the main tag.
24304 \begin_inset Quotes eld
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24312 class=`myinset' onclick=`\SpecialChar ldots
24319 \begin_inset Quotes erd
24323 By default, \SpecialChar LyX
24325 \begin_inset Quotes eld
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24339 \begin_inset Quotes erd
24343 \begin_inset Flex Code
24346 \begin_layout Plain Layout
24352 is the \SpecialChar LyX
24353 name of the inset, made lowercase and with non-alphanumeric characters
24354 converted to underscores, for example: footnote.
24357 \begin_layout Description
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24381 ] Whether to output the default CSS information \SpecialChar LyX
24382 generates for this layout,
24383 even if additional information is explicitly provided via
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24395 \begin_inset Flex Code
24398 \begin_layout Plain Layout
24404 allows you to alter or augment the generated CSS, rather than to override
24409 \begin_layout Description
24410 \begin_inset Flex Code
24413 \begin_layout Plain Layout
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24429 ] Attributes for the inner tag.
24431 \begin_inset Newline newline
24435 \begin_inset Quotes eld
24439 \begin_inset Flex Code
24442 \begin_layout Plain Layout
24443 class=`insetname_inner'
24449 \begin_inset Quotes erd
24455 \begin_layout Description
24456 \begin_inset Flex Code
24459 \begin_layout Plain Layout
24466 \begin_inset Flex Code
24469 \begin_layout Plain Layout
24475 ] The inner tag, replacing
24476 \begin_inset Flex Code
24479 \begin_layout Plain Layout
24485 in the examples above.
24486 By default, there is none.
24489 \begin_layout Description
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24511 ] Whether this inset represents a standalone block of text (such as a footnote)
24512 or instead represents material that is included in the surrounding text
24513 (such as a branch).
24517 \begin_layout Description
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24537 ] A label for this inset, possibly including a reference to a counter.
24538 For example, for footnote, it might be:
24539 \begin_inset Flex Code
24542 \begin_layout Plain Layout
24551 This is optional, and there is no default.
24554 \begin_layout Description
24555 \begin_inset Flex Code
24558 \begin_layout Plain Layout
24564 Information to be output in the
24565 \begin_inset Flex Code
24568 \begin_layout Plain Layout
24574 section when this style is used.
24575 This might, for example, be used to include a
24576 \begin_inset Flex Code
24579 \begin_layout Plain Layout
24586 \begin_inset Flex Code
24589 \begin_layout Plain Layout
24598 \begin_layout Description
24599 \begin_inset Flex Code
24602 \begin_layout Plain Layout
24608 CSS style information to be included when this style is used.
24609 Note that this will automatically be wrapped in a layout-generated
24610 \begin_inset Flex Code
24613 \begin_layout Plain Layout
24619 block, so only the CSS itself need be included.
24622 \begin_layout Description
24623 \begin_inset Flex Code
24626 \begin_layout Plain Layout
24633 \begin_inset Flex Code
24636 \begin_layout Plain Layout
24642 ] The tag to be used for the main label, replacing
24643 \begin_inset Flex Code
24646 \begin_layout Plain Layout
24652 in the examples above.
24653 The default depends upon the setting of
24654 \begin_inset Flex Code
24657 \begin_layout Plain Layout
24664 \begin_inset Flex Code
24667 \begin_layout Plain Layout
24673 is true, the default is
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24683 ; if it is false, the default is
24684 \begin_inset Flex Code
24687 \begin_layout Plain Layout
24696 \begin_layout Subsection
24700 \begin_layout Standard
24701 The XHTML output for floats too can be controlled by layout information.
24702 The output has the following form:
24705 \begin_layout LyX-Code
24707 \begin_inset Quotes erd
24711 \begin_inset Quotes erd
24717 \begin_layout LyX-Code
24718 Contents of the float.
24721 \begin_layout LyX-Code
24725 \begin_layout Standard
24726 The caption, if there is one, is a separate inset and will be output as
24728 Its appearance can be controlled via the InsetLayout for caption insets.
24732 \begin_layout Description
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24743 \begin_inset Flex Code
24746 \begin_layout Plain Layout
24752 ] Specifies attribute information to be output with the main tag.
24754 \begin_inset Quotes eld
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24762 class=`myfloat' onclick=`\SpecialChar ldots
24769 \begin_inset Quotes erd
24773 By default, \SpecialChar LyX
24775 \begin_inset Quotes eld
24779 \begin_inset Flex Code
24782 \begin_layout Plain Layout
24783 class=`float float-floattype'
24789 \begin_inset Quotes erd
24793 \begin_inset Flex Code
24796 \begin_layout Plain Layout
24802 is \SpecialChar LyX
24803 's name for this type of float, as determined by the float declaration
24805 \begin_inset CommandInset ref
24807 reference "subsec:Floats"
24811 ), though made lowercase and with non-alphanumeric characters converted
24812 to underscores, for example: float-table.
24815 \begin_layout Description
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24825 CSS style information to be included when this float is used.
24826 Note that this will automatically be wrapped in a layout-generated
24827 \begin_inset Flex Code
24830 \begin_layout Plain Layout
24836 block, so only the CSS itself need be included.
24839 \begin_layout Description
24840 \begin_inset Flex Code
24843 \begin_layout Plain Layout
24850 \begin_inset Flex Code
24853 \begin_layout Plain Layout
24859 ] The tag to be used for this float, replacing
24860 \begin_inset Quotes eld
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24874 \begin_inset Quotes erd
24877 in the example above.
24879 \begin_inset Flex Code
24882 \begin_layout Plain Layout
24888 and will rarely need changing.
24891 \begin_layout Subsection
24892 Bibliography formatting
24895 \begin_layout Standard
24896 The bibliography can be formatted using
24897 \begin_inset Flex Code
24900 \begin_layout Plain Layout
24908 \begin_inset CommandInset ref
24910 reference "subsec:Citation-format-description"
24917 \begin_layout Subsection
24922 \begin_layout Standard
24923 We have several times mentioned that \SpecialChar LyX
24924 will generate default CSS style rules
24925 for both insets and paragraph styles, based upon the other layout information
24927 In this section, we shall say a word about which layout information \SpecialChar LyX
24932 \begin_layout Standard
24933 At present, \SpecialChar LyX
24934 auto-generates CSS only for font information, making use of
24936 \begin_inset Flex Code
24939 \begin_layout Plain Layout
24946 \begin_inset Flex Code
24949 \begin_layout Plain Layout
24956 \begin_inset Flex Code
24959 \begin_layout Plain Layout
24966 \begin_inset Flex Code
24969 \begin_layout Plain Layout
24976 \begin_inset Flex Code
24979 \begin_layout Plain Layout
24986 \begin_inset CommandInset ref
24988 reference "subsec:Font-description"
24993 The translation is mostly straightforward and obvious.
24995 \begin_inset Quotes eld
24999 \begin_inset Flex Code
25002 \begin_layout Plain Layout
25009 \begin_inset Quotes erd
25013 \begin_inset Quotes eld
25017 \begin_inset Flex Code
25020 \begin_layout Plain Layout
25021 font-family: sans-serif;
25027 \begin_inset Quotes erd
25031 The correspondence of \SpecialChar LyX
25032 sizes and CSS sizes is a little less obvious but
25033 nonetheless intuitive.
25035 \begin_inset Flex Code
25038 \begin_layout Plain Layout
25045 \begin_inset Flex URL
25048 \begin_layout Plain Layout
25058 \begin_layout Chapter
25059 Including External Material
25060 \begin_inset CommandInset label
25062 name "chap:Including-External-Material"
25069 \begin_layout Standard
25070 \begin_inset Box Shadowbox
25080 height_special "totalheight"
25085 backgroundcolor "none"
25088 \begin_layout Plain Layout
25089 WARNING: This portion of the documentation has not been updated for some
25091 We certainly hope that it is still accurate, but there are no guarantees.
25099 \begin_layout Standard
25100 The use of material from sources external to \SpecialChar LyX
25101 is covered in detail in the
25107 This part of the manual covers what needs to happen behind the scenes for
25108 new sorts of material to be included.
25111 \begin_layout Section
25115 \begin_layout Standard
25116 The external material feature is based on the concept of a
25121 A template is a specification of how \SpecialChar LyX
25122 should interface with a certain kind
25124 As bundled, \SpecialChar LyX
25125 comes with predefined templates for Xfig figures, various
25126 raster format images, chess diagrams, and LilyPond music notation.
25127 You can check the actual list by using the menu
25128 \begin_inset Flex Noun
25131 \begin_layout Plain Layout
25132 Insert\SpecialChar menuseparator
25133 File\SpecialChar menuseparator
25140 Furthermore, it is possible to roll your own template to support a specific
25142 Later we'll describe in more detail what is involved, and hopefully you
25143 will submit all the templates you create so we can include them in a later
25148 \begin_layout Standard
25149 Another basic idea of the external material feature is to distinguish between
25150 the original file that serves as a base for final material and the produced
25151 file that is included in your exported or printed document.
25152 For example, consider the case of a figure produced with
25153 \begin_inset Flex Code
25156 \begin_layout Plain Layout
25163 The Xfig application itself works on an original file with the
25164 \begin_inset Flex Code
25167 \begin_layout Plain Layout
25174 Within Xfig, you create and change your figure, and when you are done,
25176 \begin_inset Flex Code
25179 \begin_layout Plain Layout
25186 When you want to include the figure in your document, you invoke
25187 \begin_inset Flex Code
25190 \begin_layout Plain Layout
25196 in order to create a PostScript file that can readily be included in your
25200 \begin_inset Flex Code
25203 \begin_layout Plain Layout
25209 file is the original file, and the PostScript file is the produced file.
25212 \begin_layout Standard
25213 This distinction is important in order to allow updating of the material
25214 while you are in the process of writing the document.
25215 Furthermore, it provides us with the flexibility that is needed to support
25216 multiple export formats.
25217 For instance, in the case of a plain text file, it is not exactly an award-winn
25218 ing idea to include the figure as raw PostScript.
25219 Instead, you would either prefer to just include a reference to the figure
25220 or try to invoke some graphics to ASCII converter to make the final result
25221 look similar to the real graphics.
25222 The external material management allows you to do this, because it is parametri
25223 zed on the different export formats that \SpecialChar LyX
25227 \begin_layout Standard
25228 Besides supporting the production of different products according to the
25229 exported format, it supports tight integration with editing and viewing
25231 In the case of an Xfig figure, you are able to invoke Xfig on the original
25232 file with a single click from within the external material dialog in \SpecialChar LyX
25234 and also preview the produced PostScript file with Ghostview with another
25236 No more fiddling around with the command line and/or file browsers to locate
25237 and manipulate the original or produced files.
25238 In this way, you are finally able to take full advantage of the many different
25239 applications that are relevant to use when you write your documents, and
25240 ultimately be more productive.
25243 \begin_layout Section
25244 The external template configuration files
25247 \begin_layout Standard
25248 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25250 However, be aware that doing this in an careless manner most probably
25254 introduce an easily exploitable security hole.
25255 So before you do this, please read the discussion about security in
25256 \begin_inset CommandInset ref
25258 reference "sec:Security-discussion"
25265 \begin_layout Standard
25266 Having said that, we encourage you to submit any interesting templates that
25271 \begin_layout Standard
25272 The external templates are defined in the
25273 \begin_inset Flex Code
25276 \begin_layout Plain Layout
25282 files that are stored in the
25283 \begin_inset Flex Code
25286 \begin_layout Plain Layout
25287 LyXDir/lib/xtemplates/
25293 Each template is defined in a file of its own.
25294 You can place your own templates in
25295 \begin_inset Flex Code
25298 \begin_layout Plain Layout
25299 UserDir/xtemplates/
25304 or copy existing templates to that directory in order to modify them.
25307 \begin_layout Standard
25308 A typical template looks like this:
25311 \begin_layout LyX-Code
25315 \begin_layout LyX-Code
25316 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25319 \begin_layout LyX-Code
25323 \begin_layout LyX-Code
25327 \begin_layout LyX-Code
25331 \begin_layout LyX-Code
25335 \begin_layout LyX-Code
25339 \begin_layout LyX-Code
25340 AutomaticProduction true
25343 \begin_layout LyX-Code
25347 \begin_layout LyX-Code
25351 \begin_layout LyX-Code
25355 \begin_layout LyX-Code
25356 TransformCommand Rotate RotationLatexCommand
25359 \begin_layout LyX-Code
25360 TransformCommand Resize ResizeLatexCommand
25363 \begin_layout LyX-Code
25364 Product "$$RotateFront$$ResizeFront
25367 \begin_layout LyX-Code
25372 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25375 \begin_layout LyX-Code
25376 $$ResizeBack$$RotateBack"
25379 \begin_layout LyX-Code
25383 \begin_layout LyX-Code
25384 UpdateResult "$$AbsPath$$Basename.pstex_t"
25387 \begin_layout LyX-Code
25388 Requirement "graphicx"
25391 \begin_layout LyX-Code
25392 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25395 \begin_layout LyX-Code
25396 ReferencedFile latex "$$AbsPath$$Basename.eps"
25399 \begin_layout LyX-Code
25400 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25403 \begin_layout LyX-Code
25407 \begin_layout LyX-Code
25411 \begin_layout LyX-Code
25412 TransformCommand Rotate RotationLatexCommand
25415 \begin_layout LyX-Code
25416 TransformCommand Resize ResizeLatexCommand
25419 \begin_layout LyX-Code
25420 Product "$$RotateFront$$ResizeFront
25423 \begin_layout LyX-Code
25428 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25431 \begin_layout LyX-Code
25432 $$ResizeBack$$RotateBack"
25435 \begin_layout LyX-Code
25436 UpdateFormat pdftex
25439 \begin_layout LyX-Code
25440 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25443 \begin_layout LyX-Code
25444 Requirement "graphicx"
25447 \begin_layout LyX-Code
25448 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25451 \begin_layout LyX-Code
25452 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25455 \begin_layout LyX-Code
25459 \begin_layout LyX-Code
25463 \begin_layout LyX-Code
25464 Product "[XFig: $$FName]"
25467 \begin_layout LyX-Code
25471 \begin_layout LyX-Code
25475 \begin_layout LyX-Code
25476 Product "<graphic fileref=
25478 "$$AbsOrRelPathMaster$$Basename.eps
25483 \begin_layout LyX-Code
25487 \begin_layout LyX-Code
25491 \begin_layout LyX-Code
25492 UpdateResult "$$AbsPath$$Basename.eps"
25495 \begin_layout LyX-Code
25496 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25499 \begin_layout LyX-Code
25500 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25503 \begin_layout LyX-Code
25507 \begin_layout LyX-Code
25511 \begin_layout Standard
25512 As you can see, the template is enclosed in
25513 \begin_inset Flex Code
25516 \begin_layout Plain Layout
25524 \begin_inset Flex Code
25527 \begin_layout Plain Layout
25534 It contains a header specifying some general settings and, for each supported
25535 primary document file format, a section
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25547 \begin_inset Flex Code
25550 \begin_layout Plain Layout
25559 \begin_layout Subsection
25560 The template header
25563 \begin_layout Description
25564 \begin_inset Flex Code
25567 \begin_layout Plain Layout
25568 AutomaticProduction
25569 \begin_inset space ~
25577 Whether the file represented by the template must be generated by \SpecialChar LyX
25579 This command must occur exactly once.
25582 \begin_layout Description
25583 \begin_inset Flex Code
25586 \begin_layout Plain Layout
25588 \begin_inset space ~
25596 A glob pattern that is used in the file dialog to filter out the desired
25598 If there is more than one possible file extension (e.
25599 \begin_inset space \thinspace{}
25603 \begin_inset space \space{}
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25617 \begin_inset Flex Code
25620 \begin_layout Plain Layout
25626 ), use something like
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25637 This command must occur exactly once.
25640 \begin_layout Description
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25646 \begin_inset space ~
25654 The text that is displayed on the button.
25655 This command must occur exactly once.
25658 \begin_layout Description
25659 \begin_inset Flex Code
25662 \begin_layout Plain Layout
25664 \begin_inset space ~
25668 \begin_inset space ~
25676 The help text that is used in the External dialog.
25677 Provide enough information to explain to the user just what the template
25678 can provide him with.
25679 This command must occur exactly once.
25682 \begin_layout Description
25683 \begin_inset Flex Code
25686 \begin_layout Plain Layout
25688 \begin_inset space ~
25696 The file format of the original file.
25697 This must be the name of a format that is known to \SpecialChar LyX
25699 \begin_inset CommandInset ref
25701 reference "sec:Formats"
25707 \begin_inset Quotes eld
25711 \begin_inset Flex Code
25714 \begin_layout Plain Layout
25721 \begin_inset Quotes erd
25724 if the template can handle original files of more than one format.
25726 will attempt to interrogate the file itself in order to deduce its format
25728 This command must occur exactly once.
25731 \begin_layout Description
25732 \begin_inset Flex Code
25735 \begin_layout Plain Layout
25737 \begin_inset space ~
25745 A unique name for the template.
25746 It must not contain substitution macros (see below).
25749 \begin_layout Description
25750 \begin_inset Flex Code
25753 \begin_layout Plain Layout
25755 \begin_inset space ~
25758 Rotate|Resize|Clip|Extra
25763 This command specifies which transformations are supported by this template.
25764 It may occur zero or more times.
25765 This command enables the corresponding tabs in the external dialog.
25767 \begin_inset Flex Code
25770 \begin_layout Plain Layout
25776 command must have either a corresponding
25777 \begin_inset Flex Code
25780 \begin_layout Plain Layout
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25797 \begin_inset Flex Code
25800 \begin_layout Plain Layout
25807 Otherwise the transformation will not be supported by that format.
25810 \begin_layout Subsection
25814 \begin_layout Description
25815 \begin_inset Flex Code
25818 \begin_layout Plain Layout
25820 \begin_inset space ~
25823 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25828 The primary document file format that this format definition is for.
25829 Not every template has a sensible representation in all document file formats.
25830 Please define nevertheless a
25831 \begin_inset Flex Code
25834 \begin_layout Plain Layout
25840 section for all templates.
25841 Use a dummy text when no representation is available.
25842 Then you can at least see a reference to the external material in the exported
25846 \begin_layout Description
25847 \begin_inset Flex Code
25850 \begin_layout Plain Layout
25852 \begin_inset space ~
25856 \begin_inset space ~
25864 This command defines an additional macro
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25874 for substitution in
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25895 itself may contain substitution macros.
25896 The advantage over using
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25916 is that the substituted value of
25917 \begin_inset Flex Code
25920 \begin_layout Plain Layout
25926 is sanitized so that it is a valid optional argument in the document format.
25927 This command may occur zero or more times.
25930 \begin_layout Description
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25936 \begin_inset space ~
25944 The text that is inserted in the exported document.
25945 This is actually the most important command and can be quite complex.
25946 This command must occur exactly once.
25949 \begin_layout Description
25950 \begin_inset Flex Code
25953 \begin_layout Plain Layout
25955 \begin_inset space ~
25963 This command specifies a preamble snippet that will be included in the
25966 It has to be defined using
25967 \begin_inset Flex Code
25970 \begin_layout Plain Layout
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25988 This command may occur zero or more times.
25991 \begin_layout Description
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
25997 \begin_inset space ~
26001 \begin_inset space ~
26009 This command denotes files that are created by the conversion process and
26010 are needed for a particular export format.
26011 If the filename is relative, it is interpreted relative to the master document.
26012 This command may be given zero or more times.
26015 \begin_layout Description
26016 \begin_inset Flex Code
26019 \begin_layout Plain Layout
26021 \begin_inset space ~
26029 The name of a required \SpecialChar LaTeX
26031 The package is included via
26032 \begin_inset Flex Code
26035 \begin_layout Plain Layout
26043 in the \SpecialChar LaTeX
26045 This command may occur zero or more times.
26048 \begin_layout Description
26049 \begin_inset Flex Code
26052 \begin_layout Plain Layout
26054 \begin_inset space ~
26058 \begin_inset space ~
26061 RotationLatexCommand
26066 This command specifies that the built in \SpecialChar LaTeX
26067 command should be used for rotation.
26068 This command may occur once or not at all.
26071 \begin_layout Description
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26077 \begin_inset space ~
26081 \begin_inset space ~
26089 This command specifies that the built in \SpecialChar LaTeX
26090 command should be used for resizing.
26091 This command may occur once or not at all.
26094 \begin_layout Description
26095 \begin_inset Flex Code
26098 \begin_layout Plain Layout
26100 \begin_inset space ~
26104 \begin_inset space ~
26107 RotationLatexOption
26112 This command specifies that rotation is done via an optional argument.
26113 This command may occur once or not at all.
26116 \begin_layout Description
26117 \begin_inset Flex Code
26120 \begin_layout Plain Layout
26122 \begin_inset space ~
26126 \begin_inset space ~
26134 This command specifies that resizing is done via an optional argument.
26135 This command may occur once or not at all.
26138 \begin_layout Description
26139 \begin_inset Flex Code
26142 \begin_layout Plain Layout
26144 \begin_inset space ~
26148 \begin_inset space ~
26156 This command specifies that clipping is done via an optional argument.
26157 This command may occur once or not at all.
26160 \begin_layout Description
26161 \begin_inset Flex Code
26164 \begin_layout Plain Layout
26166 \begin_inset space ~
26170 \begin_inset space ~
26178 This command specifies that an extra optional argument is used.
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 ~
26196 The file format of the converted file.
26197 This must be the name of a format that is known to \SpecialChar LyX
26199 \begin_inset Flex Noun
26202 \begin_layout Plain Layout
26203 Tools\SpecialChar menuseparator
26204 Preferences\SpecialChar menuseparator
26205 File Handling\SpecialChar menuseparator
26212 This command must occur exactly once.
26213 If the resulting file format is PDF, you need to specify the format
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26224 This is the PDF format used for including graphics.
26225 The other defined PDF formats are for document export.
26228 \begin_layout Description
26229 \begin_inset Flex Code
26232 \begin_layout Plain Layout
26234 \begin_inset space ~
26242 The file name of the converted file.
26243 The file name must be absolute.
26244 This command must occur exactly once.
26247 \begin_layout Subsection
26248 Preamble definitions
26251 \begin_layout Standard
26252 The external template configuration file may contain additional preamble
26253 definitions enclosed by
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26265 \begin_inset Flex Code
26268 \begin_layout Plain Layout
26275 They can be used by the templates in the
26276 \begin_inset Flex Code
26279 \begin_layout Plain Layout
26288 \begin_layout Section
26289 The substitution mechanism
26292 \begin_layout Standard
26293 When the external material facility invokes an external program, it is done
26294 on the basis of a command defined in the template configuration file.
26295 These commands can contain various macros that are expanded before execution.
26296 Execution always take place in the directory of the containing document.
26299 \begin_layout Standard
26300 Also, whenever external material is to be displayed, the name will be produced
26301 by the substitution mechanism, and most other commands in the template
26302 definition support substitution as well.
26305 \begin_layout Standard
26306 The available macros are the following:
26309 \begin_layout Description
26310 \begin_inset Flex Code
26313 \begin_layout Plain Layout
26314 $$AbsOrRelPathMaster
26319 The file path, absolute or relative to the master \SpecialChar LyX
26323 \begin_layout Description
26324 \begin_inset Flex Code
26327 \begin_layout Plain Layout
26328 $$AbsOrRelPathParent
26333 The file path, absolute or relative to the \SpecialChar LyX
26337 \begin_layout Description
26338 \begin_inset Flex Code
26341 \begin_layout Plain Layout
26347 The absolute file path.
26350 \begin_layout Description
26351 \begin_inset Flex Code
26354 \begin_layout Plain Layout
26360 The filename without path and without the extension.
26363 \begin_layout Description
26364 \begin_inset Flex Code
26367 \begin_layout Plain Layout
26369 \begin_inset Quotes eld
26373 \begin_inset Quotes erd
26381 This macro will expand to the contents of the file with the name
26382 \begin_inset Flex Code
26385 \begin_layout Plain Layout
26394 \begin_layout Description
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26404 The file extension (including the dot).
26407 \begin_layout Description
26408 \begin_inset Flex Code
26411 \begin_layout Plain Layout
26417 This will be the string
26418 \begin_inset Quotes eld
26422 \begin_inset Quotes erd
26425 if the file is in JPEG format, otherwise it will be the string
26426 \begin_inset Quotes eld
26430 \begin_inset Quotes erd
26434 This is useful to avoid uneeded conversions for output formats that support
26435 both PNG and JPEG fomats.
26436 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26441 \begin_layout Description
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26451 The filename of the file specified in the external material dialog.
26452 This is either an absolute name, or it is relative to the \SpecialChar LyX
26456 \begin_layout Description
26457 \begin_inset Flex Code
26460 \begin_layout Plain Layout
26467 \begin_inset Flex Code
26470 \begin_layout Plain Layout
26476 (absolute name or relative to the \SpecialChar LyX
26480 \begin_layout Description
26481 \begin_inset Flex Code
26484 \begin_layout Plain Layout
26490 The file path, relative to the master \SpecialChar LyX
26494 \begin_layout Description
26495 \begin_inset Flex Code
26498 \begin_layout Plain Layout
26504 The file path, relative to the \SpecialChar LyX
26508 \begin_layout Description
26509 \begin_inset Flex Code
26512 \begin_layout Plain Layout
26518 This macro will expand to the absolute path of the system directory.
26519 This is typically used to point to the various helper scripts that are
26520 bundled with \SpecialChar LyX
26524 \begin_layout Description
26525 \begin_inset Flex Code
26528 \begin_layout Plain Layout
26534 A name and full path to a temporary file which will be automatically deleted
26535 whenever the containing document is closed, or the external material insertion
26539 \begin_layout Standard
26540 All path macros contain a trailing directory separator, so you can construct
26542 \begin_inset space \thinspace{}
26546 \begin_inset space \space{}
26549 the absolute filename with
26550 \begin_inset Flex Code
26553 \begin_layout Plain Layout
26554 $$AbsPath$$Basename$$Extension
26562 \begin_layout Standard
26563 The macros above are substituted in all commands unless otherwise noted.
26565 \begin_inset Flex Code
26568 \begin_layout Plain Layout
26574 supports additionally the following substitutions if they are enabled by
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26586 \begin_inset Flex Code
26589 \begin_layout Plain Layout
26598 \begin_layout Description
26599 \begin_inset Flex Code
26602 \begin_layout Plain Layout
26608 The front part of the resize command.
26611 \begin_layout Description
26612 \begin_inset Flex Code
26615 \begin_layout Plain Layout
26621 The back part of the resize command.
26624 \begin_layout Description
26625 \begin_inset Flex Code
26628 \begin_layout Plain Layout
26634 The front part of the rotation command.
26637 \begin_layout Description
26638 \begin_inset Flex Code
26641 \begin_layout Plain Layout
26647 The back part of the rotation command.
26650 \begin_layout Standard
26651 The value string of the
26652 \begin_inset Flex Code
26655 \begin_layout Plain Layout
26661 command supports additionally the following substitutions if they are enabled
26663 \begin_inset Flex Code
26666 \begin_layout Plain Layout
26673 \begin_inset Flex Code
26676 \begin_layout Plain Layout
26685 \begin_layout Description
26686 \begin_inset Flex Code
26689 \begin_layout Plain Layout
26698 \begin_layout Description
26699 \begin_inset Flex Code
26702 \begin_layout Plain Layout
26711 \begin_layout Description
26712 \begin_inset Flex Code
26715 \begin_layout Plain Layout
26724 \begin_layout Description
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26734 The rotation option.
26737 \begin_layout Standard
26738 You may ask why there are so many path macros.
26739 There are mainly two reasons:
26742 \begin_layout Enumerate
26743 Relative and absolute file names should remain relative or absolute, respectivel
26745 Users may have reasons to prefer either form.
26746 Relative names are useful for portable documents that should work on different
26747 machines, for example.
26748 Absolute names may be required by some programs.
26751 \begin_layout Enumerate
26753 treats relative file names differently than \SpecialChar LyX
26754 and other programs in nested
26756 For \SpecialChar LyX
26757 , a relative file name is always relative to the document that contains
26759 For \SpecialChar LaTeX
26760 , it is always relative to the master document.
26761 These two definitions are identical if you have only one document, but
26762 differ if you have a master document that includes part documents.
26763 That means that relative filenames must be transformed when presented to
26766 Fortunately \SpecialChar LyX
26767 does this automatically for you if you choose the right macros.
26770 \begin_layout Standard
26771 So which path macro should be used in new template definitions? The rule
26775 \begin_layout Itemize
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26786 if an absolute path is required.
26789 \begin_layout Itemize
26791 \begin_inset Flex Code
26794 \begin_layout Plain Layout
26795 $$AbsOrRelPathMaster
26800 if the substituted string is some kind of \SpecialChar LaTeX
26804 \begin_layout Itemize
26806 \begin_inset Flex Code
26809 \begin_layout Plain Layout
26810 $$AbsOrRelPathParent
26815 in order to preserve the user's choice.
26818 \begin_layout Standard
26819 There are special cases where this rule does not work and e.
26820 \begin_inset space \thinspace{}
26824 \begin_inset space \space{}
26827 relative names are needed, but normally it will work just fine.
26828 One example for such a case is the command
26829 \begin_inset Flex Code
26832 \begin_layout Plain Layout
26833 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26838 in the XFig template above: We can't use the absolute name because the
26840 \begin_inset Flex Code
26843 \begin_layout Plain Layout
26849 files needs the relative name in order to rewrite the file content.
26852 \begin_layout Section
26853 Security discussion
26854 \begin_inset CommandInset label
26856 name "sec:Security-discussion"
26863 \begin_layout Standard
26864 The external material feature interfaces with a lot of external programs
26865 and does so automatically, so we have to consider the security implications
26867 In particular, since you have the option of including your own filenames
26868 and/or parameter strings and those are expanded into a command, it seems
26869 that it would be possible to create a malicious document which executes
26870 arbitrary commands when a user views or prints the document.
26871 This is something we definitely want to avoid.
26874 \begin_layout Standard
26875 However, since the external program commands are specified in the template
26876 configuration file only, there are no security issues if \SpecialChar LyX
26877 is properly configure
26878 d with safe templates only.
26879 This is so because the external programs are invoked with the
26880 \begin_inset Flex Code
26883 \begin_layout Plain Layout
26889 -system call rather than the
26890 \begin_inset Flex Code
26893 \begin_layout Plain Layout
26899 system-call, so it's not possible to execute arbitrary commands from the
26900 filename or parameter section via the shell.
26903 \begin_layout Standard
26904 This also implies that you are restricted in what command strings you can
26905 use in the external material templates.
26906 In particular, pipes and redirection are not readily available.
26907 This has to be so if \SpecialChar LyX
26908 should remain safe.
26909 If you want to use some of the shell features, you should write a safe
26910 script to do this in a controlled manner, and then invoke the script from
26911 the command string.
26915 \begin_layout Standard
26916 It is possible to design a template that interacts directly with the shell,
26917 but since this would allow a malicious user to execute arbitrary commands
26918 by writing clever filenames and/or parameters, we generally recommend that
26919 you only use safe scripts that work with the
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26929 system call in a controlled manner.
26930 Of course, for use in a controlled environment, it can be tempting to just
26931 fall back to use ordinary shell scripts.
26932 If you do so, be aware that you
26936 provide an easily exploitable security hole in your system.
26937 Of course it stands to reason that such unsafe templates will never be
26938 included in the standard \SpecialChar LyX
26939 distribution, although we do encourage people
26940 to submit new templates in the open source tradition.
26941 But \SpecialChar LyX
26942 as shipped from the official distribution channels will never have
26946 \begin_layout Standard
26947 Including external material provides a lot of power, and you have to be
26948 careful not to introduce security hazards with this power.
26949 A subtle error in a single line in an innocent looking script can open
26950 the door to huge security problems.
26951 So if you do not fully understand the issues, we recommend that you consult
26952 a knowledgeable security professional or the \SpecialChar LyX
26953 development team if you have
26954 any questions about whether a given template is safe or not.
26955 And do this before you use it in an uncontrolled environment.
26958 \begin_layout Chapter
26960 List of supported \SpecialChar LyX
26961 functions to be used in layouts
26962 \begin_inset CommandInset label
26964 name "chap:List-of-functions"
26971 \begin_layout Standard
26973 \begin_inset Tabular
26974 <lyxtabular version="3" rows="11" columns="8">
26975 <features tabularvalignment="middle">
26976 <column alignment="left" valignment="top">
26977 <column alignment="left" valignment="top">
26978 <column alignment="left" valignment="top">
26979 <column alignment="left" valignment="top">
26980 <column alignment="left" valignment="top">
26981 <column alignment="left" valignment="top">
26982 <column alignment="left" valignment="top">
26983 <column alignment="left" valignment="top">
26985 <cell alignment="left" valignment="top" usebox="none">
26988 \begin_layout Plain Layout
26994 <cell alignment="left" valignment="top" usebox="none">
26997 \begin_layout Plain Layout
27003 <cell alignment="left" valignment="top" usebox="none">
27006 \begin_layout Plain Layout
27012 <cell alignment="left" valignment="top" usebox="none">
27015 \begin_layout Plain Layout
27021 <cell alignment="center" valignment="top" usebox="none">
27024 \begin_layout Plain Layout
27030 <cell alignment="center" valignment="top" usebox="none">
27033 \begin_layout Plain Layout
27039 <cell alignment="center" valignment="top" usebox="none">
27042 \begin_layout Plain Layout
27048 <cell alignment="center" valignment="top" usebox="none">
27051 \begin_layout Plain Layout
27059 <cell alignment="left" valignment="top" usebox="none">
27062 \begin_layout Plain Layout
27068 <cell alignment="left" valignment="top" usebox="none">
27071 \begin_layout Plain Layout
27077 <cell alignment="left" valignment="top" usebox="none">
27080 \begin_layout Plain Layout
27086 <cell alignment="left" valignment="top" usebox="none">
27089 \begin_layout Plain Layout
27095 <cell alignment="center" valignment="top" usebox="none">
27098 \begin_layout Plain Layout
27104 <cell alignment="center" valignment="top" usebox="none">
27107 \begin_layout Plain Layout
27113 <cell alignment="center" valignment="top" usebox="none">
27116 \begin_layout Plain Layout
27122 <cell alignment="center" valignment="top" usebox="none">
27125 \begin_layout Plain Layout
27133 <cell alignment="left" valignment="top" usebox="none">
27136 \begin_layout Plain Layout
27142 <cell alignment="left" valignment="top" usebox="none">
27145 \begin_layout Plain Layout
27151 <cell alignment="left" valignment="top" usebox="none">
27154 \begin_layout Plain Layout
27160 <cell alignment="left" valignment="top" usebox="none">
27163 \begin_layout Plain Layout
27169 <cell alignment="center" valignment="top" usebox="none">
27172 \begin_layout Plain Layout
27178 <cell alignment="center" valignment="top" usebox="none">
27181 \begin_layout Plain Layout
27187 <cell alignment="center" valignment="top" usebox="none">
27190 \begin_layout Plain Layout
27196 <cell alignment="center" valignment="top" usebox="none">
27199 \begin_layout Plain Layout
27207 <cell alignment="left" valignment="top" usebox="none">
27210 \begin_layout Plain Layout
27216 <cell alignment="left" valignment="top" usebox="none">
27219 \begin_layout Plain Layout
27225 <cell alignment="left" valignment="top" usebox="none">
27228 \begin_layout Plain Layout
27234 <cell alignment="left" valignment="top" usebox="none">
27237 \begin_layout Plain Layout
27243 <cell alignment="center" valignment="top" usebox="none">
27246 \begin_layout Plain Layout
27252 <cell alignment="center" valignment="top" usebox="none">
27255 \begin_layout Plain Layout
27261 <cell alignment="center" valignment="top" usebox="none">
27264 \begin_layout Plain Layout
27270 <cell alignment="center" valignment="top" usebox="none">
27273 \begin_layout Plain Layout
27281 <cell alignment="left" valignment="top" usebox="none">
27284 \begin_layout Plain Layout
27290 <cell alignment="left" valignment="top" usebox="none">
27293 \begin_layout Plain Layout
27299 <cell alignment="left" valignment="top" usebox="none">
27302 \begin_layout Plain Layout
27308 <cell alignment="left" valignment="top" usebox="none">
27311 \begin_layout Plain Layout
27317 <cell alignment="center" valignment="top" usebox="none">
27320 \begin_layout Plain Layout
27326 <cell alignment="center" valignment="top" usebox="none">
27329 \begin_layout Plain Layout
27335 <cell alignment="center" valignment="top" usebox="none">
27338 \begin_layout Plain Layout
27344 <cell alignment="center" valignment="top" usebox="none">
27347 \begin_layout Plain Layout
27355 <cell alignment="left" valignment="top" usebox="none">
27358 \begin_layout Plain Layout
27364 <cell alignment="left" valignment="top" usebox="none">
27367 \begin_layout Plain Layout
27373 <cell alignment="left" valignment="top" usebox="none">
27376 \begin_layout Plain Layout
27382 <cell alignment="left" valignment="top" usebox="none">
27385 \begin_layout Plain Layout
27391 <cell alignment="center" valignment="top" usebox="none">
27394 \begin_layout Plain Layout
27400 <cell alignment="center" valignment="top" usebox="none">
27403 \begin_layout Plain Layout
27409 <cell alignment="center" valignment="top" usebox="none">
27412 \begin_layout Plain Layout
27418 <cell alignment="center" valignment="top" usebox="none">
27421 \begin_layout Plain Layout
27429 <cell alignment="left" valignment="top" usebox="none">
27432 \begin_layout Plain Layout
27438 <cell alignment="left" valignment="top" usebox="none">
27441 \begin_layout Plain Layout
27447 <cell alignment="left" valignment="top" usebox="none">
27450 \begin_layout Plain Layout
27456 <cell alignment="left" valignment="top" usebox="none">
27459 \begin_layout Plain Layout
27465 <cell alignment="center" valignment="top" usebox="none">
27468 \begin_layout Plain Layout
27474 <cell alignment="center" valignment="top" usebox="none">
27477 \begin_layout Plain Layout
27483 <cell alignment="center" valignment="top" usebox="none">
27486 \begin_layout Plain Layout
27492 <cell alignment="center" valignment="top" usebox="none">
27495 \begin_layout Plain Layout
27503 <cell alignment="left" valignment="top" usebox="none">
27506 \begin_layout Plain Layout
27512 <cell alignment="left" valignment="top" usebox="none">
27515 \begin_layout Plain Layout
27521 <cell alignment="left" valignment="top" usebox="none">
27524 \begin_layout Plain Layout
27530 <cell alignment="left" valignment="top" usebox="none">
27533 \begin_layout Plain Layout
27539 <cell alignment="center" valignment="top" usebox="none">
27542 \begin_layout Plain Layout
27548 <cell alignment="center" valignment="top" usebox="none">
27551 \begin_layout Plain Layout
27557 <cell alignment="center" valignment="top" usebox="none">
27560 \begin_layout Plain Layout
27566 <cell alignment="center" valignment="top" usebox="none">
27569 \begin_layout Plain Layout
27577 <cell alignment="left" valignment="top" usebox="none">
27580 \begin_layout Plain Layout
27586 <cell alignment="left" valignment="top" usebox="none">
27589 \begin_layout Plain Layout
27595 <cell alignment="left" valignment="top" usebox="none">
27598 \begin_layout Plain Layout
27604 <cell alignment="left" valignment="top" usebox="none">
27607 \begin_layout Plain Layout
27613 <cell alignment="center" valignment="top" usebox="none">
27616 \begin_layout Plain Layout
27622 <cell alignment="center" valignment="top" usebox="none">
27625 \begin_layout Plain Layout
27631 <cell alignment="center" valignment="top" usebox="none">
27634 \begin_layout Plain Layout
27640 <cell alignment="center" valignment="top" usebox="none">
27643 \begin_layout Plain Layout
27651 <cell alignment="left" valignment="top" usebox="none">
27654 \begin_layout Plain Layout
27660 <cell alignment="left" valignment="top" usebox="none">
27663 \begin_layout Plain Layout
27669 <cell alignment="left" valignment="top" usebox="none">
27672 \begin_layout Plain Layout
27678 <cell alignment="left" valignment="top" usebox="none">
27681 \begin_layout Plain Layout
27687 <cell alignment="center" valignment="top" usebox="none">
27690 \begin_layout Plain Layout
27696 <cell alignment="center" valignment="top" usebox="none">
27699 \begin_layout Plain Layout
27705 <cell alignment="center" valignment="top" usebox="none">
27708 \begin_layout Plain Layout
27714 <cell alignment="center" valignment="top" usebox="none">
27717 \begin_layout Plain Layout
27725 <cell alignment="center" valignment="top" usebox="none">
27728 \begin_layout Plain Layout
27734 <cell alignment="center" valignment="top" usebox="none">
27737 \begin_layout Plain Layout
27743 <cell alignment="center" valignment="top" usebox="none">
27746 \begin_layout Plain Layout
27752 <cell alignment="center" valignment="top" usebox="none">
27755 \begin_layout Plain Layout
27761 <cell alignment="center" valignment="top" usebox="none">
27764 \begin_layout Plain Layout
27770 <cell alignment="center" valignment="top" usebox="none">
27773 \begin_layout Plain Layout
27779 <cell alignment="center" valignment="top" usebox="none">
27782 \begin_layout Plain Layout
27788 <cell alignment="center" valignment="top" usebox="none">
27791 \begin_layout Plain Layout
27805 \begin_layout Chapter
27806 Names of available colors to be used in layouts
27807 \begin_inset CommandInset label
27809 name "chap:Names-of-colors"
27816 \begin_layout Standard
27817 The colors listed below are the standard colors and those that you can adjust
27818 in the \SpecialChar LyX
27822 \begin_layout Section
27826 \begin_layout Standard
27827 The following are no real colors, but rather act on color definitions:
27830 \begin_layout Description
27831 ignore The color is ignored
27834 \begin_layout Description
27835 inherit The color is inherited
27838 \begin_layout Description
27851 No particular color – clear or default
27854 \begin_layout Section
27858 \begin_layout Standard
27859 These are fixed colors that cannot me customized:
27862 \begin_layout Description
27866 \begin_layout Description
27870 \begin_layout Description
27874 \begin_layout Description
27878 \begin_layout Description
27882 \begin_layout Description
27886 \begin_layout Description
27890 \begin_layout Description
27894 \begin_layout Description
27898 \begin_layout Description
27902 \begin_layout Description
27906 \begin_layout Description
27910 \begin_layout Description
27914 \begin_layout Description
27918 \begin_layout Description
27922 \begin_layout Description
27926 \begin_layout Description
27930 \begin_layout Description
27934 \begin_layout Description
27938 \begin_layout Section
27942 \begin_layout Standard
27943 These are the colors allocated to specific elements in
27946 arg "dialog-show prefs"
27952 \begin_layout Description
27953 added_space Added space color
27956 \begin_layout Description
27957 addedtext Added text color
27960 \begin_layout Description
27961 appendix Appendix marker color
27964 \begin_layout Description
27965 background Background color
27968 \begin_layout Description
27969 bottomarea Bottom area color
27972 \begin_layout Description
27973 branchlabel Label color for branches
27976 \begin_layout Description
27977 buttonbg Color used for button background
27980 \begin_layout Description
27981 buttonframe Color for inset button frames
27984 \begin_layout Description
27985 buttonhoverbg Color used for button background under focus
27988 \begin_layout Description
27989 changebar Changebar color
27992 \begin_layout Description
27993 changedtextauthor1 Changed text color author 1
27996 \begin_layout Description
27997 changedtextauthor2 Changed text color author 2
28000 \begin_layout Description
28001 changedtextauthor3 Changed text color author 3
28004 \begin_layout Description
28005 changedtextauthor4 Changed text color author 4
28008 \begin_layout Description
28009 changedtextauthor5 Changed text color author 5
28012 \begin_layout Description
28013 collapsible Collapsible insets text color
28016 \begin_layout Description
28017 collapsibleframe Collapsible insets framecolor
28020 \begin_layout Description
28021 command Text color for command insets
28024 \begin_layout Description
28025 commandbg Background color for command insets
28028 \begin_layout Description
28029 commandframe Frame color for command insets
28032 \begin_layout Description
28033 comment Label color for comments
28036 \begin_layout Description
28037 commentbg Background color of comments
28040 \begin_layout Description
28041 cursor Cursor color
28044 \begin_layout Description
28045 deletedtext Deleted text color
28048 \begin_layout Description
28049 deletedtextmodifier Deleted text modifying color
28052 \begin_layout Description
28053 depthbar Color for the depth bars in the margin
28056 \begin_layout Description
28057 eolmarker End of line marker color
28060 \begin_layout Description
28061 error Color of the \SpecialChar LaTeX
28065 \begin_layout Description
28066 footlabel Label color for footnotes
28069 \begin_layout Description
28070 foreground Foreground color
28073 \begin_layout Description
28074 graphicsbg Graphics inset background color
28077 \begin_layout Description
28078 greyedoutbg Background color of greyedout inset
28081 \begin_layout Description
28082 greyedoutlabel Label color for greyedout insets
28085 \begin_layout Description
28086 greyedouttext Color for greyedout inset text
28089 \begin_layout Description
28090 indexlabel Label color for index insets
28093 \begin_layout Description
28094 inlinecompletion Inline completion color
28097 \begin_layout Description
28098 insetbg Inset marker background color
28101 \begin_layout Description
28102 insetframe Inset marker frame color
28105 \begin_layout Description
28106 language Color for marking foreign language words
28109 \begin_layout Description
28110 latex Text color in \SpecialChar LaTeX
28114 \begin_layout Description
28115 listingsbg Background color of listings inset
28118 \begin_layout Description
28119 marginlabel Label color for margin notes
28122 \begin_layout Description
28123 math Math inset text color
28126 \begin_layout Description
28127 mathbg Math inset background color
28130 \begin_layout Description
28131 mathcorners Math inset frame color not under focus
28134 \begin_layout Description
28135 mathframe Math inset frame color under focus
28138 \begin_layout Description
28139 mathline Math line color
28142 \begin_layout Description
28143 mathmacrobg Macro math inset background color
28146 \begin_layout Description
28147 mathmacroblend Macro math blended color
28150 \begin_layout Description
28151 mathmacroframe Macro math frame color
28154 \begin_layout Description
28155 mathmacrohoverbg Macro math inset background color hovered
28158 \begin_layout Description
28159 mathmacrolabel Macro math label color
28162 \begin_layout Description
28163 mathmacronewarg Macro template color for new parameters
28166 \begin_layout Description
28167 mathmacrooldarg Macro template color for old parameters
28170 \begin_layout Description
28171 newpage New page color
28174 \begin_layout Description
28175 nonunique_inlinecompletion Inline completion color for the non-unique part
28178 \begin_layout Description
28179 note Label color for notes
28182 \begin_layout Description
28183 notebg Background color of notes
28186 \begin_layout Description
28187 pagebreak Page break/line break color
28190 \begin_layout Description
28191 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28194 \begin_layout Description
28195 phantomtext Text color for phantom insets
28198 \begin_layout Description
28199 preview The color used for previews
28202 \begin_layout Description
28203 previewframe Preview frame color
28206 \begin_layout Description
28207 regexpframe Color for regexp frame
28210 \begin_layout Description
28211 scroll Color that indicates when a row can be scrolled
28214 \begin_layout Description
28215 selection Background color of selected text
28218 \begin_layout Description
28219 selectiontext Foreground color of selected text
28222 \begin_layout Description
28223 shadedbg Background color of shaded box
28226 \begin_layout Description
28227 special Special chars text color
28230 \begin_layout Description
28231 tabularline Table line color
28234 \begin_layout Description
28235 tabularonoffline Table line color
28238 \begin_layout Description
28239 urllabel Label color for URL insets
28242 \begin_layout Description
28243 urltext Color for URL inset text