1 #LyX 2.4 created this file. For more info see https://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
2412 \change_inserted -712698321 1524656940
2420 This converter runs some form of \SpecialChar LaTeX
2422 This will make \SpecialChar LyX
2423 's \SpecialChar LaTeX
2424 error logs available.
2426 \change_inserted -712698321 1524657018
2428 \begin_inset Flex Code
2431 \begin_layout Plain Layout
2433 \change_inserted -712698321 1524657012
2441 value specifies the form of \SpecialChar LaTeX
2443 \begin_inset Flex Code
2446 \begin_layout Plain Layout
2448 \change_inserted -712698321 1524657005
2449 latex, pdflatex, platex, xetex, luatex
2457 If no value is specified,
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2463 \change_inserted -712698321 1524657018
2476 \begin_layout Labeling
2477 \labelwidthstring 00.00.0000
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2483 \change_inserted -712698321 1524656935
2491 Needs the \SpecialChar LaTeX
2493 \begin_inset Flex Noun
2496 \begin_layout Plain Layout
2502 file for the conversion.
2504 \change_inserted -712698321 1524657047
2506 \begin_inset Flex Code
2509 \begin_layout Plain Layout
2511 \change_inserted -712698321 1524657030
2517 value specifies the form of \SpecialChar LaTeX
2518 that is run in order to generate the
2519 \begin_inset Flex Noun
2522 \begin_layout Plain Layout
2524 \change_inserted -712698321 1524657047
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2536 \change_inserted -712698321 1524657030
2537 latex, pdflatex, platex, xetex, luatex
2543 If no value is specified,
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2549 \change_inserted -712698321 1524657030
2560 \begin_layout Labeling
2561 \labelwidthstring 00.00.0000
2562 \begin_inset Flex Code
2565 \begin_layout Plain Layout
2572 \begin_inset Quotes eld
2576 \begin_inset Quotes erd
2579 file from the backend, which in practice means a \SpecialChar LaTeX
2580 file like the one we
2581 would export, without
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2594 \begin_layout Labeling
2595 \labelwidthstring 00.00.0000
2596 \begin_inset Flex Code
2599 \begin_layout Plain Layout
2608 \begin_layout Standard
2609 The following three flags are not really flags at all because they take
2611 \begin_inset Flex Noun
2614 \begin_layout Plain Layout
2616 \begin_inset space ~
2620 \begin_inset space ~
2631 \begin_layout Labeling
2632 \labelwidthstring 00.00.0000
2634 \change_inserted -712698321 1523206314
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2640 \change_inserted -712698321 1523206193
2646 The name of the driver that needs to be loaded with the
2650 package for this converter.
2651 The loading of the correct driver is necessary to get some PDF-specific
2660 \begin_layout Labeling
2661 \labelwidthstring 00.00.0000
2662 \begin_inset Flex Code
2665 \begin_layout Plain Layout
2671 If set, the converter's standard error will be redirected to a file
2672 \begin_inset Flex Code
2675 \begin_layout Plain Layout
2681 , and the script given as argument will be run as:
2682 \begin_inset Flex Code
2685 \begin_layout Plain Layout
2686 script < infile.out > infile.log
2692 The argument may contain
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2705 \begin_layout Labeling
2706 \labelwidthstring 00.00.0000
2707 \begin_inset Flex Code
2710 \begin_layout Plain Layout
2716 The name of the directory in which the converter will dump the generated
2719 will not create this directory, and it does not copy anything into it,
2720 though it will copy this directory to the destination.
2721 The argument may contain
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2731 , which will be replaced by the base name of the input and output files,
2732 respectively, when the directory is copied.
2733 \begin_inset Newline newline
2736 Note that resultdir and usetempdir make no sense together.
2737 The latter will be ignored if the former is given.
2740 \begin_layout Labeling
2741 \labelwidthstring 00.00.0000
2742 \begin_inset Flex Code
2745 \begin_layout Plain Layout
2751 Determines the output file name and may, contain
2752 \begin_inset Flex Code
2755 \begin_layout Plain Layout
2762 Sensible only with resultdir and optional even then; if not given, it defaults
2766 \begin_layout Standard
2768 \change_inserted -712698321 1523206384
2769 A suitable hyperref-driver is set for some converters that are installed
2770 with \SpecialChar LyX
2773 \change_deleted -712698321 1523206388
2775 \change_inserted -712698321 1523206389
2779 \change_inserted -712698321 1523206400
2783 \change_inserted -712698321 1523206407
2787 \change_inserted -712698321 1523206437
2791 \change_deleted -712698321 1523206442
2792 that are installed with \SpecialChar LyX
2799 \begin_layout Standard
2800 You do not have to define converters for all formats between which you want
2802 For example, you will note that there is no `\SpecialChar LyX
2803 to PostScript' converter,
2804 but \SpecialChar LyX
2805 will export PostScript.
2806 It does so by first creating a \SpecialChar LaTeX
2807 file (no converter needs to be defined
2808 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2810 and finally converting the resulting DVI file to PostScript.
2812 finds such `chains' of converters automatically, and it will always choose
2813 the shortest possible chain.
2814 You can, though, still define multiple conversion methods between file
2816 For example, the standard \SpecialChar LyX
2817 configuration provides five ways to convert
2822 \begin_layout Enumerate
2824 \begin_inset Flex Noun
2827 \begin_layout Plain Layout
2836 \begin_layout Enumerate
2837 via (DVI and) PostScript, using
2838 \begin_inset Flex Noun
2841 \begin_layout Plain Layout
2850 \begin_layout Enumerate
2852 \begin_inset Flex Noun
2855 \begin_layout Plain Layout
2864 \begin_layout Enumerate
2866 \begin_inset Flex Noun
2869 \begin_layout Plain Layout
2879 \begin_layout Enumerate
2881 \begin_inset Flex Noun
2884 \begin_layout Plain Layout
2894 \begin_layout Standard
2895 To define such alternate chains, you must define multiple target `file formats',
2897 \begin_inset CommandInset ref
2899 reference "sec:Formats"
2904 For example, in the standard configuration, the formats named
2905 \begin_inset Flex Noun
2908 \begin_layout Plain Layout
2915 \begin_inset Flex Noun
2918 \begin_layout Plain Layout
2925 \begin_inset Flex Noun
2928 \begin_layout Plain Layout
2935 \begin_inset Flex Noun
2938 \begin_layout Plain Layout
2945 \begin_inset Flex Noun
2948 \begin_layout Plain Layout
2955 \begin_inset Flex Noun
2958 \begin_layout Plain Layout
2965 \begin_inset Flex Noun
2968 \begin_layout Plain Layout
2975 \begin_inset Flex Noun
2978 \begin_layout Plain Layout
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2996 \begin_inset Flex Noun
2999 \begin_layout Plain Layout
3006 ) are defined, all of which share the extension
3007 \begin_inset Flex Noun
3010 \begin_layout Plain Layout
3016 , and which correspond to the conversion methods just mentioned.
3019 \begin_layout Chapter
3020 Internationalizing \SpecialChar LyX
3022 \begin_inset CommandInset label
3024 name "cha:Internationalizing-LyX"
3031 \begin_layout Standard
3033 supports using a translated interface.
3034 Last time we checked, \SpecialChar LyX
3035 provided text in thirty languages.
3036 The language of choice is called your
3041 (For further reading on locale settings, see also the documentation for
3042 locale that comes with your operating system.
3043 For Linux, the manual page for
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3053 could be a good place to start).
3056 \begin_layout Standard
3057 Notice that these translations will work, but do contain a few flaws.
3058 In particular, all dialogs have been designed with the English text in
3059 mind, which means that some of the translated text will be too large to
3060 fit within the space allocated.
3061 This is only a display problem and will not cause any harm.
3062 Also, you will find that some of the translations do not define shortcut
3063 keys for everything.
3064 Sometimes, there are simply not enough free letters to do it.
3065 Other times, the translator just hasn't got around to doing it yet.
3066 Our localization team, which you may wish to join,
3070 \begin_layout Plain Layout
3071 If you are a fluent speaker of a language other than English, joining these
3072 teams is a great way to give back to the \SpecialChar LyX
3078 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3082 \begin_layout Section
3083 Translating \SpecialChar LyX
3087 \begin_layout Subsection
3088 Translating the graphical user interface (text messages).
3091 \begin_layout Standard
3094 \begin_inset Flex Code
3097 \begin_layout Plain Layout
3103 library to handle the internationalization of the interface.
3104 To have \SpecialChar LyX
3105 speak your favorite language in all menus and dialogs, you need
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3116 -file for that language.
3117 When this is available, you'll have to generate a
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 -file from it and install the
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 The process of doing all of this is explained in the documentation for
3140 \begin_inset Flex Code
3143 \begin_layout Plain Layout
3150 It is possible to do this just for yourself, but if you're going to do
3151 it, you might as well share the results of your labors with the rest of
3152 the \SpecialChar LyX
3154 Send a message to the \SpecialChar LyX
3155 developers' list for more information about how
3159 \begin_layout Standard
3160 In short, this is what you should do (xx denotes the language code):
3163 \begin_layout Itemize
3164 Check out the \SpecialChar LyX
3167 \begin_inset CommandInset href
3169 name "information on the web"
3170 target "https://www.lyx.org/HowToUseGIT"
3178 \begin_layout Itemize
3180 \begin_inset Flex Code
3183 \begin_layout Plain Layout
3189 to the folder of the
3190 \begin_inset Flex Code
3193 \begin_layout Plain Layout
3201 \begin_inset Flex Code
3204 \begin_layout Plain Layout
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3221 doesn't exist anywhere, it can be remade with the console command
3222 \begin_inset Flex Code
3225 \begin_layout Plain Layout
3231 in that directory, or you can use an existing po-file for some other language
3235 \begin_layout Itemize
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3250 \begin_layout Plain Layout
3251 This is just a text file, so it can be edited in any text editor.
3252 But there are also specialized programs that support such editing, such
3257 (for all platforms) or
3266 contains a `mode' for editing
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3277 \begin_inset Flex URL
3280 \begin_layout Plain Layout
3282 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3292 For some menu- and widget-labels, there are also shortcut keys that should
3294 Those keys are marked after a `|', and should be translated according to
3295 the words and phrases of the language.
3296 You should also fill also out the information at the beginning of the new
3298 \begin_inset Flex Code
3301 \begin_layout Plain Layout
3307 -file with your email-address, etc., so people know where to reach you with
3308 suggestions and entertaining flames.
3311 \begin_layout Standard
3312 If you are just doing this on your own, then:
3315 \begin_layout Itemize
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3327 This can be done with
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3332 msgfmt -o xx.mo < xx.po
3340 \begin_layout Itemize
3342 \begin_inset Flex Code
3345 \begin_layout Plain Layout
3351 -file to your locale-tree, at the correct directory for application messages
3356 xx, and under the name
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3367 \begin_inset space \thinspace{}
3371 \begin_inset space \space{}
3375 \begin_inset Flex Code
3378 \begin_layout Plain Layout
3379 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3389 \begin_layout Standard
3390 As said, however, it would be best if the new
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3400 file could be added to the \SpecialChar LyX
3401 distribution, so others can use it.
3402 Adding it involves making additional changes to \SpecialChar LyX
3404 So send an email to the developers' mailing list if you're interested in
3408 \begin_layout Subsubsection
3412 \begin_layout Standard
3413 Sometimes it turns out that one English message needs to be translated into
3414 different messages in the target language.
3415 One example is the message
3416 \begin_inset Flex Code
3419 \begin_layout Plain Layout
3425 which has the German translation
3433 , depending upon exactly what the English
3434 \begin_inset Quotes eld
3438 \begin_inset Quotes erd
3443 \begin_inset Flex Code
3446 \begin_layout Plain Layout
3452 does not handle such ambiguous translations.
3453 Therefore you have to add some context information to the message: Instead
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 \begin_inset Flex Code
3468 \begin_layout Plain Layout
3469 To[[as in 'From format x to format y']]
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3479 To[[as in 'From page x to page y']].
3484 Now the two occurrences of
3485 \begin_inset Flex Code
3488 \begin_layout Plain Layout
3495 \begin_inset Flex Code
3498 \begin_layout Plain Layout
3504 and can be translated correctly to
3515 \begin_layout Standard
3516 Of course the context information needs to be stripped off the original
3517 message when no translation is used.
3518 Therefore you have to put it in double square brackets at the end of the
3519 message (see the example above).
3520 The translation mechanism of \SpecialChar LyX
3521 ensures that everything in double square
3522 brackets at the end of messages is removed before displaying the message.
3525 \begin_layout Subsection
3526 Translating the documentation.
3529 \begin_layout Standard
3530 The online documentation (in the
3531 \begin_inset Flex Noun
3534 \begin_layout Plain Layout
3540 -menu) can (and should!) be translated.
3541 If there are translated versions of the documentation available
3545 \begin_layout Plain Layout
3546 As of March 2008, at least some of the documents have been translated into
3547 fourteen languages, with the Tutorial available in a few more.
3552 and the locale is set accordingly, these will be used automagically by
3556 looks for translated versions as
3557 \begin_inset Flex Code
3560 \begin_layout Plain Layout
3561 LyXDir/doc/xx/DocName.lyx
3567 \begin_inset Flex Code
3570 \begin_layout Plain Layout
3576 is the code for the language currently in use.
3577 If there are no translated documents, the default English versions will
3579 Note that the translated versions must have the same filenames (
3580 \begin_inset Flex Code
3583 \begin_layout Plain Layout
3589 above) as the original.
3590 If you feel up to translating the documentation (an excellent way to proof-read
3591 the original documentation by the way!), there are a few things you should
3595 \begin_layout Itemize
3596 Check out the documentation translation web page at
3597 \begin_inset CommandInset href
3599 name "https://www.lyx.org/Translation"
3600 target "https://www.lyx.org/Translation"
3606 That way, you can find out which (if any) documents have already been translate
3607 d into your language.
3608 You can also find out who (if anyone) is organizing the effort to translate
3609 the documentation into your language.
3610 If no one is organizing the effort, please let us know that you're interested.
3613 \begin_layout Standard
3614 Once you get to actually translating, here's a few hints for you that may
3618 \begin_layout Itemize
3619 Join the documentation team! There is information on how to do that in
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3630 \begin_inset Flex Noun
3633 \begin_layout Plain Layout
3634 Help\SpecialChar menuseparator
3640 ), which by the way is the first document you should translate.
3643 \begin_layout Itemize
3644 Learn the typographic conventions for the language you are translating to.
3645 Typography is an ancient art and over the centuries, a great variety of
3646 conventions have developed throughout different parts of the world.
3647 Also study the professional terminology amongst typographers in your country.
3648 Inventing your own terminology will only confuse the users.
3651 (Warning! Typography is addictive!)
3654 \begin_layout Itemize
3655 Make a copy of the document.
3656 This will be your working copy.
3657 You can use this as your personal translated help-file by placing it in
3659 \begin_inset Flex Code
3662 \begin_layout Plain Layout
3669 \begin_inset Note Greyedout
3672 \begin_layout Plain Layout
3677 For a complex document with external material (images, etc.), if you make
3679 \begin_inset space \thinspace{}
3683 \begin_inset space \space{}
3686 in a temp dir, beware that the links to external material may be broken
3687 when the document is moved to a different place.
3688 The best way is to retrieve the \SpecialChar LyX
3690 \begin_inset Flex URL
3693 \begin_layout Plain Layout
3695 https://www.lyx.org/HowToUseGIT
3700 ) and to edit the doc file in place.
3708 \begin_layout Itemize
3709 Sometimes the original document (from the \SpecialChar LyX
3710 team) will be updated.
3711 Use the source viewer at
3712 \begin_inset CommandInset href
3714 name "https://www.lyx.org/trac/timeline"
3715 target "https://www.lyx.org/trac/timeline"
3720 to see what has been changed.
3721 That way you can easily see which parts of the translated document need
3725 \begin_layout Standard
3726 If you ever find an error in the original document, fix it and notify the
3727 rest of the documentation team of the changes! (You didn't forget to join
3728 the documentation team, did you?)
3731 \begin_layout Standard
3732 \begin_inset Branch OutDated
3736 \begin_layout Section
3737 International Keyboard Support
3740 \begin_layout Standard
3743 [Editor's Note: The following section is by
3751 It needs to be fixed to conform to the new Documentation Style sheet and
3752 to make use of the new v1.0 features.
3753 The whole thing also needs to be merged with the section following it.-jw
3754 It may also be badly out of date.-rh (2008)]
3757 \begin_layout Subsection
3758 Defining Own Keymaps: Keymap File Format
3761 \begin_layout Standard
3762 Let's look at a keyboard definition file a little closer.
3763 It is a plain text file defining
3766 \begin_layout Itemize
3767 key-to-key or key-to-string translations
3770 \begin_layout Itemize
3774 \begin_layout Itemize
3775 dead keys exceptions
3778 \begin_layout Standard
3779 To define key-to-key or key-to-string translation, use this command:
3782 \begin_layout Quotation
3783 \begin_inset Flex Code
3786 \begin_layout Plain Layout
3795 \begin_inset Flex Code
3798 \begin_layout Plain Layout
3807 \begin_layout Standard
3809 \begin_inset Flex Code
3812 \begin_layout Plain Layout
3818 is the key to be translated and
3819 \begin_inset Flex Code
3822 \begin_layout Plain Layout
3828 is the string to be inserted into the document.
3829 To define dead keys, use:
3832 \begin_layout Quotation
3833 \begin_inset Flex Code
3836 \begin_layout Plain Layout
3845 \begin_inset Flex Code
3848 \begin_layout Plain Layout
3857 \begin_layout Standard
3859 \begin_inset Flex Code
3862 \begin_layout Plain Layout
3868 is a keyboard key and
3869 \begin_inset Flex Code
3872 \begin_layout Plain Layout
3879 The following dead keys are supported (shortcut name is in parentheses):
3882 \begin_layout Quotation
3886 \begin_inset space \hfill{}
3892 \begin_layout Quotation
3894 \begin_inset space \hfill{}
3900 \begin_layout Quotation
3902 \begin_inset space \hfill{}
3908 \begin_layout Quotation
3910 \begin_inset space \hfill{}
3916 \begin_layout Quotation
3918 \begin_inset space \hfill{}
3924 \begin_layout Quotation
3926 \begin_inset space \hfill{}
3933 \begin_layout Plain Layout
3945 \begin_layout Quotation
3947 \begin_inset space \hfill{}
3953 \begin_layout Quotation
3955 \begin_inset space \hfill{}
3962 \begin_layout Plain Layout
3974 \begin_layout Quotation
3976 \begin_inset space \hfill{}
3982 \begin_layout Quotation
3984 \begin_inset space \hfill{}
3990 \begin_layout Quotation
3992 \begin_inset space \hfill{}
3999 \begin_layout Plain Layout
4011 \begin_layout Quotation
4013 \begin_inset space \hfill{}
4020 \begin_layout Plain Layout
4032 \begin_layout Quotation
4034 \begin_inset space \hfill{}
4040 \begin_layout Quotation
4041 hungarian umlaut (hug)
4042 \begin_inset space \hfill{}
4048 \begin_layout Quotation
4050 \begin_inset space \hfill{}
4056 \begin_layout Quotation
4058 \begin_inset space \hfill{}
4065 \begin_layout Plain Layout
4077 \begin_layout Standard
4078 Since in many international keyboards there are exceptions to what some
4079 dead keys should do, you can define them using
4082 \begin_layout Quotation
4083 \begin_inset Flex Code
4086 \begin_layout Plain Layout
4094 deadkey key outstring
4097 \begin_layout Standard
4098 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4102 \begin_layout Quotation
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4119 \begin_layout Standard
4120 to make it work correctly.
4121 Also, you have to define as exceptions dead keys over i and j, to remove
4122 the dot from them before inserting an accent mark.
4123 I will change this when the time comes, but so far I haven't had time.
4126 \begin_layout Standard
4127 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4130 \begin_inset Flex Code
4133 \begin_layout Plain Layout
4139 have different meaning.
4141 \begin_inset Flex Code
4144 \begin_layout Plain Layout
4150 marks comments, quotes start and end \SpecialChar LaTeX
4152 To enter quote, you'll need to use
4153 \begin_inset Flex Code
4156 \begin_layout Plain Layout
4165 \begin_inset Flex Code
4168 \begin_layout Plain Layout
4175 \begin_inset Flex Code
4178 \begin_layout Plain Layout
4189 \begin_layout Standard
4190 If you make a keyboard description file that works for your language, please
4191 mail it to me, so I can include it in the next keymap distribution.
4194 \begin_layout Standard
4195 More keywords will be supported in keymap configuration file in future,
4199 \begin_layout Itemize
4200 \begin_inset Flex Code
4203 \begin_layout Plain Layout
4214 \begin_inset space \hfill{}
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4230 \begin_layout Itemize
4231 \begin_inset Flex Code
4234 \begin_layout Plain Layout
4245 \begin_inset space \hfill{}
4249 \begin_inset Flex Code
4252 \begin_layout Plain Layout
4258 an external keymap translation program
4261 \begin_layout Standard
4262 Also, it should look into
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4272 file for defaults, too (for example, a
4273 \begin_inset Flex Code
4276 \begin_layout Plain Layout
4284 option to include default keyboard).
4292 \begin_layout Section
4293 International Keymap Stuff
4294 \begin_inset CommandInset label
4296 name "sec:International-Keymap-Stuff"
4303 \begin_layout Standard
4304 \begin_inset Note Note
4307 \begin_layout Plain Layout
4308 In doing the revisions on this document in March 2008, I did not look over
4309 this stuff, as I do not understand it.
4310 It would be good if someone else could do so.
4319 \begin_layout Standard
4320 The next two sections describe the
4321 \begin_inset Flex Code
4324 \begin_layout Plain Layout
4333 \begin_inset Flex Code
4336 \begin_layout Plain Layout
4344 file syntax in detail.
4345 These sections should help you design your own key map if the ones provided
4346 do not meet your needs.
4349 \begin_layout Subsection
4353 \begin_layout Standard
4357 \begin_inset Flex Code
4360 \begin_layout Plain Layout
4366 file maps keystrokes to characters or strings.
4367 As the name suggests, it sets a keyboard mapping.
4369 \begin_inset Flex Code
4372 \begin_layout Plain Layout
4383 \begin_inset Flex Code
4386 \begin_layout Plain Layout
4401 \begin_inset Flex Code
4404 \begin_layout Plain Layout
4417 \begin_inset Flex Code
4420 \begin_layout Plain Layout
4429 \begin_inset Flex Code
4432 \begin_layout Plain Layout
4440 are described in this section.
4443 \begin_layout Labeling
4444 \labelwidthstring 00.00.0000
4445 \begin_inset Flex Code
4448 \begin_layout Plain Layout
4456 Map a character to a string
4459 \begin_layout LyX-Code
4474 \begin_layout Standard
4507 the double-quote (")
4524 must be escaped with a preceding backslash (
4535 \begin_layout Standard
4537 \begin_inset Flex Noun
4540 \begin_layout Plain Layout
4548 statement to cause the symbol
4549 \begin_inset Flex Noun
4552 \begin_layout Plain Layout
4560 to be output for the keystroke
4561 \begin_inset Flex Noun
4564 \begin_layout Plain Layout
4575 \begin_layout LyX-Code
4581 \begin_layout Labeling
4582 \labelwidthstring 00.00.0000
4583 \begin_inset Flex Code
4586 \begin_layout Plain Layout
4594 Specify an accent character
4597 \begin_layout LyX-Code
4606 \begin_layout Standard
4607 This will make the cha
4645 This is the dead key
4649 \begin_layout Plain Layout
4656 refers to a key that does not produce a character by itself, but when followed
4657 with another key, produces the desired accent character.
4658 For example, a German characte
4660 r with an umlaut like
4670 can be produced in this manner.
4679 \begin_layout Standard
4692 and then another key not in
4709 followed by the other, not allowed key, as output.
4713 \begin_inset Flex Noun
4716 \begin_layout Plain Layout
4724 cancels a dead key, so if
4735 \begin_inset Flex Noun
4738 \begin_layout Plain Layout
4747 , the cursor will not go one position backwards but will instead cancel
4763 might have had on the next keystroke.
4767 \begin_layout Standard
4768 The following example specifies that the character ' is to be an acute accent,
4769 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4772 \begin_layout LyX-Code
4775 kmod ' acute aeiouAEIOU
4778 \begin_layout Labeling
4779 \labelwidthstring 00.00.0000
4780 \begin_inset Flex Code
4783 \begin_layout Plain Layout
4789 Specify an exception to the accent character
4792 \begin_layout LyX-Code
4801 \begin_layout Standard
4802 This defines an exce
4843 have been assigned a keystroke with a previous
4846 \begin_inset Flex Code
4849 \begin_layout Plain Layout
4873 must not belong in the
4920 If such a declaration does not exist in
4928 \begin_inset Flex Code
4931 \begin_layout Plain Layout
4965 \begin_inset Flex Code
4968 \begin_layout Plain Layout
4982 \begin_layout Standard
4983 The following command produces causes äi to be produced when you enter acute-i
4987 \begin_layout LyX-Code
5001 \begin_layout Labeling
5002 \labelwidthstring 00.00.0000
5003 \begin_inset Flex Code
5006 \begin_layout Plain Layout
5012 Combine two accent characters
5015 \begin_layout LyX-Code
5021 accent1 accent2 allowed
5024 \begin_layout Standard
5025 This one is getting pretty esoteric.
5026 It allows you to combine the effect
5082 \begin_inset Flex Code
5085 \begin_layout Plain Layout
5113 \begin_layout Standard
5114 Consider this example from the
5115 \begin_inset Flex Code
5118 \begin_layout Plain Layout
5129 \begin_layout LyX-Code
5132 kmod ; acute aeioyvhAEIOYVH
5136 kcomb acute umlaut iyIY
5139 \begin_layout Standard
5140 This allows you to press
5141 \begin_inset Flex Noun
5144 \begin_layout Plain Layout
5152 and get the effect of
5153 \begin_inset Flex Code
5156 \begin_layout Plain Layout
5175 in this case cancels the last dead key, so if you press
5176 \begin_inset Flex Noun
5179 \begin_layout Plain Layout
5188 \begin_inset Flex Code
5191 \begin_layout Plain Layout
5204 \begin_layout Subsection
5208 \begin_layout Standard
5210 \begin_inset Flex Code
5213 \begin_layout Plain Layout
5221 mapping is performed, a
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5235 file maps the strings that the symbols generate to characters in the current
5237 The \SpecialChar LyX
5238 distribution currently includes at least the
5239 \begin_inset Flex Code
5242 \begin_layout Plain Layout
5251 \begin_inset Flex Code
5254 \begin_layout Plain Layout
5265 \begin_layout Standard
5267 \begin_inset Flex Code
5270 \begin_layout Plain Layout
5278 file is a sequence of declarations of the form
5281 \begin_layout LyX-Code
5294 \begin_layout Standard
5295 For example, in order to map
5296 \begin_inset Flex Noun
5299 \begin_layout Plain Layout
5309 to the corresponding character in the iso-8859-1 set (233), the following
5313 \begin_layout LyX-Code
5321 \begin_layout Standard
5323 \begin_inset Flex Code
5326 \begin_layout Plain Layout
5335 \begin_inset Flex Code
5338 \begin_layout Plain Layout
5356 the same character can apply to more than one string.
5358 \begin_inset Flex Code
5361 \begin_layout Plain Layout
5372 \begin_layout LyX-Code
5384 \begin_inset Newline newline
5400 \begin_layout Standard
5402 cannot find a mapping for the string produced by the keystroke or a
5403 deadkey sequence, it will check if it looks like an accented char and try
5404 to draw an accent over the character on screen.
5407 \begin_layout Subsection
5411 \begin_layout Standard
5412 There is a second way to add support for international characters through
5413 so-called dead-keys.
5414 A dead-key works in combination with a letter to produce an accented character.
5415 Here, we'll explain how to create a really simple dead-key to illustrate
5419 \begin_layout Standard
5420 Suppose you happen to need the circumflex character,
5421 \begin_inset Quotes eld
5425 \begin_inset Quotes erd
5430 \begin_inset Flex Noun
5433 \begin_layout Plain Layout
5440 \begin_inset space ~
5444 \begin_inset Flex Noun
5447 \begin_layout Plain Layout
5453 ] to the \SpecialChar LyX
5455 \begin_inset Flex Code
5458 \begin_layout Plain Layout
5465 \begin_inset Flex Code
5468 \begin_layout Plain Layout
5475 Now, whenever you type the
5476 \begin_inset Flex Noun
5479 \begin_layout Plain Layout
5485 -key followed by a letter, that letter will have a circumflex accent on
5487 For example, the sequence
5488 \begin_inset Quotes eld
5492 \begin_inset Flex Noun
5495 \begin_layout Plain Layout
5502 \begin_inset Quotes erd
5505 produces the letter:
5506 \begin_inset Quotes eld
5510 \begin_inset Quotes erd
5514 If you tried to type
5515 \begin_inset Quotes eld
5519 \begin_inset Flex Noun
5522 \begin_layout Plain Layout
5529 \begin_inset Quotes erd
5532 , however, \SpecialChar LyX
5533 will complain with a beep, since a
5534 \begin_inset Quotes eld
5538 \begin_inset Flex Noun
5541 \begin_layout Plain Layout
5548 \begin_inset Quotes erd
5551 never takes a circumflex accent.
5553 \begin_inset Flex Noun
5556 \begin_layout Plain Layout
5562 after a dead-key produces the bare-accent.
5563 Please note this last point! If you bind a key to a dead-key, you'll need
5564 to rebind the character on that key to yet another key.
5566 \begin_inset Flex Noun
5569 \begin_layout Plain Layout
5575 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5578 \begin_layout Standard
5579 One common way to bind dead-keys is to use
5580 \begin_inset Flex Noun
5583 \begin_layout Plain Layout
5590 \begin_inset Flex Noun
5593 \begin_layout Plain Layout
5600 \begin_inset Flex Noun
5603 \begin_layout Plain Layout
5609 in combination with an accent, like
5610 \begin_inset Quotes eld
5614 \begin_inset Flex Noun
5617 \begin_layout Plain Layout
5624 \begin_inset Quotes erd
5628 \begin_inset Quotes eld
5632 \begin_inset Flex Noun
5635 \begin_layout Plain Layout
5642 \begin_inset Quotes erd
5646 \begin_inset Quotes eld
5650 \begin_inset Flex Noun
5653 \begin_layout Plain Layout
5660 \begin_inset Quotes erd
5664 Another way involves using
5665 \begin_inset Flex Code
5668 \begin_layout Plain Layout
5675 \begin_inset Flex Code
5678 \begin_layout Plain Layout
5684 to set up the special
5685 \begin_inset Flex Code
5688 \begin_layout Plain Layout
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5705 acts in some ways just like
5706 \begin_inset Flex Noun
5709 \begin_layout Plain Layout
5715 and permits you to bind keys to accented characters.
5716 You can also turn keys into dead-keys by binding them to something like
5718 \begin_inset Flex Code
5721 \begin_layout Plain Layout
5727 and then binding this symbolic key to the corresponding \SpecialChar LyX
5732 \begin_layout Plain Layout
5737 : This is exactly what I do in my
5738 \begin_inset Flex Code
5741 \begin_layout Plain Layout
5748 \begin_inset Flex Code
5751 \begin_layout Plain Layout
5759 \begin_inset Flex Noun
5762 \begin_layout Plain Layout
5764 \begin_inset space ~
5773 \begin_inset Flex Code
5776 \begin_layout Plain Layout
5782 and a bunch of these
5783 \begin_inset Quotes eld
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5797 \begin_inset Quotes erd
5800 symbolic keys bound such things as
5801 \begin_inset Flex Noun
5804 \begin_layout Plain Layout
5806 \begin_inset space ~
5815 \begin_inset Flex Noun
5818 \begin_layout Plain Layout
5820 \begin_inset space ~
5829 This is how I produce my accented characters.
5834 You can make just about anything into the
5835 \begin_inset Flex Code
5838 \begin_layout Plain Layout
5845 \begin_inset Flex Noun
5848 \begin_layout Plain Layout
5854 keys, a spare function key, etc.
5855 As for the \SpecialChar LyX
5856 commands that produce accents, check the entry for
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5871 You'll find the complete list there.
5874 \begin_layout Subsection
5875 Saving your Language Configuration
5878 \begin_layout Standard
5879 You can edit your preferences so that your desired language environment
5880 is automatically configured when \SpecialChar LyX
5882 \begin_inset Flex Noun
5885 \begin_layout Plain Layout
5886 Edit\SpecialChar menuseparator
5895 \begin_layout Chapter
5896 Installing New Document Classes, Layouts, and Templates
5897 \begin_inset CommandInset label
5899 name "cha:Installing-New-Document"
5904 \begin_inset Argument 1
5907 \begin_layout Plain Layout
5908 Installing New Document Classes
5916 \begin_layout Standard
5917 In this chapter, we describe the procedures for creating and installing
5918 new \SpecialChar LyX
5919 layout and template files, as well as offer a refresher on correctly
5920 installing new \SpecialChar LaTeX
5925 \begin_layout Standard
5926 First, let us a say a few words about how one ought to think about the relation
5927 between \SpecialChar LyX
5928 and \SpecialChar LaTeX
5930 The thing to understand is that, in a certain sense, \SpecialChar LyX
5931 doesn't know anything
5932 about \SpecialChar LaTeX
5934 Indeed, from \SpecialChar LyX
5935 's point of view, \SpecialChar LaTeX
5936 is just one of several
5937 \begin_inset Quotes eld
5941 \begin_inset Quotes erd
5944 in which it is capable of producing output.
5945 Other such formats are DocBook, plaintext, and XHTML.
5947 is, of course, a particularly important format, but very little of the
5948 information \SpecialChar LyX
5949 has about \SpecialChar LaTeX
5950 is actually contained in the program itself.
5954 \begin_layout Plain Layout
5955 Some commands are sufficiently complex that they are
5956 \begin_inset Quotes eld
5960 \begin_inset Quotes erd
5963 into \SpecialChar LyX
5965 But the developers generally regard this as a Bad Thing.
5970 Rather, that information, even for the standard classes like
5971 \begin_inset Flex Code
5974 \begin_layout Plain Layout
5980 , is contained in `layout files'.
5981 Similarly, \SpecialChar LyX
5982 itself does not know much about DocBook or XHTML.
5983 What it knows is contained in layout files.
5986 \begin_layout Standard
5987 You can think of the layout file for a given document class as a translation
5988 manual between \SpecialChar LyX
5989 constructs—paragraphs with their corresponding styles,
5990 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5993 Almost everything \SpecialChar LyX
5995 \begin_inset Flex Code
5998 \begin_layout Plain Layout
6004 , for example, is contained in the file
6005 \begin_inset Flex Code
6008 \begin_layout Plain Layout
6014 and in various other files it includes.
6015 For this reason, anyone intending to write layout files should plan to
6016 study the existing files.
6017 A good place to start is with
6018 \begin_inset Flex Code
6021 \begin_layout Plain Layout
6027 , which is included in
6028 \begin_inset Flex Code
6031 \begin_layout Plain Layout
6038 \begin_inset Flex Code
6041 \begin_layout Plain Layout
6047 , and many of the other layout files for document classes.
6048 This file is where sections and the like are defined:
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6058 tells \SpecialChar LyX
6059 how paragraphs that are marked with the Section, Subsection, etc,
6060 styles can be translated into corresponding \SpecialChar LaTeX
6061 , DocBook, and XHTML commands
6064 \begin_inset Flex Code
6067 \begin_layout Plain Layout
6073 file basically just includes several of these
6074 \begin_inset Flex Code
6077 \begin_layout Plain Layout
6086 \begin_layout Standard
6087 Defining the \SpecialChar LyX
6089 correspondence is not the only thing layout files do, though.
6090 Their other job is to define how the \SpecialChar LyX
6091 constructs themselves will appear
6093 The fact that layout files have these two jobs is often a source of confusion,
6094 because they are completely separate.
6095 Telling \SpecialChar LyX
6096 how to translate a certain paragraph style into \SpecialChar LaTeX
6099 how to display it; conversely, telling \SpecialChar LyX
6100 how to display a certain paragraph
6101 style does not tell \SpecialChar LyX
6102 how to translate it into \SpecialChar LaTeX
6103 (let alone tell \SpecialChar LaTeX
6106 So, in general, when you define a new \SpecialChar LyX
6107 construct, you must always do two
6108 quite separate things: (i)
6109 \begin_inset space ~
6112 tell \SpecialChar LyX
6113 how to translate it into \SpecialChar LaTeX
6115 \begin_inset space ~
6118 tell \SpecialChar LyX
6122 \begin_layout Standard
6123 Much the same is true, of course, as regards \SpecialChar LyX
6124 's other backend formats, though
6125 XHTML is in some ways different, because in that case \SpecialChar LyX
6130 able, to some extent, to use information about how it should display a
6131 paragraph on the screen to output information (in the form of CSS) about
6132 how the paragraph should be displayed in a browser.
6133 Even in this case, however, the distinction between what \SpecialChar LyX
6135 and how things are rendered externally remains in force, and the two can
6136 be controlled separately.
6138 \begin_inset CommandInset ref
6140 reference "sec:Tags-for-XHTML"
6147 \begin_layout Section
6148 Installing new \SpecialChar LaTeX
6152 \begin_layout Standard
6153 Some installations may not include a \SpecialChar LaTeX
6154 package or class file that you would
6155 like to use within \SpecialChar LyX
6157 For example, you might need Foil\SpecialChar TeX
6158 , a package for preparing slides for overhead
6160 Modern \SpecialChar LaTeX
6161 distributions like \SpecialChar TeX
6162 Live (2008 or newer) or MiK\SpecialChar TeX
6163 provide a user interface
6164 for installing such packages.
6165 For example, with MiK\SpecialChar TeX
6166 , you start the program
6167 \begin_inset Quotes eld
6171 \begin_inset space ~
6175 \begin_inset Quotes erd
6178 to get a list of available packages.
6179 To install one of them, right click on it or use the corresponding toolbar
6183 \begin_layout Standard
6184 If your \SpecialChar LaTeX
6185 distribution does not provide such a `package manager', or if the
6186 package is not available from your distribution, then follow these steps
6187 to install it manually:
6190 \begin_layout Enumerate
6191 Get the package from
6192 \begin_inset CommandInset href
6195 target "http://www.ctan.org/"
6203 \begin_layout Enumerate
6204 If the package contains a file with the ending
6205 \begin_inset Quotes eld
6209 \begin_inset Flex Code
6212 \begin_layout Plain Layout
6219 \begin_inset Quotes erd
6222 (is the case for Foil\SpecialChar TeX
6223 ) then open a console, change to the folder of this
6224 file and execute the command
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6235 You have now unpacked the package and have all files to install it.
6236 Most \SpecialChar LaTeX
6237 -packages are not packed and you can skip this step.
6240 \begin_layout Enumerate
6241 Now you need to decide if the package should be available for all users
6246 \begin_layout Enumerate
6247 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6248 for all users on your system, then install it in your `local' \SpecialChar TeX
6250 install it in your own `user' \SpecialChar TeX
6252 Where these trees should be created, if they do not already exist, depends
6254 To find this out, look in the file
6255 \begin_inset Flex Code
6258 \begin_layout Plain Layout
6268 \begin_layout Plain Layout
6269 This is usually in the directory
6270 \begin_inset Flex Code
6273 \begin_layout Plain Layout
6279 , though you can execute the command
6280 \begin_inset Flex Code
6283 \begin_layout Plain Layout
6294 The location of the `local' \SpecialChar TeX
6295 tree is defined by the
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6305 variable; this is usually somewhere like
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6310 /usr/local/share/texmf
6315 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6318 The location of the `user' \SpecialChar TeX
6320 \begin_inset Flex Code
6323 \begin_layout Plain Layout
6330 \begin_inset Flex Code
6333 \begin_layout Plain Layout
6340 \begin_inset Flex Code
6343 \begin_layout Plain Layout
6352 (If these variables are not predefined, you have to define them.) You'll
6353 probably need root permissions to create or modify the `local' tree, but
6354 not for your `user' tree.
6355 \begin_inset Newline newline
6358 In general, it is recommended to install in the user tree because your user
6359 will not be modified or even overwritten when you upgrade your system.
6360 It will typically also be backed up together with everything else when
6361 you backup your home directory (which, of course, you do on a regular basis).
6364 \begin_layout Enumerate
6365 On Windows, if you want the new package to be available for all users on
6366 your system, change to the folder where \SpecialChar LaTeX
6367 is installed and then change to
6369 \begin_inset Flex Code
6372 \begin_layout Plain Layout
6383 (For MiK\SpecialChar TeX
6384 , this would be by default the folder
6385 \begin_inset Flex Code
6388 \begin_layout Plain Layout
6406 \begin_layout Plain Layout
6407 Note that this will be the correct path only on English installations.
6408 On a German one, it would be
6409 \begin_inset Flex Code
6412 \begin_layout Plain Layout
6426 , and similarly for other languages.
6431 Create there a new folder
6432 \begin_inset Flex Code
6435 \begin_layout Plain Layout
6441 and copy all files of the package into it.
6443 \begin_inset Newline newline
6446 If the package should only available for you or you don't have admin permissions
6447 , do the same, but in the local \SpecialChar LaTeX
6450 \begin_inset space \thinspace{}
6453 g., for MiK\SpecialChar TeX
6455 \begin_inset space ~
6458 2.8 under Windows XP, this would be the folder:
6459 \begin_inset Newline newline
6465 \begin_inset Flex Code
6468 \begin_layout Plain Layout
6471 Documents and Settings
6483 \begin_inset Newline newline
6489 \begin_inset Phantom HPhantom
6492 \begin_layout Plain Layout
6503 \begin_inset Flex Code
6506 \begin_layout Plain Layout
6519 \begin_inset Newline newline
6522 On Vista, it would be:
6523 \begin_inset Newline newline
6527 \begin_inset Flex Code
6530 \begin_layout Plain Layout
6556 \begin_layout Enumerate
6557 Now one only need to tell \SpecialChar LaTeX
6558 that there are new files.
6559 This depends on the used \SpecialChar LaTeX
6564 \begin_layout Enumerate
6565 For \SpecialChar TeX
6566 Live execute the command
6567 \begin_inset Flex Code
6570 \begin_layout Plain Layout
6577 If you installed the package for all users, then you will probably need
6578 to have root permissions for that.
6581 \begin_layout Enumerate
6582 For MiK\SpecialChar TeX
6583 , if you have installed the package for all users, start the program
6585 \begin_inset Quotes eld
6589 \begin_inset space ~
6593 \begin_inset Quotes erd
6596 and press the button marked
6597 \begin_inset Quotes eld
6601 \begin_inset Quotes erd
6605 Otherwise start the program
6606 \begin_inset Quotes eld
6610 \begin_inset Quotes erd
6617 \begin_layout Enumerate
6618 Finally, you need to tell \SpecialChar LyX
6619 that there are new packages available.
6620 So, in \SpecialChar LyX
6622 \begin_inset Flex Noun
6625 \begin_layout Plain Layout
6628 \SpecialChar menuseparator
6634 and then restart \SpecialChar LyX
6638 \begin_layout Standard
6639 Now the package is installed.
6640 In our example, the document class
6641 \begin_inset Flex Code
6644 \begin_layout Plain Layout
6650 will now be available under
6651 \begin_inset Flex Noun
6654 \begin_layout Plain Layout
6655 Document\SpecialChar menuseparator
6656 Settings\SpecialChar menuseparator
6663 \begin_inset Quotes eld
6667 \begin_inset Quotes erd
6674 \begin_layout Standard
6675 If you would like to use a \SpecialChar LaTeX
6676 document class that is not even listed in the
6678 \begin_inset Flex Noun
6681 \begin_layout Plain Layout
6682 Document\SpecialChar menuseparator
6683 Settings\SpecialChar menuseparator
6689 , then you need to create a `layout' file for it.
6690 That is the topic of the next section.
6693 \begin_layout Section
6694 Types of layout files
6697 \begin_layout Standard
6698 This section describes the various sorts of \SpecialChar LyX
6699 files that contain layout informati
6701 These files describe various paragraph and character styles, determining
6702 how \SpecialChar LyX
6703 should display them and how they should be translated into \SpecialChar LaTeX
6705 XHTML, or whatever output format is being used.
6709 \begin_layout Standard
6710 We shall try to provide a thorough description of the process of writing
6712 However, there are so many different types of documents supported even
6713 by just \SpecialChar LaTeX
6714 that we can't hope to cover every different possibility or problem
6715 you might encounter.
6716 The \SpecialChar LyX
6717 users' list is frequented by people with lots of experience with layout
6718 design who are willing to share what they've learned, so please feel free
6719 to ask questions there.
6722 \begin_layout Standard
6723 As you prepare to write a new layout, it is extremely helpful to look at
6724 the layouts distributed with \SpecialChar LyX
6726 If you write a \SpecialChar LyX
6727 layout for a \SpecialChar LaTeX
6728 document class that might also be used by
6729 others, or write a module that might be useful to others, then you should
6730 consider posting your layout to the
6731 \begin_inset CommandInset href
6733 name "layout section on the LyX wiki"
6734 target "https://wiki.lyx.org/Layouts/Layouts"
6739 or even to the \SpecialChar LyX
6740 developers' list, so that it might be included in \SpecialChar LyX
6745 \begin_layout Plain Layout
6746 Note that \SpecialChar LyX
6747 is licensed under the General Public License, so any material
6748 that is contributed to \SpecialChar LyX
6749 must be similarly licensed.
6757 \begin_layout Subsection
6759 \begin_inset CommandInset label
6761 name "subsec:Layout-modules"
6768 \begin_layout Standard
6769 We have spoken to this point about `layout files'.
6770 But there are different sorts of files that contain layout information.
6771 Layout files, strictly so called, have the
6772 \begin_inset Flex Code
6775 \begin_layout Plain Layout
6781 extension and provide \SpecialChar LyX
6782 with information about document classes.
6783 Since \SpecialChar LyX
6784 1.6 layout information can also be contained in layout
6789 \begin_inset Flex Code
6792 \begin_layout Plain Layout
6799 Modules are to \SpecialChar LaTeX
6800 packages much as layouts are to \SpecialChar LaTeX
6801 classes, and some modules—such
6803 \begin_inset Flex Code
6806 \begin_layout Plain Layout
6812 module—specifically provide support for one package.
6813 In a sense, layout modules are similar to included
6817 \begin_layout Plain Layout
6818 These can have any extension, but by convention have the
6819 \begin_inset Flex Code
6822 \begin_layout Plain Layout
6834 \begin_inset Flex Code
6837 \begin_layout Plain Layout
6843 —in that modules are not specific to a given document class but may be used
6844 with many different classes.
6845 The difference is that using an included file with
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6855 requires editing that file.
6856 Modules, by contrast, are selected in the
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6861 Document\SpecialChar menuseparator
6870 \begin_layout Standard
6871 Building modules is the easiest way to get started with layout editing,
6872 since it can be as simple as adding a single new paragraph style or flex
6874 But modules may, in principle, contain anything a layout file can contain.
6877 \begin_layout Standard
6878 After creating a new module and copying it to the
6879 \begin_inset Flex Code
6882 \begin_layout Plain Layout
6888 folder, you will need to reconfigure and then restart \SpecialChar LyX
6891 However, changes you make to the module will be seen immediately, if you
6893 \begin_inset Flex Noun
6896 \begin_layout Plain Layout
6897 Document\SpecialChar menuseparator
6903 , highlight something, and then hit
6904 \begin_inset Quotes eld
6908 \begin_inset Quotes erd
6914 It is strongly recommended that you save your work before doing this
6919 it is strongly recommended that you not attempt to edit modules while simultaneo
6920 usly working on actual documents
6923 Though of course the developers strive to keep \SpecialChar LyX
6924 stable in such situations,
6925 syntax errors and the like in your module file could cause strange behavior.
6928 \begin_layout Subsubsection
6932 \begin_layout Standard
6933 Modules are to \SpecialChar LyX
6934 as packages are to \SpecialChar LaTeX
6936 Sometimes, however, you find yourself wanting a specific inset or character
6937 style just for one document and writing a module that will also be available
6938 to other documents makes little sense.
6939 What you need is \SpecialChar LyX
6941 \begin_inset Quotes eld
6945 \begin_inset Quotes erd
6951 \begin_layout Standard
6952 You will find it under
6954 Document\SpecialChar menuseparator
6955 Settings\SpecialChar menuseparator
6959 The large text box allows you to enter anything that you might enter in
6960 a layout file or module.
6961 You can think of a document's local layout, in fact, as a module that belongs
6963 So, in particular, you must enter a
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6974 Any format is acceptable, but one would normally use the format current
6976 (In \SpecialChar LyX
6983 , the current layout format is
6992 \begin_layout Standard
6993 When you have entered something in the
6994 \begin_inset Flex Code
6997 \begin_layout Plain Layout
7003 pane, \SpecialChar LyX
7005 \begin_inset Quotes eld
7009 \begin_inset Quotes erd
7012 button at the bottom.
7013 Clicking this button will cause \SpecialChar LyX
7014 to determine whether what you have entered
7015 is valid layout information for the chosen format.
7017 will report the result but, unfortunately, will not tell you what errors
7018 there might have been.
7019 These will be written to the terminal, however, if \SpecialChar LyX
7020 is started from a terminal.
7021 You will not be permitted to save your local layout until you have entered
7025 \begin_layout Standard
7026 The warnings at the end of the previous section apply here, too.
7027 Do not play with local layout while you are actually working, especially
7028 if you have not saved your document.
7029 That said, using local layout with a test document can be a very convenient
7030 way to try out layout ideas, or even to start developing a module.
7033 \begin_layout Subsection
7035 \begin_inset Flex Noun
7038 \begin_layout Plain Layout
7047 \begin_layout Standard
7048 There are two situations you are likely to encounter when wanting to support
7049 a new \SpecialChar LaTeX
7050 document class, involving style (
7051 \begin_inset Flex Code
7054 \begin_layout Plain Layout
7060 ) files and \SpecialChar LaTeX2e
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7072 Supporting a style file is usually fairly easy.
7073 Supporting a new class file is a bit harder.
7074 We'll discuss the former in this section and the latter in the next.
7075 Similar remarks apply, of course, if you want to support a new DocBook
7079 \begin_layout Standard
7080 The easier case is the one in which your new document class is provided
7081 as a style file that is to be used in conjunction with an already supported
7083 For the sake of the example, we'll assume that the style file is called
7085 \begin_inset Flex Noun
7088 \begin_layout Plain Layout
7094 and that it is meant to be used with
7095 \begin_inset Flex Noun
7098 \begin_layout Plain Layout
7104 , which is a standard class.
7108 \begin_layout Standard
7109 Start by copying the existing class's layout file into your local directory:
7113 \begin_layout Plain Layout
7114 Of course, which directory is your local directory will vary by platform,
7115 and \SpecialChar LyX
7116 allows you to specify your local directory on startup, too, using
7118 \begin_inset Flex Code
7121 \begin_layout Plain Layout
7135 \begin_layout LyX-Code
7136 cp report.layout ~/.lyx/layouts/myclass.layout
7139 \begin_layout Standard
7141 \begin_inset Flex Code
7144 \begin_layout Plain Layout
7150 and change the line:
7153 \begin_layout LyX-Code
7156 DeclareLaTeXClass{Report (Standard Class)}
7159 \begin_layout Standard
7163 \begin_layout LyX-Code
7166 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7169 \begin_layout Standard
7173 \begin_layout LyX-Code
7175 \begin_inset Newline newline
7181 \begin_inset Newline newline
7187 \begin_layout Standard
7188 near the top of the file.
7191 \begin_layout Standard
7192 Start \SpecialChar LyX
7194 \begin_inset Flex Noun
7197 \begin_layout Plain Layout
7198 Tools\SpecialChar menuseparator
7205 Then restart \SpecialChar LyX
7206 and try creating a new document.
7208 \begin_inset Flex Noun
7211 \begin_layout Plain Layout
7217 " as a document class option in the
7218 \begin_inset Flex Noun
7221 \begin_layout Plain Layout
7222 Document\SpecialChar menuseparator
7229 It is likely that some of the sectioning commands and such in your new
7230 class will work differently from how they worked in the base class—
7231 \begin_inset Flex Code
7234 \begin_layout Plain Layout
7240 in this example—so you can fiddle around with the settings for the different
7241 sections if you wish.
7242 The layout information for sections is contained in
7243 \begin_inset Flex Code
7246 \begin_layout Plain Layout
7252 , but you do not need to copy and change this file.
7253 Instead, you can simply add your changes to your layout file, after the
7255 \begin_inset Flex Code
7258 \begin_layout Plain Layout
7264 , which itself includes
7265 \begin_inset Flex Code
7268 \begin_layout Plain Layout
7275 For example, you might add these lines:
7278 \begin_layout LyX-Code
7282 \begin_layout LyX-Code
7286 \begin_layout LyX-Code
7290 \begin_layout LyX-Code
7294 \begin_layout LyX-Code
7298 \begin_layout Standard
7299 to change the font for chapter headings to sans-serif.
7300 This will override (or, in this case, add to) the existing declaration
7301 for the Chapter style.
7305 \begin_layout Standard
7306 Your new package may also provide commands or environments not present in
7308 In this case, you will want to add these to the layout file.
7310 \begin_inset CommandInset ref
7312 reference "sec:TextClass"
7316 for information on how to do so.
7319 \begin_layout Standard
7321 \begin_inset Flex Noun
7324 \begin_layout Plain Layout
7330 can be used with several different document classes, and even if it cannot,
7331 you might find it easiest just to write a module that you can load with
7333 The simplest possible such module would be:
7336 \begin_layout LyX-Code
7339 DeclareLyXModule{My Class}
7342 \begin_layout LyX-Code
7346 \begin_layout LyX-Code
7347 #Support for myclass.sty.
7350 \begin_layout LyX-Code
7352 \begin_inset Newline newline
7358 \begin_layout LyX-Code
7366 \begin_inset Newline newline
7372 \begin_layout LyX-Code
7374 \begin_inset Newline newline
7380 \begin_inset Newline newline
7386 \begin_layout Standard
7387 A more complex module might modify the behavior of some existing constructs
7388 or define some new ones.
7390 \begin_inset CommandInset ref
7392 reference "sec:TextClass"
7399 \begin_layout Subsection
7401 \begin_inset Flex Noun
7404 \begin_layout Plain Layout
7413 \begin_layout Standard
7414 There are two possibilities here.
7415 One is that the class file is itself based upon an existing document class.
7416 For example, many thesis classes are based upon
7417 \begin_inset Flex Noun
7420 \begin_layout Plain Layout
7427 To see whether yours is, look for a line like
7430 \begin_layout LyX-Code
7436 \begin_layout Standard
7438 If so, then you may proceed largely as in the previous section, though
7440 \begin_inset Flex Code
7443 \begin_layout Plain Layout
7444 Declare\SpecialChar LaTeX
7450 line will be different.
7451 If your new class is
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7461 and it is based upon
7462 \begin_inset Flex Code
7465 \begin_layout Plain Layout
7471 , then the line should read:
7475 \begin_layout Plain Layout
7476 And it will be easiest if you save the file to
7477 \begin_inset Flex Code
7480 \begin_layout Plain Layout
7487 assumes that the document class has the same name as the layout file.
7496 \begin_layout LyX-Code
7499 DeclareLaTeXClass[thesis,book]{thesis}
7502 \begin_layout Standard
7503 If, on the other hand, the new class is not based upon an existing class,
7504 you will probably have to
7505 \begin_inset Quotes eld
7509 \begin_inset Quotes erd
7513 We strongly suggest copying an existing layout file which uses a similar
7515 class and then modifying it, if you can do so.
7516 At least use an existing file as a starting point so you can find out what
7517 items you need to worry about.
7518 Again, the specifics are covered below.
7521 \begin_layout Subsection
7523 \begin_inset CommandInset label
7525 name "subsec:Creating-Templates"
7532 \begin_layout Standard
7533 Once you have written a layout file for a new document class, you might
7534 want to consider writing a
7539 A template acts as a kind of tutorial for your layout, showing how it might
7540 be used, though containing dummy content.
7541 You can of course look at the various templates included with \SpecialChar LyX
7545 \begin_layout Standard
7546 Templates are created just like usual documents: using \SpecialChar LyX
7548 The only difference is that usual documents contain all possible settings,
7549 including the font scheme and the paper size.
7550 Usually a user doesn't want a template to overwrite his preferred settings
7551 for such parameters.
7552 For that reason, the designer of a template should remove the corresponding
7554 \begin_inset Flex Code
7557 \begin_layout Plain Layout
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7577 from the template \SpecialChar LyX
7579 This can be done with any simple text-editor, for example
7580 \begin_inset Flex Code
7583 \begin_layout Plain Layout
7590 \begin_inset Flex Code
7593 \begin_layout Plain Layout
7602 \begin_layout Standard
7603 Put the edited template files you create in
7604 \begin_inset Flex Code
7607 \begin_layout Plain Layout
7613 , copy the ones you use from the global template directory in
7614 \begin_inset Flex Code
7617 \begin_layout Plain Layout
7623 to the same place, and redefine the template path in the
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7628 Tools\SpecialChar menuseparator
7629 Preferences\SpecialChar menuseparator
7638 \begin_layout Standard
7639 Note, by the way, that there is a template which has a particular meaning:
7640 \begin_inset Newline linebreak
7644 \begin_inset Flex Code
7647 \begin_layout Plain Layout
7654 This template is loaded every time you create a new document with
7655 \begin_inset Flex Noun
7658 \begin_layout Plain Layout
7659 File\SpecialChar menuseparator
7665 in order to provide useful defaults.
7666 To create this template from inside \SpecialChar LyX
7667 , all you have to do is to open a document
7668 with the correct settings, and use the
7669 \begin_inset Flex Noun
7672 \begin_layout Plain Layout
7673 Save as Document Defaults
7681 \begin_layout Subsection
7682 Upgrading old layout files
7685 \begin_layout Standard
7686 The format of layout files changes with each \SpecialChar LyX
7687 release, so old layout files
7688 need to be converted to the new format.
7690 reads a layout file in an older format, it automatically calls the
7692 \begin_inset Flex Code
7695 \begin_layout Plain Layout
7701 to convert it to a temporary file in current format.
7702 The original file is left untouched.
7703 If you use the layout file often, then, you may want to convert it permanently,
7704 so that \SpecialChar LyX
7705 does not have to do so itself every time.
7706 To do this, you can call the converter manually:
7709 \begin_layout Enumerate
7711 \begin_inset Flex Code
7714 \begin_layout Plain Layout
7721 \begin_inset Flex Code
7724 \begin_layout Plain Layout
7733 \begin_layout Enumerate
7735 \begin_inset Newline newline
7739 \begin_inset Flex Code
7742 \begin_layout Plain Layout
7743 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7749 \begin_inset Newline newline
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7762 is the name of your \SpecialChar LyX
7766 \begin_layout Standard
7767 Note that manual conversion does not affect included files, so these will
7768 have to be converted separately.
7771 \begin_layout Subsection
7772 \begin_inset CommandInset label
7774 name "subsec:Cite-Engine-Files"
7781 \begin_layout Standard
7782 A specific form of layout files are the so-called
7783 \begin_inset Flex Code
7786 \begin_layout Plain Layout
7792 files that are located in the
7793 \begin_inset Flex Code
7796 \begin_layout Plain Layout
7803 Their purpose is to define the specifics of \SpecialChar LaTeX
7804 packages aimed at bibliography
7817 , but also the way how normal Bib\SpecialChar TeX
7818 citations (without additional packages)
7819 are handled in \SpecialChar LyX
7820 is defined in such a file.
7824 \begin_layout Standard
7825 More specifically, it is defined which packages \SpecialChar LyX
7826 needs to load, which citation
7827 commands are available, how these are to be displayed in \SpecialChar LyX
7829 the dialogs, the context menus) as well as in the XHTML and plain text
7831 Furthermore, the files specify available style variants (author-year, numerical
7832 , etc.) and their specifics.
7833 The cite engine files are also used to generate the options that are available
7836 Document\SpecialChar menuseparator
7837 Settings\SpecialChar menuseparator
7838 Bibliography\SpecialChar menuseparator
7844 \begin_layout Standard
7845 Even though a cite engine file is essentially a normal layout file that
7846 could theoretically include any layout information, it usually primarily
7847 includes some specific parameters such as
7848 \begin_inset Flex Code
7851 \begin_layout Plain Layout
7858 \begin_inset Flex Code
7861 \begin_layout Plain Layout
7868 \begin_inset Flex Code
7871 \begin_layout Plain Layout
7878 \begin_inset Flex Code
7881 \begin_layout Plain Layout
7888 The syntax of the latter two is described in
7889 \begin_inset CommandInset ref
7891 reference "subsec:Citation-engine-description"
7899 \begin_inset CommandInset ref
7901 reference "subsec:Citation-format-description"
7905 , as well as in the files themselves.
7908 \begin_layout Section
7909 \begin_inset CommandInset label
7911 name "sec:TextClass"
7915 The layout file format
7918 \begin_layout Standard
7919 The following sections describe how layout files are structured and written.
7920 Our advice is to go slowly, save and test often.
7921 It is really not that hard, except that the multitude of options can become
7922 overwhelming, especially if you try to check out too many at once.
7923 It becomes easier if you use existing layouts of \SpecialChar LyX
7924 as examples/reference
7925 or if you modify an existing layout to your needs.
7928 \begin_layout Standard
7929 Note that all the tags used in layout files are case-insensitive.
7931 \begin_inset Flex Code
7934 \begin_layout Plain Layout
7941 \begin_inset Flex Code
7944 \begin_layout Plain Layout
7951 \begin_inset Flex Code
7954 \begin_layout Plain Layout
7960 are really the same tag.
7961 The possible arguments are printed in brackets after the tag's name.
7962 The default argument is typeset
7963 \begin_inset Flex Code
7966 \begin_layout Plain Layout
7975 If the argument has a data type like
7976 \begin_inset Quotes eld
7980 \begin_inset Quotes erd
7984 \begin_inset Quotes eld
7988 \begin_inset Quotes erd
7991 , the default is shown like this:
7992 \begin_inset Flex Code
7995 \begin_layout Plain Layout
8006 \begin_layout Subsection
8007 The document class declaration and classification
8010 \begin_layout Standard
8011 Lines in a layout file which begin with
8012 \begin_inset Flex Code
8015 \begin_layout Plain Layout
8022 There is one exception to this rule.
8024 \begin_inset Flex Code
8027 \begin_layout Plain Layout
8033 files should begin with lines like:
8036 \begin_layout LyX-Code
8039 #% Do not delete the line below; configure depends on this
8042 \begin_layout LyX-Code
8047 DeclareLaTeXClass{Article (Standard Class)}
8050 \begin_layout LyX-Code
8055 DeclareCategory{Articles}
8058 \begin_layout Standard
8059 The second and third lines are used when you (re)configure \SpecialChar LyX
8061 The layout file is read by the \SpecialChar LaTeX
8063 \begin_inset Flex Code
8066 \begin_layout Plain Layout
8072 , in a special mode where
8073 \begin_inset Flex Code
8076 \begin_layout Plain Layout
8083 The first line is just a \SpecialChar LaTeX
8084 comment, the second one contains the mandatory
8085 declaration of the text class and the third line contains the optional
8086 classification of the class.
8087 If these lines appear in a file named
8088 \begin_inset Flex Code
8091 \begin_layout Plain Layout
8097 , then they define a text class of name
8098 \begin_inset Flex Code
8101 \begin_layout Plain Layout
8107 (the name of the layout file) which uses the \SpecialChar LaTeX
8109 \begin_inset Flex Code
8112 \begin_layout Plain Layout
8118 (the default is to use the same name as the layout).
8120 \begin_inset Quotes eld
8123 Article (Standard Class)
8124 \begin_inset Quotes erd
8127 that appears above is used as a description of the text class in the
8128 \begin_inset Flex Noun
8131 \begin_layout Plain Layout
8132 Document\SpecialChar menuseparator
8140 \begin_inset Quotes eld
8144 \begin_inset Quotes erd
8147 in the example) is also used in the
8148 \begin_inset Flex Noun
8151 \begin_layout Plain Layout
8152 Document\SpecialChar menuseparator
8158 dialog: the text classes are grouped by these categories (which are usually
8159 genres, so typical categories are
8160 \begin_inset Quotes eld
8164 \begin_inset Quotes erd
8168 \begin_inset Quotes eld
8172 \begin_inset Quotes erd
8176 \begin_inset Quotes eld
8180 \begin_inset Quotes erd
8184 \begin_inset Quotes eld
8188 \begin_inset Quotes erd
8192 \begin_inset Quotes eld
8196 \begin_inset Quotes erd
8200 \begin_inset Quotes eld
8204 \begin_inset Quotes erd
8208 If no category has been declared, the class will be put in the
8209 \begin_inset Quotes eld
8213 \begin_inset Quotes erd
8219 \begin_layout Standard
8220 Let's assume that you wrote your own text class that uses the
8221 \begin_inset Flex Code
8224 \begin_layout Plain Layout
8230 document class, but where you changed the appearance of the section headings.
8231 If you put it in a file
8232 \begin_inset Flex Code
8235 \begin_layout Plain Layout
8241 , the header of this file should be:
8244 \begin_layout LyX-Code
8247 #% Do not delete the line below; configure depends on this
8250 \begin_layout LyX-Code
8255 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8258 \begin_layout LyX-Code
8263 DeclareCategory{Articles}
8266 \begin_layout Standard
8267 This declares a text class
8268 \begin_inset Flex Code
8271 \begin_layout Plain Layout
8277 , associated with the \SpecialChar LaTeX
8279 \begin_inset Flex Code
8282 \begin_layout Plain Layout
8289 \begin_inset Quotes eld
8292 Article (with My Own Headings)
8293 \begin_inset Quotes erd
8297 If your text class depends on several packages, you can declare it as:
8300 \begin_layout LyX-Code
8303 #% Do not delete the line below; configure depends on this
8306 \begin_layout LyX-Code
8311 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8314 \begin_layout LyX-Code
8319 DeclareCategory{Articles}
8322 \begin_layout Standard
8323 This indicates that your text class uses the
8324 \begin_inset Flex Code
8327 \begin_layout Plain Layout
8334 Finally, it is also possible to declare classes for DocBook code.
8335 Typical declarations will look like:
8338 \begin_layout LyX-Code
8341 #% Do not delete the line below; configure depends on this
8344 \begin_layout LyX-Code
8349 DeclareDocBookClass[article]{SGML (DocBook Article)}
8352 \begin_layout LyX-Code
8357 DeclareCategory{Articles (DocBook)}
8360 \begin_layout Standard
8361 Note that these declarations can also be given an optional parameter declaring
8362 the name of the document class (but not a list).
8365 \begin_layout Standard
8366 So, to be as explicit as possible, the form of the layout declaration is:
8369 \begin_layout LyX-Code
8374 DeclareLaTeXClass[class,package.sty]{layout description}
8377 \begin_layout LyX-Code
8382 DeclareCategory{category}
8385 \begin_layout Standard
8386 The class need only be specified if the name of the \SpecialChar LaTeX
8388 name of the layout file are different or if there are packages to load.
8389 If the name of the class file is not specified, then \SpecialChar LyX
8391 that it is the same as the name of the layout file.
8394 \begin_layout Standard
8395 When the text class has been modified to your taste, all you have to do
8396 is to copy it either to
8397 \begin_inset Flex Code
8400 \begin_layout Plain Layout
8407 \begin_inset Flex Code
8410 \begin_layout Plain Layout
8417 \begin_inset Flex Noun
8420 \begin_layout Plain Layout
8421 Tools\SpecialChar menuseparator
8427 , exit \SpecialChar LyX
8429 Then your new text class should be available along with the others.
8432 \begin_layout Standard
8433 Once the layout file is installed, you can edit it and see your changes
8434 without having to reconfigure or to restart \SpecialChar LyX
8439 \begin_layout Plain Layout
8440 In versions of \SpecialChar LyX
8441 prior to 1.6, this was not true.
8442 As a result, editing layout files was very time consuming, since you had
8443 constantly to restart \SpecialChar LyX
8449 You can force a reload of the current layout by using the \SpecialChar LyX
8451 \begin_inset Flex Noun
8454 \begin_layout Plain Layout
8461 There is no default binding for this function—though, of course, you can
8462 bind it to a key yourself.
8463 But you will normally use this function simply by entering it in the mini-buffe
8468 \begin_layout Standard
8474 \begin_inset Flex Noun
8477 \begin_layout Plain Layout
8483 is very much an `advanced feature'.
8488 recommended that you save your work before using this function.
8493 recommended that you not attempt to edit layout information while simultaneousl
8494 y working on a document that you care about.
8495 Use a test document.
8496 Syntax errors and the like in your layout file could cause peculiar behavior.
8497 In particular, such errors could cause \SpecialChar LyX
8498 to regard the current layout as
8499 invalid and to attempt to switch to some other layout.
8503 \begin_layout Plain Layout
8504 Really bad syntax errors may even caused \SpecialChar LyX
8506 This is because certain sorts of errors may make \SpecialChar LyX
8517 The \SpecialChar LyX
8518 team strives to keep \SpecialChar LyX
8519 stable in such situations, but safe is better
8524 \begin_layout Plain Layout
8525 While we're giving advice: make regular backups.
8526 And be nice to your mother.
8534 \begin_layout Subsection
8535 The Module declaration
8538 \begin_layout Standard
8539 A module must begin with a line like the following:
8542 \begin_layout LyX-Code
8545 DeclareLyXModule[endnotes.sty]{Endnotes}
8548 \begin_layout Standard
8549 The mandatory argument, in curly brackets, is the name of the module, as
8551 \begin_inset Flex Noun
8554 \begin_layout Plain Layout
8555 Document\SpecialChar menuseparator
8556 Settings\SpecialChar menuseparator
8563 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8565 on which the module depends.
8566 It is also possible to use the form
8567 \begin_inset Flex Noun
8570 \begin_layout Plain Layout
8576 as an optional argument, which declares that the module can only be used
8577 when there exists a conversion chain between the formats `
8578 \begin_inset Flex Code
8581 \begin_layout Plain Layout
8588 \begin_inset Flex Code
8591 \begin_layout Plain Layout
8600 \begin_layout Standard
8601 The module declaration should then be followed by lines like the following:
8605 \begin_layout Plain Layout
8606 Preferably in English if the module should be published with \SpecialChar LyX
8608 This description will appear in the list of messages to be translated and
8609 will be thus translated with the next interface update.
8617 \begin_layout LyX-Code
8621 \begin_layout LyX-Code
8622 #Adds an endnote command, in addition to footnotes.
8626 \begin_layout LyX-Code
8627 #You will need to add
8629 theendnotes in TeX code where you
8632 \begin_layout LyX-Code
8633 #want the endnotes to appear.
8637 \begin_layout LyX-Code
8641 \begin_layout LyX-Code
8642 #Requires: somemodule | othermodule
8645 \begin_layout LyX-Code
8646 #Excludes: badmodule
8649 \begin_layout Standard
8650 The description is used in
8651 \begin_inset Flex Noun
8654 \begin_layout Plain Layout
8655 Document\SpecialChar menuseparator
8656 Settings\SpecialChar menuseparator
8662 to provide the user with information about what the module does.
8664 \begin_inset Flex Code
8667 \begin_layout Plain Layout
8673 line is used to identify other modules with which this one must be used;
8675 \begin_inset Flex Code
8678 \begin_layout Plain Layout
8684 line is used to identify modules with which this one may not be used.
8685 Both are optional, and, as shown, multiple modules should be separated
8686 with the pipe symbol: |.
8687 Note that the required modules are treated disjunctively:
8691 of the required modules must be used.
8696 excluded module may be used.
8697 Note that modules are identified here by their filenames without the
8698 \begin_inset Flex Code
8701 \begin_layout Plain Layout
8709 \begin_inset Flex Code
8712 \begin_layout Plain Layout
8719 \begin_inset Flex Code
8722 \begin_layout Plain Layout
8731 \begin_layout Subsection
8732 The CiteEngine file declaration
8735 \begin_layout Standard
8736 A cite engine file must begin with a line like the following:
8739 \begin_layout LyX-Code
8742 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8745 \begin_layout Standard
8746 The mandatory argument, in curly brackets, is the name of the cite style,
8747 as it should appear in
8748 \begin_inset Flex Noun
8751 \begin_layout Plain Layout
8752 Document\SpecialChar menuseparator
8753 Settings\SpecialChar menuseparator
8760 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8762 on which the cite engine depends.
8765 \begin_layout Standard
8766 The cite engine declaration should then be followed by lines like the following:
8770 \begin_layout Plain Layout
8771 Preferably in English if the module should be published with \SpecialChar LyX
8773 This description will appear in the list of messages to be translated and
8774 will be thus translated with the next interface update.
8782 \begin_layout LyX-Code
8786 \begin_layout LyX-Code
8787 # Biblatex supports many author-year and numerical styles.
8790 \begin_layout LyX-Code
8791 # It is mainly aimed at the Humanities.
8795 \begin_layout LyX-Code
8796 # customizable, fully localized and provides many features
8799 \begin_layout LyX-Code
8800 # that are not possible with BibTeX.
8801 The use of 'biber' as
8804 \begin_layout LyX-Code
8805 # bibliography processor is advised.
8808 \begin_layout LyX-Code
8812 \begin_layout Standard
8813 The description is used in
8814 \begin_inset Flex Noun
8817 \begin_layout Plain Layout
8818 Document\SpecialChar menuseparator
8819 Settings\SpecialChar menuseparator
8825 to provide the user with information about the cite engine.
8828 \begin_layout Subsection
8832 \begin_layout Standard
8833 The first non-comment line of any layout file, included file, or module
8838 contain the file format number:
8841 \begin_layout Description
8842 \begin_inset Flex Code
8845 \begin_layout Plain Layout
8852 \begin_inset Flex Code
8855 \begin_layout Plain Layout
8861 ] The format number of the layout file.
8864 \begin_layout Standard
8865 This tag was introduced with \SpecialChar LyX
8867 \begin_inset space ~
8871 Layout files from older \SpecialChar LyX
8872 versions do not have an explicit file format and
8873 are considered to have
8874 \begin_inset Flex Code
8877 \begin_layout Plain Layout
8879 \begin_inset space ~
8888 The format for the present version of \SpecialChar LyX
8890 But each version of \SpecialChar LyX
8891 is capable of reading earlier versions' layout files,
8892 just as they are capable of reading files produced by earlier versions
8895 There is, however, no provision for converting to earlier formats.
8898 \begin_layout Subsection
8899 \begin_inset CommandInset label
8901 name "subsec:General-text-class"
8905 General text class parameters
8908 \begin_layout Standard
8909 These are general parameters that govern the behavior of an entire document
8915 mean that they must appear in
8916 \begin_inset Flex Code
8919 \begin_layout Plain Layout
8925 files rather than in modules.
8926 A module can contain any layout tag.)
8929 \begin_layout Description
8931 \change_inserted -712698321 1526899478
8932 \begin_inset Flex Code
8935 \begin_layout Plain Layout
8937 \change_inserted -712698321 1526898610
8938 AddToCiteEngine <engine>
8943 Extends the possibilities for displaying citation references.
8945 \begin_inset CommandInset ref
8947 reference "subsec:Citation-engine-description"
8956 \begin_inset Flex Code
8959 \begin_layout Plain Layout
8961 \change_inserted -712698321 1526898823
8972 \begin_layout Description
8973 \begin_inset Flex Code
8976 \begin_layout Plain Layout
8982 Adds information that will be output in the
8983 \begin_inset Flex Code
8986 \begin_layout Plain Layout
8992 block when the document is output to XHTML.
8993 Typically, this would be used to output CSS style information, but it can
8994 be used for anything that can appear in
8995 \begin_inset Flex Code
8998 \begin_layout Plain Layout
9006 \begin_inset Quotes eld
9010 \begin_inset Flex Code
9013 \begin_layout Plain Layout
9020 \begin_inset Quotes erd
9026 \begin_layout Description
9027 \begin_inset Flex Code
9030 \begin_layout Plain Layout
9036 Adds information to the document preamble.
9038 \begin_inset Newline newline
9042 \begin_inset Quotes eld
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9056 \begin_inset Quotes erd
9062 \begin_layout Description
9063 \begin_inset Flex Code
9066 \begin_layout Plain Layout
9072 Defines the possibilities for displaying citation references.
9074 \begin_inset CommandInset ref
9076 reference "subsec:Citation-engine-description"
9085 \begin_inset Quotes eld
9089 \begin_inset Flex Code
9092 \begin_layout Plain Layout
9099 \begin_inset Quotes erd
9103 Primarily used in cite engine files (see
9104 \begin_inset CommandInset ref
9106 reference "subsec:Cite-Engine-Files"
9115 \change_inserted -712698321 1526898530
9116 Note that if you specify this in a layout file or module, any cite engine
9117 definition will be overridden.
9119 \begin_inset Flex Code
9122 \begin_layout Plain Layout
9124 \change_inserted -712698321 1526898530
9137 \begin_layout Description
9138 \begin_inset Flex Code
9141 \begin_layout Plain Layout
9147 Defines formats for use in the display of bibliographic information.
9149 \begin_inset CommandInset ref
9151 reference "subsec:Citation-format-description"
9157 \begin_inset Quotes eld
9161 \begin_inset Flex Code
9164 \begin_layout Plain Layout
9171 \begin_inset Quotes erd
9175 Primarily used in cite engine files (see
9176 \begin_inset CommandInset ref
9178 reference "subsec:Cite-Engine-Files"
9187 \change_inserted -712698321 1526898585
9188 A cite format defined in a layout or module will override the cite engine
9194 \begin_layout Description
9195 \begin_inset Flex Code
9198 \begin_layout Plain Layout
9205 \begin_inset Flex Code
9208 \begin_layout Plain Layout
9217 \begin_inset Flex Code
9220 \begin_layout Plain Layout
9226 ] Determines whether
9230 or Bib\SpecialChar TeX
9231 is used to generate a Bibliography.
9232 Primarily used in cite engine files (see
9233 \begin_inset CommandInset ref
9235 reference "subsec:Cite-Engine-Files"
9245 \begin_layout Description
9246 \begin_inset Flex Code
9249 \begin_layout Plain Layout
9255 Describes various global options supported by the document class.
9257 \begin_inset CommandInset ref
9259 reference "subsec:ClassOptions"
9265 \begin_inset Quotes eld
9269 \begin_inset Flex Code
9272 \begin_layout Plain Layout
9279 \begin_inset Quotes erd
9285 \begin_layout Description
9286 \begin_inset Flex Code
9289 \begin_layout Plain Layout
9296 \begin_inset Flex Code
9299 \begin_layout Plain Layout
9308 \begin_inset space \thinspace{}
9312 \begin_inset Flex Code
9315 \begin_layout Plain Layout
9321 ] Whether the class should
9325 to having one or two columns.
9326 Can be changed in the
9327 \begin_inset Flex Noun
9330 \begin_layout Plain Layout
9331 Document\SpecialChar menuseparator
9340 \begin_layout Description
9341 \begin_inset Flex Code
9344 \begin_layout Plain Layout
9351 \begin_inset Flex Code
9354 \begin_layout Plain Layout
9360 ] This sequence defines the properties for a counter.
9361 If the counter does not yet exist, it is created; if it does exist, it
9364 \begin_inset Quotes eld
9368 \begin_inset Flex Code
9371 \begin_layout Plain Layout
9378 \begin_inset Quotes erd
9382 \begin_inset Newline newline
9386 \begin_inset CommandInset ref
9388 reference "subsec:Counters"
9392 for details on counters.
9395 \begin_layout Description
9396 \begin_inset Flex Code
9399 \begin_layout Plain Layout
9405 Sets the default font used to display the document.
9407 \begin_inset CommandInset ref
9409 reference "subsec:Font-description"
9413 for how to declare fonts.
9415 \begin_inset Quotes eld
9419 \begin_inset Flex Code
9422 \begin_layout Plain Layout
9429 \begin_inset Quotes erd
9435 \begin_layout Description
9436 \begin_inset Flex Code
9439 \begin_layout Plain Layout
9446 \begin_inset Flex Code
9449 \begin_layout Plain Layout
9455 ] Specifies a module to be included by default with this document class.
9456 The module is specified as filename without the
9457 \begin_inset Flex Code
9460 \begin_layout Plain Layout
9467 The user can still remove the module, but it will be active at the outset.
9468 (This applies only when new files are created, or when this class is chosen
9469 for an existing document.)
9472 \begin_layout Description
9473 \begin_inset Flex Code
9476 \begin_layout Plain Layout
9483 \begin_inset Flex Code
9486 \begin_layout Plain Layout
9492 ] This is the style that will be assigned to new paragraphs, usually
9493 \begin_inset Flex Noun
9496 \begin_layout Plain Layout
9503 This will default to the first defined style if not given, but you are
9504 encouraged to use this directive.
9507 \begin_layout Description
9508 \begin_inset Flex Code
9511 \begin_layout Plain Layout
9518 \begin_inset Flex Code
9521 \begin_layout Plain Layout
9527 ] This tag indicates that the module (which is specified by filename without
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9538 extension) cannot be used with this document class.
9539 This might be used in a journal-specific layout file to prevent, say, the
9541 \begin_inset Flex Code
9544 \begin_layout Plain Layout
9550 module that numbers theorems by section.
9555 be used in a module.
9556 Modules have their own way of excluding other modules (see
9557 \begin_inset CommandInset ref
9559 reference "subsec:Layout-modules"
9566 \begin_layout Description
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9576 Defines a new float.
9578 \begin_inset CommandInset ref
9580 reference "subsec:Floats"
9586 \begin_inset Quotes eld
9590 \begin_inset Flex Code
9593 \begin_layout Plain Layout
9600 \begin_inset Quotes erd
9606 \begin_layout Description
9607 \begin_inset Flex Code
9610 \begin_layout Plain Layout
9616 Sets the information that will be output in the
9617 \begin_inset Flex Code
9620 \begin_layout Plain Layout
9626 block when this document class is output to XHTML.
9627 Note that this will completely override any prior
9628 \begin_inset Flex Code
9631 \begin_layout Plain Layout
9638 \begin_inset Flex Code
9641 \begin_layout Plain Layout
9649 \begin_inset Newline newline
9653 \begin_inset Flex Code
9656 \begin_layout Plain Layout
9662 if you just want to add material to the preamble.) Must end with
9663 \begin_inset Quotes eld
9667 \begin_inset Flex Code
9670 \begin_layout Plain Layout
9677 \begin_inset Quotes erd
9683 \begin_layout Description
9684 \begin_inset Flex Code
9687 \begin_layout Plain Layout
9694 \begin_inset Flex Code
9697 \begin_layout Plain Layout
9703 ] The style to use for the table of contents, bibliography, and so forth,
9704 when the document is output to HTML.
9705 For articles, this should normally be
9706 \begin_inset Flex Code
9709 \begin_layout Plain Layout
9716 \begin_inset Flex Code
9719 \begin_layout Plain Layout
9726 If it is not given, then \SpecialChar LyX
9727 will attempt to figure out which layout to use.
9730 \begin_layout Description
9731 \begin_inset Flex Code
9734 \begin_layout Plain Layout
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9750 ] Modifies the properties of the given counter.
9751 If the counter does not exist, the statement is ignored.
9753 \begin_inset Quotes eld
9757 \begin_inset Flex Code
9760 \begin_layout Plain Layout
9767 \begin_inset Quotes erd
9771 \begin_inset Newline newline
9775 \begin_inset CommandInset ref
9777 reference "subsec:Counters"
9781 for details on counters.
9784 \begin_layout Description
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9795 \begin_inset Flex Code
9798 \begin_layout Plain Layout
9804 ] This allows you to include another layout definition file within yours
9805 to avoid duplicating commands.
9806 Common examples are the standard layout files, for example,
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9816 , which contains most of the basic layouts.
9819 \begin_layout Description
9820 \begin_inset Flex Code
9823 \begin_layout Plain Layout
9830 \begin_inset Flex Code
9833 \begin_layout Plain Layout
9839 ] This section (re-)defines the layout of an inset.
9840 It can be applied to an existing inset or to a new, user-defined inset,
9841 e.g., a new character style.
9843 \begin_inset Quotes eld
9847 \begin_inset Flex Code
9850 \begin_layout Plain Layout
9857 \begin_inset Quotes erd
9861 \begin_inset Newline newline
9865 \begin_inset CommandInset ref
9867 reference "subsec:Flex-insets-and"
9871 for more information.
9875 \begin_layout Description
9876 \begin_inset Flex Code
9879 \begin_layout Plain Layout
9886 \begin_inset Flex Code
9889 \begin_layout Plain Layout
9895 ] A string that indicates the width of the left margin on the screen, for
9897 \begin_inset Quotes eld
9901 \begin_inset Flex Code
9904 \begin_layout Plain Layout
9911 \begin_inset Quotes erd
9915 (Note that this is not a `length', like
9916 \begin_inset Quotes eld
9920 \begin_inset Quotes erd
9926 \begin_layout Description
9927 \begin_inset Flex Code
9930 \begin_layout Plain Layout
9937 \begin_inset Flex Code
9940 \begin_layout Plain Layout
9946 ] An integer that determines the maximal number of names displayed in an
9947 author-year citation before the citation switches to
9948 \begin_inset Quotes eld
9952 \begin_inset Quotes erd
9956 Primarily used in cite engine files (see
9957 \begin_inset CommandInset ref
9959 reference "subsec:Cite-Engine-Files"
9969 \begin_layout Description
9970 \begin_inset Flex Code
9973 \begin_layout Plain Layout
9980 \begin_inset Flex Code
9983 \begin_layout Plain Layout
9989 ] Modifies the properties of the given paragraph style.
9990 If the style does not exist, this section is ignored.
9992 \begin_inset Quotes eld
9996 \begin_inset Flex Code
9999 \begin_layout Plain Layout
10006 \begin_inset Quotes erd
10012 \begin_layout Description
10013 \begin_inset Flex Code
10016 \begin_layout Plain Layout
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10032 ] Deletes an existing counter, usually one defined in an included file.
10035 \begin_layout Description
10036 \begin_inset Flex Code
10039 \begin_layout Plain Layout
10046 \begin_inset Flex Code
10049 \begin_layout Plain Layout
10055 ] Deletes an existing float.
10056 This is particularly useful when you want to suppress a float that has
10057 been defined in an input file.
10060 \begin_layout Description
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10080 ] Deletes an existing style.
10083 \begin_layout Description
10084 \begin_inset Flex Code
10087 \begin_layout Plain Layout
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10104 \begin_inset Flex Code
10107 \begin_layout Plain Layout
10113 ] Define a new table of contents with type
10114 \begin_inset Flex Code
10117 \begin_layout Plain Layout
10124 \begin_inset Flex Code
10127 \begin_layout Plain Layout
10134 See also the AddToToc commands.
10137 \begin_layout Description
10138 \begin_inset Flex Code
10141 \begin_layout Plain Layout
10148 \begin_inset Flex Code
10151 \begin_layout Plain Layout
10157 ] The file format (as defined in the \SpecialChar LyX
10158 preferences) produced by this document
10160 It is mainly useful when
10161 \begin_inset Flex Code
10164 \begin_layout Plain Layout
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10180 and one wants to define a new type of literate document.
10181 The format is reset to
10182 \begin_inset Quotes eld
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10196 \begin_inset Quotes erd
10200 \begin_inset Quotes eld
10204 \begin_inset Flex Code
10207 \begin_layout Plain Layout
10214 \begin_inset Quotes erd
10217 when the corresponding
10218 \begin_inset Flex Code
10221 \begin_layout Plain Layout
10227 parameter is encountered.
10230 \begin_layout Description
10231 \begin_inset Flex Code
10234 \begin_layout Plain Layout
10241 \begin_inset Flex Code
10244 \begin_layout Plain Layout
10255 \begin_inset Flex Code
10258 \begin_layout Plain Layout
10265 \begin_inset Flex Code
10268 \begin_layout Plain Layout
10274 ] Specifies what sort of output documents using this class will produce.
10277 \begin_layout Description
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10307 ] Specifies options, given in the second string, for the package named by
10310 \begin_inset Quotes eld
10314 \begin_inset Flex Code
10317 \begin_layout Plain Layout
10318 PackageOptions natbib square
10324 \begin_inset Quotes erd
10328 \begin_inset Flex Code
10331 \begin_layout Plain Layout
10337 to be loaded with the
10338 \begin_inset Flex Code
10341 \begin_layout Plain Layout
10348 (For \SpecialChar TeX
10349 perts, this causes \SpecialChar LyX
10351 \begin_inset Flex Code
10354 \begin_layout Plain Layout
10357 PassOptionsToPackage{natbib}{square}
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10375 \begin_layout Description
10376 \begin_inset Flex Code
10379 \begin_layout Plain Layout
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10417 ] The default pagestyle.
10418 Can be changed in the
10419 \begin_inset Flex Noun
10422 \begin_layout Plain Layout
10423 Document\SpecialChar menuseparator
10432 \begin_layout Description
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10442 Sets the preamble for the \SpecialChar LaTeX
10444 Note that this will completely override any prior
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 if you just want to add material to the preamble.) Must end with
10476 \begin_inset Quotes eld
10480 \begin_inset Flex Code
10483 \begin_layout Plain Layout
10490 \begin_inset Quotes erd
10496 \begin_layout Description
10497 \begin_inset Flex Code
10500 \begin_layout Plain Layout
10507 \begin_inset Flex Code
10510 \begin_layout Plain Layout
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10529 \begin_inset space \thinspace{}
10533 \begin_inset Flex Code
10536 \begin_layout Plain Layout
10542 ] Whether the class already provides the feature
10543 \begin_inset Flex Code
10546 \begin_layout Plain Layout
10553 A feature is in general the name of a package (e.
10554 \begin_inset space \thinspace{}
10558 \begin_inset space \space{}
10562 \begin_inset Flex Code
10565 \begin_layout Plain Layout
10572 \begin_inset Flex Code
10575 \begin_layout Plain Layout
10582 \begin_inset space \thinspace{}
10586 \begin_inset space \space{}
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10611 \begin_inset CommandInset ref
10613 reference "chap:List-of-functions"
10617 for the list of features.
10620 \begin_layout Description
10621 \begin_inset Flex Code
10624 \begin_layout Plain Layout
10631 \begin_inset Flex Code
10634 \begin_layout Plain Layout
10640 ] Indicates that this layout provides the functionality of the module mentioned,
10641 which should be specified by the filename without the
10642 \begin_inset Flex Code
10645 \begin_layout Plain Layout
10652 This will typically be used if the layout includes the module directly,
10653 rather than using the
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10663 tag to indicate that it ought to be used.
10664 It could also be used in a module that provided an alternate implementation
10665 of the same functionality.
10668 \begin_layout Description
10669 \begin_inset Flex Code
10672 \begin_layout Plain Layout
10679 \begin_inset Flex Code
10682 \begin_layout Plain Layout
10688 ] Creates a new paragraph style if it does not already exist.
10689 If the style does exist, this section is ignored.
10691 \begin_inset Quotes eld
10695 \begin_inset Flex Code
10698 \begin_layout Plain Layout
10705 \begin_inset Quotes erd
10711 \begin_layout Description
10712 \begin_inset Flex Code
10715 \begin_layout Plain Layout
10722 \begin_inset Flex Code
10725 \begin_layout Plain Layout
10731 ] Whether the class requires the feature
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10742 Multiple features must be separated by commas.
10743 Note that you can only request supported features.
10745 \begin_inset CommandInset ref
10747 reference "chap:List-of-functions"
10751 for the list of features.).
10752 If you require a package with specific options, you can additionally use
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10766 \begin_layout Description
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10777 \begin_inset Flex Code
10780 \begin_layout Plain Layout
10786 ] A string that indicates the width of the right margin on the screen, for
10788 \begin_inset Quotes eld
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10802 \begin_inset Quotes erd
10808 \begin_layout Description
10809 \begin_inset Flex Code
10812 \begin_layout Plain Layout
10819 \begin_inset Flex Code
10822 \begin_layout Plain Layout
10828 ] Sets which divisions get numbered.
10830 \begin_inset Newline newline
10834 \begin_inset Flex Code
10837 \begin_layout Plain Layout
10843 counter in \SpecialChar LaTeX
10847 \begin_layout Description
10848 \begin_inset Flex Code
10851 \begin_layout Plain Layout
10858 \begin_inset Flex Code
10861 \begin_layout Plain Layout
10870 \begin_inset space \thinspace{}
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10883 ] Whether the class-default should be printing on one or both sides of the
10885 Can be changed in the
10886 \begin_inset Flex Noun
10889 \begin_layout Plain Layout
10890 Document\SpecialChar menuseparator
10899 \begin_layout Description
10900 \begin_inset Flex Code
10903 \begin_layout Plain Layout
10910 \begin_inset Flex Code
10913 \begin_layout Plain Layout
10919 ] This sequence defines a paragraph style.
10920 If the style does not yet exist, it is created; if it does exist, its parameter
10923 \begin_inset Quotes eld
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10937 \begin_inset Quotes erd
10941 \begin_inset Newline newline
10945 \begin_inset CommandInset ref
10947 reference "subsec:Paragraph-Styles"
10951 for details on paragraph styles.
10954 \begin_layout Description
10955 \begin_inset Flex Code
10958 \begin_layout Plain Layout
10965 \begin_inset Flex Code
10968 \begin_layout Plain Layout
10974 ] The name of the command or environment to be used with
10975 \begin_inset Flex Code
10978 \begin_layout Plain Layout
10987 \begin_layout Description
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10998 \begin_inset Flex Code
11001 \begin_layout Plain Layout
11010 \begin_inset Flex Code
11013 \begin_layout Plain Layout
11019 ] Indicates what kind of markup is used to define the title of a document.
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11030 means that the macro with name
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11040 will be inserted after the last layout which has
11041 \begin_inset Quotes eld
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11050 \begin_inset space ~
11059 \begin_inset Quotes erd
11064 \begin_inset Flex Code
11067 \begin_layout Plain Layout
11073 corresponds to the case where all layouts which have
11074 \begin_inset Quotes eld
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11083 \begin_inset space ~
11092 \begin_inset Quotes erd
11095 should be enclosed into the
11096 \begin_inset Flex Code
11099 \begin_layout Plain Layout
11108 \begin_layout Description
11109 \begin_inset Flex Code
11112 \begin_layout Plain Layout
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11128 ] Sets which divisions are included in the table of contents.
11130 \begin_inset Flex Code
11133 \begin_layout Plain Layout
11139 counter in \SpecialChar LaTeX
11143 \begin_layout Subsection
11144 \begin_inset Flex Code
11147 \begin_layout Plain Layout
11154 \begin_inset CommandInset label
11156 name "subsec:ClassOptions"
11163 \begin_layout Standard
11165 \begin_inset Flex Code
11168 \begin_layout Plain Layout
11174 section can contain the following entries:
11177 \begin_layout Description
11178 \begin_inset Flex Code
11181 \begin_layout Plain Layout
11188 \begin_inset Flex Code
11191 \begin_layout Plain Layout
11197 ] The list of available font sizes for the document's main font, separated
11199 \begin_inset Quotes eld
11203 \begin_inset Flex Code
11206 \begin_layout Plain Layout
11213 \begin_inset Quotes erd
11219 \begin_layout Description
11220 \begin_inset Flex Code
11223 \begin_layout Plain Layout
11229 Used to set the DTD line with XML-based output classes.
11231 \begin_inset space \thinspace{}
11235 \begin_inset Quotes eld
11238 -//OASIS//DTD DocBook V4.2//EN
11239 \begin_inset Quotes erd
11245 \begin_layout Description
11246 \begin_inset Flex Code
11249 \begin_layout Plain Layout
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11260 string="empty|plain|headings|fancy"
11265 ] The list of available page sty\SpecialChar softhyphen
11267 \begin_inset Quotes eld
11271 \begin_inset Flex Code
11274 \begin_layout Plain Layout
11281 \begin_inset Quotes erd
11287 \begin_layout Description
11288 \begin_inset Flex Code
11291 \begin_layout Plain Layout
11298 \begin_inset Flex Code
11301 \begin_layout Plain Layout
11307 ] Some document class options, separated by a comma, that will be added
11308 to the optional part of the
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11323 \begin_layout Standard
11325 \begin_inset Flex Code
11328 \begin_layout Plain Layout
11334 section must end with
11335 \begin_inset Quotes eld
11339 \begin_inset Flex Code
11342 \begin_layout Plain Layout
11349 \begin_inset Quotes erd
11355 \begin_layout Subsection
11357 \begin_inset CommandInset label
11359 name "subsec:Paragraph-Styles"
11366 \begin_layout Standard
11367 A paragraph style description looks like this:
11371 \begin_layout Plain Layout
11372 Note that this will either define a new style or modify an existing one.
11380 \begin_layout LyX-Code
11387 \begin_layout LyX-Code
11391 \begin_layout LyX-Code
11395 \begin_layout Standard
11396 where the following commands are allowed:
11399 \begin_layout Description
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11410 \begin_inset Flex Code
11413 \begin_layout Plain Layout
11419 =""] This paragraph will appear in the table of contents of the given type.
11420 An empty string disables.
11421 See also the OutlinerName and the IsTocCaption commands.
11425 \begin_layout Description
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11444 , left, right, center
11449 ] Paragraph alignment.
11452 \begin_layout Description
11453 \begin_inset Flex Code
11456 \begin_layout Plain Layout
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11471 , left, right, center
11476 ] A comma separated list of permitted alignments.
11477 (Some \SpecialChar LaTeX
11478 styles prohibit certain alignments, since those wouldn't make sense.
11479 For example a right-aligned or centered enumeration isn't possible.)
11482 \begin_layout Description
11483 \begin_inset Flex Code
11486 \begin_layout Plain Layout
11493 \begin_inset Flex Code
11496 \begin_layout Plain Layout
11502 ] Defines argument number <int> of a command\SpecialChar breakableslash
11503 environment associated with
11505 This is useful for things like section headings, and only makes sense with
11508 Every (optional or required) argument of a command or environment – except
11509 for the required argument that is associated with the content of the paragraph
11510 itself – has a separate definition, where the number specifies the order
11512 The definition must end with
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11523 So a command with two optional arguments has:
11527 \begin_layout Quote
11533 \begin_layout Quote
11539 \begin_layout Quote
11545 \begin_layout Quote
11551 \begin_layout Quote
11557 \begin_layout Quote
11563 \begin_layout Standard
11565 \begin_inset Flex Code
11568 \begin_layout Plain Layout
11574 definition, the following specifications are possible:
11577 \begin_layout Itemize
11578 \begin_inset Flex Code
11581 \begin_layout Plain Layout
11588 \begin_inset Flex Code
11591 \begin_layout Plain Layout
11597 The string that will appear both in the menu (to insert this argument)
11598 and on the argument inset button (unless you also specify a separate
11599 \begin_inset Flex Code
11602 \begin_layout Plain Layout
11609 For the menu, you can define an accelerator by appending the respective
11610 character to the string, divided by
11611 \begin_inset Quotes eld
11615 \begin_inset Quotes erd
11619 \begin_inset space \thinspace{}
11623 \begin_inset space \space{}
11627 \begin_inset Quotes eld
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11641 \begin_inset Quotes erd
11647 \begin_layout Itemize
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11667 A separate string for the menu.
11668 You can define an accelerator by appending the respective character to
11669 the string, divided by
11670 \begin_inset Quotes eld
11674 \begin_inset Quotes erd
11678 \begin_inset space \thinspace{}
11682 \begin_inset space \space{}
11686 \begin_inset Quotes eld
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11700 \begin_inset Quotes erd
11704 This specification is optional.
11705 If it is not given the
11706 \begin_inset Flex Code
11709 \begin_layout Plain Layout
11715 will be used instead for the menu.
11718 \begin_layout Itemize
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11738 A longer explanatory text that appears in the tooltip when hovering over
11739 the argument inset.
11742 \begin_layout Itemize
11743 \begin_inset Flex Code
11746 \begin_layout Plain Layout
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11765 \begin_inset space \thinspace{}
11769 \begin_inset Flex Code
11772 \begin_layout Plain Layout
11778 ] Declare if this is a mandatory (1) or an optional (0) argument.
11779 Mandatory arguments will be output empty if not given, while optional arguments
11780 will not be output at all.
11781 By default, mandatory arguments are delimited by
11782 \begin_inset Flex Code
11785 \begin_layout Plain Layout
11791 , while optional arguments are delimited by
11792 \begin_inset Flex Code
11795 \begin_layout Plain Layout
11804 \begin_layout Itemize
11805 \begin_inset Flex Code
11808 \begin_layout Plain Layout
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11824 defines another argument (by its number) which this argument requires to
11825 be output if it is itself output.
11827 \begin_inset space \thinspace{}
11830 g., in \SpecialChar LaTeX
11831 commands, optional arguments often require previous optional arguments
11832 to be output (at least empty), as in
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11839 command[][argument]{text}
11845 This can be achieved by the statement
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11868 \begin_layout Itemize
11869 \begin_inset Flex Code
11872 \begin_layout Plain Layout
11879 \begin_inset Flex Code
11882 \begin_layout Plain Layout
11888 defines a custom left delimiter (instead of
11889 \begin_inset Flex Code
11892 \begin_layout Plain Layout
11899 \begin_inset Flex Code
11902 \begin_layout Plain Layout
11909 A line break in the output can be indicated by
11910 \begin_inset Flex Code
11913 \begin_layout Plain Layout
11922 \begin_layout Itemize
11923 \begin_inset Flex Code
11926 \begin_layout Plain Layout
11933 \begin_inset Flex Code
11936 \begin_layout Plain Layout
11942 defines a custom right delimiter (instead of
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11953 \begin_inset Flex Code
11956 \begin_layout Plain Layout
11963 A line break in the output can be indicated by
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11976 \begin_layout Itemize
11977 \begin_inset Flex Code
11980 \begin_layout Plain Layout
11987 \begin_inset Flex Code
11990 \begin_layout Plain Layout
11996 defines an argument that is inserted if and only if no user-specified arguments
11998 \begin_inset space \thinspace{}
12002 \begin_inset space \space{}
12005 if no argument inset has been inserted (note that also an empty argument
12006 inset omits the DefaultArg).
12007 Multiple arguments need to be separated by comma.
12010 \begin_layout Itemize
12011 \begin_inset Flex Code
12014 \begin_layout Plain Layout
12021 \begin_inset Flex Code
12024 \begin_layout Plain Layout
12030 defines an argument that is inserted in any case (alone or in addition
12031 to user-specified arguments).
12032 Multiple arguments need to be separated by comma.
12035 \begin_layout Itemize
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 The font used for the argument content, see
12046 \begin_inset CommandInset ref
12048 reference "subsec:Font-description"
12055 \begin_layout Itemize
12056 \begin_inset Flex Code
12059 \begin_layout Plain Layout
12065 The font used for the label; see
12066 \begin_inset CommandInset ref
12068 reference "subsec:Font-description"
12075 \begin_layout Itemize
12076 \begin_inset Flex Code
12079 \begin_layout Plain Layout
12086 \begin_inset Flex Code
12089 \begin_layout Plain Layout
12094 , Minimalistic, Conglomerate
12099 ] describes the rendering style used for the inset's frame and buttons.
12102 \begin_layout Itemize
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12113 \begin_inset Flex Code
12116 \begin_layout Plain Layout
12123 \begin_inset Flex Code
12126 \begin_layout Plain Layout
12132 , this argument is automatically inserted when the respective style is selected.
12133 Currently, only one argument per style\SpecialChar breakableslash
12134 layout can be automatically inserted.
12137 \begin_layout Itemize
12138 \begin_inset Flex Code
12141 \begin_layout Plain Layout
12148 \begin_inset Flex Code
12151 \begin_layout Plain Layout
12158 \begin_inset Flex Code
12161 \begin_layout Plain Layout
12167 , this argument will be inserted with a copy of the co-text (either selected
12168 text or the whole paragraph) as content.
12171 \begin_layout Itemize
12172 \begin_inset Flex Code
12175 \begin_layout Plain Layout
12182 \begin_inset Flex Code
12185 \begin_layout Plain Layout
12195 ] Whether the contents of this argument should be output in raw form, meaning
12196 without special translations that \SpecialChar LaTeX
12199 \begin_inset Flex Code
12202 \begin_layout Plain Layout
12208 status is inherited by the inset or paragraph layout the argument belongs
12209 to, true and false change the status for the given argument only.
12212 \begin_layout Itemize
12213 \begin_inset Flex Code
12216 \begin_layout Plain Layout
12223 \begin_inset Flex Code
12226 \begin_layout Plain Layout
12227 string of characters
12236 Defines individual characters
12237 \begin_inset Newline linebreak
12240 that should be output in raw form, meaning without special translations
12241 that \SpecialChar LaTeX
12243 Note that, contrary to PassThru, this needs to be explicitly defined for
12245 That is, arguments do not inherit PassThruChars from their parent inset
12249 \begin_layout Itemize
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12272 \begin_inset space \thinspace{}
12276 \begin_inset Flex Code
12279 \begin_layout Plain Layout
12285 ] If this is set to 1, the argument will output its content in the corresponding
12286 item in the table of contents.
12290 \begin_layout Standard
12291 By default, the text entered in the \SpecialChar LyX
12292 workarea in the respective layout is
12293 the last (mandatory) argument of a command if the
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12314 However, arguments with the prefix
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12324 are output after this workarea argument.
12325 Note that post-argument numbering restarts at 1, so the first argument
12326 following the workarea argument is
12327 \begin_inset Flex Code
12330 \begin_layout Plain Layout
12337 Post-arguments are ignored in any other
12338 \begin_inset Flex Code
12341 \begin_layout Plain Layout
12348 \begin_inset Flex Code
12351 \begin_layout Plain Layout
12360 \begin_layout Standard
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12374 \begin_inset Flex Code
12377 \begin_layout Plain Layout
12386 \begin_inset Flex Code
12389 \begin_layout Plain Layout
12395 followed by the number (e.
12396 \begin_inset space \thinspace{}
12400 \begin_inset space \space{}
12404 \begin_inset Flex Code
12407 \begin_layout Plain Layout
12414 \change_inserted -712698321 1534487781
12418 \begin_layout Standard
12420 \change_inserted -712698321 1534488561
12421 Finally, there is a special argument type with the prefix
12422 \begin_inset Flex Code
12425 \begin_layout Plain Layout
12427 \change_inserted -712698321 1534487844
12436 It is not really an argument, but uses the argument interface (thus, the
12437 prefix is also followed by a number, e.
12438 \begin_inset space \thinspace{}
12443 \begin_inset Flex Code
12446 \begin_layout Plain Layout
12448 \change_inserted -712698321 1534488412
12449 Argument listpreamble:1
12455 As the name implies, it is targeted at lists such as
12472 Its content will be output at the list start, before the first
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12478 \change_inserted -712698321 1534488058
12488 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12490 This way, users can insert redefinitions (of lengths etc.) to individual
12492 By default, these arguments do not have a delimiter.
12498 \begin_layout Description
12499 \begin_inset Flex Code
12502 \begin_layout Plain Layout
12508 Includes a comma-separated list of layouts that should be nested in and
12509 after the current layout.
12510 Only makes sense for nestable layouts (such as environments).
12512 \begin_inset Quotes eld
12516 \begin_inset Flex Code
12519 \begin_layout Plain Layout
12526 \begin_inset Quotes erd
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12543 \begin_layout Description
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12553 Note that this will completely override any prior
12554 \begin_inset Flex Code
12557 \begin_layout Plain Layout
12563 declaration for this style.
12565 \begin_inset Quotes eld
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12579 \begin_inset Quotes erd
12584 \begin_inset CommandInset ref
12586 reference "subsec:I18n"
12590 for details on its use.
12593 \begin_layout Description
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12604 \begin_inset Flex Code
12607 \begin_layout Plain Layout
12617 \begin_layout Plain Layout
12618 Note that a `float' here is a real number, such as: 1.5.
12623 The vertical space with which the last of a chain of paragraphs with this
12624 style is separated from the following paragraph.
12625 If the next paragraph has another style, the separations are not simply
12626 added, but the maximum is taken.
12629 \begin_layout Description
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12640 \begin_inset Flex Code
12643 \begin_layout Plain Layout
12649 ] The category for this style.
12650 This is used to group related styles in the style combobox on the toolbar.
12651 Any string can be used, but you may want to use existing categories with
12656 \begin_layout Description
12657 \begin_inset Flex Code
12660 \begin_layout Plain Layout
12666 Depth of XML command.
12667 Used only with XML-type formats.
12670 \begin_layout Description
12671 \begin_inset Flex Code
12674 \begin_layout Plain Layout
12681 \begin_inset Flex Code
12684 \begin_layout Plain Layout
12690 ] Copies all the features of an existing style into the current one.
12694 \begin_layout Description
12695 \begin_inset Flex Code
12698 \begin_layout Plain Layout
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12714 ] The name of a style whose preamble should be output
12719 This allows to ensure some ordering of the preamble snippets when macros
12720 definitions depend on one another.
12724 \begin_layout Plain Layout
12725 Note that, besides that functionality, there is no way to ensure any ordering
12727 The ordering that you see in a given version of \SpecialChar LyX
12728 may change without warning
12737 \begin_layout Description
12738 \begin_inset Flex Code
12741 \begin_layout Plain Layout
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12756 , Box, Filled_Box, Static
12761 ] The type of label that stands at the end of the paragraph (or sequence
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12773 \begin_inset Newline newline
12777 \begin_inset Flex Code
12780 \begin_layout Plain Layout
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12818 \begin_inset Quotes eld
12822 \begin_inset Quotes erd
12826 \begin_inset Flex Code
12829 \begin_layout Plain Layout
12836 \begin_inset space \space{}
12840 \begin_inset Flex Code
12843 \begin_layout Plain Layout
12849 ) is a white (resp.
12850 \begin_inset space ~
12853 black) square suitable for end of proof markers,
12854 \begin_inset Flex Code
12857 \begin_layout Plain Layout
12863 is an explicit text string.
12866 \begin_layout Description
12867 \begin_inset Flex Code
12870 \begin_layout Plain Layout
12877 \begin_inset Flex Code
12880 \begin_layout Plain Layout
12886 ] The string used for a label with a
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12897 \begin_inset Newline newline
12901 \begin_inset Flex Code
12904 \begin_layout Plain Layout
12914 \begin_layout Description
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12924 The font used for both the text body
12930 \begin_inset CommandInset ref
12932 reference "subsec:Font-description"
12937 Note that defining this font automatically defines the
12938 \begin_inset Flex Code
12941 \begin_layout Plain Layout
12948 So you should define this one first if you also want to define
12949 \begin_inset Flex Code
12952 \begin_layout Plain Layout
12961 \begin_layout Description
12962 \begin_inset Flex Code
12965 \begin_layout Plain Layout
12972 \begin_inset Flex Code
12975 \begin_layout Plain Layout
12981 ] Used for backporting new styles to stable \SpecialChar LyX
12983 The first stable version that supports this tag is \SpecialChar LyX
12985 The argument is a number which may either be 0, -1 or any value greater
12988 \begin_inset Flex Code
12991 \begin_layout Plain Layout
12997 flag of a style is greater than zero, it will always be written to the
12999 If a .lyx file is read, the style definitions from the document header are
13000 added to the document class.
13001 Therefore even older \SpecialChar LyX
13002 versions can handle the style.
13004 \begin_inset Flex Code
13007 \begin_layout Plain Layout
13013 is a version number: if the style is read, and the version number is less
13014 than the version number of the already existing style in the document class,
13015 the new style is ignored.
13016 If the version number is greater, the new style replaces the existing style.
13017 A value of -1 means an infinite version number, i.
13018 \begin_inset space \thinspace{}
13022 \begin_inset space \space{}
13025 the style is always used.
13028 \begin_layout Description
13029 \begin_inset Flex Code
13032 \begin_layout Plain Layout
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13051 \begin_inset space \thinspace{}
13055 \begin_inset Flex Code
13058 \begin_layout Plain Layout
13064 ] Usually \SpecialChar LyX
13065 does not allow you to insert more than one space between words,
13066 since a space is considered as the separation between two words, not a
13067 character or symbol of its own.
13068 This is a very fine thing but sometimes annoying, for example, when typing
13069 program code or plain \SpecialChar LaTeX
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13082 Note that \SpecialChar LyX
13083 will create protected blanks for the additional blanks when
13084 in another mode than \SpecialChar LaTeX
13088 \begin_layout Description
13089 \begin_inset Flex Code
13092 \begin_layout Plain Layout
13098 These tags are used with XHTML output.
13100 \begin_inset CommandInset ref
13102 reference "subsec:Paragraph-Style-XHTML"
13109 \begin_layout Description
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13119 [FIXME] (Used only with XML-type formats.)
13122 \begin_layout Description
13123 \begin_inset Flex Code
13126 \begin_layout Plain Layout
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13145 \begin_inset space \thinspace{}
13149 \begin_inset Flex Code
13152 \begin_layout Plain Layout
13159 \begin_inset Flex Code
13162 \begin_layout Plain Layout
13168 , marks the style as to be included in the document preamble and not in
13170 This is useful for document classes that want such information as the title
13171 and author to appear in the preamble.
13172 Note that this works only for styles for which the
13173 \begin_inset Flex Code
13176 \begin_layout Plain Layout
13183 \begin_inset Flex Code
13186 \begin_layout Plain Layout
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13205 \begin_layout Description
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13228 \begin_inset space \thinspace{}
13232 \begin_inset Flex Code
13235 \begin_layout Plain Layout
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13251 , marks the style as being part of a title block (see also the
13252 \begin_inset Flex Code
13255 \begin_layout Plain Layout
13262 \begin_inset Flex Code
13265 \begin_layout Plain Layout
13274 \begin_layout Description
13275 \begin_inset Flex Code
13278 \begin_layout Plain Layout
13284 Includes a comma-separated list of layouts after which this one should
13286 Only makes sense with regard to nestable layouts (such as environments).
13288 \begin_inset Quotes eld
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13302 \begin_inset Quotes erd
13307 \begin_inset Flex Code
13310 \begin_layout Plain Layout
13319 \begin_layout Description
13320 \begin_inset Flex Code
13323 \begin_layout Plain Layout
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13342 \begin_inset space \thinspace{}
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13355 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13356 of its contents in its item in the table of contents.
13357 Otherwise, only the label, if it exists, appears.
13360 \begin_layout Description
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13371 \begin_inset Flex Code
13374 \begin_layout Plain Layout
13380 ] The \SpecialChar LaTeX
13381 command sequence declaring an item in a list.
13382 The command is to be defined without the preceding backslash (the default
13384 \begin_inset Quotes eld
13388 \begin_inset Quotes erd
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13403 in the \SpecialChar LaTeX
13407 \begin_layout Description
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13427 ] This provides extra space between paragraphs that have the same style.
13428 If you put other styles into an environment, each is separated with the
13430 \begin_inset Flex Code
13433 \begin_layout Plain Layout
13440 But the whole items of the environment are additionally separated with
13442 \begin_inset Flex Code
13445 \begin_layout Plain Layout
13452 Note that this is a
13457 \begin_layout Description
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13467 [FIXME] (Used only with XML-type formats.)
13470 \begin_layout Description
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13493 \begin_inset space \thinspace{}
13497 \begin_inset Flex Code
13500 \begin_layout Plain Layout
13506 ] Usually \SpecialChar LyX
13507 does not allow you to leave a paragraph empty, since it would
13508 lead to empty \SpecialChar LaTeX
13510 There are some cases where this could be desirable however: in a letter
13511 template, the required fields can be provided as empty fields, so that
13512 people do not forget them; in some special classes, a style can be used
13513 as some kind of break, which does not contain actual text.
13516 \begin_layout Description
13517 \begin_inset Flex Code
13520 \begin_layout Plain Layout
13527 \begin_inset Flex Code
13530 \begin_layout Plain Layout
13536 ] The vertical space between the label and the text body.
13537 Only used for labels that are above the text body (
13538 \begin_inset Flex Code
13541 \begin_layout Plain Layout
13548 \begin_inset Newline newline
13552 \begin_inset Flex Code
13555 \begin_layout Plain Layout
13556 Centered_Top_Environment
13564 \begin_layout Description
13565 \begin_inset Flex Code
13568 \begin_layout Plain Layout
13575 \begin_inset Flex Code
13578 \begin_layout Plain Layout
13584 ] The name of the counter for automatic numbering.
13585 In order to have the counter appear with your label, you will need to reference
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13599 This will work with
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13620 \begin_inset Flex Code
13623 \begin_layout Plain Layout
13630 \begin_inset Flex Code
13633 \begin_layout Plain Layout
13640 \begin_inset Newline newline
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13667 , though this case is a bit complicated.
13668 Suppose you declare
13669 \begin_inset Quotes eld
13673 \begin_inset Flex Code
13676 \begin_layout Plain Layout
13677 LabelCounter myenum
13683 \begin_inset Quotes erd
13687 Then the actual counters used are
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13718 \begin_inset Flex Code
13721 \begin_layout Plain Layout
13727 , much as in \SpecialChar LaTeX
13729 These counters must all be declared separately.
13730 \begin_inset Newline newline
13734 \begin_inset CommandInset ref
13736 reference "subsec:Counters"
13740 for details on counters.
13743 \begin_layout Description
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13753 The font used for the label.
13755 \begin_inset CommandInset ref
13757 reference "subsec:Font-description"
13764 \begin_layout Description
13765 \begin_inset Flex Code
13768 \begin_layout Plain Layout
13775 \begin_inset Flex Code
13778 \begin_layout Plain Layout
13784 ] Text that indicates how far a label should be indented.
13787 \begin_layout Description
13788 \begin_inset Flex Code
13791 \begin_layout Plain Layout
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13807 ] Text that indicates the amount of horizontal space between the label and
13809 Only used for labels that are not above the text body.
13812 \begin_layout Description
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13823 \begin_inset Flex Code
13826 \begin_layout Plain Layout
13832 ] The string used for the label.
13834 \begin_inset Flex Code
13837 \begin_layout Plain Layout
13843 is set, this string can be contain the special formatting commands described
13845 \begin_inset CommandInset ref
13847 reference "subsec:Counters"
13854 \begin_layout Description
13855 \begin_inset Flex Code
13858 \begin_layout Plain Layout
13859 LabelStringAppendix
13865 \begin_inset Flex Code
13868 \begin_layout Plain Layout
13874 ] This is used inside the appendix instead of
13875 \begin_inset Newline newline
13879 \begin_inset Flex Code
13882 \begin_layout Plain Layout
13890 \begin_inset Flex Code
13893 \begin_layout Plain Layout
13900 \begin_inset Newline newline
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13908 LabelStringAppendix
13916 \begin_layout Description
13917 \begin_inset Flex Code
13920 \begin_layout Plain Layout
13926 [FIXME] (Used only with XML-type formats.)
13929 \begin_layout Description
13930 \begin_inset Flex Code
13933 \begin_layout Plain Layout
13940 \begin_inset Flex Code
13943 \begin_layout Plain Layout
13948 , Manual, Static, Above,
13949 \begin_inset Newline newline
13952 Centered, Sensitive, Enumerate,
13953 \begin_inset Newline newline
13956 Itemize, Bibliography
13965 \begin_layout Description
13966 \begin_inset Flex Code
13969 \begin_layout Plain Layout
13975 means the label is the very first word (up to the first real blank).
13976 Use protected spaces if you want more than one word as the label.
13980 \begin_layout Description
13981 \begin_inset Flex Code
13984 \begin_layout Plain Layout
13990 means the label is simply what is declared as
13991 \begin_inset Flex Code
13994 \begin_layout Plain Layout
14001 This will be displayed
14002 \begin_inset Quotes eld
14006 \begin_inset Quotes erd
14009 , at the beginning of the paragraph.
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14030 , then it will be displayed only in the first paragraph of any sequence
14031 of paragraphs with the same
14032 \begin_inset Flex Code
14035 \begin_layout Plain Layout
14044 \begin_layout Description
14045 \begin_inset Flex Code
14048 \begin_layout Plain Layout
14055 \begin_inset space ~
14059 \begin_inset space ~
14063 \begin_inset Flex Code
14066 \begin_layout Plain Layout
14072 are special cases of
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14083 The label will be printed above the paragraph either at the beginning of
14084 the line or centered.
14087 \begin_layout Description
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14097 is a special case for the caption-labels
14098 \begin_inset Quotes eld
14102 \begin_inset Quotes erd
14106 \begin_inset Quotes eld
14110 \begin_inset Quotes erd
14114 \begin_inset Newline newline
14118 \begin_inset Flex Code
14121 \begin_layout Plain Layout
14127 means the (hardcoded) label string depends on the kind of float: It is
14128 hardcoded to be `FloatType N', where N is the value of the counter associated
14130 For the case that a caption is inserted outside of a float the
14131 \begin_inset Flex Code
14134 \begin_layout Plain Layout
14141 \begin_inset Quotes eld
14145 \begin_inset Quotes erd
14151 \begin_layout Description
14152 \begin_inset Flex Code
14155 \begin_layout Plain Layout
14161 produces the usual sort of enumeration labels.
14162 The number type needs to be set in the
14167 \begin_inset CommandInset ref
14169 reference "subsec:Counters"
14176 \begin_layout Description
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14186 produces various bullets at the different levels.
14187 The bullet types displayed can be set via
14188 \begin_inset Flex Noun
14191 \begin_layout Plain Layout
14192 Document\SpecialChar menuseparator
14193 Settings\SpecialChar menuseparator
14202 \begin_layout Description
14203 \begin_inset Flex Code
14206 \begin_layout Plain Layout
14212 should be used only with
14213 \begin_inset Flex Code
14216 \begin_layout Plain Layout
14217 LatexType BibEnvironment
14226 \begin_layout Description
14227 \begin_inset Flex Code
14230 \begin_layout Plain Layout
14236 Note that this will completely override any prior
14237 \begin_inset Flex Code
14240 \begin_layout Plain Layout
14246 declaration for this style.
14248 \begin_inset Quotes eld
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 \begin_inset Quotes erd
14267 \begin_inset CommandInset ref
14269 reference "subsec:I18n"
14273 for details on its use.
14276 \begin_layout Description
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14296 ] The name of the corresponding \SpecialChar LaTeX
14298 Either the environment or command name.
14301 \begin_layout Description
14302 \begin_inset Flex Code
14305 \begin_layout Plain Layout
14312 \begin_inset Flex Code
14315 \begin_layout Plain Layout
14321 ] An optional parameter for the corresponding
14322 \begin_inset Flex Code
14325 \begin_layout Plain Layout
14332 This parameter cannot be changed from within \SpecialChar LyX
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14343 for customizable parameters).
14344 This will be output as is after all \SpecialChar LaTeX
14346 \begin_inset Flex Code
14349 \begin_layout Plain Layout
14358 \begin_layout Description
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 \begin_inset Flex Code
14372 \begin_layout Plain Layout
14377 , Command, Environment, Item_Environment,
14378 \begin_inset Newline newline
14381 List_Environment, Bib_Environment
14386 ] How the style should be translated into \SpecialChar LaTeX
14391 \begin_layout Plain Layout
14392 \begin_inset Flex Code
14395 \begin_layout Plain Layout
14401 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14402 Visit the SGML class files for specific examples.
14411 \begin_layout Description
14412 \begin_inset Flex Code
14415 \begin_layout Plain Layout
14421 means nothing special.
14424 \begin_layout Description
14425 \begin_inset Flex Code
14428 \begin_layout Plain Layout
14435 \begin_inset Flex Code
14438 \begin_layout Plain Layout
14445 {\SpecialChar ldots
14454 \begin_layout Description
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14465 \begin_inset Flex Code
14468 \begin_layout Plain Layout
14475 }\SpecialChar ldots
14491 \begin_layout Description
14492 \begin_inset Flex Code
14495 \begin_layout Plain Layout
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14512 \begin_inset Flex Code
14515 \begin_layout Plain Layout
14523 is generated for each paragraph of this environment.
14527 \begin_layout Description
14528 \begin_inset Flex Code
14531 \begin_layout Plain Layout
14538 \begin_inset Flex Code
14541 \begin_layout Plain Layout
14548 \begin_inset Newline newline
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14561 is passed as an argument to the environment.
14562 \begin_inset Newline newline
14566 \begin_inset Flex Code
14569 \begin_layout Plain Layout
14575 can be defined in the
14576 \begin_inset Flex Noun
14579 \begin_layout Plain Layout
14580 Edit\SpecialChar menuseparator
14582 \begin_inset space ~
14593 \begin_layout Description
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14613 but adds the necessary mandatory argument (the longest label) to the begin
14614 statement of the bibliography environment:
14615 \begin_inset Newline newline
14619 \begin_inset Flex Code
14622 \begin_layout Plain Layout
14625 begin{thebibliography}{99}
14631 It is therefore only useful for bibliography environments.
14632 The default longest label
14633 \begin_inset Quotes eld
14637 \begin_inset Quotes erd
14640 can be changed by the user in the paragraph settings of a bibliography
14644 \begin_layout Standard
14645 Putting the last few things together, the \SpecialChar LaTeX
14646 output will be either:
14649 \begin_layout LyX-Code
14652 LatexName[LatexParam]{\SpecialChar ldots
14656 \begin_layout Standard
14660 \begin_layout LyX-Code
14663 begin{LatexName}[LatexParam] \SpecialChar ldots
14669 \begin_layout Standard
14670 depending upon the \SpecialChar LaTeX
14675 \begin_layout Description
14676 \begin_inset Flex Code
14679 \begin_layout Plain Layout
14686 \begin_inset Flex Code
14689 \begin_layout Plain Layout
14695 ] A string that is put at the beginning of the style content.
14696 A line break in the output can be indicated by
14697 \begin_inset Flex Code
14700 \begin_layout Plain Layout
14709 \begin_layout Description
14710 \begin_inset Flex Code
14713 \begin_layout Plain Layout
14720 \begin_inset Flex Code
14723 \begin_layout Plain Layout
14729 ] If you put styles into environments, the different
14730 \begin_inset Flex Code
14733 \begin_layout Plain Layout
14739 are not simply added, but added with a factor
14740 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14744 Note that this parameter is also used when
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14765 \begin_inset Flex Code
14768 \begin_layout Plain Layout
14775 Then it is added to the manual or dynamic margin.
14776 \begin_inset Newline newline
14780 \begin_inset Quotes eld
14784 \begin_inset Flex Code
14787 \begin_layout Plain Layout
14794 \begin_inset Quotes erd
14797 means that the paragraph is indented with the width of
14798 \begin_inset Quotes eld
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14812 \begin_inset Quotes erd
14815 in the normal font.
14816 You can get a negative width by prefixing the string with
14817 \begin_inset Quotes eld
14821 \begin_inset Flex Code
14824 \begin_layout Plain Layout
14831 \begin_inset Quotes erd
14835 This way was chosen so that the look is the same with each used screen
14839 \begin_layout Description
14840 \begin_inset Flex Code
14843 \begin_layout Plain Layout
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14858 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14864 \begin_inset Newline newline
14867 The kind of margin that the style has on the left side.
14871 \begin_layout Description
14872 \begin_inset Flex Code
14875 \begin_layout Plain Layout
14881 just means a fixed margin.
14884 \begin_layout Description
14885 \begin_inset Flex Code
14888 \begin_layout Plain Layout
14894 means that the left margin depends on the string entered in the
14895 \begin_inset Flex Noun
14898 \begin_layout Plain Layout
14899 Edit\SpecialChar menuseparator
14901 \begin_inset space ~
14910 This is used to typeset nice lists without tabulators.
14913 \begin_layout Description
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14923 means that the margin depends on the size of the label.
14924 This is used for automatic enumerated headlines.
14925 It is obvious that the headline
14926 \begin_inset Quotes eld
14929 5.4.3.2.1 Very long headline
14930 \begin_inset Quotes erd
14933 must have a wider left margin (as wide as
14934 \begin_inset Quotes eld
14938 \begin_inset Quotes erd
14941 plus the space) than
14942 \begin_inset Quotes eld
14945 3.2 Very long headline
14946 \begin_inset Quotes erd
14950 \begin_inset Quotes eld
14954 \begin_inset Quotes erd
14957 are not able to do this.
14960 \begin_layout Description
14961 \begin_inset Flex Code
14964 \begin_layout Plain Layout
14970 is similar, but only the very first row of the paragraph is dynamic, while
14971 the others are static; this is used, for example, for descriptions.
14974 \begin_layout Description
14975 \begin_inset Flex Code
14978 \begin_layout Plain Layout
14984 means the margin is chosen in a way that the longest row of this paragraph
14985 fits to the right margin.
14986 This is used to typeset an address on the right edge of the page.
14990 \begin_layout Description
14991 \begin_inset Flex Code
14994 \begin_layout Plain Layout
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15013 \begin_inset space \thinspace{}
15017 \begin_inset Flex Code
15020 \begin_layout Plain Layout
15026 ] Whether fragile commands in this style should be
15027 \begin_inset Flex Code
15030 \begin_layout Plain Layout
15043 whether this command should itself be protected.)
15044 \change_inserted -712698321 1523696949
15048 \begin_layout Description
15050 \change_inserted -712698321 1523696969
15051 \begin_inset Flex Code
15054 \begin_layout Plain Layout
15056 \change_inserted -712698321 1523696950
15063 \begin_inset Flex Code
15066 \begin_layout Plain Layout
15068 \change_inserted -712698321 1523696950
15077 \begin_inset space \thinspace{}
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15086 \change_inserted -712698321 1523696950
15092 ] This causes macros that contain this layout to be protected with
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15098 \change_inserted -712698321 1523696950
15111 ) if necessary and thus allows (some) verbatim stuff in macros.
15116 \begin_layout Description
15117 \begin_inset Flex Code
15120 \begin_layout Plain Layout
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15137 \begin_inset space \thinspace{}
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15152 ] Whether newlines are translated into \SpecialChar LaTeX
15154 \begin_inset Flex Code
15157 \begin_layout Plain Layout
15168 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15170 inside \SpecialChar LyX
15174 \begin_layout Description
15175 \begin_inset Flex Code
15178 \begin_layout Plain Layout
15185 \begin_inset Flex Code
15188 \begin_layout Plain Layout
15197 \begin_inset space \thinspace{}
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15210 ] If set to true, and if
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15230 ) paragraphs are being indented, then the indentation of such a paragraph
15231 following one of this type will be suppressed.
15232 (So this will not affect the display of non-default paragraphs.)
15235 \begin_layout Description
15236 \begin_inset Flex Code
15239 \begin_layout Plain Layout
15246 \begin_inset Flex Code
15249 \begin_layout Plain Layout
15255 ] Name of a style that has replaced this style.
15256 This is used to rename a style, while keeping backward compatibility.
15259 \begin_layout Description
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15270 \begin_inset Flex Code
15273 \begin_layout Plain Layout
15280 \begin_inset space \thinspace{}
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15293 ] Determines whether consecutive paragraphs of the same type are treated
15294 as belonging together.
15295 This has the effect that the
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15305 is only printed once before such a group.
15306 By default, this is true for
15307 \begin_inset Flex Code
15310 \begin_layout Plain Layout
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15327 \begin_inset Flex Code
15330 \begin_layout Plain Layout
15336 and false for all other types.
15339 \begin_layout Description
15340 \begin_inset Flex Code
15343 \begin_layout Plain Layout
15350 \begin_inset Flex Code
15353 \begin_layout Plain Layout
15362 \begin_inset space \thinspace{}
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15375 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15377 but only by a line break; together with
15378 \begin_inset Flex Code
15381 \begin_layout Plain Layout
15387 , this allows to emulate a plain text editor (like the ERT inset).
15390 \begin_layout Description
15391 \begin_inset Flex Code
15394 \begin_layout Plain Layout
15401 \begin_inset Flex Code
15404 \begin_layout Plain Layout
15410 ] The indent of the very first line of a paragraph.
15412 \begin_inset Newline newline
15416 \begin_inset Flex Code
15419 \begin_layout Plain Layout
15425 will be fixed for a certain style.
15426 The exception is the default style, since the indentation for these paragraphs
15427 can be prohibited with
15428 \begin_inset Flex Code
15431 \begin_layout Plain Layout
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15448 style paragraphs inside environments use the
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15458 of the environment, not their native one.
15460 \begin_inset Flex Code
15463 \begin_layout Plain Layout
15469 paragraphs inside an enumeration are not indented.
15472 \begin_layout Description
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15492 ] The vertical space between two paragraphs of this style.
15495 \begin_layout Description
15496 \begin_inset Flex Code
15499 \begin_layout Plain Layout
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15516 allows the user to choose either
15517 \begin_inset Quotes eld
15521 \begin_inset Quotes erd
15525 \begin_inset Quotes eld
15529 \begin_inset Quotes erd
15532 to separate paragraphs.
15534 \begin_inset Quotes eld
15538 \begin_inset Quotes erd
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15553 \begin_inset Quotes eld
15557 \begin_inset Quotes erd
15561 \begin_inset Flex Code
15564 \begin_layout Plain Layout
15570 is ignored and all paragraphs are separated by the
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15581 The vertical space is calculated with
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15587 \begin_inset space ~
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15605 is the height of a row with the normal font.
15606 This way, the look stays the same with different screen fonts.
15609 \begin_layout Description
15610 \begin_inset Flex Code
15613 \begin_layout Plain Layout
15620 \begin_inset Flex Code
15623 \begin_layout Plain Layout
15632 \begin_inset space \thinspace{}
15636 \begin_inset Flex Code
15639 \begin_layout Plain Layout
15645 ] Whether the contents of this paragraph should be output in raw form, meaning
15646 without special translations that \SpecialChar LaTeX
15650 \begin_layout Description
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15674 Defines individual characters that should be output in raw form, meaning
15675 without special translations that \SpecialChar LaTeX
15679 \begin_layout Description
15680 \begin_inset Flex Code
15683 \begin_layout Plain Layout
15689 Information to be included in the \SpecialChar LaTeX
15690 preamble when this style is used.
15691 Used to define macros, load packages, etc., required by this particular
15694 \begin_inset Quotes eld
15698 \begin_inset Flex Code
15701 \begin_layout Plain Layout
15708 \begin_inset Quotes erd
15714 \begin_layout Description
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15725 \begin_inset Flex Code
15728 \begin_layout Plain Layout
15734 ] The prefix to use when creating labels referring to paragraphs of this
15736 This allows the use of formatted references.
15739 \begin_layout Description
15740 \begin_inset Flex Code
15743 \begin_layout Plain Layout
15750 \begin_inset Flex Code
15753 \begin_layout Plain Layout
15759 ] Whether the style requires the feature
15760 \begin_inset Flex Code
15763 \begin_layout Plain Layout
15770 \begin_inset CommandInset ref
15772 reference "chap:List-of-functions"
15776 for the list of features).
15777 If you require a package with specific options, you can additionally use
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15788 as a general text class parameter (see
15789 \begin_inset CommandInset ref
15791 reference "subsec:General-text-class"
15798 \begin_layout Description
15799 \begin_inset Flex Code
15802 \begin_layout Plain Layout
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15821 \begin_inset Flex Code
15824 \begin_layout Plain Layout
15830 ] Resets the \SpecialChar LaTeX
15831 arguments of this style (as defined via the
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15842 This is useful if you have copied a style via
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15852 , but you do not want to inherit its (required and optional) arguments.
15855 \begin_layout Description
15856 \begin_inset Flex Code
15859 \begin_layout Plain Layout
15866 \begin_inset Flex Code
15869 \begin_layout Plain Layout
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15887 ] Resumes a counter that is usually reset at each new sequence of layouts.
15888 This is currently only useful when
15889 \begin_inset Flex Code
15892 \begin_layout Plain Layout
15899 \begin_inset Flex Code
15902 \begin_layout Plain Layout
15911 \begin_layout Description
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15931 ] A string that is put at the end of the layout content.
15932 A line break in the output can be indicated by
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15945 \begin_layout Description
15946 \begin_inset Flex Code
15949 \begin_layout Plain Layout
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15978 \begin_layout Description
15979 \begin_inset Flex Code
15982 \begin_layout Plain Layout
15989 \begin_inset Flex Code
15992 \begin_layout Plain Layout
16001 \begin_inset Flex Code
16004 \begin_layout Plain Layout
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16026 \begin_inset space ~
16034 ] This defines what the default spacing should be in the style.
16036 \begin_inset Flex Code
16039 \begin_layout Plain Layout
16046 \begin_inset Flex Code
16049 \begin_layout Plain Layout
16056 \begin_inset Flex Code
16059 \begin_layout Plain Layout
16065 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16066 If you specify the argument
16067 \begin_inset Flex Code
16070 \begin_layout Plain Layout
16076 , then you must also provide a value argument which will be the actual multiplie
16078 Note that, contrary to other parameters,
16079 \begin_inset Flex Code
16082 \begin_layout Plain Layout
16088 implies the generation of specific \SpecialChar LaTeX
16089 code, using the \SpecialChar LaTeX
16093 \begin_inset Flex Code
16096 \begin_layout Plain Layout
16105 \begin_layout Description
16106 \begin_inset Flex Code
16109 \begin_layout Plain Layout
16116 \begin_inset Flex Code
16119 \begin_layout Plain Layout
16126 \begin_inset space \thinspace{}
16130 \begin_inset Flex Code
16133 \begin_layout Plain Layout
16141 ] Allow spell-checking paragraphs of this style.
16145 \begin_layout Description
16146 \begin_inset Flex Code
16149 \begin_layout Plain Layout
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16177 ] Steps the master counter of a given counter at the beginning of a new
16178 sequence of layouts.
16179 This is currently only useful when
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16202 \begin_layout Description
16203 \begin_inset Flex Code
16206 \begin_layout Plain Layout
16212 The font used for the text body .
16214 \begin_inset CommandInset ref
16216 reference "subsec:Font-description"
16223 \begin_layout Description
16224 \begin_inset Flex Code
16227 \begin_layout Plain Layout
16236 \begin_inset Flex Code
16239 \begin_layout Plain Layout
16249 The level of the style in the table of contents.
16250 This is used for automatic numbering of section headings.
16253 \begin_layout Description
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16266 \begin_inset Flex Code
16269 \begin_layout Plain Layout
16280 \begin_inset Flex Code
16283 \begin_layout Plain Layout
16290 \begin_inset Flex Code
16293 \begin_layout Plain Layout
16299 ] This tag determines whether the first line indentation of this paragraph
16300 can be toggled via the Paragraph settings dialog.
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16317 is set, indentation can be toggled if the document settings use
16318 \begin_inset Quotes eld
16322 \begin_inset Quotes erd
16325 paragraph style, with
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16335 , indentation can always be toggled, notwithstanding the document settings,
16337 \begin_inset Flex Code
16340 \begin_layout Plain Layout
16346 , indentation can never be toggled.
16349 \begin_layout Description
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16360 \begin_inset Flex Code
16363 \begin_layout Plain Layout
16369 ] The vertical space with which the very first of a chain of paragraphs
16370 with this style is separated from the previous paragraph.
16371 If the previous paragraph has another style, the separations are not simply
16372 added, but the maximum is taken.
16375 \begin_layout Subsection
16376 \begin_inset CommandInset label
16382 Internationalization of Paragraph Styles
16385 \begin_layout Standard
16387 has long supported internationalization of layout information, but, until
16388 version 2.0, this applied only to the user interface and not to, say, PDF
16390 Thus, French authors were forced to resort to ugly hacks if they wanted
16395 1' instead of `Theorem 1'.
16396 Thanks to Georg Baum, that is no longer the case.
16399 \begin_layout Standard
16401 \begin_inset Flex Code
16404 \begin_layout Plain Layout
16410 defines text that is to appear in the typeset document, it may use
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16421 \begin_inset Flex Code
16424 \begin_layout Plain Layout
16430 to support non-English and even multi-language documents correctly.
16431 The following excerpt (from the
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16441 file) shows how this works:
16444 \begin_layout LyX-Code
16449 \begin_layout LyX-Code
16452 theoremstyle{remark}
16455 \begin_layout LyX-Code
16458 newtheorem{claim}[thm]{
16465 \begin_layout LyX-Code
16469 \begin_layout LyX-Code
16473 \begin_layout LyX-Code
16478 claimname}{_(Claim)}
16481 \begin_layout LyX-Code
16485 \begin_layout LyX-Code
16489 \begin_layout LyX-Code
16498 claimname}{_(Claim)}}
16501 \begin_layout LyX-Code
16506 \begin_layout Standard
16507 In principle, any legal \SpecialChar LaTeX
16509 \begin_inset Flex Code
16512 \begin_layout Plain Layout
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16528 tags, but in practice they will typically look as they do here.
16529 The key to correct translation of the typeset text is the definition of
16530 the \SpecialChar LaTeX
16532 \begin_inset Flex Code
16535 \begin_layout Plain Layout
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16559 \begin_layout Standard
16561 \begin_inset Flex Code
16564 \begin_layout Plain Layout
16570 tag provides for internationalization based upon the overall language of
16572 The contents of the tag will be included in the preamble, just as with
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16584 What makes it special is the use of the
16585 \begin_inset Quotes eld
16589 \begin_inset Quotes erd
16593 \begin_inset Flex Code
16596 \begin_layout Plain Layout
16602 , which will be replaced, when \SpecialChar LyX
16603 produces \SpecialChar LaTeX
16604 output, with the translation of
16605 its argument into the document language.
16608 \begin_layout Standard
16610 \begin_inset Flex Code
16613 \begin_layout Plain Layout
16619 tag is more complex, since it is meant to provide support for multi-language
16620 documents and so offers an interface to the
16621 \begin_inset Flex Code
16624 \begin_layout Plain Layout
16631 Its contents will be added to the preamble once for each language that
16632 appears in the document.
16633 In this case, the argument to
16634 \begin_inset Flex Code
16637 \begin_layout Plain Layout
16643 will be replaced with its translation into the language in question; the
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16654 is replaced by the language name (as used by the babel package).
16657 \begin_layout Standard
16658 A German document that also included a French section would thus have the
16659 following in the preamble:
16662 \begin_layout LyX-Code
16671 claimname}{Affirmation}}
16672 \begin_inset Newline newline
16683 claimname}{Behauptung}}
16684 \begin_inset Newline newline
16691 claimname}{Behauptung}
16694 \begin_layout Standard
16697 \begin_inset Flex Code
16700 \begin_layout Plain Layout
16706 will then conspire to produce the correct text in the output.
16709 \begin_layout Standard
16710 One important point to note here is that the translations are provided by
16712 itself, through the file
16713 \begin_inset Flex Code
16716 \begin_layout Plain Layout
16723 This means, in effect, that
16724 \begin_inset Flex Code
16727 \begin_layout Plain Layout
16734 \begin_inset Flex Code
16737 \begin_layout Plain Layout
16743 are really only of use in layout files that are provided with \SpecialChar LyX
16745 entered in user-created layout files will not be seen by \SpecialChar LyX
16746 's internationalizatio
16747 n routines unless the
16748 \begin_inset Flex Code
16751 \begin_layout Plain Layout
16757 file is modified accordingly.
16758 That said, however, any layout created with the intention that it will
16759 be included with \SpecialChar LyX
16760 should use these tags where appropriate.
16761 Please note that the paragraph style translations provided by \SpecialChar LyX
16763 change with a minor update (e.
16764 \begin_inset space \thinspace{}
16768 \begin_inset space \space{}
16771 from version 2.1.x to 2.1.y).
16772 It is however quite likely that a major update (e.
16773 \begin_inset space \thinspace{}
16777 \begin_inset space \space{}
16780 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16783 \begin_layout Subsection
16785 \begin_inset CommandInset label
16787 name "subsec:Floats"
16794 \begin_layout Standard
16795 It is necessary to define the floats (
16796 \begin_inset Flex Noun
16799 \begin_layout Plain Layout
16806 \begin_inset Flex Noun
16809 \begin_layout Plain Layout
16815 , \SpecialChar ldots
16816 ) in the text class itself.
16817 Standard floats are included in the file
16818 \begin_inset Flex Code
16821 \begin_layout Plain Layout
16827 , so you may have to do no more than add
16830 \begin_layout LyX-Code
16831 Input stdfloats.inc
16834 \begin_layout Standard
16835 to your layout file.
16836 If you want to implement a text class that proposes some other float types
16837 (like the AGU class bundled with \SpecialChar LyX
16838 ), the information below will hopefully
16842 \begin_layout Description
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16862 =!htbpH] Allowed placement options for this float type.
16863 The value is a string of placement characters.
16864 Possible characters include:
16869 \begin_inset Quotes eld
16873 \begin_inset Quotes erd
16881 \begin_inset Quotes eld
16885 \begin_inset Quotes erd
16893 \begin_inset Quotes eld
16897 \begin_inset Quotes erd
16905 \begin_inset Quotes eld
16909 \begin_inset Quotes erd
16917 \begin_inset Quotes eld
16921 \begin_inset Quotes erd
16929 \begin_inset Quotes eld
16933 \begin_inset Quotes erd
16937 The order of the characters in the string does not matter.
16938 If no placement options are allowed, use the string
16945 \begin_layout Description
16946 \begin_inset Flex Code
16949 \begin_layout Plain Layout
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16968 \begin_inset space \thinspace{}
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16987 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16994 \begin_inset Flex Code
16997 \begin_layout Plain Layout
17003 if the float does not support this feature.
17006 \begin_layout Description
17007 \begin_inset Flex Code
17010 \begin_layout Plain Layout
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17029 \begin_inset space \thinspace{}
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17048 ] Defines whether the float has a starred variant that spans columns in
17049 a two column paragraph.
17051 \begin_inset Flex Code
17054 \begin_layout Plain Layout
17060 if the float does not support this feature.
17063 \begin_layout Description
17064 \begin_inset Flex Code
17067 \begin_layout Plain Layout
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17084 \begin_inset Quotes erd
17088 \begin_inset Quotes erd
17091 ] The file name extension of an auxiliary file for the list of figures (or
17094 writes the captions to this file.
17097 \begin_layout Description
17098 \begin_inset Flex Code
17101 \begin_layout Plain Layout
17108 \begin_inset Flex Code
17111 \begin_layout Plain Layout
17118 \begin_inset Quotes erd
17122 \begin_inset Quotes erd
17125 ] The string that will be used in the menus and also for the caption.
17126 This is translated to the current language if babel is used.
17129 \begin_layout Description
17130 \begin_inset Flex Code
17133 \begin_layout Plain Layout
17139 These tags control the XHTML output.
17141 \begin_inset CommandInset ref
17143 reference "sec:Tags-for-XHTML"
17150 \begin_layout Description
17151 \begin_inset Flex Code
17154 \begin_layout Plain Layout
17163 \begin_inset Flex Code
17166 \begin_layout Plain Layout
17175 \begin_inset space \thinspace{}
17179 \begin_inset Flex Code
17182 \begin_layout Plain Layout
17188 ] Indicates whether the float is already defined in the document class or
17189 if instead the \SpecialChar LaTeX
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17200 needs to be loaded to define it on-the-fly.
17202 \begin_inset Flex Code
17205 \begin_layout Plain Layout
17212 \begin_inset Flex Code
17215 \begin_layout Plain Layout
17222 It should be set to
17223 \begin_inset Flex Code
17226 \begin_layout Plain Layout
17232 if the float is already defined by the \SpecialChar LaTeX
17236 \begin_layout Description
17237 \begin_inset Flex Code
17240 \begin_layout Plain Layout
17247 \begin_inset Flex Code
17250 \begin_layout Plain Layout
17257 \begin_inset Quotes erd
17261 \begin_inset Quotes erd
17264 ] The command used to generate a list of floats of this type; the leading
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17282 is false, since there is no standard way to generate this command.
17284 \begin_inset Flex Code
17287 \begin_layout Plain Layout
17293 is true, since in that case there is a standard way to define the command.
17296 \begin_layout Description
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17317 \begin_inset Quotes erd
17321 \begin_inset Quotes erd
17324 ] A title for a list of floats of this kind (list of figures, tables, or
17326 It is used for the screen label within \SpecialChar LyX
17327 , it is used by \SpecialChar LaTeX
17329 it is used as the title in the XHTML output.
17330 It will be translated to the document language.
17333 \begin_layout Description
17334 \begin_inset Flex Code
17337 \begin_layout Plain Layout
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17354 \begin_inset Quotes erd
17358 \begin_inset Quotes erd
17361 ] This (optional) argument determines whether floats of this class will
17362 be numbered within some sectional unit of the document.
17364 \begin_inset Flex Code
17367 \begin_layout Plain Layout
17374 \begin_inset Quotes eld
17378 \begin_inset Flex Code
17381 \begin_layout Plain Layout
17388 \begin_inset Quotes erd
17391 , the floats will be numbered within chapters.
17395 \begin_layout Description
17396 \begin_inset Flex Code
17399 \begin_layout Plain Layout
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17416 \begin_inset Quotes erd
17420 \begin_inset Quotes erd
17423 ] The default placement for the given class of floats.
17424 The string should be as in standard \SpecialChar LaTeX
17426 \begin_inset Flex Code
17429 \begin_layout Plain Layout
17436 \begin_inset Flex Code
17439 \begin_layout Plain Layout
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17456 \begin_inset Flex Code
17459 \begin_layout Plain Layout
17465 for top, bottom, page, and here, respectively.
17469 \begin_layout Plain Layout
17470 Note that the order of these letters in the string is irrelevant, like in
17477 On top of that there is a new type,
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17487 , which does not really correspond to a float, since it means: put it
17488 \begin_inset Quotes eld
17492 \begin_inset Quotes erd
17496 Note however that the
17497 \begin_inset Flex Code
17500 \begin_layout Plain Layout
17506 specifier is special and, because of implementation details, cannot be
17507 used in non-built in float types.
17508 If you do not understand what this means, just use
17509 \begin_inset Quotes eld
17513 \begin_inset Flex Code
17516 \begin_layout Plain Layout
17523 \begin_inset Quotes erd
17529 \begin_layout Description
17530 \begin_inset Flex Code
17533 \begin_layout Plain Layout
17540 \begin_inset Flex Code
17543 \begin_layout Plain Layout
17549 ] The prefix to use when creating labels referring to floats of this type.
17550 This allows the use of formatted references.
17551 Note that you can remove any
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17561 set by a copied style by using the special value
17562 \begin_inset Quotes eld
17566 \begin_inset Quotes erd
17569 , which must be all caps.
17572 \begin_layout Description
17573 \begin_inset Flex Code
17576 \begin_layout Plain Layout
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17593 \begin_inset Quotes erd
17597 \begin_inset Quotes erd
17600 ] The style used when defining the float using
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17615 \begin_layout Description
17616 \begin_inset Flex Code
17619 \begin_layout Plain Layout
17626 \begin_inset Flex Code
17629 \begin_layout Plain Layout
17636 \begin_inset Quotes erd
17640 \begin_inset Quotes erd
17644 \begin_inset Quotes eld
17648 \begin_inset Quotes erd
17651 of the new class of floats, like program or algorithm.
17652 After the appropriate
17653 \begin_inset Flex Code
17656 \begin_layout Plain Layout
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17677 \begin_inset Flex Code
17680 \begin_layout Plain Layout
17691 \begin_layout Description
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17712 \begin_inset space \thinspace{}
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17727 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17738 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17742 \begin_layout Standard
17743 Note that defining a float with type
17744 \begin_inset Flex Code
17747 \begin_layout Plain Layout
17755 automatically defines the corresponding counter with name
17756 \begin_inset Flex Code
17759 \begin_layout Plain Layout
17770 \begin_layout Subsection
17771 Flex insets and InsetLayout
17772 \begin_inset CommandInset label
17774 name "subsec:Flex-insets-and"
17781 \begin_layout Standard
17782 Flex insets come in three different kinds:
17785 \begin_layout Itemize
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17796 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17798 \begin_inset Flex Code
17801 \begin_layout Plain Layout
17810 \begin_inset Flex Code
17813 \begin_layout Plain Layout
17824 \begin_layout Itemize
17826 \begin_inset Flex Code
17829 \begin_layout Plain Layout
17835 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17837 footnote, and the like.
17838 An obvious example is an endnote inset, which is defined in the
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17851 \begin_layout Itemize
17853 \begin_inset Flex Code
17856 \begin_layout Plain Layout
17862 ): For use with DocBook classes.
17865 \begin_layout Standard
17866 Flex insets are defined using the
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17876 tag, which shall be explained in a moment.
17879 \begin_layout Standard
17881 \begin_inset Flex Code
17884 \begin_layout Plain Layout
17890 tag also serves another function: It can be used to customize the general
17891 layout of many different types of insets.
17893 \begin_inset Flex Code
17896 \begin_layout Plain Layout
17902 can be used to customize the layout parameters for footnotes, marginal
17903 notes, note insets, \SpecialChar TeX
17904 code (ERT) insets, branches, listings, indexes, boxes,
17905 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17908 \begin_layout Standard
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17919 definition must begin with a line of the form:
17922 \begin_layout LyX-Code
17926 \begin_layout Standard
17928 \begin_inset Flex Code
17931 \begin_layout Plain Layout
17937 indicates the inset whose layout is being defined, and here there are four
17941 \begin_layout Enumerate
17942 The layout for a pre-existing inset is being modified.
17943 In this case, can be
17944 \begin_inset Flex Code
17947 \begin_layout Plain Layout
17953 any one of the following:
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17964 \begin_inset Flex Code
17967 \begin_layout Plain Layout
17974 \begin_inset Flex Code
17977 \begin_layout Plain Layout
17984 \begin_inset Flex Code
17987 \begin_layout Plain Layout
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18014 \begin_inset Flex Code
18017 \begin_layout Plain Layout
18024 \begin_inset Flex Code
18027 \begin_layout Plain Layout
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18064 \begin_inset Flex Code
18067 \begin_layout Plain Layout
18074 \begin_inset Flex Code
18077 \begin_layout Plain Layout
18084 \begin_inset Flex Code
18087 \begin_layout Plain Layout
18094 \begin_inset Flex Code
18097 \begin_layout Plain Layout
18104 \begin_inset Flex Code
18107 \begin_layout Plain Layout
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18124 \begin_inset Flex Code
18127 \begin_layout Plain Layout
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18144 \begin_inset Flex Code
18147 \begin_layout Plain Layout
18156 \begin_layout Enumerate
18157 The layout for a Flex inset is being defined.
18159 \begin_inset Flex Code
18162 \begin_layout Plain Layout
18168 must be of the form
18169 \begin_inset Quotes eld
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18183 \begin_inset Quotes erd
18187 \begin_inset Flex Code
18190 \begin_layout Plain Layout
18196 may be be any valid identifier not used by a pre-existing Flex inset.
18197 The identifier may include spaces, but in that case the whole thing must
18198 be wrapped in quotes.
18199 Note that the definition of a flex inset
18204 \begin_inset Flex Code
18207 \begin_layout Plain Layout
18213 entry, declaring which type of inset it defines.
18216 \begin_layout Enumerate
18217 The layout for user specific branch is being defined.
18219 \begin_inset Flex Code
18222 \begin_layout Plain Layout
18228 must be of the form
18229 \begin_inset Quotes eld
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18243 \begin_inset Quotes erd
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18256 may be be any valid identifier of branch defined in user's document.
18257 The identifier may include spaces, but in that case the whole thing must
18258 be wrapped in quotes.
18259 The main purpose of this feature is to allow \SpecialChar LaTeX
18260 wrapping around specific
18261 branches as user needs.
18264 \begin_layout Enumerate
18265 The layout of a user (or class) specific caption is being defined.
18267 \begin_inset Flex Code
18270 \begin_layout Plain Layout
18276 must be of the form
18277 \begin_inset Quotes eld
18281 \begin_inset Flex Code
18284 \begin_layout Plain Layout
18291 \begin_inset Quotes erd
18295 \begin_inset Flex Code
18298 \begin_layout Plain Layout
18304 specifies the name of the caption as it appears in the menu.
18305 Have a look at the standard caption (
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18315 ), the specific captions of the KOMA-Script classes (
18316 \begin_inset Flex Code
18319 \begin_layout Plain Layout
18326 \begin_inset Flex Code
18329 \begin_layout Plain Layout
18338 \begin_inset space ~
18342 \begin_inset Newline linebreak
18348 \begin_inset Flex Code
18351 \begin_layout Plain Layout
18357 ) for applications.
18360 \begin_layout Standard
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18371 definition can contain the following entries:
18374 \begin_layout Description
18375 \begin_inset Flex Code
18378 \begin_layout Plain Layout
18385 \begin_inset Flex Code
18388 \begin_layout Plain Layout
18394 =""] This inset will appear in the table of contents of the given type.
18395 An empty string disables.
18396 See also the OutlinerName and the IsTocCaption commands.
18397 This is only implemented for Flex insets.
18401 \begin_layout Description
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18421 ] Defines argument number of a command\SpecialChar breakableslash
18422 environment associated with the current
18424 The definition must end with
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18436 \begin_inset CommandInset ref
18438 reference "subsec:Paragraph-Styles"
18445 \begin_layout Description
18446 \begin_inset Flex Code
18449 \begin_layout Plain Layout
18455 Preamble for changing language commands; see
18456 \begin_inset CommandInset ref
18458 reference "subsec:I18n"
18465 \begin_layout Description
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 ] The color for the inset's background.
18487 \begin_inset CommandInset ref
18489 reference "chap:Names-of-colors"
18493 for a list of the available color names.
18496 \begin_layout Description
18497 \begin_inset Flex Code
18500 \begin_layout Plain Layout
18507 \begin_inset Flex Code
18510 \begin_layout Plain Layout
18519 \begin_inset space \thinspace{}
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18532 ] Whether to use the content of the inset as the label, when the inset is
18537 \begin_layout Description
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18557 ] As with paragraph styles, see
18558 \begin_inset CommandInset ref
18560 reference "subsec:Paragraph-Styles"
18565 Note that you need to specify the complete type, e.
18566 \begin_inset space \thinspace{}
18570 \begin_inset space ~
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18578 CopyStyle Flex:<name>
18586 \begin_layout Description
18587 \begin_inset Flex Code
18590 \begin_layout Plain Layout
18597 \begin_inset Flex Code
18600 \begin_layout Plain Layout
18609 \begin_inset space \thinspace{}
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18622 ] Indicates whether the user may employ the Paragraph Settings dialog to
18623 customize the paragraph.
18626 \begin_layout Description
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18637 \begin_inset Flex Code
18640 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18657 \begin_inset Flex Code
18660 \begin_layout Plain Layout
18666 , describing the rendering style used for the inset's frame and buttons.
18667 Footnotes generally use
18668 \begin_inset Flex Code
18671 \begin_layout Plain Layout
18677 , ERT insets generally
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18687 , and character styles
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18700 \begin_layout Description
18701 \begin_inset Flex Code
18704 \begin_layout Plain Layout
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18723 \begin_inset space \thinspace{}
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18741 \begin_inset Flex Code
18744 \begin_layout Plain Layout
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18761 Indicates whether the environment will stand on its own in the output or
18762 will appear inline with the surrounding text.
18763 If set to false, it is supposed that the \SpecialChar LaTeX
18764 environment ignores white space
18765 (including one newline character) after the
18766 \begin_inset Flex Code
18769 \begin_layout Plain Layout
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18801 \begin_layout Description
18802 \begin_inset Flex Code
18805 \begin_layout Plain Layout
18811 Required at the end of the
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18824 \begin_layout Description
18825 \begin_inset Flex Code
18828 \begin_layout Plain Layout
18834 The font used for both the text body
18840 \begin_inset CommandInset ref
18842 reference "subsec:Font-description"
18847 Note that defining this font automatically defines the
18848 \begin_inset Flex Code
18851 \begin_layout Plain Layout
18857 to the same value, so define this first and define
18858 \begin_inset Flex Code
18861 \begin_layout Plain Layout
18867 later if you want them to be different.
18870 \begin_layout Description
18871 \begin_inset Flex Code
18874 \begin_layout Plain Layout
18875 FixedWidthPreambleEncoding
18881 \begin_inset Flex Code
18884 \begin_layout Plain Layout
18893 \begin_inset space \thinspace{}
18897 \begin_inset Flex Code
18900 \begin_layout Plain Layout
18906 ] Force a fixed width encoding for the translated contents of
18907 \begin_inset Flex Code
18910 \begin_layout Plain Layout
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18926 code generated by this layout.
18927 This is needed for special \SpecialChar LaTeX
18932 that do not work with variable width encodings such as
18937 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18938 backends such as Xe\SpecialChar TeX
18940 Lua\SpecialChar TeX
18944 \begin_layout Description
18945 \begin_inset Flex Code
18948 \begin_layout Plain Layout
18949 ForceLocalFontSwitch
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18967 \begin_inset space \thinspace{}
18971 \begin_inset Flex Code
18974 \begin_layout Plain Layout
18980 ] When using babel, always use a local font switch (
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18992 ), never a global one (such as
18993 \begin_inset Flex Code
18996 \begin_layout Plain Layout
19007 \begin_layout Description
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19018 \begin_inset Flex Code
19021 \begin_layout Plain Layout
19030 \begin_inset space \thinspace{}
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19044 \begin_inset Quotes eld
19048 \begin_inset Quotes erd
19051 language, leading to Left-to-Right (Latin) output, e.
19052 \begin_inset space \thinspace{}
19056 \begin_inset space \space{}
19059 in \SpecialChar TeX
19064 \begin_layout Description
19065 \begin_inset Flex Code
19068 \begin_layout Plain Layout
19075 \begin_inset Flex Code
19078 \begin_layout Plain Layout
19087 \begin_inset space \thinspace{}
19091 \begin_inset Flex Code
19094 \begin_layout Plain Layout
19100 ] Force a a line break in the \SpecialChar LaTeX
19101 output before the inset starts and after
19103 This assures the inset itself is output on its own lines, for parsing purposes.
19106 \begin_layout Description
19107 \begin_inset Flex Code
19110 \begin_layout Plain Layout
19117 \begin_inset Flex Code
19120 \begin_layout Plain Layout
19129 \begin_inset space \thinspace{}
19133 \begin_inset Flex Code
19136 \begin_layout Plain Layout
19142 ] Indicates whether the
19143 \begin_inset Flex Code
19146 \begin_layout Plain Layout
19152 should be used or, instead, the user can change the paragraph style used
19157 \begin_layout Description
19158 \begin_inset Flex Code
19161 \begin_layout Plain Layout
19168 \begin_inset Flex Code
19171 \begin_layout Plain Layout
19180 \begin_inset space \thinspace{}
19184 \begin_inset Flex Code
19187 \begin_layout Plain Layout
19193 ] As with paragraph styles, see
19194 \begin_inset CommandInset ref
19196 reference "subsec:Paragraph-Styles"
19203 \begin_layout Description
19204 \begin_inset Flex Code
19207 \begin_layout Plain Layout
19213 These tags control the XHTML output.
19215 \begin_inset CommandInset ref
19217 reference "sec:Tags-for-XHTML"
19224 \begin_layout Description
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19235 \begin_inset Flex Code
19238 \begin_layout Plain Layout
19247 \begin_inset space \thinspace{}
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19260 ] Whether to include the contents of this inset in the strings generated
19261 for the `Outline' pane for all table of contents, regardless of the AddToToc
19263 One would not, for example, want the content of a footnote in a section
19264 header to be included in the TOC displayed in the outline, but one would
19265 normally want the content of a character style displayed.
19266 Default is false: not to include.
19269 \begin_layout Description
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19292 \begin_inset space \thinspace{}
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19305 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19306 of its contents in its item in the table of contents.
19307 Otherwise, only the label appears.
19310 \begin_layout Description
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19335 \begin_inset space \thinspace{}
19339 \begin_inset Flex Code
19342 \begin_layout Plain Layout
19348 ] As with paragraph styles, see
19349 \begin_inset CommandInset ref
19351 reference "subsec:Paragraph-Styles"
19358 \begin_layout Description
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19368 The font used for the label.
19370 \begin_inset CommandInset ref
19372 reference "subsec:Font-description"
19377 Note that this definition can never appear before
19378 \begin_inset Flex Code
19381 \begin_layout Plain Layout
19387 , lest it be ineffective.
19390 \begin_layout Description
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19411 \begin_inset Quotes erd
19415 \begin_inset Quotes erd
19418 ] What will be displayed on the button or elsewhere as the inset label.
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19431 \begin_inset Flex Code
19434 \begin_layout Plain Layout
19440 ) modify this label on the fly.
19443 \begin_layout Description
19444 \begin_inset Flex Code
19447 \begin_layout Plain Layout
19453 Language dependent preamble; see
19454 \begin_inset CommandInset ref
19456 reference "subsec:I18n"
19463 \begin_layout Description
19464 \begin_inset Flex Code
19467 \begin_layout Plain Layout
19474 \begin_inset Flex Code
19477 \begin_layout Plain Layout
19483 ] The name of the corresponding \SpecialChar LaTeX
19485 Either the environment or command name.
19488 \begin_layout Description
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19508 ] The optional parameter for the corresponding
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19518 stuff, including possible bracket pairs like
19519 \begin_inset Flex Code
19522 \begin_layout Plain Layout
19529 This parameter cannot be changed from within \SpecialChar LyX
19531 \begin_inset Flex Code
19534 \begin_layout Plain Layout
19540 for customizable parameters).
19541 It will be output as is after all \SpecialChar LaTeX
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19555 \begin_layout Description
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19570 Command, Environment, None
19575 ] How the style should be translated into \SpecialChar LaTeX
19580 \begin_layout Plain Layout
19581 \begin_inset Flex Code
19584 \begin_layout Plain Layout
19590 is perhaps a bit misleading, since these rules apply to SGML classes too.
19591 Visit the SGML class files for specific examples.
19600 \begin_layout Description
19601 \begin_inset Flex Code
19604 \begin_layout Plain Layout
19610 means nothing special
19613 \begin_layout Description
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19634 {\SpecialChar ldots
19643 \begin_layout Description
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19664 }\SpecialChar ldots
19679 \begin_layout Standard
19680 Putting the last few things together, the \SpecialChar LaTeX
19681 output will be either:
19684 \begin_layout LyX-Code
19687 LatexName[LatexParam]{\SpecialChar ldots
19691 \begin_layout Standard
19695 \begin_layout LyX-Code
19698 begin{LatexName}[LatexParam] \SpecialChar ldots
19704 \begin_layout Standard
19705 depending upon the \SpecialChar LaTeX
19710 \begin_layout Description
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19721 \begin_inset Flex Code
19724 \begin_layout Plain Layout
19730 ] A string that is put at the beginning of the layout content.
19731 A line break in the output can be indicated by
19732 \begin_inset Flex Code
19735 \begin_layout Plain Layout
19744 \begin_layout Description
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19765 \begin_inset Flex Code
19768 \begin_layout Plain Layout
19775 \begin_inset Flex Code
19778 \begin_layout Plain Layout
19785 \begin_inset Flex Code
19788 \begin_layout Plain Layout
19794 (indicating a dummy definition ending definitions of charstyles, etc).
19795 This entry is required in and is only meaningful for Flex insets.
19796 Among other things, it determines on which menu this inset will appear.
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19817 will automatically set
19818 \begin_inset Flex Code
19821 \begin_layout Plain Layout
19828 \begin_inset Flex Code
19831 \begin_layout Plain Layout
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19848 can be set to true, or
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19868 insets by setting it
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19885 \begin_layout Description
19886 \begin_inset Flex Code
19889 \begin_layout Plain Layout
19896 \begin_inset Flex Code
19899 \begin_layout Plain Layout
19908 \begin_inset space \thinspace{}
19912 \begin_inset Flex Code
19915 \begin_layout Plain Layout
19921 ] Whether multiple paragraphs are permitted in this inset.
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19932 to the same value and
19933 \begin_inset Flex Code
19936 \begin_layout Plain Layout
19942 to the opposite value.
19943 These can be reset to other values, if they are used
19948 \begin_inset Flex Code
19951 \begin_layout Plain Layout
19961 \begin_layout Description
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19984 \begin_inset space \thinspace{}
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19997 ] Whether fragile commands in this inset should be
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20014 whether the command should itself be protected.) Default is false.
20015 \change_inserted -712698321 1523633958
20019 \begin_layout Description
20021 \change_inserted -712698321 1523634088
20022 \begin_inset Flex Code
20025 \begin_layout Plain Layout
20027 \change_inserted -712698321 1523633961
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20039 \change_inserted -712698321 1523633958
20048 \begin_inset space \thinspace{}
20052 \begin_inset Flex Code
20055 \begin_layout Plain Layout
20057 \change_inserted -712698321 1523633958
20063 ] This causes macros that contain this inset to be protected with
20064 \begin_inset Flex Code
20067 \begin_layout Plain Layout
20069 \change_inserted -712698321 1523634038
20084 ) if necessary and thus allows (some) verbatim stuff in macros.
20090 \begin_layout Description
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20101 \begin_inset Flex Code
20104 \begin_layout Plain Layout
20110 ] Deletes an existing
20111 \begin_inset Flex Code
20114 \begin_layout Plain Layout
20123 \begin_layout Description
20124 \begin_inset Flex Code
20127 \begin_layout Plain Layout
20134 \begin_inset Flex Code
20137 \begin_layout Plain Layout
20144 \begin_inset Flex Code
20147 \begin_layout Plain Layout
20153 that has replaced this
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20164 This is used to rename an
20165 \begin_inset Flex Code
20168 \begin_layout Plain Layout
20174 , while keeping backward compatibility.
20177 \begin_layout Description
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20188 \begin_inset Flex Code
20191 \begin_layout Plain Layout
20200 \begin_inset space \thinspace{}
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20213 ] As with paragraph styles, see
20214 \begin_inset CommandInset ref
20216 reference "subsec:Paragraph-Styles"
20224 \begin_layout Description
20225 \begin_inset Flex Code
20228 \begin_layout Plain Layout
20235 \begin_inset Flex Code
20238 \begin_layout Plain Layout
20247 \begin_inset space \thinspace{}
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20260 ] As with paragraph styles, see
20261 \begin_inset CommandInset ref
20263 reference "subsec:Paragraph-Styles"
20271 \begin_layout Description
20272 \begin_inset Flex Code
20275 \begin_layout Plain Layout
20281 As with paragraph styles, see
20282 \begin_inset CommandInset ref
20284 reference "subsec:Paragraph-Styles"
20291 \begin_layout Description
20292 \begin_inset Flex Code
20295 \begin_layout Plain Layout
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20311 ] The prefix to use when creating labels referring to insets of this type.
20312 This allows the use of formatted references.
20315 \begin_layout Description
20316 \begin_inset Flex Code
20319 \begin_layout Plain Layout
20326 \begin_inset Flex Code
20329 \begin_layout Plain Layout
20335 ] As with paragraph styles, see
20336 \begin_inset CommandInset ref
20338 reference "subsec:Paragraph-Styles"
20345 \begin_layout Description
20346 \begin_inset Flex Code
20349 \begin_layout Plain Layout
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20368 \begin_inset space \thinspace{}
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20381 ] Resets the \SpecialChar LaTeX
20382 arguments of this layout (as defined via the
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20393 This is useful if you have copied a style via
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20403 , but you do not want to inherit its (required and optional) arguments.
20406 \begin_layout Description
20407 \begin_inset Flex Code
20410 \begin_layout Plain Layout
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20427 \begin_inset space \thinspace{}
20431 \begin_inset Flex Code
20434 \begin_layout Plain Layout
20442 ] Whether this inset should use the font of its surrounding environment
20444 Default is false: use the font of the surrounding environment.
20447 \begin_layout Description
20448 \begin_inset Flex Code
20451 \begin_layout Plain Layout
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20467 ] A string that is put at the end of the layout content.
20468 A line break in the output can be indicated by
20469 \begin_inset Flex Code
20472 \begin_layout Plain Layout
20481 \begin_layout Description
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20502 \begin_inset space \thinspace{}
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20517 ] Allow spell-checking the contents of this inset.
20521 \begin_layout Subsection
20523 \begin_inset CommandInset label
20525 name "subsec:Counters"
20532 \begin_layout Standard
20533 It is necessary to define the counters (
20534 \begin_inset Flex Noun
20537 \begin_layout Plain Layout
20544 \begin_inset Flex Noun
20547 \begin_layout Plain Layout
20553 , \SpecialChar ldots
20554 ) in the text class itself.
20555 The standard counters are defined in the file
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20565 , so you may have to do no more than add
20568 \begin_layout LyX-Code
20569 Input stdcounters.inc
20572 \begin_layout Standard
20573 to your layout file to get them to work.
20574 But if you want to define custom counters, then you can do so.
20575 The counter declaration must begin with:
20578 \begin_layout LyX-Code
20579 Counter CounterName
20582 \begin_layout Standard
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20593 ' is replaced by the name of the counter.
20594 And it must end with
20595 \begin_inset Quotes eld
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 \begin_inset Quotes erd
20613 The following parameters can also be used:
20616 \begin_layout Description
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20636 ] Sets the initial value for the counter, to which it will be reset whenever
20638 Normally, one will want the default, 1.
20641 \begin_layout Description
20642 \begin_inset Flex Code
20645 \begin_layout Plain Layout
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20662 \begin_inset Quotes erd
20666 \begin_inset Quotes erd
20669 ] When defined, this string defines how the counter is displayed.
20670 Setting this value sets
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20675 LabelStringAppendix
20681 The following special constructs can be used in the string:
20685 \begin_layout Itemize
20686 \begin_inset Flex Code
20689 \begin_layout Plain Layout
20697 will be replaced by the expansion of the
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20712 LabelStringAppendix
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20731 \begin_layout Itemize
20732 counter values can be expressed using \SpecialChar LaTeX
20734 \begin_inset Newline newline
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20773 \begin_layout Plain Layout
20783 Actually, the situation is a bit more complicated: any
20802 other than those described below will produce arabic numerals.
20803 It would not be surprising to see this change in the future.
20809 \begin_inset Flex Code
20812 \begin_layout Plain Layout
20818 : 1, 2, 3,\SpecialChar ldots
20820 \begin_inset Flex Code
20823 \begin_layout Plain Layout
20829 for lower-case letters: a, b, c, \SpecialChar ldots
20831 \begin_inset Flex Code
20834 \begin_layout Plain Layout
20840 for upper-case letters: A, B, C, \SpecialChar ldots
20842 \begin_inset Flex Code
20845 \begin_layout Plain Layout
20851 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20853 \begin_inset Flex Code
20856 \begin_layout Plain Layout
20862 for upper-case roman numerals: I, II, III\SpecialChar ldots
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20873 for hebrew numerals.
20877 \begin_layout Standard
20878 If LabelString is not defined, a default value is constructed as follows:
20879 if the counter has a master counter
20880 \begin_inset Flex Code
20883 \begin_layout Plain Layout
20890 \begin_inset Flex Code
20893 \begin_layout Plain Layout
20900 \begin_inset Newline newline
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20917 is used; otherwise the string
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20932 \begin_layout Description
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20937 LabelStringAppendix
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20953 \begin_inset Quotes erd
20957 \begin_inset Quotes erd
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20970 , but for use in the Appendix.
20973 \begin_layout Description
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20994 \begin_inset Quotes erd
20998 \begin_inset Quotes erd
21001 ] A format for use with formatted references to this counter.
21002 For example, one might want to have references to section numbers appear
21004 \begin_inset Quotes eld
21008 \begin_inset Quotes erd
21012 The string should contain
21013 \begin_inset Quotes eld
21017 \begin_inset Quotes erd
21021 This will be replaced by the counter number itself.
21022 So, for sections, it would be: Section ##.
21025 \begin_layout Description
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21036 \begin_inset Flex Code
21039 \begin_layout Plain Layout
21046 \begin_inset Quotes erd
21050 \begin_inset Quotes erd
21053 ] If this is set to the name of another counter, the present counter will
21054 be reset every time the other one is increased.
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21078 \begin_layout Subsection
21080 \begin_inset CommandInset label
21082 name "subsec:Font-description"
21089 \begin_layout Standard
21090 A font description looks like this:
21093 \begin_layout LyX-Code
21110 \begin_layout LyX-Code
21114 \begin_layout LyX-Code
21118 \begin_layout Standard
21119 The following commands are available:
21122 \begin_layout Description
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21133 \begin_inset Flex Code
21136 \begin_layout Plain Layout
21145 \begin_inset Flex Code
21148 \begin_layout Plain Layout
21155 \begin_inset Flex Code
21158 \begin_layout Plain Layout
21165 \begin_inset Flex Code
21168 \begin_layout Plain Layout
21175 \begin_inset Flex Code
21178 \begin_layout Plain Layout
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21205 \begin_inset Flex Code
21208 \begin_layout Plain Layout
21215 \begin_inset Flex Code
21218 \begin_layout Plain Layout
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21235 \begin_inset Flex Code
21238 \begin_layout Plain Layout
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21275 \begin_inset Flex Code
21278 \begin_layout Plain Layout
21285 \begin_inset Flex Code
21288 \begin_layout Plain Layout
21295 \begin_inset Flex Code
21298 \begin_layout Plain Layout
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21337 \begin_layout Description
21338 \begin_inset Flex Code
21341 \begin_layout Plain Layout
21348 \begin_inset Flex Code
21351 \begin_layout Plain Layout
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21382 \begin_layout Description
21383 \begin_inset Flex Code
21386 \begin_layout Plain Layout
21393 \begin_inset Flex Code
21396 \begin_layout Plain Layout
21402 ] Valid arguments are:
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21423 \begin_inset Flex Code
21426 \begin_layout Plain Layout
21433 \begin_inset Flex Code
21436 \begin_layout Plain Layout
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21453 \begin_inset Flex Code
21456 \begin_layout Plain Layout
21463 \begin_inset Flex Code
21466 \begin_layout Plain Layout
21473 \begin_inset Flex Code
21476 \begin_layout Plain Layout
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21493 \begin_inset Flex Code
21496 \begin_layout Plain Layout
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21513 \begin_inset Flex Code
21516 \begin_layout Plain Layout
21523 Each of these turns on or off the corresponding attribute.
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21534 turns on emphasis, and
21535 \begin_inset Flex Code
21538 \begin_layout Plain Layout
21546 \begin_inset Newline newline
21549 If the latter seems puzzling, remember that the font settings for the present
21550 context are generally inherited from the surrounding context.
21552 \begin_inset Flex Code
21555 \begin_layout Plain Layout
21561 would turn off the emphasis that was anyway in effect, say, in a theorem
21565 \begin_layout Description
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21576 \begin_inset Flex Code
21579 \begin_layout Plain Layout
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21600 \begin_layout Description
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21611 \begin_inset Flex Code
21614 \begin_layout Plain Layout
21623 \begin_inset Flex Code
21626 \begin_layout Plain Layout
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21655 \begin_layout Description
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21698 \begin_inset Flex Code
21701 \begin_layout Plain Layout
21708 \begin_inset Flex Code
21711 \begin_layout Plain Layout
21718 \begin_inset Flex Code
21721 \begin_layout Plain Layout
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21750 \begin_layout Subsection
21751 \begin_inset CommandInset label
21753 name "subsec:Citation-engine-description"
21757 Cite engine description
21760 \begin_layout Standard
21762 \begin_inset Flex Code
21765 \begin_layout Plain Layout
21771 blocks, as used mainly in cite engine files (see
21772 \begin_inset CommandInset ref
21774 reference "subsec:Cite-Engine-Files"
21781 ), define the citation commands provided by a specific
21782 \begin_inset Quotes eld
21786 \begin_inset Quotes erd
21790 A cite engine, in \SpecialChar LyX
21791 terms, is way specific way to format citations, using
21792 numbers, author names and/or years.
21793 Currently, \SpecialChar LyX
21794 supports three such engine types, namely:
21797 \begin_layout Enumerate
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21807 : the default Bib\SpecialChar TeX
21808 way to format citations, a simple numeric style (e.
21809 \begin_inset space \thinspace{}
21813 \begin_inset Quotes eld
21817 \begin_inset Quotes erd
21823 \begin_layout Enumerate
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21833 : Harvard-styled citations using author names and publication year (e.
21834 \begin_inset space \thinspace{}
21838 \begin_inset Quotes eld
21841 Smith and Miller (2017b)
21842 \begin_inset Quotes erd
21848 \begin_layout Enumerate
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21858 : extended numerical citations that also allow for author or title next
21860 \begin_inset space \thinspace{}
21864 \begin_inset Quotes eld
21867 Smith and Miller [1]
21868 \begin_inset Quotes erd
21874 \begin_layout Standard
21875 \begin_inset Flex Code
21878 \begin_layout Plain Layout
21884 blocks look like this:
21887 \begin_layout LyX-Code
21891 \begin_layout LyX-Code
21895 \begin_layout LyX-Code
21899 \begin_layout LyX-Code
21900 citeyearpar[][]=parencite*
21903 \begin_layout LyX-Code
21907 \begin_layout LyX-Code
21911 \begin_layout Standard
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21922 denotes the engine.
21923 The individual lines respectively define a cite command or cite command
21924 paradigm supported by this engine.
21925 The line can be as simple as a cite command that is used both to name the
21926 respective \SpecialChar LyX
21927 command and the \SpecialChar LaTeX
21928 output or more complex in order to differentiate
21930 The full syntax is:
21933 \begin_layout LyX-Code
21934 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21937 \begin_layout Itemize
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21947 : The name as used in the
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21961 \begin_layout Standard
21962 For portability reasons, we try to use the same name for same-formatted
21963 commands in different cite packages (thus many names stem from natbib,
21964 and thus we need to differentiate a
21965 \begin_inset Flex Code
21968 \begin_layout Plain Layout
21974 sometimes, if the \SpecialChar LaTeX
21975 command names differ).
21979 \begin_layout Itemize
21980 \begin_inset Flex Code
21983 \begin_layout Plain Layout
21989 : a (comma-separated) list of commands that fall back to the given
21990 \begin_inset Flex Code
21993 \begin_layout Plain Layout
21999 in the current engine.
22000 This eases the switch of citation packages and engines.
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22021 in layout definitions.
22024 \begin_layout Itemize
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22034 : The actual \SpecialChar LaTeX
22035 command that is output.
22039 \begin_layout Standard
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22050 \begin_inset Flex Code
22053 \begin_layout Plain Layout
22061 \begin_inset Flex Code
22064 \begin_layout Plain Layout
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22080 will be output to \SpecialChar LaTeX
22084 \begin_layout Standard
22088 \begin_layout Itemize
22089 Capitalization indicates that the command also has a capitalized form (
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22103 \begin_inset Flex Code
22106 \begin_layout Plain Layout
22115 These usually enforce up-casing of name prefixes (
22120 \begin_inset Formula $\Rightarrow$
22130 \begin_layout Itemize
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22141 indicate the number of optional arguments (there can be 0–2).
22144 \begin_layout Itemize
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22155 indicates there is a starred version of the command (
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22169 \begin_inset Flex Code
22172 \begin_layout Plain Layout
22185 \begin_layout Standard
22186 By default, the starred version means: Output all authors even if it should
22188 \begin_inset Quotes eld
22192 \begin_inset Quotes erd
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22208 \begin_layout Standard
22209 If the star has a different meaning for a given command, it can be specified
22211 \begin_inset Flex Code
22214 \begin_layout Plain Layout
22215 <!_stardesc!_stardesctooltip>
22221 Maximal two translatable macro keywords, marked by the prefix
22222 \begin_inset Flex Code
22225 \begin_layout Plain Layout
22232 The first points to the string that replaces the
22233 \begin_inset Quotes eld
22237 \begin_inset Quotes erd
22240 checkbox label in the citation dialog, the second one to an optional tool
22241 tip for this checkbox.
22245 \begin_layout Standard
22246 Note that these two macros have to be defined in a
22247 \begin_inset Flex Code
22250 \begin_layout Plain Layout
22256 (see next section), dropping the
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22266 from the prefix, like this:
22269 \begin_layout LyX-Code
22270 _stardesc Sta&rred command label
22273 \begin_layout LyX-Code
22274 _stardesctooltip Tooltip for the starred command checkbox.
22278 \begin_layout Itemize
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22289 indicates that this command features
22290 \begin_inset Quotes eld
22293 qualified citation lists
22294 \begin_inset Quotes erd
22302 -specific feature for multi-reference citations where an individual pre-
22303 and postnote can be given to each reference in the list.
22304 Please refer to the
22308 manual for details.
22309 \change_inserted -712698321 1526898670
22313 \begin_layout Standard
22315 \change_inserted -712698321 1526899524
22316 If you want to add a cite command to a cite engine (e.
22317 \begin_inset space \thinspace{}
22320 g., add a specific command provided by a class), you can use
22321 \begin_inset Flex Code
22324 \begin_layout Plain Layout
22326 \change_inserted -712698321 1526898768
22327 AddToCiteEngine <engine type> \SpecialChar ldots
22336 Note that only cite commands that do not exist yet are added.
22341 \begin_layout Subsection
22342 \begin_inset CommandInset label
22344 name "subsec:Citation-format-description"
22348 Cite format description
22351 \begin_layout Standard
22353 \begin_inset Flex Code
22356 \begin_layout Plain Layout
22362 blocks are used to describe how bibliographic information should be displayed,
22363 both within \SpecialChar LyX
22364 itself (in the citation dialog and in tooltips, for example)
22365 and in XHTML output.
22366 Such a block might look like this:
22369 \begin_layout LyX-Code
22373 \begin_layout LyX-Code
22377 \begin_layout LyX-Code
22381 \begin_layout LyX-Code
22385 \begin_layout Standard
22389 \begin_layout LyX-Code
22393 \begin_layout LyX-Code
22397 \begin_layout LyX-Code
22401 \begin_layout LyX-Code
22405 \begin_layout Standard
22406 In the first case, the individual lines define how the bibliographic information
22407 associated with an article or book, respectively, is to be displayed, and
22408 such a definition can be given for any
22409 \begin_inset Quotes els
22413 \begin_inset Quotes ers
22416 that might be present in a Bib\SpecialChar TeX
22419 defines a default format in the source code that will be used if no specific
22420 definition has been given.
22422 predefines several formats in the file
22423 \begin_inset Flex Code
22426 \begin_layout Plain Layout
22432 , which is included in most of \SpecialChar LyX
22433 's document classes.
22436 \begin_layout Standard
22437 In the second case, the lines define how a specific citation command (in
22439 \begin_inset Flex Code
22442 \begin_layout Plain Layout
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22462 ) is to be displayed on the citation inset label, in the citation dialog,
22463 menu or XHTML output.
22465 defines such formats for the citation style variants it supports via
22467 Document\SpecialChar menuseparator
22468 Setting\SpecialChar menuseparator
22469 Bibliography\SpecialChar ldots
22473 \begin_inset Flex Code
22476 \begin_layout Plain Layout
22482 files that are shipped with \SpecialChar LyX
22484 \begin_inset CommandInset ref
22486 reference "subsec:Cite-Engine-Files"
22496 \begin_layout Standard
22497 The definitions use a simple language that allows Bib\SpecialChar TeX
22498 keys to be replaced
22500 Keys should be enclosed in
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22521 So a simple definition might look like this:
22524 \begin_layout LyX-Code
22526 \begin_inset Quotes eld
22530 \begin_inset Quotes erd
22536 \begin_layout Standard
22537 This would print the author, followed by a comma, followed by the title,
22538 in quotes, followed by a period.
22541 \begin_layout Standard
22542 Of course, sometimes you may want to print a key only if it exists.
22543 This can be done by using a conditional construction, such as:
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22549 \begin_inset space ~
22559 \begin_inset Flex Code
22562 \begin_layout Plain Layout
22568 key exists, then print
22569 \begin_inset Quotes eld
22573 \begin_inset space ~
22577 \begin_inset Quotes erd
22580 followed by the volume key.
22581 It is also possible to have an else clause in the conditional, such as:
22582 \begin_inset Newline newline
22586 \begin_inset Flex Code
22589 \begin_layout Plain Layout
22590 {%author%[[%author%]][[%editor%, ed.]]}
22596 \begin_inset Newline newline
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22609 key is printed if it exists; otherwise, the editor key is printed, followed
22611 \begin_inset Quotes eld
22615 \begin_inset space ~
22619 \begin_inset Quotes erd
22622 Note that the key is again enclosed in
22623 \begin_inset Flex Code
22626 \begin_layout Plain Layout
22632 signs; the entire conditional is enclosed in braces; and the if and else
22633 clauses are enclosed in double brackets,
22634 \begin_inset Quotes eld
22638 \begin_inset Flex Code
22641 \begin_layout Plain Layout
22648 \begin_inset Quotes eld
22652 \begin_inset Quotes eld
22656 \begin_inset Flex Code
22659 \begin_layout Plain Layout
22666 \begin_inset Quotes erd
22670 There must be no space between any of these.
22673 \begin_layout Standard
22674 Next to the entry keys, there are some special keys that can be used for
22675 these conditionals:
22678 \begin_layout Itemize
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22683 {%dialog%[[true]][[false]]}
22689 \begin_inset Quotes eld
22693 \begin_inset Quotes erd
22696 part for dialogs and menus, the
22697 \begin_inset Quotes eld
22701 \begin_inset Quotes erd
22704 part for other contexts (workarea, export)
22707 \begin_layout Itemize
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22712 {%export%[[true]][[false]]}
22718 \begin_inset Quotes eld
22722 \begin_inset Quotes erd
22725 part for export and menus, the
22726 \begin_inset Quotes eld
22730 \begin_inset Quotes erd
22733 part for other contexts (workarea, dialog)
22736 \begin_layout Itemize
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22747 \begin_inset Quotes eld
22751 \begin_inset Quotes erd
22754 part if another item follows (e.
22755 \begin_inset space \thinspace{}
22758 g., in a citation with multiple keys)
22761 \begin_layout Itemize
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22766 {%second%[[true]][[false]]}
22772 \begin_inset Quotes eld
22776 \begin_inset Quotes erd
22779 if this is the second of multiple items, else the
22780 \begin_inset Quotes eld
22784 \begin_inset Quotes erd
22790 \begin_layout Itemize
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22795 {%ifstar%[[true]][[false]]}
22801 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22808 part for starred citation commands (such as
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22820 ), the false part for unstarred
22823 \begin_layout Itemize
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22828 {%ifentrytype:<type>%[[true]][[false]]}
22834 \begin_inset Quotes eld
22838 \begin_inset Quotes erd
22841 if the current entry type matches
22842 \begin_inset Flex Code
22845 \begin_layout Plain Layout
22851 , else the false part (e.g., in a citation definition:
22852 \begin_inset Flex Code
22855 \begin_layout Plain Layout
22856 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22864 \begin_layout Itemize
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22869 {%ifmultiple:<authortype>%[[true]][[false]]}
22875 \begin_inset Quotes eld
22879 \begin_inset Quotes erd
22882 if the current author type (author, editor etc.) has multiple authors, else
22883 the false part (e.g., in a bibliography definition:
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22888 {%ifmultiple:editor%[[eds.]][[ed.]]}
22896 \begin_layout Itemize
22897 \begin_inset Flex Code
22900 \begin_layout Plain Layout
22901 {%ifqualified%[[true]][[false]]}
22907 \begin_inset Quotes eld
22911 \begin_inset Quotes erd
22914 part if the current citation is a qualified citation list (a specific
22918 format for multi-reference citations), the false part if this is not the
22922 \begin_layout Standard
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22933 prints the author key as it is recorded in the bibliography file.
22934 This might not be what you want, since it will result in a string such
22936 \begin_inset Quotes eld
22939 Miller, Peter and Smith, Mary and White, Jane
22940 \begin_inset Quotes erd
22944 \begin_inset Quotes eld
22948 \begin_inset Quotes erd
22951 is used by Bib\SpecialChar TeX
22952 to delimit authors).
22954 therefore provides some methods to get properly formatted name lists (which
22955 will also get translated).
22956 The following keys are provided:
22959 \begin_layout Enumerate
22960 For name lists with pre- and surname, suitable for the main authors/editors
22961 of a bibliography item.
22963 \begin_inset Flex Code
22966 \begin_layout Plain Layout
22972 part denotes the kind of list that is requested (e.g.
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22987 \begin_layout Itemize
22988 \begin_inset Flex Code
22991 \begin_layout Plain Layout
22992 %abbrvnames:<nametype>%
22997 : Provides a name list which is abbreviated (with
22998 \begin_inset Quotes eld
23002 \begin_inset Quotes erd
23006 \begin_inset Flex Code
23009 \begin_layout Plain Layout
23018 \begin_layout Itemize
23019 \begin_inset Flex Code
23022 \begin_layout Plain Layout
23023 %fullnames:<nametype>%
23028 : Provides a full name list (never abbreviated with
23029 \begin_inset Quotes eld
23033 \begin_inset Quotes erd
23039 \begin_layout Itemize
23040 \begin_inset Flex Code
23043 \begin_layout Plain Layout
23044 %forceabbrvnames:<nametype>%
23049 : Provides a name list which is always abbreviated (with
23050 \begin_inset Quotes eld
23054 \begin_inset Quotes erd
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23071 \begin_layout Enumerate
23072 Alternative name lists with pre- and surname, if the order of pre- and surname
23073 inside the bibliography item differs (as in:
23074 \begin_inset Quotes eld
23077 Miller, John: Some text, in: Mary Smith, ed.: A volume
23078 \begin_inset Quotes erd
23085 \begin_layout Itemize
23086 \begin_inset Flex Code
23089 \begin_layout Plain Layout
23090 %abbrvbynames:<nametype>%
23095 : Provides a name list which is abbreviated (with
23096 \begin_inset Quotes eld
23100 \begin_inset Quotes erd
23104 \begin_inset Flex Code
23107 \begin_layout Plain Layout
23116 \begin_layout Itemize
23117 \begin_inset Flex Code
23120 \begin_layout Plain Layout
23121 %fullbynames:<nametype>%
23126 : Provides a full name list (never abbreviated with
23127 \begin_inset Quotes eld
23131 \begin_inset Quotes erd
23137 \begin_layout Itemize
23138 \begin_inset Flex Code
23141 \begin_layout Plain Layout
23142 %forceabbrvbynames:<nametype>%
23147 : Provides a name list which is always abbreviated (with
23148 \begin_inset Quotes eld
23152 \begin_inset Quotes erd
23156 \begin_inset Flex Code
23159 \begin_layout Plain Layout
23169 \begin_layout Enumerate
23170 And finally name lists which consist of family names only, as used in author-yea
23172 These do not take a
23173 \begin_inset Flex Code
23176 \begin_layout Plain Layout
23182 part, but always return either an author list or, if this does not exist,
23183 an editor list (as common in author-year labels):
23187 \begin_layout Itemize
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23197 : Provides a name list which is abbreviated (with
23198 \begin_inset Quotes eld
23202 \begin_inset Quotes erd
23206 \begin_inset Flex Code
23209 \begin_layout Plain Layout
23218 \begin_layout Itemize
23219 \begin_inset Flex Code
23222 \begin_layout Plain Layout
23228 : Provides a full name list (never abbreviated with
23229 \begin_inset Quotes eld
23233 \begin_inset Quotes erd
23239 \begin_layout Itemize
23240 \begin_inset Flex Code
23243 \begin_layout Plain Layout
23244 %forceabbrvciteauthor%
23249 : Provides a name list which is always abbreviated (with
23250 \begin_inset Quotes eld
23254 \begin_inset Quotes erd
23258 \begin_inset Flex Code
23261 \begin_layout Plain Layout
23271 \begin_layout Standard
23272 The order of pre- and surname in the former two lists can be adjusted by
23276 \begin_layout Itemize
23277 \begin_inset Flex Code
23280 \begin_layout Plain Layout
23281 !firstnameform %surname%, %prename%
23286 (first author in lists of type 1)
23289 \begin_layout Itemize
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23294 !othernameform %surname%, %prename%
23299 (other authors in lists of type 1)
23302 \begin_layout Itemize
23303 \begin_inset Flex Code
23306 \begin_layout Plain Layout
23307 !firstbynameform %prename% %surname%
23312 (first author in lists of type 2)
23315 \begin_layout Itemize
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23320 !otherbynameform %prename% %surname%
23325 (other authors in lists of type 2)
23328 \begin_layout Standard
23329 This allows you to configure namings like
23330 \begin_inset Quotes eld
23333 Miller, Peter and Mary Smith: \SpecialChar ldots
23334 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23336 \begin_inset Quotes erd
23342 \begin_layout Standard
23343 There is one other piece of syntax available in definitions, which looks
23345 \begin_inset Flex Code
23348 \begin_layout Plain Layout
23355 This defines a piece of formatting information that is to be used when
23357 \begin_inset Quotes eld
23361 \begin_inset Quotes erd
23365 Obviously, we do not want to output HTML tags when writing plain text,
23366 so they should be wrapped in
23367 \begin_inset Quotes eld
23371 \begin_inset Quotes erd
23375 \begin_inset Quotes eld
23379 \begin_inset Quotes erd
23385 \begin_layout Standard
23386 Two special sorts of definitions are also possible in a
23387 \begin_inset Flex Code
23390 \begin_layout Plain Layout
23397 An example of the first would be:
23400 \begin_layout LyX-Code
23402 \begin_inset Quotes eld
23406 \begin_inset Quotes erd
23412 \begin_layout Standard
23413 This is an abbreviation, or macro, and it can be used by treating it as
23415 \begin_inset Flex Code
23418 \begin_layout Plain Layout
23427 \begin_inset Flex Code
23430 \begin_layout Plain Layout
23436 exactly as it would treat its definition.
23437 So, let us issue the obvious
23445 \begin_layout LyX-Code
23449 \begin_layout Standard
23450 or anything like it.
23452 shouldn't go into an infinite loop, but it may go into a long one before
23456 \begin_layout Standard
23457 The second sort of special definition might look like this:
23460 \begin_layout LyX-Code
23464 \begin_layout Standard
23465 This defines a translatable piece of text, which allows relevant parts of
23466 the bibliography or citation to be translated.
23467 It can be included in a definition by treating it as a key:
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23478 Note that there are two different translation paths: All definitions starting
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23489 , such as in the example above, will be translated to the currently active
23490 buffer language (so the translation will match the generated document).
23491 All definitions starting with underscore only will be translated to the
23493 This is the proper translation for strings that only occur in the dialogs
23494 or on buttons, such as this one:
23497 \begin_layout LyX-Code
23498 _addtobib Add to bibliography only.
23501 \begin_layout Standard
23502 Several of these translatable strings are predefined in
23503 \begin_inset Flex Code
23506 \begin_layout Plain Layout
23513 \begin_inset Flex Code
23516 \begin_layout Plain Layout
23523 Note that these are not macros, in the sense just defined.
23524 They will not be expanded.
23527 \begin_layout Standard
23528 So here then is an example that uses several of these features:
23529 \begin_inset VSpace defskip
23535 \begin_layout Standard
23539 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23542 \begin_layout Standard
23543 \begin_inset VSpace defskip
23546 This defines a macro that prints the author, followed by a comma, if the
23548 \begin_inset Flex Code
23551 \begin_layout Plain Layout
23557 key is defined, or else prints the name of the editor, followed by the
23559 \begin_inset Flex Code
23562 \begin_layout Plain Layout
23568 or its translation (it is by default
23569 \begin_inset Quotes eld
23573 \begin_inset Quotes erd
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23587 Note that this is in fact defined in
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23597 , so you can use it in your own definitions, or re-definitions, if you load
23601 \begin_layout Section
23602 \begin_inset CommandInset label
23604 name "sec:Tags-for-XHTML"
23608 Tags for XHTML output
23611 \begin_layout Standard
23612 As with \SpecialChar LaTeX
23613 or DocBook, the format of \SpecialChar LyX
23614 's XHTML output is also controlled by
23615 layout information.
23616 In general, \SpecialChar LyX
23617 provides sensible defaults and, as mentioned earlier, it will
23618 even construct default CSS style rules from the other layout tags.
23619 For example, \SpecialChar LyX
23620 will attempt to use the information provided in the
23621 \begin_inset Flex Code
23624 \begin_layout Plain Layout
23630 declaration for the Chapter style to write CSS that will appropriately
23631 format chapter headings.
23634 \begin_layout Standard
23635 In many cases, then, you may not have to do anything at all to get acceptable
23636 XHTML output for your own environments, custom insets, and so forth.
23637 But in some cases you will, and so \SpecialChar LyX
23638 provides a number of layout tags that
23639 can be used to customize the XHTML and CSS that are generated.
23642 \begin_layout Standard
23643 Note that there are two tags,
23644 \begin_inset Flex Code
23647 \begin_layout Plain Layout
23654 \begin_inset Flex Code
23657 \begin_layout Plain Layout
23663 that may appear outside style and inset declarations.
23665 \begin_inset CommandInset ref
23667 reference "subsec:General-text-class"
23671 for details on these.
23674 \begin_layout Subsection
23675 \begin_inset CommandInset label
23677 name "subsec:Paragraph-Style-XHTML"
23684 \begin_layout Standard
23685 The sort of XHTML \SpecialChar LyX
23686 outputs for a paragraph depends upon whether we are dealing
23687 with a normal paragraph, a command, or an environment, where this is itself
23688 determined by the contents of the corresponding
23689 \begin_inset Flex Code
23692 \begin_layout Plain Layout
23703 \begin_layout Standard
23704 For a command or normal paragraph, the output XHTML has the following form:
23707 \begin_layout LyX-Code
23711 \begin_inset Quotes erd
23715 \begin_inset Quotes erd
23721 \begin_layout LyX-Code
23725 \begin_inset Quotes erd
23729 \begin_inset Quotes erd
23735 \begin_layout LyX-Code
23738 Contents of the paragraph.
23741 \begin_layout LyX-Code
23747 \begin_layout Standard
23748 The label tags are of course omitted if the paragraph does not have a label.
23751 \begin_layout Standard
23752 For an environment that is not some sort of list, the XHTML takes this form:
23755 \begin_layout LyX-Code
23759 \begin_inset Quotes erd
23763 \begin_inset Quotes erd
23769 \begin_layout LyX-Code
23773 \begin_inset Quotes erd
23777 \begin_inset Quotes erd
23781 \begin_inset Quotes erd
23785 \begin_inset Quotes erd
23788 >Environment Label</labeltag>First paragraph.</itemtag>
23791 \begin_layout LyX-Code
23794 <itemtag>Second paragraph.</itemtag>
23797 \begin_layout LyX-Code
23803 \begin_layout Standard
23804 Note that the label is output only for the first paragraph, as it should
23805 be for a theorem, for example.
23809 \begin_layout Standard
23810 For a list, we have one of these forms:
23813 \begin_layout LyX-Code
23817 \begin_inset Quotes erd
23821 \begin_inset Quotes erd
23827 \begin_layout LyX-Code
23831 \begin_inset Quotes erd
23835 \begin_inset Quotes erd
23839 \begin_inset Quotes erd
23843 \begin_inset Quotes erd
23846 >List Label</labeltag>First item.</itemtag>
23849 \begin_layout LyX-Code
23853 \begin_inset Quotes erd
23857 \begin_inset Quotes erd
23861 \begin_inset Quotes erd
23865 \begin_inset Quotes erd
23868 >List Label</labeltag>Second item.</itemtag>
23871 \begin_layout LyX-Code
23877 \begin_layout LyX-Code
23881 \begin_layout LyX-Code
23885 \begin_inset Quotes erd
23889 \begin_inset Quotes erd
23895 \begin_layout LyX-Code
23899 \begin_inset Quotes erd
23903 \begin_inset Quotes erd
23906 >List Label</labeltag><itemtag attr=
23907 \begin_inset Quotes erd
23911 \begin_inset Quotes erd
23914 >First item.</itemtag>
23917 \begin_layout LyX-Code
23921 \begin_inset Quotes erd
23925 \begin_inset Quotes erd
23928 >List Label</labeltag><itemtag attr=
23929 \begin_inset Quotes erd
23933 \begin_inset Quotes erd
23936 >Second item.</itemtag>
23939 \begin_layout LyX-Code
23945 \begin_layout Standard
23946 Note the different orders of
23947 \begin_inset Flex Code
23950 \begin_layout Plain Layout
23957 \begin_inset Flex Code
23960 \begin_layout Plain Layout
23967 Which order we get depends upon the setting of
23968 \begin_inset Flex Code
23971 \begin_layout Plain Layout
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23987 is false (the default), you get the first of these, with the label within
23988 the item; if true, you get the second, with the label outside the item.
23991 \begin_layout Standard
23992 The specific tags and attributes output for each paragraph type can be controlle
23993 d by means of the layout tags we are about to describe.
23994 As mentioned earlier, however, \SpecialChar LyX
23995 uses sensible defaults for many of these,
23996 so you often may not need to do very much to get good XHTML output.
23997 Think of the available tags as there so you can tweak things to your liking.
24000 \begin_layout Description
24001 \begin_inset Flex Code
24004 \begin_layout Plain Layout
24011 \begin_inset Flex Code
24014 \begin_layout Plain Layout
24020 ] Specifies attribute information to be output with the main tag.
24022 \begin_inset Quotes eld
24026 \begin_inset Flex Code
24029 \begin_layout Plain Layout
24036 \begin_inset Quotes erd
24040 By default, \SpecialChar LyX
24042 \begin_inset Quotes eld
24046 \begin_inset Flex Code
24049 \begin_layout Plain Layout
24056 \begin_inset Quotes erd
24060 \begin_inset Flex Code
24063 \begin_layout Plain Layout
24069 is the \SpecialChar LyX
24070 name of the layout, made lowercase, for example: chapter.
24075 contain any style information.
24077 \begin_inset Flex Code
24080 \begin_layout Plain Layout
24089 \begin_layout Description
24090 \begin_inset Flex Code
24093 \begin_layout Plain Layout
24100 \begin_inset Flex Code
24103 \begin_layout Plain Layout
24113 ] Whether to output the default CSS information \SpecialChar LyX
24114 generates for this layout,
24115 even if additional information is explicitly provided via
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24127 \begin_inset Flex Code
24130 \begin_layout Plain Layout
24136 allows you to alter or augment the generated CSS, rather than to override
24139 \begin_inset Flex Code
24142 \begin_layout Plain Layout
24151 \begin_layout Description
24152 \begin_inset Flex Code
24155 \begin_layout Plain Layout
24162 \begin_inset Flex Code
24165 \begin_layout Plain Layout
24171 ] The tag to be used for individual paragraphs of environments, replacing
24173 \begin_inset Flex Code
24176 \begin_layout Plain Layout
24182 in the examples above.
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24196 \begin_layout Description
24197 \begin_inset Flex Code
24200 \begin_layout Plain Layout
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24216 ] Attributes for the item tag.
24218 \begin_inset Newline newline
24222 \begin_inset Quotes eld
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24230 class=`layoutname_item'
24236 \begin_inset Quotes erd
24244 contain any style information.
24246 \begin_inset Flex Code
24249 \begin_layout Plain Layout
24258 \begin_layout Description
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24269 \begin_inset Flex Code
24272 \begin_layout Plain Layout
24278 ] The tag to be used for paragraph and item labels, replacing
24279 \begin_inset Flex Code
24282 \begin_layout Plain Layout
24288 in the examples above.
24290 \begin_inset Flex Code
24293 \begin_layout Plain Layout
24300 \begin_inset Flex Code
24303 \begin_layout Plain Layout
24310 \begin_inset Flex Code
24313 \begin_layout Plain Layout
24320 \begin_inset Flex Code
24323 \begin_layout Plain Layout
24324 Centered_Top_Environment
24329 , in which case it defaults to
24330 \begin_inset Flex Code
24333 \begin_layout Plain Layout
24342 \begin_layout Description
24343 \begin_inset Flex Code
24346 \begin_layout Plain Layout
24353 \begin_inset Flex Code
24356 \begin_layout Plain Layout
24362 ] Attributes for the label tag.
24364 \begin_inset Newline newline
24368 \begin_inset Quotes eld
24372 \begin_inset Flex Code
24375 \begin_layout Plain Layout
24376 class=`layoutname_label'
24382 \begin_inset Quotes erd
24390 contain any style information.
24392 \begin_inset Flex Code
24395 \begin_layout Plain Layout
24404 \begin_layout Description
24405 \begin_inset Flex Code
24408 \begin_layout Plain Layout
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24428 ] Meaningful only for list-like environments, this tag controls whether
24429 the label tag is output before or inside the item tag.
24430 This is used, for example, in the description environment, where we want
24432 \begin_inset Flex Code
24435 \begin_layout Plain Layout
24436 <dt>\SpecialChar ldots
24437 </dt><dd>\SpecialChar ldots
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24454 : The label tag is output inside the item tag.
24457 \begin_layout Description
24458 \begin_inset Flex Code
24461 \begin_layout Plain Layout
24467 Information to be output in the
24468 \begin_inset Flex Code
24471 \begin_layout Plain Layout
24477 section when this style is used.
24478 This might, for example, be used to include a
24479 \begin_inset Flex Code
24482 \begin_layout Plain Layout
24489 \begin_inset Flex Code
24492 \begin_layout Plain Layout
24501 \begin_layout Description
24502 \begin_inset Flex Code
24505 \begin_layout Plain Layout
24511 CSS style information to be included when this style is used.
24512 Note that this will automatically be wrapped in a layout-generated
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24522 block, so only the CSS itself need be included.
24524 \begin_inset Flex Code
24527 \begin_layout Plain Layout
24536 \begin_layout Description
24537 \begin_inset Flex Code
24540 \begin_layout Plain Layout
24547 \begin_inset Flex Code
24550 \begin_layout Plain Layout
24556 ] The tag to be used for the main label, replacing
24557 \begin_inset Flex Code
24560 \begin_layout Plain Layout
24566 in the examples above.
24568 \begin_inset Flex Code
24571 \begin_layout Plain Layout
24580 \begin_layout Description
24581 \begin_inset Flex Code
24584 \begin_layout Plain Layout
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24604 ] Marks this style as the one to be used to generate the
24605 \begin_inset Flex Code
24608 \begin_layout Plain Layout
24614 tag for the XHTML file.
24615 By default, it is false.
24617 \begin_inset Flex Code
24620 \begin_layout Plain Layout
24626 file sets it to true for the
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24640 \begin_layout Subsection
24644 \begin_layout Standard
24645 The XHTML output of insets can also be controlled by information in layout
24650 \begin_layout Plain Layout
24651 At present, this is true only for
24652 \begin_inset Quotes eld
24656 \begin_inset Quotes erd
24659 insets (insets you can type into) and is not true for
24660 \begin_inset Quotes eld
24664 \begin_inset Quotes erd
24667 insets (insets that are associated with dialog boxes).
24672 Here, too, \SpecialChar LyX
24673 tries to provide sensible defaults, and it constructs default
24675 But everything can be customized.
24678 \begin_layout Standard
24679 The XHTML \SpecialChar LyX
24680 outputs for an inset has the following form:
24683 \begin_layout LyX-Code
24685 \begin_inset Quotes erd
24689 \begin_inset Quotes erd
24695 \begin_layout LyX-Code
24696 <labeltag>Label</labeltag>
24699 \begin_layout LyX-Code
24701 \begin_inset Quotes erd
24705 \begin_inset Quotes erd
24708 >Contents of the inset.</innertag>
24711 \begin_layout LyX-Code
24715 \begin_layout Standard
24716 If the inset permits multiple paragraphs—that is, if
24717 \begin_inset Flex Code
24720 \begin_layout Plain Layout
24726 is true—then the contents of the inset will itself be output as paragraphs
24727 formatted according to the styles used for those paragraphs (standard,
24728 quote, and the like).
24729 The label tag is of course omitted if the paragraph does not have a label
24730 and, at present, is always
24731 \begin_inset Flex Code
24734 \begin_layout Plain Layout
24741 The inner tag is optional and, by default, does not appear.
24744 \begin_layout Standard
24745 The specific tags and attributes output for each inset can be controlled
24746 by means of the following layout tags.
24749 \begin_layout Description
24750 \begin_inset Flex Code
24753 \begin_layout Plain Layout
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24769 ] Specifies attribute information to be output with the main tag.
24771 \begin_inset Quotes eld
24775 \begin_inset Flex Code
24778 \begin_layout Plain Layout
24779 class=`myinset' onclick=`\SpecialChar ldots
24786 \begin_inset Quotes erd
24790 By default, \SpecialChar LyX
24792 \begin_inset Quotes eld
24796 \begin_inset Flex Code
24799 \begin_layout Plain Layout
24806 \begin_inset Quotes erd
24810 \begin_inset Flex Code
24813 \begin_layout Plain Layout
24819 is the \SpecialChar LyX
24820 name of the inset, made lowercase and with non-alphanumeric characters
24821 converted to underscores, for example: footnote.
24824 \begin_layout Description
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24848 ] Whether to output the default CSS information \SpecialChar LyX
24849 generates for this layout,
24850 even if additional information is explicitly provided via
24851 \begin_inset Flex Code
24854 \begin_layout Plain Layout
24862 \begin_inset Flex Code
24865 \begin_layout Plain Layout
24871 allows you to alter or augment the generated CSS, rather than to override
24876 \begin_layout Description
24877 \begin_inset Flex Code
24880 \begin_layout Plain Layout
24887 \begin_inset Flex Code
24890 \begin_layout Plain Layout
24896 ] Attributes for the inner tag.
24898 \begin_inset Newline newline
24902 \begin_inset Quotes eld
24906 \begin_inset Flex Code
24909 \begin_layout Plain Layout
24910 class=`insetname_inner'
24916 \begin_inset Quotes erd
24922 \begin_layout Description
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24942 ] The inner tag, replacing
24943 \begin_inset Flex Code
24946 \begin_layout Plain Layout
24952 in the examples above.
24953 By default, there is none.
24956 \begin_layout Description
24957 \begin_inset Flex Code
24960 \begin_layout Plain Layout
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24978 ] Whether this inset represents a standalone block of text (such as a footnote)
24979 or instead represents material that is included in the surrounding text
24980 (such as a branch).
24984 \begin_layout Description
24985 \begin_inset Flex Code
24988 \begin_layout Plain Layout
24995 \begin_inset Flex Code
24998 \begin_layout Plain Layout
25004 ] A label for this inset, possibly including a reference to a counter.
25005 For example, for footnote, it might be:
25006 \begin_inset Flex Code
25009 \begin_layout Plain Layout
25018 This is optional, and there is no default.
25021 \begin_layout Description
25022 \begin_inset Flex Code
25025 \begin_layout Plain Layout
25031 Information to be output in the
25032 \begin_inset Flex Code
25035 \begin_layout Plain Layout
25041 section when this style is used.
25042 This might, for example, be used to include a
25043 \begin_inset Flex Code
25046 \begin_layout Plain Layout
25053 \begin_inset Flex Code
25056 \begin_layout Plain Layout
25065 \begin_layout Description
25066 \begin_inset Flex Code
25069 \begin_layout Plain Layout
25075 CSS style information to be included when this style is used.
25076 Note that this will automatically be wrapped in a layout-generated
25077 \begin_inset Flex Code
25080 \begin_layout Plain Layout
25086 block, so only the CSS itself need be included.
25089 \begin_layout Description
25090 \begin_inset Flex Code
25093 \begin_layout Plain Layout
25100 \begin_inset Flex Code
25103 \begin_layout Plain Layout
25109 ] The tag to be used for the main label, replacing
25110 \begin_inset Flex Code
25113 \begin_layout Plain Layout
25119 in the examples above.
25120 The default depends upon the setting of
25121 \begin_inset Flex Code
25124 \begin_layout Plain Layout
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25140 is true, the default is
25141 \begin_inset Flex Code
25144 \begin_layout Plain Layout
25150 ; if it is false, the default is
25151 \begin_inset Flex Code
25154 \begin_layout Plain Layout
25163 \begin_layout Subsection
25167 \begin_layout Standard
25168 The XHTML output for floats too can be controlled by layout information.
25169 The output has the following form:
25172 \begin_layout LyX-Code
25174 \begin_inset Quotes erd
25178 \begin_inset Quotes erd
25184 \begin_layout LyX-Code
25185 Contents of the float.
25188 \begin_layout LyX-Code
25192 \begin_layout Standard
25193 The caption, if there is one, is a separate inset and will be output as
25195 Its appearance can be controlled via the InsetLayout for caption insets.
25199 \begin_layout Description
25200 \begin_inset Flex Code
25203 \begin_layout Plain Layout
25210 \begin_inset Flex Code
25213 \begin_layout Plain Layout
25219 ] Specifies attribute information to be output with the main tag.
25221 \begin_inset Quotes eld
25225 \begin_inset Flex Code
25228 \begin_layout Plain Layout
25229 class=`myfloat' onclick=`\SpecialChar ldots
25236 \begin_inset Quotes erd
25240 By default, \SpecialChar LyX
25242 \begin_inset Quotes eld
25246 \begin_inset Flex Code
25249 \begin_layout Plain Layout
25250 class=`float float-floattype'
25256 \begin_inset Quotes erd
25260 \begin_inset Flex Code
25263 \begin_layout Plain Layout
25269 is \SpecialChar LyX
25270 's name for this type of float, as determined by the float declaration
25272 \begin_inset CommandInset ref
25274 reference "subsec:Floats"
25278 ), though made lowercase and with non-alphanumeric characters converted
25279 to underscores, for example: float-table.
25282 \begin_layout Description
25283 \begin_inset Flex Code
25286 \begin_layout Plain Layout
25292 CSS style information to be included when this float is used.
25293 Note that this will automatically be wrapped in a layout-generated
25294 \begin_inset Flex Code
25297 \begin_layout Plain Layout
25303 block, so only the CSS itself need be included.
25306 \begin_layout Description
25307 \begin_inset Flex Code
25310 \begin_layout Plain Layout
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25326 ] The tag to be used for this float, replacing
25327 \begin_inset Quotes eld
25331 \begin_inset Flex Code
25334 \begin_layout Plain Layout
25341 \begin_inset Quotes erd
25344 in the example above.
25346 \begin_inset Flex Code
25349 \begin_layout Plain Layout
25355 and will rarely need changing.
25358 \begin_layout Subsection
25359 Bibliography formatting
25362 \begin_layout Standard
25363 The bibliography can be formatted using
25364 \begin_inset Flex Code
25367 \begin_layout Plain Layout
25375 \begin_inset CommandInset ref
25377 reference "subsec:Citation-format-description"
25384 \begin_layout Subsection
25389 \begin_layout Standard
25390 We have several times mentioned that \SpecialChar LyX
25391 will generate default CSS style rules
25392 for both insets and paragraph styles, based upon the other layout information
25394 In this section, we shall say a word about which layout information \SpecialChar LyX
25399 \begin_layout Standard
25400 At present, \SpecialChar LyX
25401 auto-generates CSS only for font information, making use of
25403 \begin_inset Flex Code
25406 \begin_layout Plain Layout
25413 \begin_inset Flex Code
25416 \begin_layout Plain Layout
25423 \begin_inset Flex Code
25426 \begin_layout Plain Layout
25433 \begin_inset Flex Code
25436 \begin_layout Plain Layout
25443 \begin_inset Flex Code
25446 \begin_layout Plain Layout
25453 \begin_inset CommandInset ref
25455 reference "subsec:Font-description"
25460 The translation is mostly straightforward and obvious.
25462 \begin_inset Quotes eld
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25476 \begin_inset Quotes erd
25480 \begin_inset Quotes eld
25484 \begin_inset Flex Code
25487 \begin_layout Plain Layout
25488 font-family: sans-serif;
25494 \begin_inset Quotes erd
25498 The correspondence of \SpecialChar LyX
25499 sizes and CSS sizes is a little less obvious but
25500 nonetheless intuitive.
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25512 \begin_inset Flex URL
25515 \begin_layout Plain Layout
25525 \begin_layout Chapter
25526 Including External Material
25527 \begin_inset CommandInset label
25529 name "chap:Including-External-Material"
25536 \begin_layout Standard
25537 \begin_inset Box Shadowbox
25547 height_special "totalheight"
25552 backgroundcolor "none"
25555 \begin_layout Plain Layout
25556 WARNING: This portion of the documentation has not been updated for some
25558 We certainly hope that it is still accurate, but there are no guarantees.
25566 \begin_layout Standard
25567 The use of material from sources external to \SpecialChar LyX
25568 is covered in detail in the
25574 This part of the manual covers what needs to happen behind the scenes for
25575 new sorts of material to be included.
25578 \begin_layout Section
25582 \begin_layout Standard
25583 The external material feature is based on the concept of a
25588 A template is a specification of how \SpecialChar LyX
25589 should interface with a certain kind
25591 As bundled, \SpecialChar LyX
25592 comes with predefined templates for Xfig figures, various
25593 raster format images, chess diagrams, and LilyPond music notation.
25594 You can check the actual list by using the menu
25595 \begin_inset Flex Noun
25598 \begin_layout Plain Layout
25599 Insert\SpecialChar menuseparator
25600 File\SpecialChar menuseparator
25607 Furthermore, it is possible to roll your own template to support a specific
25609 Later we'll describe in more detail what is involved, and hopefully you
25610 will submit all the templates you create so we can include them in a later
25615 \begin_layout Standard
25616 Another basic idea of the external material feature is to distinguish between
25617 the original file that serves as a base for final material and the produced
25618 file that is included in your exported or printed document.
25619 For example, consider the case of a figure produced with
25620 \begin_inset Flex Code
25623 \begin_layout Plain Layout
25630 The Xfig application itself works on an original file with the
25631 \begin_inset Flex Code
25634 \begin_layout Plain Layout
25641 Within Xfig, you create and change your figure, and when you are done,
25643 \begin_inset Flex Code
25646 \begin_layout Plain Layout
25653 When you want to include the figure in your document, you invoke
25654 \begin_inset Flex Code
25657 \begin_layout Plain Layout
25663 in order to create a PostScript file that can readily be included in your
25667 \begin_inset Flex Code
25670 \begin_layout Plain Layout
25676 file is the original file, and the PostScript file is the produced file.
25679 \begin_layout Standard
25680 This distinction is important in order to allow updating of the material
25681 while you are in the process of writing the document.
25682 Furthermore, it provides us with the flexibility that is needed to support
25683 multiple export formats.
25684 For instance, in the case of a plain text file, it is not exactly an award-winn
25685 ing idea to include the figure as raw PostScript.
25686 Instead, you would either prefer to just include a reference to the figure
25687 or try to invoke some graphics to ASCII converter to make the final result
25688 look similar to the real graphics.
25689 The external material management allows you to do this, because it is parametri
25690 zed on the different export formats that \SpecialChar LyX
25694 \begin_layout Standard
25695 Besides supporting the production of different products according to the
25696 exported format, it supports tight integration with editing and viewing
25698 In the case of an Xfig figure, you are able to invoke Xfig on the original
25699 file with a single click from within the external material dialog in \SpecialChar LyX
25701 and also preview the produced PostScript file with Ghostview with another
25703 No more fiddling around with the command line and/or file browsers to locate
25704 and manipulate the original or produced files.
25705 In this way, you are finally able to take full advantage of the many different
25706 applications that are relevant to use when you write your documents, and
25707 ultimately be more productive.
25710 \begin_layout Section
25711 The external template configuration files
25714 \begin_layout Standard
25715 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25717 However, be aware that doing this in an careless manner most probably
25721 introduce an easily exploitable security hole.
25722 So before you do this, please read the discussion about security in
25723 \begin_inset CommandInset ref
25725 reference "sec:Security-discussion"
25732 \begin_layout Standard
25733 Having said that, we encourage you to submit any interesting templates that
25738 \begin_layout Standard
25739 The external templates are defined in the
25740 \begin_inset Flex Code
25743 \begin_layout Plain Layout
25749 files that are stored in the
25750 \begin_inset Flex Code
25753 \begin_layout Plain Layout
25754 LyXDir/lib/xtemplates/
25760 Each template is defined in a file of its own.
25761 You can place your own templates in
25762 \begin_inset Flex Code
25765 \begin_layout Plain Layout
25766 UserDir/xtemplates/
25771 or copy existing templates to that directory in order to modify them.
25774 \begin_layout Standard
25775 A typical template looks like this:
25778 \begin_layout LyX-Code
25782 \begin_layout LyX-Code
25783 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25786 \begin_layout LyX-Code
25790 \begin_layout LyX-Code
25794 \begin_layout LyX-Code
25798 \begin_layout LyX-Code
25802 \begin_layout LyX-Code
25806 \begin_layout LyX-Code
25807 AutomaticProduction true
25810 \begin_layout LyX-Code
25814 \begin_layout LyX-Code
25818 \begin_layout LyX-Code
25822 \begin_layout LyX-Code
25823 TransformCommand Rotate RotationLatexCommand
25826 \begin_layout LyX-Code
25827 TransformCommand Resize ResizeLatexCommand
25830 \begin_layout LyX-Code
25831 Product "$$RotateFront$$ResizeFront
25834 \begin_layout LyX-Code
25839 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25842 \begin_layout LyX-Code
25843 $$ResizeBack$$RotateBack"
25846 \begin_layout LyX-Code
25850 \begin_layout LyX-Code
25851 UpdateResult "$$AbsPath$$Basename.pstex_t"
25854 \begin_layout LyX-Code
25855 Requirement "graphicx"
25858 \begin_layout LyX-Code
25859 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25862 \begin_layout LyX-Code
25863 ReferencedFile latex "$$AbsPath$$Basename.eps"
25866 \begin_layout LyX-Code
25867 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25870 \begin_layout LyX-Code
25874 \begin_layout LyX-Code
25878 \begin_layout LyX-Code
25879 TransformCommand Rotate RotationLatexCommand
25882 \begin_layout LyX-Code
25883 TransformCommand Resize ResizeLatexCommand
25886 \begin_layout LyX-Code
25887 Product "$$RotateFront$$ResizeFront
25890 \begin_layout LyX-Code
25895 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25898 \begin_layout LyX-Code
25899 $$ResizeBack$$RotateBack"
25902 \begin_layout LyX-Code
25903 UpdateFormat pdftex
25906 \begin_layout LyX-Code
25907 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25910 \begin_layout LyX-Code
25911 Requirement "graphicx"
25914 \begin_layout LyX-Code
25915 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25918 \begin_layout LyX-Code
25919 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25922 \begin_layout LyX-Code
25926 \begin_layout LyX-Code
25930 \begin_layout LyX-Code
25931 Product "[XFig: $$FName]"
25934 \begin_layout LyX-Code
25938 \begin_layout LyX-Code
25942 \begin_layout LyX-Code
25943 Product "<graphic fileref=
25945 "$$AbsOrRelPathMaster$$Basename.eps
25950 \begin_layout LyX-Code
25954 \begin_layout LyX-Code
25958 \begin_layout LyX-Code
25959 UpdateResult "$$AbsPath$$Basename.eps"
25962 \begin_layout LyX-Code
25963 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25966 \begin_layout LyX-Code
25967 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25970 \begin_layout LyX-Code
25974 \begin_layout LyX-Code
25978 \begin_layout Standard
25979 As you can see, the template is enclosed in
25980 \begin_inset Flex Code
25983 \begin_layout Plain Layout
25991 \begin_inset Flex Code
25994 \begin_layout Plain Layout
26001 It contains a header specifying some general settings and, for each supported
26002 primary document file format, a section
26003 \begin_inset Flex Code
26006 \begin_layout Plain Layout
26014 \begin_inset Flex Code
26017 \begin_layout Plain Layout
26026 \begin_layout Subsection
26027 The template header
26030 \begin_layout Description
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26035 AutomaticProduction
26036 \begin_inset space ~
26044 Whether the file represented by the template must be generated by \SpecialChar LyX
26046 This command must occur exactly once.
26049 \begin_layout Description
26050 \begin_inset Flex Code
26053 \begin_layout Plain Layout
26055 \begin_inset space ~
26063 A glob pattern that is used in the file dialog to filter out the desired
26065 If there is more than one possible file extension (e.
26066 \begin_inset space \thinspace{}
26070 \begin_inset space \space{}
26074 \begin_inset Flex Code
26077 \begin_layout Plain Layout
26084 \begin_inset Flex Code
26087 \begin_layout Plain Layout
26093 ), use something like
26094 \begin_inset Flex Code
26097 \begin_layout Plain Layout
26104 This command must occur exactly once.
26107 \begin_layout Description
26108 \begin_inset Flex Code
26111 \begin_layout Plain Layout
26113 \begin_inset space ~
26121 The text that is displayed on the button.
26122 This command must occur exactly once.
26125 \begin_layout Description
26126 \begin_inset Flex Code
26129 \begin_layout Plain Layout
26131 \begin_inset space ~
26135 \begin_inset space ~
26143 The help text that is used in the External dialog.
26144 Provide enough information to explain to the user just what the template
26145 can provide him with.
26146 This command must occur exactly once.
26149 \begin_layout Description
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26155 \begin_inset space ~
26163 The file format of the original file.
26164 This must be the name of a format that is known to \SpecialChar LyX
26166 \begin_inset CommandInset ref
26168 reference "sec:Formats"
26174 \begin_inset Quotes eld
26178 \begin_inset Flex Code
26181 \begin_layout Plain Layout
26188 \begin_inset Quotes erd
26191 if the template can handle original files of more than one format.
26193 will attempt to interrogate the file itself in order to deduce its format
26195 This command must occur exactly once.
26198 \begin_layout Description
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26204 \begin_inset space ~
26212 A unique name for the template.
26213 It must not contain substitution macros (see below).
26216 \begin_layout Description
26217 \begin_inset Flex Code
26220 \begin_layout Plain Layout
26222 \begin_inset space ~
26225 Rotate|Resize|Clip|Extra
26230 This command specifies which transformations are supported by this template.
26231 It may occur zero or more times.
26232 This command enables the corresponding tabs in the external dialog.
26234 \begin_inset Flex Code
26237 \begin_layout Plain Layout
26243 command must have either a corresponding
26244 \begin_inset Flex Code
26247 \begin_layout Plain Layout
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26274 Otherwise the transformation will not be supported by that format.
26277 \begin_layout Subsection
26281 \begin_layout Description
26282 \begin_inset Flex Code
26285 \begin_layout Plain Layout
26287 \begin_inset space ~
26290 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26295 The primary document file format that this format definition is for.
26296 Not every template has a sensible representation in all document file formats.
26297 Please define nevertheless a
26298 \begin_inset Flex Code
26301 \begin_layout Plain Layout
26307 section for all templates.
26308 Use a dummy text when no representation is available.
26309 Then you can at least see a reference to the external material in the exported
26313 \begin_layout Description
26314 \begin_inset Flex Code
26317 \begin_layout Plain Layout
26319 \begin_inset space ~
26323 \begin_inset space ~
26331 This command defines an additional macro
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26341 for substitution in
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26353 \begin_inset Flex Code
26356 \begin_layout Plain Layout
26362 itself may contain substitution macros.
26363 The advantage over using
26364 \begin_inset Flex Code
26367 \begin_layout Plain Layout
26374 \begin_inset Flex Code
26377 \begin_layout Plain Layout
26383 is that the substituted value of
26384 \begin_inset Flex Code
26387 \begin_layout Plain Layout
26393 is sanitized so that it is a valid optional argument in the document format.
26394 This command may occur zero or more times.
26397 \begin_layout Description
26398 \begin_inset Flex Code
26401 \begin_layout Plain Layout
26403 \begin_inset space ~
26411 The text that is inserted in the exported document.
26412 This is actually the most important command and can be quite complex.
26413 This command must occur exactly once.
26416 \begin_layout Description
26417 \begin_inset Flex Code
26420 \begin_layout Plain Layout
26422 \begin_inset space ~
26430 This command specifies a preamble snippet that will be included in the
26433 It has to be defined using
26434 \begin_inset Flex Code
26437 \begin_layout Plain Layout
26445 \begin_inset Flex Code
26448 \begin_layout Plain Layout
26455 This command may occur zero or more times.
26458 \begin_layout Description
26459 \begin_inset Flex Code
26462 \begin_layout Plain Layout
26464 \begin_inset space ~
26468 \begin_inset space ~
26476 This command denotes files that are created by the conversion process and
26477 are needed for a particular export format.
26478 If the filename is relative, it is interpreted relative to the master document.
26479 This command may be given zero or more times.
26482 \begin_layout Description
26483 \begin_inset Flex Code
26486 \begin_layout Plain Layout
26488 \begin_inset space ~
26496 The name of a required \SpecialChar LaTeX
26498 The package is included via
26499 \begin_inset Flex Code
26502 \begin_layout Plain Layout
26510 in the \SpecialChar LaTeX
26512 This command may occur zero or more times.
26515 \begin_layout Description
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26521 \begin_inset space ~
26525 \begin_inset space ~
26528 RotationLatexCommand
26533 This command specifies that the built in \SpecialChar LaTeX
26534 command should be used for rotation.
26535 This command may occur once or not at all.
26538 \begin_layout Description
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26544 \begin_inset space ~
26548 \begin_inset space ~
26556 This command specifies that the built in \SpecialChar LaTeX
26557 command should be used for resizing.
26558 This command may occur once or not at all.
26561 \begin_layout Description
26562 \begin_inset Flex Code
26565 \begin_layout Plain Layout
26567 \begin_inset space ~
26571 \begin_inset space ~
26574 RotationLatexOption
26579 This command specifies that rotation is done via an optional argument.
26580 This command may occur once or not at all.
26583 \begin_layout Description
26584 \begin_inset Flex Code
26587 \begin_layout Plain Layout
26589 \begin_inset space ~
26593 \begin_inset space ~
26601 This command specifies that resizing is done via an optional argument.
26602 This command may occur once or not at all.
26605 \begin_layout Description
26606 \begin_inset Flex Code
26609 \begin_layout Plain Layout
26611 \begin_inset space ~
26615 \begin_inset space ~
26623 This command specifies that clipping is done via an optional argument.
26624 This command may occur once or not at all.
26627 \begin_layout Description
26628 \begin_inset Flex Code
26631 \begin_layout Plain Layout
26633 \begin_inset space ~
26637 \begin_inset space ~
26645 This command specifies that an extra optional argument is used.
26646 This command may occur once or not at all.
26649 \begin_layout Description
26650 \begin_inset Flex Code
26653 \begin_layout Plain Layout
26655 \begin_inset space ~
26663 The file format of the converted file.
26664 This must be the name of a format that is known to \SpecialChar LyX
26666 \begin_inset Flex Noun
26669 \begin_layout Plain Layout
26670 Tools\SpecialChar menuseparator
26671 Preferences\SpecialChar menuseparator
26672 File Handling\SpecialChar menuseparator
26679 This command must occur exactly once.
26680 If the resulting file format is PDF, you need to specify the format
26681 \begin_inset Flex Code
26684 \begin_layout Plain Layout
26691 This is the PDF format used for including graphics.
26692 The other defined PDF formats are for document export.
26695 \begin_layout Description
26696 \begin_inset Flex Code
26699 \begin_layout Plain Layout
26701 \begin_inset space ~
26709 The file name of the converted file.
26710 The file name must be absolute.
26711 This command must occur exactly once.
26714 \begin_layout Subsection
26715 Preamble definitions
26718 \begin_layout Standard
26719 The external template configuration file may contain additional preamble
26720 definitions enclosed by
26721 \begin_inset Flex Code
26724 \begin_layout Plain Layout
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26742 They can be used by the templates in the
26743 \begin_inset Flex Code
26746 \begin_layout Plain Layout
26755 \begin_layout Section
26756 The substitution mechanism
26759 \begin_layout Standard
26760 When the external material facility invokes an external program, it is done
26761 on the basis of a command defined in the template configuration file.
26762 These commands can contain various macros that are expanded before execution.
26763 Execution always take place in the directory of the containing document.
26766 \begin_layout Standard
26767 Also, whenever external material is to be displayed, the name will be produced
26768 by the substitution mechanism, and most other commands in the template
26769 definition support substitution as well.
26772 \begin_layout Standard
26773 The available macros are the following:
26776 \begin_layout Description
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26781 $$AbsOrRelPathMaster
26786 The file path, absolute or relative to the master \SpecialChar LyX
26790 \begin_layout Description
26791 \begin_inset Flex Code
26794 \begin_layout Plain Layout
26795 $$AbsOrRelPathParent
26800 The file path, absolute or relative to the \SpecialChar LyX
26804 \begin_layout Description
26805 \begin_inset Flex Code
26808 \begin_layout Plain Layout
26814 The absolute file path.
26817 \begin_layout Description
26818 \begin_inset Flex Code
26821 \begin_layout Plain Layout
26827 The filename without path and without the extension.
26830 \begin_layout Description
26831 \begin_inset Flex Code
26834 \begin_layout Plain Layout
26836 \begin_inset Quotes eld
26840 \begin_inset Quotes erd
26848 This macro will expand to the contents of the file with the name
26849 \begin_inset Flex Code
26852 \begin_layout Plain Layout
26861 \begin_layout Description
26862 \begin_inset Flex Code
26865 \begin_layout Plain Layout
26871 The file extension (including the dot).
26874 \begin_layout Description
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26884 This will be the string
26885 \begin_inset Quotes eld
26889 \begin_inset Quotes erd
26892 if the file is in JPEG format, otherwise it will be the string
26893 \begin_inset Quotes eld
26897 \begin_inset Quotes erd
26901 This is useful to avoid uneeded conversions for output formats that support
26902 both PNG and JPEG fomats.
26903 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26908 \begin_layout Description
26909 \begin_inset Flex Code
26912 \begin_layout Plain Layout
26918 The filename of the file specified in the external material dialog.
26919 This is either an absolute name, or it is relative to the \SpecialChar LyX
26923 \begin_layout Description
26924 \begin_inset Flex Code
26927 \begin_layout Plain Layout
26934 \begin_inset Flex Code
26937 \begin_layout Plain Layout
26943 (absolute name or relative to the \SpecialChar LyX
26947 \begin_layout Description
26948 \begin_inset Flex Code
26951 \begin_layout Plain Layout
26957 The file path, relative to the master \SpecialChar LyX
26961 \begin_layout Description
26962 \begin_inset Flex Code
26965 \begin_layout Plain Layout
26971 The file path, relative to the \SpecialChar LyX
26975 \begin_layout Description
26976 \begin_inset Flex Code
26979 \begin_layout Plain Layout
26985 This macro will expand to the absolute path of the system directory.
26986 This is typically used to point to the various helper scripts that are
26987 bundled with \SpecialChar LyX
26991 \begin_layout Description
26992 \begin_inset Flex Code
26995 \begin_layout Plain Layout
27001 A name and full path to a temporary file which will be automatically deleted
27002 whenever the containing document is closed, or the external material insertion
27006 \begin_layout Standard
27007 All path macros contain a trailing directory separator, so you can construct
27009 \begin_inset space \thinspace{}
27013 \begin_inset space \space{}
27016 the absolute filename with
27017 \begin_inset Flex Code
27020 \begin_layout Plain Layout
27021 $$AbsPath$$Basename$$Extension
27029 \begin_layout Standard
27030 The macros above are substituted in all commands unless otherwise noted.
27032 \begin_inset Flex Code
27035 \begin_layout Plain Layout
27041 supports additionally the following substitutions if they are enabled by
27043 \begin_inset Flex Code
27046 \begin_layout Plain Layout
27053 \begin_inset Flex Code
27056 \begin_layout Plain Layout
27065 \begin_layout Description
27066 \begin_inset Flex Code
27069 \begin_layout Plain Layout
27075 The front part of the resize command.
27078 \begin_layout Description
27079 \begin_inset Flex Code
27082 \begin_layout Plain Layout
27088 The back part of the resize command.
27091 \begin_layout Description
27092 \begin_inset Flex Code
27095 \begin_layout Plain Layout
27101 The front part of the rotation command.
27104 \begin_layout Description
27105 \begin_inset Flex Code
27108 \begin_layout Plain Layout
27114 The back part of the rotation command.
27117 \begin_layout Standard
27118 The value string of the
27119 \begin_inset Flex Code
27122 \begin_layout Plain Layout
27128 command supports additionally the following substitutions if they are enabled
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27140 \begin_inset Flex Code
27143 \begin_layout Plain Layout
27152 \begin_layout Description
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27165 \begin_layout Description
27166 \begin_inset Flex Code
27169 \begin_layout Plain Layout
27178 \begin_layout Description
27179 \begin_inset Flex Code
27182 \begin_layout Plain Layout
27191 \begin_layout Description
27192 \begin_inset Flex Code
27195 \begin_layout Plain Layout
27201 The rotation option.
27204 \begin_layout Standard
27205 You may ask why there are so many path macros.
27206 There are mainly two reasons:
27209 \begin_layout Enumerate
27210 Relative and absolute file names should remain relative or absolute, respectivel
27212 Users may have reasons to prefer either form.
27213 Relative names are useful for portable documents that should work on different
27214 machines, for example.
27215 Absolute names may be required by some programs.
27218 \begin_layout Enumerate
27220 treats relative file names differently than \SpecialChar LyX
27221 and other programs in nested
27223 For \SpecialChar LyX
27224 , a relative file name is always relative to the document that contains
27226 For \SpecialChar LaTeX
27227 , it is always relative to the master document.
27228 These two definitions are identical if you have only one document, but
27229 differ if you have a master document that includes part documents.
27230 That means that relative filenames must be transformed when presented to
27233 Fortunately \SpecialChar LyX
27234 does this automatically for you if you choose the right macros.
27237 \begin_layout Standard
27238 So which path macro should be used in new template definitions? The rule
27242 \begin_layout Itemize
27244 \begin_inset Flex Code
27247 \begin_layout Plain Layout
27253 if an absolute path is required.
27256 \begin_layout Itemize
27258 \begin_inset Flex Code
27261 \begin_layout Plain Layout
27262 $$AbsOrRelPathMaster
27267 if the substituted string is some kind of \SpecialChar LaTeX
27271 \begin_layout Itemize
27273 \begin_inset Flex Code
27276 \begin_layout Plain Layout
27277 $$AbsOrRelPathParent
27282 in order to preserve the user's choice.
27285 \begin_layout Standard
27286 There are special cases where this rule does not work and e.
27287 \begin_inset space \thinspace{}
27291 \begin_inset space \space{}
27294 relative names are needed, but normally it will work just fine.
27295 One example for such a case is the command
27296 \begin_inset Flex Code
27299 \begin_layout Plain Layout
27300 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27305 in the XFig template above: We can't use the absolute name because the
27307 \begin_inset Flex Code
27310 \begin_layout Plain Layout
27316 files needs the relative name in order to rewrite the file content.
27319 \begin_layout Section
27320 Security discussion
27321 \begin_inset CommandInset label
27323 name "sec:Security-discussion"
27330 \begin_layout Standard
27331 The external material feature interfaces with a lot of external programs
27332 and does so automatically, so we have to consider the security implications
27334 In particular, since you have the option of including your own filenames
27335 and/or parameter strings and those are expanded into a command, it seems
27336 that it would be possible to create a malicious document which executes
27337 arbitrary commands when a user views or prints the document.
27338 This is something we definitely want to avoid.
27341 \begin_layout Standard
27342 However, since the external program commands are specified in the template
27343 configuration file only, there are no security issues if \SpecialChar LyX
27344 is properly configure
27345 d with safe templates only.
27346 This is so because the external programs are invoked with the
27347 \begin_inset Flex Code
27350 \begin_layout Plain Layout
27356 -system call rather than the
27357 \begin_inset Flex Code
27360 \begin_layout Plain Layout
27366 system-call, so it's not possible to execute arbitrary commands from the
27367 filename or parameter section via the shell.
27370 \begin_layout Standard
27371 This also implies that you are restricted in what command strings you can
27372 use in the external material templates.
27373 In particular, pipes and redirection are not readily available.
27374 This has to be so if \SpecialChar LyX
27375 should remain safe.
27376 If you want to use some of the shell features, you should write a safe
27377 script to do this in a controlled manner, and then invoke the script from
27378 the command string.
27382 \begin_layout Standard
27383 It is possible to design a template that interacts directly with the shell,
27384 but since this would allow a malicious user to execute arbitrary commands
27385 by writing clever filenames and/or parameters, we generally recommend that
27386 you only use safe scripts that work with the
27387 \begin_inset Flex Code
27390 \begin_layout Plain Layout
27396 system call in a controlled manner.
27397 Of course, for use in a controlled environment, it can be tempting to just
27398 fall back to use ordinary shell scripts.
27399 If you do so, be aware that you
27403 provide an easily exploitable security hole in your system.
27404 Of course it stands to reason that such unsafe templates will never be
27405 included in the standard \SpecialChar LyX
27406 distribution, although we do encourage people
27407 to submit new templates in the open source tradition.
27408 But \SpecialChar LyX
27409 as shipped from the official distribution channels will never have
27413 \begin_layout Standard
27414 Including external material provides a lot of power, and you have to be
27415 careful not to introduce security hazards with this power.
27416 A subtle error in a single line in an innocent looking script can open
27417 the door to huge security problems.
27418 So if you do not fully understand the issues, we recommend that you consult
27419 a knowledgeable security professional or the \SpecialChar LyX
27420 development team if you have
27421 any questions about whether a given template is safe or not.
27422 And do this before you use it in an uncontrolled environment.
27425 \begin_layout Chapter
27427 List of supported \SpecialChar LyX
27428 functions to be used in layouts
27429 \begin_inset CommandInset label
27431 name "chap:List-of-functions"
27438 \begin_layout Standard
27440 \begin_inset Tabular
27441 <lyxtabular version="3" rows="11" columns="8">
27442 <features tabularvalignment="middle">
27443 <column alignment="left" valignment="top">
27444 <column alignment="left" valignment="top">
27445 <column alignment="left" valignment="top">
27446 <column alignment="left" valignment="top">
27447 <column alignment="left" valignment="top">
27448 <column alignment="left" valignment="top">
27449 <column alignment="left" valignment="top">
27450 <column alignment="left" valignment="top">
27452 <cell alignment="left" valignment="top" usebox="none">
27455 \begin_layout Plain Layout
27461 <cell alignment="left" valignment="top" usebox="none">
27464 \begin_layout Plain Layout
27470 <cell alignment="left" valignment="top" usebox="none">
27473 \begin_layout Plain Layout
27479 <cell alignment="left" valignment="top" usebox="none">
27482 \begin_layout Plain Layout
27488 <cell alignment="center" valignment="top" usebox="none">
27491 \begin_layout Plain Layout
27497 <cell alignment="center" valignment="top" usebox="none">
27500 \begin_layout Plain Layout
27506 <cell alignment="center" valignment="top" usebox="none">
27509 \begin_layout Plain Layout
27515 <cell alignment="center" valignment="top" usebox="none">
27518 \begin_layout Plain Layout
27526 <cell alignment="left" valignment="top" usebox="none">
27529 \begin_layout Plain Layout
27535 <cell alignment="left" valignment="top" usebox="none">
27538 \begin_layout Plain Layout
27544 <cell alignment="left" valignment="top" usebox="none">
27547 \begin_layout Plain Layout
27553 <cell alignment="left" valignment="top" usebox="none">
27556 \begin_layout Plain Layout
27562 <cell alignment="center" valignment="top" usebox="none">
27565 \begin_layout Plain Layout
27571 <cell alignment="center" valignment="top" usebox="none">
27574 \begin_layout Plain Layout
27580 <cell alignment="center" valignment="top" usebox="none">
27583 \begin_layout Plain Layout
27589 <cell alignment="center" valignment="top" usebox="none">
27592 \begin_layout Plain Layout
27600 <cell alignment="left" valignment="top" usebox="none">
27603 \begin_layout Plain Layout
27609 <cell alignment="left" valignment="top" usebox="none">
27612 \begin_layout Plain Layout
27618 <cell alignment="left" valignment="top" usebox="none">
27621 \begin_layout Plain Layout
27627 <cell alignment="left" valignment="top" usebox="none">
27630 \begin_layout Plain Layout
27636 <cell alignment="center" valignment="top" usebox="none">
27639 \begin_layout Plain Layout
27645 <cell alignment="center" valignment="top" usebox="none">
27648 \begin_layout Plain Layout
27654 <cell alignment="center" valignment="top" usebox="none">
27657 \begin_layout Plain Layout
27663 <cell alignment="center" valignment="top" usebox="none">
27666 \begin_layout Plain Layout
27674 <cell alignment="left" valignment="top" usebox="none">
27677 \begin_layout Plain Layout
27683 <cell alignment="left" valignment="top" usebox="none">
27686 \begin_layout Plain Layout
27692 <cell alignment="left" valignment="top" usebox="none">
27695 \begin_layout Plain Layout
27701 <cell alignment="left" valignment="top" usebox="none">
27704 \begin_layout Plain Layout
27710 <cell alignment="center" valignment="top" usebox="none">
27713 \begin_layout Plain Layout
27719 <cell alignment="center" valignment="top" usebox="none">
27722 \begin_layout Plain Layout
27728 <cell alignment="center" valignment="top" usebox="none">
27731 \begin_layout Plain Layout
27737 <cell alignment="center" valignment="top" usebox="none">
27740 \begin_layout Plain Layout
27748 <cell alignment="left" valignment="top" usebox="none">
27751 \begin_layout Plain Layout
27757 <cell alignment="left" valignment="top" usebox="none">
27760 \begin_layout Plain Layout
27766 <cell alignment="left" valignment="top" usebox="none">
27769 \begin_layout Plain Layout
27775 <cell alignment="left" valignment="top" usebox="none">
27778 \begin_layout Plain Layout
27784 <cell alignment="center" valignment="top" usebox="none">
27787 \begin_layout Plain Layout
27793 <cell alignment="center" valignment="top" usebox="none">
27796 \begin_layout Plain Layout
27802 <cell alignment="center" valignment="top" usebox="none">
27805 \begin_layout Plain Layout
27811 <cell alignment="center" valignment="top" usebox="none">
27814 \begin_layout Plain Layout
27822 <cell alignment="left" valignment="top" usebox="none">
27825 \begin_layout Plain Layout
27831 <cell alignment="left" valignment="top" usebox="none">
27834 \begin_layout Plain Layout
27840 <cell alignment="left" valignment="top" usebox="none">
27843 \begin_layout Plain Layout
27849 <cell alignment="left" valignment="top" usebox="none">
27852 \begin_layout Plain Layout
27858 <cell alignment="center" valignment="top" usebox="none">
27861 \begin_layout Plain Layout
27867 <cell alignment="center" valignment="top" usebox="none">
27870 \begin_layout Plain Layout
27876 <cell alignment="center" valignment="top" usebox="none">
27879 \begin_layout Plain Layout
27885 <cell alignment="center" valignment="top" usebox="none">
27888 \begin_layout Plain Layout
27896 <cell alignment="left" valignment="top" usebox="none">
27899 \begin_layout Plain Layout
27905 <cell alignment="left" valignment="top" usebox="none">
27908 \begin_layout Plain Layout
27914 <cell alignment="left" valignment="top" usebox="none">
27917 \begin_layout Plain Layout
27923 <cell alignment="left" valignment="top" usebox="none">
27926 \begin_layout Plain Layout
27932 <cell alignment="center" valignment="top" usebox="none">
27935 \begin_layout Plain Layout
27941 <cell alignment="center" valignment="top" usebox="none">
27944 \begin_layout Plain Layout
27950 <cell alignment="center" valignment="top" usebox="none">
27953 \begin_layout Plain Layout
27959 <cell alignment="center" valignment="top" usebox="none">
27962 \begin_layout Plain Layout
27970 <cell alignment="left" valignment="top" usebox="none">
27973 \begin_layout Plain Layout
27979 <cell alignment="left" valignment="top" usebox="none">
27982 \begin_layout Plain Layout
27988 <cell alignment="left" valignment="top" usebox="none">
27991 \begin_layout Plain Layout
27997 <cell alignment="left" valignment="top" usebox="none">
28000 \begin_layout Plain Layout
28006 <cell alignment="center" valignment="top" usebox="none">
28009 \begin_layout Plain Layout
28015 <cell alignment="center" valignment="top" usebox="none">
28018 \begin_layout Plain Layout
28024 <cell alignment="center" valignment="top" usebox="none">
28027 \begin_layout Plain Layout
28033 <cell alignment="center" valignment="top" usebox="none">
28036 \begin_layout Plain Layout
28044 <cell alignment="left" valignment="top" usebox="none">
28047 \begin_layout Plain Layout
28053 <cell alignment="left" valignment="top" usebox="none">
28056 \begin_layout Plain Layout
28062 <cell alignment="left" valignment="top" usebox="none">
28065 \begin_layout Plain Layout
28071 <cell alignment="left" valignment="top" usebox="none">
28074 \begin_layout Plain Layout
28080 <cell alignment="center" valignment="top" usebox="none">
28083 \begin_layout Plain Layout
28089 <cell alignment="center" valignment="top" usebox="none">
28092 \begin_layout Plain Layout
28098 <cell alignment="center" valignment="top" usebox="none">
28101 \begin_layout Plain Layout
28107 <cell alignment="center" valignment="top" usebox="none">
28110 \begin_layout Plain Layout
28118 <cell alignment="left" valignment="top" usebox="none">
28121 \begin_layout Plain Layout
28127 <cell alignment="left" valignment="top" usebox="none">
28130 \begin_layout Plain Layout
28136 <cell alignment="left" valignment="top" usebox="none">
28139 \begin_layout Plain Layout
28145 <cell alignment="left" valignment="top" usebox="none">
28148 \begin_layout Plain Layout
28154 <cell alignment="center" valignment="top" usebox="none">
28157 \begin_layout Plain Layout
28163 <cell alignment="center" valignment="top" usebox="none">
28166 \begin_layout Plain Layout
28172 <cell alignment="center" valignment="top" usebox="none">
28175 \begin_layout Plain Layout
28181 <cell alignment="center" valignment="top" usebox="none">
28184 \begin_layout Plain Layout
28192 <cell alignment="center" valignment="top" usebox="none">
28195 \begin_layout Plain Layout
28201 <cell alignment="center" valignment="top" usebox="none">
28204 \begin_layout Plain Layout
28210 <cell alignment="center" valignment="top" usebox="none">
28213 \begin_layout Plain Layout
28219 <cell alignment="center" valignment="top" usebox="none">
28222 \begin_layout Plain Layout
28228 <cell alignment="center" valignment="top" usebox="none">
28231 \begin_layout Plain Layout
28237 <cell alignment="center" valignment="top" usebox="none">
28240 \begin_layout Plain Layout
28246 <cell alignment="center" valignment="top" usebox="none">
28249 \begin_layout Plain Layout
28255 <cell alignment="center" valignment="top" usebox="none">
28258 \begin_layout Plain Layout
28272 \begin_layout Chapter
28273 Names of available colors to be used in layouts
28274 \begin_inset CommandInset label
28276 name "chap:Names-of-colors"
28283 \begin_layout Standard
28284 The colors listed below are the standard colors and those that you can adjust
28285 in the \SpecialChar LyX
28289 \begin_layout Section
28293 \begin_layout Standard
28294 The following are no real colors, but rather act on color definitions:
28297 \begin_layout Description
28298 ignore The color is ignored
28301 \begin_layout Description
28302 inherit The color is inherited
28305 \begin_layout Description
28318 No particular color – clear or default
28321 \begin_layout Section
28325 \begin_layout Standard
28326 These are fixed colors that cannot me customized:
28329 \begin_layout Description
28333 \begin_layout Description
28337 \begin_layout Description
28341 \begin_layout Description
28345 \begin_layout Description
28349 \begin_layout Description
28353 \begin_layout Description
28357 \begin_layout Description
28361 \begin_layout Description
28365 \begin_layout Description
28369 \begin_layout Description
28373 \begin_layout Description
28377 \begin_layout Description
28381 \begin_layout Description
28385 \begin_layout Description
28389 \begin_layout Description
28393 \begin_layout Description
28397 \begin_layout Description
28401 \begin_layout Description
28405 \begin_layout Section
28409 \begin_layout Standard
28410 These are the colors allocated to specific elements in
28413 arg "dialog-show prefs"
28419 \begin_layout Description
28420 added_space Added space color
28423 \begin_layout Description
28424 addedtext Added text color
28427 \begin_layout Description
28428 appendix Appendix marker color
28431 \begin_layout Description
28432 background Background color
28435 \begin_layout Description
28436 bottomarea Bottom area color
28439 \begin_layout Description
28440 branchlabel Label color for branches
28443 \begin_layout Description
28444 buttonbg Color used for button background
28447 \begin_layout Description
28448 buttonframe Color for inset button frames
28451 \begin_layout Description
28452 buttonhoverbg Color used for button background under focus
28455 \begin_layout Description
28456 changebar Changebar color
28459 \begin_layout Description
28460 changedtextauthor1 Changed text color author 1
28463 \begin_layout Description
28464 changedtextauthor2 Changed text color author 2
28467 \begin_layout Description
28468 changedtextauthor3 Changed text color author 3
28471 \begin_layout Description
28472 changedtextauthor4 Changed text color author 4
28475 \begin_layout Description
28476 changedtextauthor5 Changed text color author 5
28479 \begin_layout Description
28480 collapsible Collapsible insets text color
28483 \begin_layout Description
28484 collapsibleframe Collapsible insets framecolor
28487 \begin_layout Description
28488 command Text color for command insets
28491 \begin_layout Description
28492 commandbg Background color for command insets
28495 \begin_layout Description
28496 commandframe Frame color for command insets
28499 \begin_layout Description
28500 comment Label color for comments
28503 \begin_layout Description
28504 commentbg Background color of comments
28507 \begin_layout Description
28508 cursor Cursor color
28511 \begin_layout Description
28512 deletedtext Deleted text color
28515 \begin_layout Description
28516 deletedtextmodifier Deleted text modifying color
28519 \begin_layout Description
28520 depthbar Color for the depth bars in the margin
28523 \begin_layout Description
28524 eolmarker End of line marker color
28527 \begin_layout Description
28528 error Color of the \SpecialChar LaTeX
28532 \begin_layout Description
28533 footlabel Label color for footnotes
28536 \begin_layout Description
28537 foreground Foreground color
28540 \begin_layout Description
28541 graphicsbg Graphics inset background color
28544 \begin_layout Description
28545 greyedoutbg Background color of greyedout inset
28548 \begin_layout Description
28549 greyedoutlabel Label color for greyedout insets
28552 \begin_layout Description
28553 greyedouttext Color for greyedout inset text
28556 \begin_layout Description
28557 indexlabel Label color for index insets
28560 \begin_layout Description
28561 inlinecompletion Inline completion color
28564 \begin_layout Description
28565 insetbg Inset marker background color
28568 \begin_layout Description
28569 insetframe Inset marker frame color
28572 \begin_layout Description
28573 language Color for marking foreign language words
28576 \begin_layout Description
28577 latex Text color in \SpecialChar LaTeX
28581 \begin_layout Description
28582 listingsbg Background color of listings inset
28585 \begin_layout Description
28586 marginlabel Label color for margin notes
28589 \begin_layout Description
28590 math Math inset text color
28593 \begin_layout Description
28594 mathbg Math inset background color
28597 \begin_layout Description
28598 mathcorners Math inset frame color not under focus
28601 \begin_layout Description
28602 mathframe Math inset frame color under focus
28605 \begin_layout Description
28606 mathline Math line color
28609 \begin_layout Description
28610 mathmacrobg Macro math inset background color
28613 \begin_layout Description
28614 mathmacroblend Macro math blended color
28617 \begin_layout Description
28618 mathmacroframe Macro math frame color
28621 \begin_layout Description
28622 mathmacrohoverbg Macro math inset background color hovered
28625 \begin_layout Description
28626 mathmacrolabel Macro math label color
28629 \begin_layout Description
28630 mathmacronewarg Macro template color for new parameters
28633 \begin_layout Description
28634 mathmacrooldarg Macro template color for old parameters
28637 \begin_layout Description
28638 newpage New page color
28641 \begin_layout Description
28642 nonunique_inlinecompletion Inline completion color for the non-unique part
28645 \begin_layout Description
28646 note Label color for notes
28649 \begin_layout Description
28650 notebg Background color of notes
28653 \begin_layout Description
28654 pagebreak Page break/line break color
28657 \begin_layout Description
28658 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28661 \begin_layout Description
28662 phantomtext Text color for phantom insets
28665 \begin_layout Description
28666 preview The color used for previews
28669 \begin_layout Description
28670 previewframe Preview frame color
28673 \begin_layout Description
28674 regexpframe Color for regexp frame
28677 \begin_layout Description
28678 scroll Color that indicates when a row can be scrolled
28681 \begin_layout Description
28682 selection Background color of selected text
28685 \begin_layout Description
28686 selectiontext Foreground color of selected text
28689 \begin_layout Description
28690 shadedbg Background color of shaded box
28693 \begin_layout Description
28694 special Special chars text color
28697 \begin_layout Description
28698 tabularline Table line color
28701 \begin_layout Description
28702 tabularonoffline Table line color
28705 \begin_layout Description
28706 urllabel Label color for URL insets
28709 \begin_layout Description
28710 urltext Color for URL inset text