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"
133 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
139 Customizing \SpecialChar LyX
140 : Features for the Advanced User
144 by the \SpecialChar LyX
149 \begin_layout Plain Layout
151 If you have comments or error corrections, please send them to the \SpecialChar LyX
154 \begin_inset CommandInset href
156 target "lyx-docs@lists.lyx.org"
164 \begin_inset Quotes eld
168 \begin_inset Quotes erd
171 in the subject header, and please cc the current maintainer of this file,
172 Richard Heck <rgheck@comcast.net>.
178 \begin_inset Newline newline
182 \begin_inset Newline newline
188 \begin_layout Standard
189 \begin_inset CommandInset toc
190 LatexCommand tableofcontents
197 \begin_layout Standard
198 \begin_inset Note Note
201 \begin_layout Plain Layout
202 Please use change tracking when modifying this document.
203 This makes it easier for our translators to recognize things that have
204 been changed, and it helps the maintainer keep up-to-date with what's been
213 \begin_layout Chapter
217 \begin_layout Standard
218 This manual covers the customization features present in \SpecialChar LyX
220 In it, we discuss issues like keyboard shortcuts, screen previewing options,
221 printer options, sending commands to \SpecialChar LyX
222 via the \SpecialChar LyX
223 Server, internationalization,
224 installing new \SpecialChar LaTeX
225 classes and \SpecialChar LyX
227 We can't possibly hope to touch on everything you can change—our developers
228 add new features faster than we can document them—but we will explain the
229 most common customizations and hopefully point you in the right direction
230 for some of the more obscure ones.
233 \begin_layout Standard
234 \begin_inset Branch OutDated
238 \begin_layout Standard
239 Information from previous versions of this document that now seems to be
240 outdated is contained in the OutDated branch of this document.
241 By default, this information will not appear in the \SpecialChar LaTeX
250 \begin_layout Chapter
255 \begin_layout Standard
256 This chapter aims to help you to find your way through the \SpecialChar LyX
259 Before continuing to read this chapter, you should find out where your
261 library and user directories are by using
262 \begin_inset Flex Noun
265 \begin_layout Plain Layout
266 Help\SpecialChar menuseparator
277 The library directory is the place where \SpecialChar LyX
278 places its system-wide configuration
279 files; the user directory is where you can place your modified versions.
280 We will call the former
281 \begin_inset Flex Code
284 \begin_layout Plain Layout
291 \begin_inset Flex Noun
294 \begin_layout Plain Layout
300 in the remainder of this document.
304 \begin_layout Section
306 \begin_inset Flex Code
309 \begin_layout Plain Layout
318 \begin_layout Standard
319 \begin_inset Flex Code
322 \begin_layout Plain Layout
328 and its sub-directories contain a number of files and that can be used
329 to customize \SpecialChar LyX
331 You can change many of these files from within \SpecialChar LyX
333 \begin_inset Flex Noun
336 \begin_layout Plain Layout
337 Tools\SpecialChar menuseparator
344 Most customization that you will want to do in \SpecialChar LyX
345 is possible through this
347 However, many other inner aspects of \SpecialChar LyX
348 can be customized by modifying the
350 \begin_inset Flex Code
353 \begin_layout Plain Layout
360 These files fall in different categories, described in the following subsection
364 \begin_layout Subsection
365 Automatically generated files
368 \begin_layout Standard
369 The files, which are to be found in
370 \begin_inset Flex Noun
373 \begin_layout Plain Layout
379 , are generated when you configure \SpecialChar LyX
381 They contain various default values that are guessed by inspection.
382 In general, it is not a good idea to modify them, since they might be overwritt
386 \begin_layout Labeling
387 \labelwidthstring 00.00.0000
388 \begin_inset Flex Code
391 \begin_layout Plain Layout
397 contains defaults for various commands.
400 \begin_layout Labeling
401 \labelwidthstring 00.00.0000
402 \begin_inset Flex Code
405 \begin_layout Plain Layout
411 contains the list of packages that have been recognized by \SpecialChar LyX
413 It is currently unused by the \SpecialChar LyX
414 program itself, but the information extracted,
415 and more, is made available with
416 \begin_inset Flex Noun
419 \begin_layout Plain Layout
420 Help\SpecialChar menuseparator
434 \begin_layout Labeling
435 \labelwidthstring 00.00.0000
436 \begin_inset Flex Code
439 \begin_layout Plain Layout
445 the list of text classes that have been found in your
446 \begin_inset Flex Code
449 \begin_layout Plain Layout
455 directories, along with the associated \SpecialChar LaTeX
456 document class and their description.
459 \begin_layout Labeling
460 \labelwidthstring 00.00.0000
461 \begin_inset Flex Code
464 \begin_layout Plain Layout
470 the list of layout modules found in your
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
483 \begin_layout Labeling
484 \labelwidthstring 00.00.0000
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
494 lists of various sorts of \SpecialChar LaTeX
495 -related files found on your system
498 \begin_layout Labeling
499 \labelwidthstring 00.00.0000
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
504 doc/\SpecialChar LaTeX
510 is automatically generated during configuration from the file
511 \begin_inset Flex Code
514 \begin_layout Plain Layout
522 It contains information on your \SpecialChar LaTeX
526 \begin_layout Subsection
530 \begin_layout Standard
531 These directories are duplicated between
532 \begin_inset Flex Code
535 \begin_layout Plain Layout
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
552 If a particular files exists in both places, the one in
553 \begin_inset Flex Code
556 \begin_layout Plain Layout
565 \begin_layout Labeling
566 \labelwidthstring 00.00.0000
567 \begin_inset Flex Code
570 \begin_layout Plain Layout
576 this directory contains files with the extension
577 \begin_inset Flex Code
580 \begin_layout Plain Layout
586 that define the keybindings used in \SpecialChar LyX
588 If there exists an internationalized version of the bind file named
589 \begin_inset Flex Code
592 \begin_layout Plain Layout
598 , that will be used first.
601 \begin_layout Labeling
602 \labelwidthstring 00.00.0000
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
612 contains files with the extension
613 \begin_inset Flex Code
616 \begin_layout Plain Layout
622 which define the diverse citation possibilities (natbib, biblatex etc.).
624 \begin_inset CommandInset ref
626 reference "subsec:Cite-Engine-Files"
636 \begin_layout Labeling
637 \labelwidthstring 00.00.0000
638 \begin_inset Flex Code
641 \begin_layout Plain Layout
647 contains graphics files that can be included in documents.
651 \begin_layout Labeling
652 \labelwidthstring 00.00.0000
653 \begin_inset Flex Code
656 \begin_layout Plain Layout
662 contains \SpecialChar LyX
663 documentation files (including the one you are currently reading).
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
675 deserves special attention, as noted above.
676 The internationalized help docs are in subdirectories
677 \begin_inset Flex Code
680 \begin_layout Plain Layout
687 \begin_inset Quotes eld
691 \begin_inset Quotes erd
694 is the ISO language code.
696 \begin_inset CommandInset ref
698 reference "cha:Internationalizing-LyX"
705 \begin_layout Labeling
706 \labelwidthstring 00.00.0000
707 \begin_inset Flex Code
710 \begin_layout Plain Layout
716 contains example files that explain how to use some features.
717 In the file browser, press the
718 \begin_inset Flex Noun
721 \begin_layout Plain Layout
730 \begin_layout Labeling
731 \labelwidthstring 00.00.0000
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
741 contains image files that are used by the
742 \begin_inset Flex Noun
745 \begin_layout Plain Layout
752 In addition, it also contains the individual icons used in the toolbar
753 and the banners that can be shown when \SpecialChar LyX
757 \begin_layout Labeling
758 \labelwidthstring 00.00.0000
759 \begin_inset Flex Code
762 \begin_layout Plain Layout
768 contains keyboard keymapping files.
770 \begin_inset CommandInset ref
772 reference "sec:International-Keymap-Stuff"
779 \begin_layout Labeling
780 \labelwidthstring 00.00.0000
781 \begin_inset Flex Code
784 \begin_layout Plain Layout
790 contains the text class and module files described in
791 \begin_inset CommandInset ref
793 reference "cha:Installing-New-Document"
800 \begin_layout Labeling
801 \labelwidthstring 00.00.0000
802 \begin_inset Flex Code
805 \begin_layout Plain Layout
812 \begin_inset Flex Code
815 \begin_layout Plain Layout
821 Python scripts used to convert between \SpecialChar LyX
823 These can be run from the command line if, say, you want to batch-convert
827 \begin_layout Labeling
828 \labelwidthstring 00.00.0000
829 \begin_inset Flex Code
832 \begin_layout Plain Layout
838 contains some files that demonstrate the capabilities of the
839 \begin_inset Flex Noun
842 \begin_layout Plain Layout
853 Also contains some scripts used by \SpecialChar LyX
857 \begin_layout Labeling
858 \labelwidthstring 00.00.0000
859 \begin_inset Flex Code
862 \begin_layout Plain Layout
868 contains the standard \SpecialChar LyX
869 template files described in
870 \begin_inset CommandInset ref
872 reference "subsec:Creating-Templates"
879 \begin_layout Labeling
880 \labelwidthstring 00.00.0000
881 \begin_inset Flex Code
884 \begin_layout Plain Layout
890 contains files with the extension
891 \begin_inset Flex Code
894 \begin_layout Plain Layout
900 that define the user interface to \SpecialChar LyX
902 That is, the files define which items appear in which menus and the items
903 appearing on the toolbar.
906 \begin_layout Labeling
907 \labelwidthstring 00.00.0000
908 \begin_inset Flex Code
911 \begin_layout Plain Layout
917 contains files with the extension
918 \begin_inset Flex Code
921 \begin_layout Plain Layout
927 which define the templates for the insertion of external material to a
930 \begin_inset CommandInset ref
932 reference "chap:Including-External-Material"
939 \begin_layout Subsection
940 Files you don't want to modify
943 \begin_layout Standard
944 These files are used internally by \SpecialChar LyX
945 and you generally do not need to modify
946 them unless you are a developer.
949 \begin_layout Labeling
950 \labelwidthstring 00.00.0000
951 \begin_inset Flex Code
954 \begin_layout Plain Layout
960 this file contains the list of \SpecialChar LyX
962 The contents are displayed with the menu entry
963 \begin_inset Flex Noun
966 \begin_layout Plain Layout
967 Help\SpecialChar menuseparator
980 \begin_layout Labeling
981 \labelwidthstring 00.00.0000
982 \begin_inset Flex Code
985 \begin_layout Plain Layout
991 this is a \SpecialChar LaTeX
992 script used during the configuration process.
996 \begin_layout Labeling
997 \labelwidthstring 00.00.0000
998 \begin_inset Flex Code
1001 \begin_layout Plain Layout
1007 this is a Python script that is used to re-configure \SpecialChar LyX
1009 It creates configuration files in the directory it was run from.
1012 \begin_layout Subsection
1013 Other files needing a line or two
1016 \begin_layout Labeling
1017 \labelwidthstring 00.00.0000
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1027 this contains tables describing how different character encodings can be
1031 \begin_layout Labeling
1032 \labelwidthstring 00.00.0000
1033 \begin_inset Flex Code
1036 \begin_layout Plain Layout
1042 this file contains a list of all the languages currently supported by \SpecialChar LyX
1046 \begin_layout Labeling
1047 \labelwidthstring 00.00.0000
1048 \begin_inset Flex Code
1051 \begin_layout Plain Layout
1057 contains information about the supported fonts.
1060 \begin_layout Labeling
1061 \labelwidthstring 00.00.0000
1062 \begin_inset Flex Code
1065 \begin_layout Plain Layout
1071 this file contains translations for internationalized paragraph styles
1073 \begin_inset CommandInset ref
1075 reference "subsec:I18n"
1082 \begin_layout Labeling
1083 \labelwidthstring 00.00.0000
1084 \begin_inset Flex Code
1087 \begin_layout Plain Layout
1093 this file contains information about Unicode-encoded glyphs and the way
1094 they are supported by \SpecialChar LyX
1095 via \SpecialChar LaTeX
1099 \begin_layout Section
1100 Your local configuration directory
1103 \begin_layout Standard
1104 Even if you are using \SpecialChar LyX
1105 as an unprivileged user, you might want to change
1107 configuration for your own use.
1109 \begin_inset Flex Code
1112 \begin_layout Plain Layout
1118 directory contains all your personal configuration files.
1119 This is the directory described as
1120 \begin_inset Quotes eld
1124 \begin_inset Quotes erd
1128 \begin_inset Flex Noun
1131 \begin_layout Plain Layout
1132 Help\SpecialChar menuseparator
1134 \begin_inset space ~
1143 This directory is used as a mirror of
1144 \begin_inset Flex Code
1147 \begin_layout Plain Layout
1153 , which means that every file in
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1163 is a replacement for the corresponding file in
1164 \begin_inset Flex Code
1167 \begin_layout Plain Layout
1174 Any configuration file described in the above sections can be placed either
1175 in the system-wide directory, in which case it will affect all users, or
1176 in your local directory for your own use.
1179 \begin_layout Standard
1180 To make things clearer, let's provide a few examples:
1183 \begin_layout Itemize
1184 The preferences set in the
1185 \begin_inset Flex Noun
1188 \begin_layout Plain Layout
1189 Tools\SpecialChar menuseparator
1195 dialog are saved to a file
1196 \begin_inset Flex Code
1199 \begin_layout Plain Layout
1206 \begin_inset Flex Code
1209 \begin_layout Plain Layout
1218 \begin_layout Itemize
1219 When you reconfigure using
1220 \begin_inset Flex Noun
1223 \begin_layout Plain Layout
1224 Tools\SpecialChar menuseparator
1232 \begin_inset Flex Code
1235 \begin_layout Plain Layout
1241 script, and the resulting files are written in your local configuration
1243 This means that any additional text class file that you might have added
1245 \begin_inset Flex Code
1248 \begin_layout Plain Layout
1254 will be added to the list of classes in the
1255 \begin_inset Flex Noun
1258 \begin_layout Plain Layout
1259 Document\SpecialChar menuseparator
1268 \begin_layout Itemize
1269 If you get some updated documentation from \SpecialChar LyX
1270 ftp site and cannot install
1271 it because you do not have sysadmin rights on your system, you can just
1273 \begin_inset Flex Code
1276 \begin_layout Plain Layout
1282 and the items in the
1283 \begin_inset Flex Noun
1286 \begin_layout Plain Layout
1292 menu will open them!
1295 \begin_layout Section
1296 Running \SpecialChar LyX
1297 with multiple configurations
1300 \begin_layout Standard
1301 The configuration freedom of the local configuration directory may not suffice
1302 if you want to have more than one configuration at your disposal.
1303 For example, you may want to be use different key bindings or printer settings
1305 You can achieve this by having several such directories.
1306 You then specify which directory to use at run-time.
1309 \begin_layout Standard
1310 Invoking \SpecialChar LyX
1311 with the command line switch
1312 \begin_inset Flex Code
1315 \begin_layout Plain Layout
1325 instructs the program to read the configuration from that directory, and
1326 not from the default directory.
1327 (You can determine the default directory by running \SpecialChar LyX
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1338 switch.) If the specified directory does not exist, \SpecialChar LyX
1340 for you, just like it does for the default directory on the first time
1341 you run the program.
1342 You can modify the configuration options in this additional user directory
1343 exactly as you would for the default directory.
1344 These directories are completely independent (but read on).
1345 Note that setting the environment variable
1346 \begin_inset Flex Code
1349 \begin_layout Plain Layout
1355 to some value has exactly the same effect.
1358 \begin_layout Standard
1359 Having several configurations also requires more maintenance: if you want
1360 to add a new layout to
1361 \begin_inset Flex Code
1364 \begin_layout Plain Layout
1370 which you want available from all your configurations, you must add it
1371 to each directory separately.
1372 You can avoid this with the following trick: after \SpecialChar LyX
1373 creates the additional
1374 directory, most of the subdirectories (see above) are empty.
1375 If you want the new configuration to mirror an existing one, replace the
1376 empty subdirectory with a symbolic link to the matching subdirectory in
1377 the existing configuration.
1379 \begin_inset Flex Code
1382 \begin_layout Plain Layout
1388 subdirectory, however, since it contains a file written by the configuration
1389 script (also accessible through
1390 \begin_inset Flex Noun
1393 \begin_layout Plain Layout
1394 Tools\SpecialChar menuseparator
1400 ) which is configuration-specific.
1403 \begin_layout Chapter
1404 The Preferences dialog
1407 \begin_layout Standard
1408 All options of the preferences dialog are described in the Appendix
1410 The Preferences Dialog
1417 For some options you might find here more details.
1420 \begin_layout Section
1422 \begin_inset CommandInset label
1431 \begin_layout Standard
1432 The first step is to define your file formats if they are not already defined.
1434 \begin_inset Flex Noun
1437 \begin_layout Plain Layout
1438 Tools\SpecialChar menuseparator
1446 \begin_inset Flex Noun
1449 \begin_layout Plain Layout
1450 File Handling\SpecialChar menuseparator
1457 \begin_inset Flex Noun
1460 \begin_layout Plain Layout
1466 button to define your new format.
1468 \begin_inset Flex Noun
1471 \begin_layout Plain Layout
1477 field contains the name used to identify the format in the GUI.
1479 \begin_inset Flex Noun
1482 \begin_layout Plain Layout
1488 is used to identify the format internally.
1489 You will also need to enter a file extension.
1490 These are all required.
1492 \begin_inset Flex Noun
1495 \begin_layout Plain Layout
1501 field is used to provide a keyboard shortcut on the menus.
1502 (For example, pressing
1503 \begin_inset Flex Noun
1506 \begin_layout Plain Layout
1513 \begin_inset Flex Noun
1516 \begin_layout Plain Layout
1517 Document\SpecialChar menuseparator
1518 View (Other Formats)\SpecialChar menuseparator
1527 \begin_layout Standard
1529 \begin_inset Flex Noun
1532 \begin_layout Plain Layout
1539 \begin_inset Flex Noun
1542 \begin_layout Plain Layout
1549 For example, you might want to use
1550 \begin_inset Flex Noun
1553 \begin_layout Plain Layout
1559 to view PostScript files.
1560 You can enter the command needed to start the program in the corresponding
1562 In defining this command, you can use the four variables listed in the
1564 The viewer is launched when you view an image in \SpecialChar LyX
1566 \begin_inset Flex Noun
1569 \begin_layout Plain Layout
1570 Document\SpecialChar menuseparator
1577 The editor is for example launched when you right-click on an image and
1579 \begin_inset Flex Noun
1582 \begin_layout Plain Layout
1588 in the appearing context menu.
1591 \begin_layout Standard
1593 \begin_inset Flex Noun
1596 \begin_layout Plain Layout
1602 type of a format is optional, but if it is specified, it must be unique
1604 It is used to detect files of this format from the file contents.
1605 For some important file formats there is no MIME type officially registered
1607 \begin_inset CommandInset href
1610 target "http://www.iana.org/assignments/media-types/"
1616 Therefore \SpecialChar LyX
1617 uses the extended list of MIME types as specified by
1618 \begin_inset CommandInset href
1620 name "freedesktop.org"
1621 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1629 \begin_layout Standard
1631 \begin_inset Flex Noun
1634 \begin_layout Plain Layout
1640 option tells \SpecialChar LyX
1641 that a format is suitable for document export.
1642 If this is set and if a suitable conversion route exists (see
1643 \begin_inset CommandInset ref
1645 reference "sec:Converters"
1649 ), the format will appear in the
1650 \begin_inset Flex Noun
1653 \begin_layout Plain Layout
1654 File\SpecialChar menuseparator
1661 The format will also appear in the
1662 \begin_inset Flex Noun
1665 \begin_layout Plain Layout
1666 Document\SpecialChar menuseparator
1672 menu if a viewer is specified for the format.
1673 Pure image formats, such as
1674 \begin_inset Flex Code
1677 \begin_layout Plain Layout
1683 , should not use this option.
1684 Formats that can both represent vector graphics and documents like
1685 \begin_inset Flex Code
1688 \begin_layout Plain Layout
1697 \begin_layout Standard
1699 \begin_inset Flex Noun
1702 \begin_layout Plain Layout
1703 Vector graphics format
1708 tells \SpecialChar LyX
1709 that a format can contain vector graphics.
1710 This information is used to determine the target format of included graphics
1712 \begin_inset Flex Noun
1715 \begin_layout Plain Layout
1722 Included graphics may need to be converted to either
1723 \begin_inset Flex Noun
1726 \begin_layout Plain Layout
1733 \begin_inset Flex Noun
1736 \begin_layout Plain Layout
1743 \begin_inset Flex Noun
1746 \begin_layout Plain Layout
1753 \begin_inset Flex Noun
1756 \begin_layout Plain Layout
1762 cannot handle other image formats.
1763 If an included graphic is not already in
1764 \begin_inset Flex Noun
1767 \begin_layout Plain Layout
1774 \begin_inset Flex Noun
1777 \begin_layout Plain Layout
1784 \begin_inset Flex Noun
1787 \begin_layout Plain Layout
1793 format, it is converted to
1794 \begin_inset Flex Noun
1797 \begin_layout Plain Layout
1803 if the vector format option is set, and otherwise to
1804 \begin_inset Flex Noun
1807 \begin_layout Plain Layout
1816 \begin_layout Section
1820 \begin_layout Standard
1821 Since all conversions from one format to another take place in \SpecialChar LyX
1823 directory, it is sometimes necessary to modify a file before copying it
1824 to the temporary directory in order that the conversion may be performed.
1828 \begin_layout Plain Layout
1829 For example, the file may refer to other files—images, for example—using
1830 relative file names, and these may become invalid when the file is copied
1831 to the temporary directory.
1836 This is done by a Copier: It copies a file to (or from) the temporary directory
1837 and may modify it in the process.
1840 \begin_layout Standard
1841 The definitions of the copiers may use eight variables:
1844 \begin_layout Labeling
1845 \labelwidthstring 00.00.0000
1846 \begin_inset Flex Code
1849 \begin_layout Plain Layout
1855 The \SpecialChar LyX
1856 system directory (e.
1857 \begin_inset space \thinspace{}
1861 \begin_inset space \space{}
1865 \begin_inset Flex Noun
1868 \begin_layout Plain Layout
1877 \begin_layout Labeling
1878 \labelwidthstring 00.00.0000
1879 \begin_inset Flex Code
1882 \begin_layout Plain Layout
1891 \begin_layout Labeling
1892 \labelwidthstring 00.00.0000
1893 \begin_inset Flex Code
1896 \begin_layout Plain Layout
1905 \begin_layout Labeling
1906 \labelwidthstring 00.00.0000
1907 \begin_inset Flex Code
1910 \begin_layout Plain Layout
1916 The base name (without filename extension) in the \SpecialChar LyX
1920 \begin_layout Labeling
1921 \labelwidthstring 00.00.0000
1922 \begin_inset Flex Code
1925 \begin_layout Plain Layout
1931 The full directory path of the \SpecialChar LyX
1935 \begin_layout Labeling
1936 \labelwidthstring 00.00.0000
1937 \begin_inset Flex Code
1940 \begin_layout Plain Layout
1946 The full pathname to the original \SpecialChar LyX
1947 file being processed
1950 \begin_layout Labeling
1951 \labelwidthstring 00.00.0000
1952 \begin_inset Flex Code
1955 \begin_layout Plain Layout
1961 The filename (without any directory path) of the \SpecialChar LyX
1965 \begin_layout Labeling
1966 \labelwidthstring 00.00.0000
1967 \begin_inset Flex Code
1970 \begin_layout Plain Layout
1976 The `\SpecialChar LaTeX
1980 \begin_layout Standard
1981 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1989 It is relevant only when exporting files suitable for such inclusion.
1992 \begin_layout Standard
1993 Copiers can be used to do almost anything with output files.
1994 For example, suppose you want generated pdf files to be copied to a special
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2006 Then you could write a shell script such as this one:
2009 \begin_layout Standard
2010 \begin_inset listings
2014 \begin_layout Plain Layout
2019 \begin_layout Plain Layout
2024 \begin_layout Plain Layout
2026 TOFILE=`basename $2`
2029 \begin_layout Plain Layout
2031 cp $FROMFILE /home/you/pdf/$TOFILE
2036 Save it in your local \SpecialChar LyX
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2042 /home/you/.lyx/scripts/pdfcopier.sh
2047 —and make it executable, if you need to do so on your platform.
2049 \begin_inset Flex Noun
2052 \begin_layout Plain Layout
2053 Tools\SpecialChar menuseparator
2059 dialog, select under
2060 \begin_inset Flex Noun
2063 \begin_layout Plain Layout
2064 File Handling\SpecialChar menuseparator
2071 \begin_inset Flex Noun
2074 \begin_layout Plain Layout
2080 format—or one of the other pdf formats—and enter
2081 \begin_inset Flex Code
2084 \begin_layout Plain Layout
2085 pdfcopier.sh $$i $$o
2091 \begin_inset Flex Noun
2094 \begin_layout Plain Layout
2104 \begin_layout Standard
2105 Copiers are used by \SpecialChar LyX
2106 in various of its own conversions.
2107 For example, if appropriate programs are found, \SpecialChar LyX
2108 will automatically install
2110 \begin_inset Flex Noun
2113 \begin_layout Plain Layout
2120 \begin_inset Flex Noun
2123 \begin_layout Plain Layout
2125 \begin_inset space ~
2134 When these formats are exported, the copier sees that not just the main
2135 HTML file but various associated files (style files, images, etc.) are also
2137 All these files are written to a subdirectory of the directory in which
2138 the original \SpecialChar LyX
2143 \begin_layout Plain Layout
2144 This copier can be customized.
2146 \begin_inset Quotes eld
2150 \begin_inset Quotes erd
2153 argument takes a comma-separated list of extensions to be copied; if it
2154 is omitted, all files will be copied.
2156 \begin_inset Quotes eld
2160 \begin_inset Quotes erd
2163 argument determines the extension added to the generated directory.
2165 \begin_inset Quotes eld
2169 \begin_inset Flex Noun
2172 \begin_layout Plain Layout
2179 \begin_inset Quotes erd
2182 , so HTML generated from
2183 \begin_inset Flex Noun
2186 \begin_layout Plain Layout
2187 /path/to/filename.lyx
2193 \begin_inset Flex Noun
2196 \begin_layout Plain Layout
2197 /path/to/filename.html.LyXconv
2211 \begin_layout Section
2213 \begin_inset CommandInset label
2215 name "sec:Converters"
2222 \begin_layout Standard
2223 You can define your own Converters to convert files between different formats.
2225 \begin_inset Flex Noun
2228 \begin_layout Plain Layout
2229 Tools\SpecialChar menuseparator
2230 Preferences\SpecialChar menuseparator
2231 File Handling\SpecialChar menuseparator
2240 \begin_layout Standard
2241 To define a new converter, select the
2242 \begin_inset Flex Noun
2245 \begin_layout Plain Layout
2247 \begin_inset space ~
2256 \begin_inset Flex Noun
2259 \begin_layout Plain Layout
2261 \begin_inset space ~
2269 from the drop-down lists, enter the command needed for the conversion,
2271 \begin_inset Flex Noun
2274 \begin_layout Plain Layout
2281 Several variables can be used in the definition of converters:
2284 \begin_layout Labeling
2285 \labelwidthstring 00.00.0000
2286 \begin_inset Flex Code
2289 \begin_layout Plain Layout
2295 The \SpecialChar LyX
2299 \begin_layout Labeling
2300 \labelwidthstring 00.00.0000
2301 \begin_inset Flex Code
2304 \begin_layout Plain Layout
2313 \begin_layout Labeling
2314 \labelwidthstring 00.00.0000
2315 \begin_inset Flex Code
2318 \begin_layout Plain Layout
2327 \begin_layout Labeling
2328 \labelwidthstring 00.00.0000
2329 \begin_inset Flex Code
2332 \begin_layout Plain Layout
2338 The base filename of the input file (i.
2339 \begin_inset space \thinspace{}
2342 g., without the extension)
2345 \begin_layout Labeling
2346 \labelwidthstring 00.00.0000
2347 \begin_inset Flex Code
2350 \begin_layout Plain Layout
2356 The path to the input file
2359 \begin_layout Labeling
2360 \labelwidthstring 00.00.0000
2361 \begin_inset Flex Code
2364 \begin_layout Plain Layout
2370 The path to the original input file (this is different from $$p when a
2371 chain of converters is called)
2374 \begin_layout Labeling
2375 \labelwidthstring 00.00.0000
2376 \begin_inset Flex Code
2379 \begin_layout Plain Layout
2385 The iconv name for the encoding of the document.
2388 \begin_layout Standard
2390 \begin_inset Flex Noun
2393 \begin_layout Plain Layout
2395 \begin_inset space ~
2403 field you can enter the following flags, separated by commas:
2406 \begin_layout Labeling
2407 \labelwidthstring 00.00.0000
2408 \begin_inset Flex Code
2411 \begin_layout Plain Layout
2413 \change_inserted -712698321 1524656940
2421 This converter runs some form of \SpecialChar LaTeX
2423 This will make \SpecialChar LyX
2424 's \SpecialChar LaTeX
2425 error logs available.
2427 \change_inserted -712698321 1524657018
2429 \begin_inset Flex Code
2432 \begin_layout Plain Layout
2434 \change_inserted -712698321 1524657012
2442 value specifies the form of \SpecialChar LaTeX
2444 \begin_inset Flex Code
2447 \begin_layout Plain Layout
2449 \change_inserted -712698321 1524657005
2450 latex, pdflatex, platex, xetex, luatex
2458 If no value is specified,
2459 \begin_inset Flex Code
2462 \begin_layout Plain Layout
2464 \change_inserted -712698321 1524657018
2477 \begin_layout Labeling
2478 \labelwidthstring 00.00.0000
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2484 \change_inserted -712698321 1524656935
2492 Needs the \SpecialChar LaTeX
2494 \begin_inset Flex Noun
2497 \begin_layout Plain Layout
2503 file for the conversion.
2505 \change_inserted -712698321 1524657047
2507 \begin_inset Flex Code
2510 \begin_layout Plain Layout
2512 \change_inserted -712698321 1524657030
2518 value specifies the form of \SpecialChar LaTeX
2519 that is run in order to generate the
2520 \begin_inset Flex Noun
2523 \begin_layout Plain Layout
2525 \change_inserted -712698321 1524657047
2532 \begin_inset Flex Code
2535 \begin_layout Plain Layout
2537 \change_inserted -712698321 1524657030
2538 latex, pdflatex, platex, xetex, luatex
2544 If no value is specified,
2545 \begin_inset Flex Code
2548 \begin_layout Plain Layout
2550 \change_inserted -712698321 1524657030
2561 \begin_layout Labeling
2562 \labelwidthstring 00.00.0000
2563 \begin_inset Flex Code
2566 \begin_layout Plain Layout
2573 \begin_inset Quotes eld
2577 \begin_inset Quotes erd
2580 file from the backend, which in practice means a \SpecialChar LaTeX
2581 file like the one we
2582 would export, without
2583 \begin_inset Flex Code
2586 \begin_layout Plain Layout
2595 \begin_layout Labeling
2596 \labelwidthstring 00.00.0000
2597 \begin_inset Flex Code
2600 \begin_layout Plain Layout
2609 \begin_layout Standard
2610 The following three flags are not really flags at all because they take
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2617 \begin_inset space ~
2621 \begin_inset space ~
2632 \begin_layout Labeling
2633 \labelwidthstring 00.00.0000
2635 \change_inserted -712698321 1523206314
2636 \begin_inset Flex Code
2639 \begin_layout Plain Layout
2641 \change_inserted -712698321 1523206193
2647 The name of the driver that needs to be loaded with the
2651 package for this converter.
2652 The loading of the correct driver is necessary to get some PDF-specific
2661 \begin_layout Labeling
2662 \labelwidthstring 00.00.0000
2663 \begin_inset Flex Code
2666 \begin_layout Plain Layout
2672 If set, the converter's standard error will be redirected to a file
2673 \begin_inset Flex Code
2676 \begin_layout Plain Layout
2682 , and the script given as argument will be run as:
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2687 script < infile.out > infile.log
2693 The argument may contain
2694 \begin_inset Flex Code
2697 \begin_layout Plain Layout
2706 \begin_layout Labeling
2707 \labelwidthstring 00.00.0000
2708 \begin_inset Flex Code
2711 \begin_layout Plain Layout
2717 The name of the directory in which the converter will dump the generated
2720 will not create this directory, and it does not copy anything into it,
2721 though it will copy this directory to the destination.
2722 The argument may contain
2723 \begin_inset Flex Code
2726 \begin_layout Plain Layout
2732 , which will be replaced by the base name of the input and output files,
2733 respectively, when the directory is copied.
2734 \begin_inset Newline newline
2737 Note that resultdir and usetempdir make no sense together.
2738 The latter will be ignored if the former is given.
2741 \begin_layout Labeling
2742 \labelwidthstring 00.00.0000
2743 \begin_inset Flex Code
2746 \begin_layout Plain Layout
2752 Determines the output file name and may, contain
2753 \begin_inset Flex Code
2756 \begin_layout Plain Layout
2763 Sensible only with resultdir and optional even then; if not given, it defaults
2767 \begin_layout Standard
2769 \change_inserted -712698321 1523206384
2770 A suitable hyperref-driver is set for some converters that are installed
2771 with \SpecialChar LyX
2774 \change_deleted -712698321 1523206388
2776 \change_inserted -712698321 1523206389
2780 \change_inserted -712698321 1523206400
2784 \change_inserted -712698321 1523206407
2788 \change_inserted -712698321 1523206437
2792 \change_deleted -712698321 1523206442
2793 that are installed with \SpecialChar LyX
2800 \begin_layout Standard
2801 You do not have to define converters for all formats between which you want
2803 For example, you will note that there is no `\SpecialChar LyX
2804 to PostScript' converter,
2805 but \SpecialChar LyX
2806 will export PostScript.
2807 It does so by first creating a \SpecialChar LaTeX
2808 file (no converter needs to be defined
2809 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2811 and finally converting the resulting DVI file to PostScript.
2813 finds such `chains' of converters automatically, and it will always choose
2814 the shortest possible chain.
2815 You can, though, still define multiple conversion methods between file
2817 For example, the standard \SpecialChar LyX
2818 configuration provides five ways to convert
2823 \begin_layout Enumerate
2825 \begin_inset Flex Noun
2828 \begin_layout Plain Layout
2837 \begin_layout Enumerate
2838 via (DVI and) PostScript, using
2839 \begin_inset Flex Noun
2842 \begin_layout Plain Layout
2851 \begin_layout Enumerate
2853 \begin_inset Flex Noun
2856 \begin_layout Plain Layout
2865 \begin_layout Enumerate
2867 \begin_inset Flex Noun
2870 \begin_layout Plain Layout
2880 \begin_layout Enumerate
2882 \begin_inset Flex Noun
2885 \begin_layout Plain Layout
2895 \begin_layout Standard
2896 To define such alternate chains, you must define multiple target `file formats',
2898 \begin_inset CommandInset ref
2900 reference "sec:Formats"
2905 For example, in the standard configuration, the formats named
2906 \begin_inset Flex Noun
2909 \begin_layout Plain Layout
2916 \begin_inset Flex Noun
2919 \begin_layout Plain Layout
2926 \begin_inset Flex Noun
2929 \begin_layout Plain Layout
2936 \begin_inset Flex Noun
2939 \begin_layout Plain Layout
2946 \begin_inset Flex Noun
2949 \begin_layout Plain Layout
2956 \begin_inset Flex Noun
2959 \begin_layout Plain Layout
2966 \begin_inset Flex Noun
2969 \begin_layout Plain Layout
2976 \begin_inset Flex Noun
2979 \begin_layout Plain Layout
2987 \begin_inset Flex Noun
2990 \begin_layout Plain Layout
2997 \begin_inset Flex Noun
3000 \begin_layout Plain Layout
3007 ) are defined, all of which share the extension
3008 \begin_inset Flex Noun
3011 \begin_layout Plain Layout
3017 , and which correspond to the conversion methods just mentioned.
3020 \begin_layout Chapter
3021 Internationalizing \SpecialChar LyX
3023 \begin_inset CommandInset label
3025 name "cha:Internationalizing-LyX"
3032 \begin_layout Standard
3034 supports using a translated interface.
3035 Last time we checked, \SpecialChar LyX
3036 provided text in thirty languages.
3037 The language of choice is called your
3042 (For further reading on locale settings, see also the documentation for
3043 locale that comes with your operating system.
3044 For Linux, the manual page for
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3054 could be a good place to start).
3057 \begin_layout Standard
3058 Notice that these translations will work, but do contain a few flaws.
3059 In particular, all dialogs have been designed with the English text in
3060 mind, which means that some of the translated text will be too large to
3061 fit within the space allocated.
3062 This is only a display problem and will not cause any harm.
3063 Also, you will find that some of the translations do not define shortcut
3064 keys for everything.
3065 Sometimes, there are simply not enough free letters to do it.
3066 Other times, the translator just hasn't got around to doing it yet.
3067 Our localization team, which you may wish to join,
3071 \begin_layout Plain Layout
3072 If you are a fluent speaker of a language other than English, joining these
3073 teams is a great way to give back to the \SpecialChar LyX
3079 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3083 \begin_layout Section
3084 Translating \SpecialChar LyX
3088 \begin_layout Subsection
3089 Translating the graphical user interface (text messages).
3092 \begin_layout Standard
3095 \begin_inset Flex Code
3098 \begin_layout Plain Layout
3104 library to handle the internationalization of the interface.
3105 To have \SpecialChar LyX
3106 speak your favorite language in all menus and dialogs, you need
3108 \begin_inset Flex Code
3111 \begin_layout Plain Layout
3117 -file for that language.
3118 When this is available, you'll have to generate a
3119 \begin_inset Flex Code
3122 \begin_layout Plain Layout
3128 -file from it and install the
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3139 The process of doing all of this is explained in the documentation for
3141 \begin_inset Flex Code
3144 \begin_layout Plain Layout
3151 It is possible to do this just for yourself, but if you're going to do
3152 it, you might as well share the results of your labors with the rest of
3153 the \SpecialChar LyX
3155 Send a message to the \SpecialChar LyX
3156 developers' list for more information about how
3160 \begin_layout Standard
3161 In short, this is what you should do (xx denotes the language code):
3164 \begin_layout Itemize
3165 Check out the \SpecialChar LyX
3168 \begin_inset CommandInset href
3170 name "information on the web"
3171 target "https://www.lyx.org/HowToUseGIT"
3179 \begin_layout Itemize
3181 \begin_inset Flex Code
3184 \begin_layout Plain Layout
3190 to the folder of the
3191 \begin_inset Flex Code
3194 \begin_layout Plain Layout
3202 \begin_inset Flex Code
3205 \begin_layout Plain Layout
3213 \begin_inset Flex Code
3216 \begin_layout Plain Layout
3222 doesn't exist anywhere, it can be remade with the console command
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3232 in that directory, or you can use an existing po-file for some other language
3236 \begin_layout Itemize
3238 \begin_inset Flex Code
3241 \begin_layout Plain Layout
3251 \begin_layout Plain Layout
3252 This is just a text file, so it can be edited in any text editor.
3253 But there are also specialized programs that support such editing, such
3258 (for all platforms) or
3267 contains a `mode' for editing
3268 \begin_inset Flex Code
3271 \begin_layout Plain Layout
3278 \begin_inset Flex URL
3281 \begin_layout Plain Layout
3283 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3293 For some menu- and widget-labels, there are also shortcut keys that should
3295 Those keys are marked after a `|', and should be translated according to
3296 the words and phrases of the language.
3297 You should also fill also out the information at the beginning of the new
3299 \begin_inset Flex Code
3302 \begin_layout Plain Layout
3308 -file with your email-address, etc., so people know where to reach you with
3309 suggestions and entertaining flames.
3312 \begin_layout Standard
3313 If you are just doing this on your own, then:
3316 \begin_layout Itemize
3318 \begin_inset Flex Code
3321 \begin_layout Plain Layout
3328 This can be done with
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3333 msgfmt -o xx.mo < xx.po
3341 \begin_layout Itemize
3343 \begin_inset Flex Code
3346 \begin_layout Plain Layout
3352 -file to your locale-tree, at the correct directory for application messages
3357 xx, and under the name
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3368 \begin_inset space \thinspace{}
3372 \begin_inset space \space{}
3376 \begin_inset Flex Code
3379 \begin_layout Plain Layout
3380 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3390 \begin_layout Standard
3391 As said, however, it would be best if the new
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3401 file could be added to the \SpecialChar LyX
3402 distribution, so others can use it.
3403 Adding it involves making additional changes to \SpecialChar LyX
3405 So send an email to the developers' mailing list if you're interested in
3409 \begin_layout Subsubsection
3413 \begin_layout Standard
3414 Sometimes it turns out that one English message needs to be translated into
3415 different messages in the target language.
3416 One example is the message
3417 \begin_inset Flex Code
3420 \begin_layout Plain Layout
3426 which has the German translation
3434 , depending upon exactly what the English
3435 \begin_inset Quotes eld
3439 \begin_inset Quotes erd
3444 \begin_inset Flex Code
3447 \begin_layout Plain Layout
3453 does not handle such ambiguous translations.
3454 Therefore you have to add some context information to the message: Instead
3456 \begin_inset Flex Code
3459 \begin_layout Plain Layout
3466 \begin_inset Flex Code
3469 \begin_layout Plain Layout
3470 To[[as in 'From format x to format y']]
3476 \begin_inset Flex Code
3479 \begin_layout Plain Layout
3480 To[[as in 'From page x to page y']].
3485 Now the two occurrences of
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3505 and can be translated correctly to
3516 \begin_layout Standard
3517 Of course the context information needs to be stripped off the original
3518 message when no translation is used.
3519 Therefore you have to put it in double square brackets at the end of the
3520 message (see the example above).
3521 The translation mechanism of \SpecialChar LyX
3522 ensures that everything in double square
3523 brackets at the end of messages is removed before displaying the message.
3526 \begin_layout Subsection
3527 Translating the documentation.
3530 \begin_layout Standard
3531 The online documentation (in the
3532 \begin_inset Flex Noun
3535 \begin_layout Plain Layout
3541 -menu) can (and should!) be translated.
3542 If there are translated versions of the documentation available
3546 \begin_layout Plain Layout
3547 As of March 2008, at least some of the documents have been translated into
3548 fourteen languages, with the Tutorial available in a few more.
3553 and the locale is set accordingly, these will be used automagically by
3557 looks for translated versions as
3558 \begin_inset Flex Code
3561 \begin_layout Plain Layout
3562 LyXDir/doc/xx/DocName.lyx
3568 \begin_inset Flex Code
3571 \begin_layout Plain Layout
3577 is the code for the language currently in use.
3578 If there are no translated documents, the default English versions will
3580 Note that the translated versions must have the same filenames (
3581 \begin_inset Flex Code
3584 \begin_layout Plain Layout
3590 above) as the original.
3591 If you feel up to translating the documentation (an excellent way to proof-read
3592 the original documentation by the way!), there are a few things you should
3596 \begin_layout Itemize
3597 Check out the documentation translation web page at
3598 \begin_inset CommandInset href
3600 name "https://www.lyx.org/Translation"
3601 target "https://www.lyx.org/Translation"
3607 That way, you can find out which (if any) documents have already been translate
3608 d into your language.
3609 You can also find out who (if anyone) is organizing the effort to translate
3610 the documentation into your language.
3611 If no one is organizing the effort, please let us know that you're interested.
3614 \begin_layout Standard
3615 Once you get to actually translating, here's a few hints for you that may
3619 \begin_layout Itemize
3620 Join the documentation team! There is information on how to do that in
3621 \begin_inset Flex Code
3624 \begin_layout Plain Layout
3631 \begin_inset Flex Noun
3634 \begin_layout Plain Layout
3635 Help\SpecialChar menuseparator
3641 ), which by the way is the first document you should translate.
3644 \begin_layout Itemize
3645 Learn the typographic conventions for the language you are translating to.
3646 Typography is an ancient art and over the centuries, a great variety of
3647 conventions have developed throughout different parts of the world.
3648 Also study the professional terminology amongst typographers in your country.
3649 Inventing your own terminology will only confuse the users.
3652 (Warning! Typography is addictive!)
3655 \begin_layout Itemize
3656 Make a copy of the document.
3657 This will be your working copy.
3658 You can use this as your personal translated help-file by placing it in
3660 \begin_inset Flex Code
3663 \begin_layout Plain Layout
3670 \begin_inset Note Greyedout
3673 \begin_layout Plain Layout
3678 For a complex document with external material (images, etc.), if you make
3680 \begin_inset space \thinspace{}
3684 \begin_inset space \space{}
3687 in a temp dir, beware that the links to external material may be broken
3688 when the document is moved to a different place.
3689 The best way is to retrieve the \SpecialChar LyX
3691 \begin_inset Flex URL
3694 \begin_layout Plain Layout
3696 https://www.lyx.org/HowToUseGIT
3701 ) and to edit the doc file in place.
3709 \begin_layout Itemize
3710 Sometimes the original document (from the \SpecialChar LyX
3711 team) will be updated.
3712 Use the source viewer at
3713 \begin_inset CommandInset href
3715 name "https://www.lyx.org/trac/timeline"
3716 target "https://www.lyx.org/trac/timeline"
3721 to see what has been changed.
3722 That way you can easily see which parts of the translated document need
3726 \begin_layout Standard
3727 If you ever find an error in the original document, fix it and notify the
3728 rest of the documentation team of the changes! (You didn't forget to join
3729 the documentation team, did you?)
3732 \begin_layout Standard
3733 \begin_inset Branch OutDated
3737 \begin_layout Section
3738 International Keyboard Support
3741 \begin_layout Standard
3744 [Editor's Note: The following section is by
3752 It needs to be fixed to conform to the new Documentation Style sheet and
3753 to make use of the new v1.0 features.
3754 The whole thing also needs to be merged with the section following it.-jw
3755 It may also be badly out of date.-rh (2008)]
3758 \begin_layout Subsection
3759 Defining Own Keymaps: Keymap File Format
3762 \begin_layout Standard
3763 Let's look at a keyboard definition file a little closer.
3764 It is a plain text file defining
3767 \begin_layout Itemize
3768 key-to-key or key-to-string translations
3771 \begin_layout Itemize
3775 \begin_layout Itemize
3776 dead keys exceptions
3779 \begin_layout Standard
3780 To define key-to-key or key-to-string translation, use this command:
3783 \begin_layout Quotation
3784 \begin_inset Flex Code
3787 \begin_layout Plain Layout
3796 \begin_inset Flex Code
3799 \begin_layout Plain Layout
3808 \begin_layout Standard
3810 \begin_inset Flex Code
3813 \begin_layout Plain Layout
3819 is the key to be translated and
3820 \begin_inset Flex Code
3823 \begin_layout Plain Layout
3829 is the string to be inserted into the document.
3830 To define dead keys, use:
3833 \begin_layout Quotation
3834 \begin_inset Flex Code
3837 \begin_layout Plain Layout
3846 \begin_inset Flex Code
3849 \begin_layout Plain Layout
3858 \begin_layout Standard
3860 \begin_inset Flex Code
3863 \begin_layout Plain Layout
3869 is a keyboard key and
3870 \begin_inset Flex Code
3873 \begin_layout Plain Layout
3880 The following dead keys are supported (shortcut name is in parentheses):
3883 \begin_layout Quotation
3887 \begin_inset space \hfill{}
3893 \begin_layout Quotation
3895 \begin_inset space \hfill{}
3901 \begin_layout Quotation
3903 \begin_inset space \hfill{}
3909 \begin_layout Quotation
3911 \begin_inset space \hfill{}
3917 \begin_layout Quotation
3919 \begin_inset space \hfill{}
3925 \begin_layout Quotation
3927 \begin_inset space \hfill{}
3934 \begin_layout Plain Layout
3946 \begin_layout Quotation
3948 \begin_inset space \hfill{}
3954 \begin_layout Quotation
3956 \begin_inset space \hfill{}
3963 \begin_layout Plain Layout
3975 \begin_layout Quotation
3977 \begin_inset space \hfill{}
3983 \begin_layout Quotation
3985 \begin_inset space \hfill{}
3991 \begin_layout Quotation
3993 \begin_inset space \hfill{}
4000 \begin_layout Plain Layout
4012 \begin_layout Quotation
4014 \begin_inset space \hfill{}
4021 \begin_layout Plain Layout
4033 \begin_layout Quotation
4035 \begin_inset space \hfill{}
4041 \begin_layout Quotation
4042 hungarian umlaut (hug)
4043 \begin_inset space \hfill{}
4049 \begin_layout Quotation
4051 \begin_inset space \hfill{}
4057 \begin_layout Quotation
4059 \begin_inset space \hfill{}
4066 \begin_layout Plain Layout
4078 \begin_layout Standard
4079 Since in many international keyboards there are exceptions to what some
4080 dead keys should do, you can define them using
4083 \begin_layout Quotation
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4095 deadkey key outstring
4098 \begin_layout Standard
4099 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4103 \begin_layout Quotation
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4120 \begin_layout Standard
4121 to make it work correctly.
4122 Also, you have to define as exceptions dead keys over i and j, to remove
4123 the dot from them before inserting an accent mark.
4124 I will change this when the time comes, but so far I haven't had time.
4127 \begin_layout Standard
4128 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4131 \begin_inset Flex Code
4134 \begin_layout Plain Layout
4140 have different meaning.
4142 \begin_inset Flex Code
4145 \begin_layout Plain Layout
4151 marks comments, quotes start and end \SpecialChar LaTeX
4153 To enter quote, you'll need to use
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4166 \begin_inset Flex Code
4169 \begin_layout Plain Layout
4176 \begin_inset Flex Code
4179 \begin_layout Plain Layout
4190 \begin_layout Standard
4191 If you make a keyboard description file that works for your language, please
4192 mail it to me, so I can include it in the next keymap distribution.
4195 \begin_layout Standard
4196 More keywords will be supported in keymap configuration file in future,
4200 \begin_layout Itemize
4201 \begin_inset Flex Code
4204 \begin_layout Plain Layout
4215 \begin_inset space \hfill{}
4219 \begin_inset Flex Code
4222 \begin_layout Plain Layout
4231 \begin_layout Itemize
4232 \begin_inset Flex Code
4235 \begin_layout Plain Layout
4246 \begin_inset space \hfill{}
4250 \begin_inset Flex Code
4253 \begin_layout Plain Layout
4259 an external keymap translation program
4262 \begin_layout Standard
4263 Also, it should look into
4264 \begin_inset Flex Code
4267 \begin_layout Plain Layout
4273 file for defaults, too (for example, a
4274 \begin_inset Flex Code
4277 \begin_layout Plain Layout
4285 option to include default keyboard).
4293 \begin_layout Section
4294 International Keymap Stuff
4295 \begin_inset CommandInset label
4297 name "sec:International-Keymap-Stuff"
4304 \begin_layout Standard
4305 \begin_inset Note Note
4308 \begin_layout Plain Layout
4309 In doing the revisions on this document in March 2008, I did not look over
4310 this stuff, as I do not understand it.
4311 It would be good if someone else could do so.
4320 \begin_layout Standard
4321 The next two sections describe the
4322 \begin_inset Flex Code
4325 \begin_layout Plain Layout
4334 \begin_inset Flex Code
4337 \begin_layout Plain Layout
4345 file syntax in detail.
4346 These sections should help you design your own key map if the ones provided
4347 do not meet your needs.
4350 \begin_layout Subsection
4354 \begin_layout Standard
4358 \begin_inset Flex Code
4361 \begin_layout Plain Layout
4367 file maps keystrokes to characters or strings.
4368 As the name suggests, it sets a keyboard mapping.
4370 \begin_inset Flex Code
4373 \begin_layout Plain Layout
4384 \begin_inset Flex Code
4387 \begin_layout Plain Layout
4402 \begin_inset Flex Code
4405 \begin_layout Plain Layout
4418 \begin_inset Flex Code
4421 \begin_layout Plain Layout
4430 \begin_inset Flex Code
4433 \begin_layout Plain Layout
4441 are described in this section.
4444 \begin_layout Labeling
4445 \labelwidthstring 00.00.0000
4446 \begin_inset Flex Code
4449 \begin_layout Plain Layout
4457 Map a character to a string
4460 \begin_layout LyX-Code
4475 \begin_layout Standard
4508 the double-quote (")
4525 must be escaped with a preceding backslash (
4536 \begin_layout Standard
4538 \begin_inset Flex Noun
4541 \begin_layout Plain Layout
4549 statement to cause the symbol
4550 \begin_inset Flex Noun
4553 \begin_layout Plain Layout
4561 to be output for the keystroke
4562 \begin_inset Flex Noun
4565 \begin_layout Plain Layout
4576 \begin_layout LyX-Code
4582 \begin_layout Labeling
4583 \labelwidthstring 00.00.0000
4584 \begin_inset Flex Code
4587 \begin_layout Plain Layout
4595 Specify an accent character
4598 \begin_layout LyX-Code
4607 \begin_layout Standard
4608 This will make the cha
4646 This is the dead key
4650 \begin_layout Plain Layout
4657 refers to a key that does not produce a character by itself, but when followed
4658 with another key, produces the desired accent character.
4659 For example, a German characte
4661 r with an umlaut like
4671 can be produced in this manner.
4680 \begin_layout Standard
4693 and then another key not in
4710 followed by the other, not allowed key, as output.
4714 \begin_inset Flex Noun
4717 \begin_layout Plain Layout
4725 cancels a dead key, so if
4736 \begin_inset Flex Noun
4739 \begin_layout Plain Layout
4748 , the cursor will not go one position backwards but will instead cancel
4764 might have had on the next keystroke.
4768 \begin_layout Standard
4769 The following example specifies that the character ' is to be an acute accent,
4770 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4773 \begin_layout LyX-Code
4776 kmod ' acute aeiouAEIOU
4779 \begin_layout Labeling
4780 \labelwidthstring 00.00.0000
4781 \begin_inset Flex Code
4784 \begin_layout Plain Layout
4790 Specify an exception to the accent character
4793 \begin_layout LyX-Code
4802 \begin_layout Standard
4803 This defines an exce
4844 have been assigned a keystroke with a previous
4847 \begin_inset Flex Code
4850 \begin_layout Plain Layout
4874 must not belong in the
4921 If such a declaration does not exist in
4929 \begin_inset Flex Code
4932 \begin_layout Plain Layout
4966 \begin_inset Flex Code
4969 \begin_layout Plain Layout
4983 \begin_layout Standard
4984 The following command produces causes äi to be produced when you enter acute-i
4988 \begin_layout LyX-Code
5002 \begin_layout Labeling
5003 \labelwidthstring 00.00.0000
5004 \begin_inset Flex Code
5007 \begin_layout Plain Layout
5013 Combine two accent characters
5016 \begin_layout LyX-Code
5022 accent1 accent2 allowed
5025 \begin_layout Standard
5026 This one is getting pretty esoteric.
5027 It allows you to combine the effect
5083 \begin_inset Flex Code
5086 \begin_layout Plain Layout
5114 \begin_layout Standard
5115 Consider this example from the
5116 \begin_inset Flex Code
5119 \begin_layout Plain Layout
5130 \begin_layout LyX-Code
5133 kmod ; acute aeioyvhAEIOYVH
5137 kcomb acute umlaut iyIY
5140 \begin_layout Standard
5141 This allows you to press
5142 \begin_inset Flex Noun
5145 \begin_layout Plain Layout
5153 and get the effect of
5154 \begin_inset Flex Code
5157 \begin_layout Plain Layout
5176 in this case cancels the last dead key, so if you press
5177 \begin_inset Flex Noun
5180 \begin_layout Plain Layout
5189 \begin_inset Flex Code
5192 \begin_layout Plain Layout
5205 \begin_layout Subsection
5209 \begin_layout Standard
5211 \begin_inset Flex Code
5214 \begin_layout Plain Layout
5222 mapping is performed, a
5223 \begin_inset Flex Code
5226 \begin_layout Plain Layout
5236 file maps the strings that the symbols generate to characters in the current
5238 The \SpecialChar LyX
5239 distribution currently includes at least the
5240 \begin_inset Flex Code
5243 \begin_layout Plain Layout
5252 \begin_inset Flex Code
5255 \begin_layout Plain Layout
5266 \begin_layout Standard
5268 \begin_inset Flex Code
5271 \begin_layout Plain Layout
5279 file is a sequence of declarations of the form
5282 \begin_layout LyX-Code
5295 \begin_layout Standard
5296 For example, in order to map
5297 \begin_inset Flex Noun
5300 \begin_layout Plain Layout
5310 to the corresponding character in the iso-8859-1 set (233), the following
5314 \begin_layout LyX-Code
5322 \begin_layout Standard
5324 \begin_inset Flex Code
5327 \begin_layout Plain Layout
5336 \begin_inset Flex Code
5339 \begin_layout Plain Layout
5357 the same character can apply to more than one string.
5359 \begin_inset Flex Code
5362 \begin_layout Plain Layout
5373 \begin_layout LyX-Code
5385 \begin_inset Newline newline
5401 \begin_layout Standard
5403 cannot find a mapping for the string produced by the keystroke or a
5404 deadkey sequence, it will check if it looks like an accented char and try
5405 to draw an accent over the character on screen.
5408 \begin_layout Subsection
5412 \begin_layout Standard
5413 There is a second way to add support for international characters through
5414 so-called dead-keys.
5415 A dead-key works in combination with a letter to produce an accented character.
5416 Here, we'll explain how to create a really simple dead-key to illustrate
5420 \begin_layout Standard
5421 Suppose you happen to need the circumflex character,
5422 \begin_inset Quotes eld
5426 \begin_inset Quotes erd
5431 \begin_inset Flex Noun
5434 \begin_layout Plain Layout
5441 \begin_inset space ~
5445 \begin_inset Flex Noun
5448 \begin_layout Plain Layout
5454 ] to the \SpecialChar LyX
5456 \begin_inset Flex Code
5459 \begin_layout Plain Layout
5466 \begin_inset Flex Code
5469 \begin_layout Plain Layout
5476 Now, whenever you type the
5477 \begin_inset Flex Noun
5480 \begin_layout Plain Layout
5486 -key followed by a letter, that letter will have a circumflex accent on
5488 For example, the sequence
5489 \begin_inset Quotes eld
5493 \begin_inset Flex Noun
5496 \begin_layout Plain Layout
5503 \begin_inset Quotes erd
5506 produces the letter:
5507 \begin_inset Quotes eld
5511 \begin_inset Quotes erd
5515 If you tried to type
5516 \begin_inset Quotes eld
5520 \begin_inset Flex Noun
5523 \begin_layout Plain Layout
5530 \begin_inset Quotes erd
5533 , however, \SpecialChar LyX
5534 will complain with a beep, since a
5535 \begin_inset Quotes eld
5539 \begin_inset Flex Noun
5542 \begin_layout Plain Layout
5549 \begin_inset Quotes erd
5552 never takes a circumflex accent.
5554 \begin_inset Flex Noun
5557 \begin_layout Plain Layout
5563 after a dead-key produces the bare-accent.
5564 Please note this last point! If you bind a key to a dead-key, you'll need
5565 to rebind the character on that key to yet another key.
5567 \begin_inset Flex Noun
5570 \begin_layout Plain Layout
5576 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5579 \begin_layout Standard
5580 One common way to bind dead-keys is to use
5581 \begin_inset Flex Noun
5584 \begin_layout Plain Layout
5591 \begin_inset Flex Noun
5594 \begin_layout Plain Layout
5601 \begin_inset Flex Noun
5604 \begin_layout Plain Layout
5610 in combination with an accent, like
5611 \begin_inset Quotes eld
5615 \begin_inset Flex Noun
5618 \begin_layout Plain Layout
5625 \begin_inset Quotes erd
5629 \begin_inset Quotes eld
5633 \begin_inset Flex Noun
5636 \begin_layout Plain Layout
5643 \begin_inset Quotes erd
5647 \begin_inset Quotes eld
5651 \begin_inset Flex Noun
5654 \begin_layout Plain Layout
5661 \begin_inset Quotes erd
5665 Another way involves using
5666 \begin_inset Flex Code
5669 \begin_layout Plain Layout
5676 \begin_inset Flex Code
5679 \begin_layout Plain Layout
5685 to set up the special
5686 \begin_inset Flex Code
5689 \begin_layout Plain Layout
5697 \begin_inset Flex Code
5700 \begin_layout Plain Layout
5706 acts in some ways just like
5707 \begin_inset Flex Noun
5710 \begin_layout Plain Layout
5716 and permits you to bind keys to accented characters.
5717 You can also turn keys into dead-keys by binding them to something like
5719 \begin_inset Flex Code
5722 \begin_layout Plain Layout
5728 and then binding this symbolic key to the corresponding \SpecialChar LyX
5733 \begin_layout Plain Layout
5738 : This is exactly what I do in my
5739 \begin_inset Flex Code
5742 \begin_layout Plain Layout
5749 \begin_inset Flex Code
5752 \begin_layout Plain Layout
5760 \begin_inset Flex Noun
5763 \begin_layout Plain Layout
5765 \begin_inset space ~
5774 \begin_inset Flex Code
5777 \begin_layout Plain Layout
5783 and a bunch of these
5784 \begin_inset Quotes eld
5788 \begin_inset Flex Code
5791 \begin_layout Plain Layout
5798 \begin_inset Quotes erd
5801 symbolic keys bound such things as
5802 \begin_inset Flex Noun
5805 \begin_layout Plain Layout
5807 \begin_inset space ~
5816 \begin_inset Flex Noun
5819 \begin_layout Plain Layout
5821 \begin_inset space ~
5830 This is how I produce my accented characters.
5835 You can make just about anything into the
5836 \begin_inset Flex Code
5839 \begin_layout Plain Layout
5846 \begin_inset Flex Noun
5849 \begin_layout Plain Layout
5855 keys, a spare function key, etc.
5856 As for the \SpecialChar LyX
5857 commands that produce accents, check the entry for
5858 \begin_inset Flex Code
5861 \begin_layout Plain Layout
5872 You'll find the complete list there.
5875 \begin_layout Subsection
5876 Saving your Language Configuration
5879 \begin_layout Standard
5880 You can edit your preferences so that your desired language environment
5881 is automatically configured when \SpecialChar LyX
5883 \begin_inset Flex Noun
5886 \begin_layout Plain Layout
5887 Edit\SpecialChar menuseparator
5896 \begin_layout Chapter
5897 Installing New Document Classes, Layouts, and Templates
5898 \begin_inset CommandInset label
5900 name "cha:Installing-New-Document"
5905 \begin_inset Argument 1
5908 \begin_layout Plain Layout
5909 Installing New Document Classes
5917 \begin_layout Standard
5918 In this chapter, we describe the procedures for creating and installing
5919 new \SpecialChar LyX
5920 layout and template files, as well as offer a refresher on correctly
5921 installing new \SpecialChar LaTeX
5926 \begin_layout Standard
5927 First, let us a say a few words about how one ought to think about the relation
5928 between \SpecialChar LyX
5929 and \SpecialChar LaTeX
5931 The thing to understand is that, in a certain sense, \SpecialChar LyX
5932 doesn't know anything
5933 about \SpecialChar LaTeX
5935 Indeed, from \SpecialChar LyX
5936 's point of view, \SpecialChar LaTeX
5937 is just one of several
5938 \begin_inset Quotes eld
5942 \begin_inset Quotes erd
5945 in which it is capable of producing output.
5946 Other such formats are DocBook, plaintext, and XHTML.
5948 is, of course, a particularly important format, but very little of the
5949 information \SpecialChar LyX
5950 has about \SpecialChar LaTeX
5951 is actually contained in the program itself.
5955 \begin_layout Plain Layout
5956 Some commands are sufficiently complex that they are
5957 \begin_inset Quotes eld
5961 \begin_inset Quotes erd
5964 into \SpecialChar LyX
5966 But the developers generally regard this as a Bad Thing.
5971 Rather, that information, even for the standard classes like
5972 \begin_inset Flex Code
5975 \begin_layout Plain Layout
5981 , is contained in `layout files'.
5982 Similarly, \SpecialChar LyX
5983 itself does not know much about DocBook or XHTML.
5984 What it knows is contained in layout files.
5987 \begin_layout Standard
5988 You can think of the layout file for a given document class as a translation
5989 manual between \SpecialChar LyX
5990 constructs—paragraphs with their corresponding styles,
5991 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5994 Almost everything \SpecialChar LyX
5996 \begin_inset Flex Code
5999 \begin_layout Plain Layout
6005 , for example, is contained in the file
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6015 and in various other files it includes.
6016 For this reason, anyone intending to write layout files should plan to
6017 study the existing files.
6018 A good place to start is with
6019 \begin_inset Flex Code
6022 \begin_layout Plain Layout
6028 , which is included in
6029 \begin_inset Flex Code
6032 \begin_layout Plain Layout
6039 \begin_inset Flex Code
6042 \begin_layout Plain Layout
6048 , and many of the other layout files for document classes.
6049 This file is where sections and the like are defined:
6050 \begin_inset Flex Code
6053 \begin_layout Plain Layout
6059 tells \SpecialChar LyX
6060 how paragraphs that are marked with the Section, Subsection, etc,
6061 styles can be translated into corresponding \SpecialChar LaTeX
6062 , DocBook, and XHTML commands
6065 \begin_inset Flex Code
6068 \begin_layout Plain Layout
6074 file basically just includes several of these
6075 \begin_inset Flex Code
6078 \begin_layout Plain Layout
6087 \begin_layout Standard
6088 Defining the \SpecialChar LyX
6090 correspondence is not the only thing layout files do, though.
6091 Their other job is to define how the \SpecialChar LyX
6092 constructs themselves will appear
6094 The fact that layout files have these two jobs is often a source of confusion,
6095 because they are completely separate.
6096 Telling \SpecialChar LyX
6097 how to translate a certain paragraph style into \SpecialChar LaTeX
6100 how to display it; conversely, telling \SpecialChar LyX
6101 how to display a certain paragraph
6102 style does not tell \SpecialChar LyX
6103 how to translate it into \SpecialChar LaTeX
6104 (let alone tell \SpecialChar LaTeX
6107 So, in general, when you define a new \SpecialChar LyX
6108 construct, you must always do two
6109 quite separate things: (i)
6110 \begin_inset space ~
6113 tell \SpecialChar LyX
6114 how to translate it into \SpecialChar LaTeX
6116 \begin_inset space ~
6119 tell \SpecialChar LyX
6123 \begin_layout Standard
6124 Much the same is true, of course, as regards \SpecialChar LyX
6125 's other backend formats, though
6126 XHTML is in some ways different, because in that case \SpecialChar LyX
6131 able, to some extent, to use information about how it should display a
6132 paragraph on the screen to output information (in the form of CSS) about
6133 how the paragraph should be displayed in a browser.
6134 Even in this case, however, the distinction between what \SpecialChar LyX
6136 and how things are rendered externally remains in force, and the two can
6137 be controlled separately.
6139 \begin_inset CommandInset ref
6141 reference "sec:Tags-for-XHTML"
6148 \begin_layout Section
6149 Installing new \SpecialChar LaTeX
6153 \begin_layout Standard
6154 Some installations may not include a \SpecialChar LaTeX
6155 package or class file that you would
6156 like to use within \SpecialChar LyX
6158 For example, you might need Foil\SpecialChar TeX
6159 , a package for preparing slides for overhead
6161 Modern \SpecialChar LaTeX
6162 distributions like \SpecialChar TeX
6163 Live (2008 or newer) or MiK\SpecialChar TeX
6164 provide a user interface
6165 for installing such packages.
6166 For example, with MiK\SpecialChar TeX
6167 , you start the program
6168 \begin_inset Quotes eld
6172 \begin_inset space ~
6176 \begin_inset Quotes erd
6179 to get a list of available packages.
6180 To install one of them, right click on it or use the corresponding toolbar
6184 \begin_layout Standard
6185 If your \SpecialChar LaTeX
6186 distribution does not provide such a `package manager', or if the
6187 package is not available from your distribution, then follow these steps
6188 to install it manually:
6191 \begin_layout Enumerate
6192 Get the package from
6193 \begin_inset CommandInset href
6196 target "http://www.ctan.org/"
6204 \begin_layout Enumerate
6205 If the package contains a file with the ending
6206 \begin_inset Quotes eld
6210 \begin_inset Flex Code
6213 \begin_layout Plain Layout
6220 \begin_inset Quotes erd
6223 (is the case for Foil\SpecialChar TeX
6224 ) then open a console, change to the folder of this
6225 file and execute the command
6226 \begin_inset Flex Code
6229 \begin_layout Plain Layout
6236 You have now unpacked the package and have all files to install it.
6237 Most \SpecialChar LaTeX
6238 -packages are not packed and you can skip this step.
6241 \begin_layout Enumerate
6242 Now you need to decide if the package should be available for all users
6247 \begin_layout Enumerate
6248 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6249 for all users on your system, then install it in your `local' \SpecialChar TeX
6251 install it in your own `user' \SpecialChar TeX
6253 Where these trees should be created, if they do not already exist, depends
6255 To find this out, look in the file
6256 \begin_inset Flex Code
6259 \begin_layout Plain Layout
6269 \begin_layout Plain Layout
6270 This is usually in the directory
6271 \begin_inset Flex Code
6274 \begin_layout Plain Layout
6280 , though you can execute the command
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6295 The location of the `local' \SpecialChar TeX
6296 tree is defined by the
6297 \begin_inset Flex Code
6300 \begin_layout Plain Layout
6306 variable; this is usually somewhere like
6307 \begin_inset Flex Code
6310 \begin_layout Plain Layout
6311 /usr/local/share/texmf
6316 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6319 The location of the `user' \SpecialChar TeX
6321 \begin_inset Flex Code
6324 \begin_layout Plain Layout
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6341 \begin_inset Flex Code
6344 \begin_layout Plain Layout
6353 (If these variables are not predefined, you have to define them.) You'll
6354 probably need root permissions to create or modify the `local' tree, but
6355 not for your `user' tree.
6356 \begin_inset Newline newline
6359 In general, it is recommended to install in the user tree because your user
6360 will not be modified or even overwritten when you upgrade your system.
6361 It will typically also be backed up together with everything else when
6362 you backup your home directory (which, of course, you do on a regular basis).
6365 \begin_layout Enumerate
6366 On Windows, if you want the new package to be available for all users on
6367 your system, change to the folder where \SpecialChar LaTeX
6368 is installed and then change to
6370 \begin_inset Flex Code
6373 \begin_layout Plain Layout
6384 (For MiK\SpecialChar TeX
6385 , this would be by default the folder
6386 \begin_inset Flex Code
6389 \begin_layout Plain Layout
6407 \begin_layout Plain Layout
6408 Note that this will be the correct path only on English installations.
6409 On a German one, it would be
6410 \begin_inset Flex Code
6413 \begin_layout Plain Layout
6427 , and similarly for other languages.
6432 Create there a new folder
6433 \begin_inset Flex Code
6436 \begin_layout Plain Layout
6442 and copy all files of the package into it.
6444 \begin_inset Newline newline
6447 If the package should only available for you or you don't have admin permissions
6448 , do the same, but in the local \SpecialChar LaTeX
6451 \begin_inset space \thinspace{}
6454 g., for MiK\SpecialChar TeX
6456 \begin_inset space ~
6459 2.8 under Windows XP, this would be the folder:
6460 \begin_inset Newline newline
6466 \begin_inset Flex Code
6469 \begin_layout Plain Layout
6472 Documents and Settings
6484 \begin_inset Newline newline
6490 \begin_inset Phantom HPhantom
6493 \begin_layout Plain Layout
6504 \begin_inset Flex Code
6507 \begin_layout Plain Layout
6520 \begin_inset Newline newline
6523 On Vista, it would be:
6524 \begin_inset Newline newline
6528 \begin_inset Flex Code
6531 \begin_layout Plain Layout
6557 \begin_layout Enumerate
6558 Now one only need to tell \SpecialChar LaTeX
6559 that there are new files.
6560 This depends on the used \SpecialChar LaTeX
6565 \begin_layout Enumerate
6566 For \SpecialChar TeX
6567 Live execute the command
6568 \begin_inset Flex Code
6571 \begin_layout Plain Layout
6578 If you installed the package for all users, then you will probably need
6579 to have root permissions for that.
6582 \begin_layout Enumerate
6583 For MiK\SpecialChar TeX
6584 , if you have installed the package for all users, start the program
6586 \begin_inset Quotes eld
6590 \begin_inset space ~
6594 \begin_inset Quotes erd
6597 and press the button marked
6598 \begin_inset Quotes eld
6602 \begin_inset Quotes erd
6606 Otherwise start the program
6607 \begin_inset Quotes eld
6611 \begin_inset Quotes erd
6618 \begin_layout Enumerate
6619 Finally, you need to tell \SpecialChar LyX
6620 that there are new packages available.
6621 So, in \SpecialChar LyX
6623 \begin_inset Flex Noun
6626 \begin_layout Plain Layout
6629 \SpecialChar menuseparator
6635 and then restart \SpecialChar LyX
6639 \begin_layout Standard
6640 Now the package is installed.
6641 In our example, the document class
6642 \begin_inset Flex Code
6645 \begin_layout Plain Layout
6651 will now be available under
6652 \begin_inset Flex Noun
6655 \begin_layout Plain Layout
6656 Document\SpecialChar menuseparator
6657 Settings\SpecialChar menuseparator
6664 \begin_inset Quotes eld
6668 \begin_inset Quotes erd
6675 \begin_layout Standard
6676 If you would like to use a \SpecialChar LaTeX
6677 document class that is not even listed in the
6679 \begin_inset Flex Noun
6682 \begin_layout Plain Layout
6683 Document\SpecialChar menuseparator
6684 Settings\SpecialChar menuseparator
6690 , then you need to create a `layout' file for it.
6691 That is the topic of the next section.
6694 \begin_layout Section
6695 Types of layout files
6698 \begin_layout Standard
6699 This section describes the various sorts of \SpecialChar LyX
6700 files that contain layout informati
6702 These files describe various paragraph and character styles, determining
6703 how \SpecialChar LyX
6704 should display them and how they should be translated into \SpecialChar LaTeX
6706 XHTML, or whatever output format is being used.
6710 \begin_layout Standard
6711 We shall try to provide a thorough description of the process of writing
6713 However, there are so many different types of documents supported even
6714 by just \SpecialChar LaTeX
6715 that we can't hope to cover every different possibility or problem
6716 you might encounter.
6717 The \SpecialChar LyX
6718 users' list is frequented by people with lots of experience with layout
6719 design who are willing to share what they've learned, so please feel free
6720 to ask questions there.
6723 \begin_layout Standard
6724 As you prepare to write a new layout, it is extremely helpful to look at
6725 the layouts distributed with \SpecialChar LyX
6727 If you write a \SpecialChar LyX
6728 layout for a \SpecialChar LaTeX
6729 document class that might also be used by
6730 others, or write a module that might be useful to others, then you should
6731 consider posting your layout to the
6732 \begin_inset CommandInset href
6734 name "layout section on the LyX wiki"
6735 target "https://wiki.lyx.org/Layouts/Layouts"
6740 or even to the \SpecialChar LyX
6741 developers' list, so that it might be included in \SpecialChar LyX
6746 \begin_layout Plain Layout
6747 Note that \SpecialChar LyX
6748 is licensed under the General Public License, so any material
6749 that is contributed to \SpecialChar LyX
6750 must be similarly licensed.
6758 \begin_layout Subsection
6760 \begin_inset CommandInset label
6762 name "subsec:Layout-modules"
6769 \begin_layout Standard
6770 We have spoken to this point about `layout files'.
6771 But there are different sorts of files that contain layout information.
6772 Layout files, strictly so called, have the
6773 \begin_inset Flex Code
6776 \begin_layout Plain Layout
6782 extension and provide \SpecialChar LyX
6783 with information about document classes.
6784 Since \SpecialChar LyX
6785 1.6 layout information can also be contained in layout
6790 \begin_inset Flex Code
6793 \begin_layout Plain Layout
6800 Modules are to \SpecialChar LaTeX
6801 packages much as layouts are to \SpecialChar LaTeX
6802 classes, and some modules—such
6804 \begin_inset Flex Code
6807 \begin_layout Plain Layout
6813 module—specifically provide support for one package.
6814 In a sense, layout modules are similar to included
6818 \begin_layout Plain Layout
6819 These can have any extension, but by convention have the
6820 \begin_inset Flex Code
6823 \begin_layout Plain Layout
6835 \begin_inset Flex Code
6838 \begin_layout Plain Layout
6844 —in that modules are not specific to a given document class but may be used
6845 with many different classes.
6846 The difference is that using an included file with
6847 \begin_inset Flex Code
6850 \begin_layout Plain Layout
6856 requires editing that file.
6857 Modules, by contrast, are selected in the
6858 \begin_inset Flex Noun
6861 \begin_layout Plain Layout
6862 Document\SpecialChar menuseparator
6871 \begin_layout Standard
6872 Building modules is the easiest way to get started with layout editing,
6873 since it can be as simple as adding a single new paragraph style or flex
6875 But modules may, in principle, contain anything a layout file can contain.
6878 \begin_layout Standard
6879 After creating a new module and copying it to the
6880 \begin_inset Flex Code
6883 \begin_layout Plain Layout
6889 folder, you will need to reconfigure and then restart \SpecialChar LyX
6892 However, changes you make to the module will be seen immediately, if you
6894 \begin_inset Flex Noun
6897 \begin_layout Plain Layout
6898 Document\SpecialChar menuseparator
6904 , highlight something, and then hit
6905 \begin_inset Quotes eld
6909 \begin_inset Quotes erd
6915 It is strongly recommended that you save your work before doing this
6920 it is strongly recommended that you not attempt to edit modules while simultaneo
6921 usly working on actual documents
6924 Though of course the developers strive to keep \SpecialChar LyX
6925 stable in such situations,
6926 syntax errors and the like in your module file could cause strange behavior.
6929 \begin_layout Subsubsection
6933 \begin_layout Standard
6934 Modules are to \SpecialChar LyX
6935 as packages are to \SpecialChar LaTeX
6937 Sometimes, however, you find yourself wanting a specific inset or character
6938 style just for one document and writing a module that will also be available
6939 to other documents makes little sense.
6940 What you need is \SpecialChar LyX
6942 \begin_inset Quotes eld
6946 \begin_inset Quotes erd
6952 \begin_layout Standard
6953 You will find it under
6955 Document\SpecialChar menuseparator
6956 Settings\SpecialChar menuseparator
6960 The large text box allows you to enter anything that you might enter in
6961 a layout file or module.
6962 You can think of a document's local layout, in fact, as a module that belongs
6964 So, in particular, you must enter a
6965 \begin_inset Flex Code
6968 \begin_layout Plain Layout
6975 Any format is acceptable, but one would normally use the format current
6977 (In \SpecialChar LyX
6984 , the current layout format is
6993 \begin_layout Standard
6994 When you have entered something in the
6995 \begin_inset Flex Code
6998 \begin_layout Plain Layout
7004 pane, \SpecialChar LyX
7006 \begin_inset Quotes eld
7010 \begin_inset Quotes erd
7013 button at the bottom.
7014 Clicking this button will cause \SpecialChar LyX
7015 to determine whether what you have entered
7016 is valid layout information for the chosen format.
7018 will report the result but, unfortunately, will not tell you what errors
7019 there might have been.
7020 These will be written to the terminal, however, if \SpecialChar LyX
7021 is started from a terminal.
7022 You will not be permitted to save your local layout until you have entered
7026 \begin_layout Standard
7027 The warnings at the end of the previous section apply here, too.
7028 Do not play with local layout while you are actually working, especially
7029 if you have not saved your document.
7030 That said, using local layout with a test document can be a very convenient
7031 way to try out layout ideas, or even to start developing a module.
7034 \begin_layout Subsection
7036 \begin_inset Flex Noun
7039 \begin_layout Plain Layout
7048 \begin_layout Standard
7049 There are two situations you are likely to encounter when wanting to support
7050 a new \SpecialChar LaTeX
7051 document class, involving style (
7052 \begin_inset Flex Code
7055 \begin_layout Plain Layout
7061 ) files and \SpecialChar LaTeX2e
7063 \begin_inset Flex Code
7066 \begin_layout Plain Layout
7073 Supporting a style file is usually fairly easy.
7074 Supporting a new class file is a bit harder.
7075 We'll discuss the former in this section and the latter in the next.
7076 Similar remarks apply, of course, if you want to support a new DocBook
7080 \begin_layout Standard
7081 The easier case is the one in which your new document class is provided
7082 as a style file that is to be used in conjunction with an already supported
7084 For the sake of the example, we'll assume that the style file is called
7086 \begin_inset Flex Noun
7089 \begin_layout Plain Layout
7095 and that it is meant to be used with
7096 \begin_inset Flex Noun
7099 \begin_layout Plain Layout
7105 , which is a standard class.
7109 \begin_layout Standard
7110 Start by copying the existing class's layout file into your local directory:
7114 \begin_layout Plain Layout
7115 Of course, which directory is your local directory will vary by platform,
7116 and \SpecialChar LyX
7117 allows you to specify your local directory on startup, too, using
7119 \begin_inset Flex Code
7122 \begin_layout Plain Layout
7136 \begin_layout LyX-Code
7137 cp report.layout ~/.lyx/layouts/myclass.layout
7140 \begin_layout Standard
7142 \begin_inset Flex Code
7145 \begin_layout Plain Layout
7151 and change the line:
7154 \begin_layout LyX-Code
7157 DeclareLaTeXClass{Report (Standard Class)}
7160 \begin_layout Standard
7164 \begin_layout LyX-Code
7167 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7170 \begin_layout Standard
7174 \begin_layout LyX-Code
7176 \begin_inset Newline newline
7182 \begin_inset Newline newline
7188 \begin_layout Standard
7189 near the top of the file.
7192 \begin_layout Standard
7193 Start \SpecialChar LyX
7195 \begin_inset Flex Noun
7198 \begin_layout Plain Layout
7199 Tools\SpecialChar menuseparator
7206 Then restart \SpecialChar LyX
7207 and try creating a new document.
7209 \begin_inset Flex Noun
7212 \begin_layout Plain Layout
7218 " as a document class option in the
7219 \begin_inset Flex Noun
7222 \begin_layout Plain Layout
7223 Document\SpecialChar menuseparator
7230 It is likely that some of the sectioning commands and such in your new
7231 class will work differently from how they worked in the base class—
7232 \begin_inset Flex Code
7235 \begin_layout Plain Layout
7241 in this example—so you can fiddle around with the settings for the different
7242 sections if you wish.
7243 The layout information for sections is contained in
7244 \begin_inset Flex Code
7247 \begin_layout Plain Layout
7253 , but you do not need to copy and change this file.
7254 Instead, you can simply add your changes to your layout file, after the
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7265 , which itself includes
7266 \begin_inset Flex Code
7269 \begin_layout Plain Layout
7276 For example, you might add these lines:
7279 \begin_layout LyX-Code
7283 \begin_layout LyX-Code
7287 \begin_layout LyX-Code
7291 \begin_layout LyX-Code
7295 \begin_layout LyX-Code
7299 \begin_layout Standard
7300 to change the font for chapter headings to sans-serif.
7301 This will override (or, in this case, add to) the existing declaration
7302 for the Chapter style.
7306 \begin_layout Standard
7307 Your new package may also provide commands or environments not present in
7309 In this case, you will want to add these to the layout file.
7311 \begin_inset CommandInset ref
7313 reference "sec:TextClass"
7317 for information on how to do so.
7320 \begin_layout Standard
7322 \begin_inset Flex Noun
7325 \begin_layout Plain Layout
7331 can be used with several different document classes, and even if it cannot,
7332 you might find it easiest just to write a module that you can load with
7334 The simplest possible such module would be:
7337 \begin_layout LyX-Code
7340 DeclareLyXModule{My Class}
7343 \begin_layout LyX-Code
7347 \begin_layout LyX-Code
7348 #Support for myclass.sty.
7351 \begin_layout LyX-Code
7353 \begin_inset Newline newline
7359 \begin_layout LyX-Code
7367 \begin_inset Newline newline
7373 \begin_layout LyX-Code
7375 \begin_inset Newline newline
7381 \begin_inset Newline newline
7387 \begin_layout Standard
7388 A more complex module might modify the behavior of some existing constructs
7389 or define some new ones.
7391 \begin_inset CommandInset ref
7393 reference "sec:TextClass"
7400 \begin_layout Subsection
7402 \begin_inset Flex Noun
7405 \begin_layout Plain Layout
7414 \begin_layout Standard
7415 There are two possibilities here.
7416 One is that the class file is itself based upon an existing document class.
7417 For example, many thesis classes are based upon
7418 \begin_inset Flex Noun
7421 \begin_layout Plain Layout
7428 To see whether yours is, look for a line like
7431 \begin_layout LyX-Code
7437 \begin_layout Standard
7439 If so, then you may proceed largely as in the previous section, though
7441 \begin_inset Flex Code
7444 \begin_layout Plain Layout
7445 Declare\SpecialChar LaTeX
7451 line will be different.
7452 If your new class is
7453 \begin_inset Flex Code
7456 \begin_layout Plain Layout
7462 and it is based upon
7463 \begin_inset Flex Code
7466 \begin_layout Plain Layout
7472 , then the line should read:
7476 \begin_layout Plain Layout
7477 And it will be easiest if you save the file to
7478 \begin_inset Flex Code
7481 \begin_layout Plain Layout
7488 assumes that the document class has the same name as the layout file.
7497 \begin_layout LyX-Code
7500 DeclareLaTeXClass[thesis,book]{thesis}
7503 \begin_layout Standard
7504 If, on the other hand, the new class is not based upon an existing class,
7505 you will probably have to
7506 \begin_inset Quotes eld
7510 \begin_inset Quotes erd
7514 We strongly suggest copying an existing layout file which uses a similar
7516 class and then modifying it, if you can do so.
7517 At least use an existing file as a starting point so you can find out what
7518 items you need to worry about.
7519 Again, the specifics are covered below.
7522 \begin_layout Subsection
7524 \begin_inset CommandInset label
7526 name "subsec:Creating-Templates"
7533 \begin_layout Standard
7534 Once you have written a layout file for a new document class, you might
7535 want to consider writing a
7540 A template acts as a kind of tutorial for your layout, showing how it might
7541 be used, though containing dummy content.
7542 You can of course look at the various templates included with \SpecialChar LyX
7546 \begin_layout Standard
7547 Templates are created just like usual documents: using \SpecialChar LyX
7549 The only difference is that usual documents contain all possible settings,
7550 including the font scheme and the paper size.
7551 Usually a user doesn't want a template to overwrite his preferred settings
7552 for such parameters.
7553 For that reason, the designer of a template should remove the corresponding
7555 \begin_inset Flex Code
7558 \begin_layout Plain Layout
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7578 from the template \SpecialChar LyX
7580 This can be done with any simple text-editor, for example
7581 \begin_inset Flex Code
7584 \begin_layout Plain Layout
7591 \begin_inset Flex Code
7594 \begin_layout Plain Layout
7603 \begin_layout Standard
7604 Put the edited template files you create in
7605 \begin_inset Flex Code
7608 \begin_layout Plain Layout
7614 , copy the ones you use from the global template directory in
7615 \begin_inset Flex Code
7618 \begin_layout Plain Layout
7624 to the same place, and redefine the template path in the
7625 \begin_inset Flex Noun
7628 \begin_layout Plain Layout
7629 Tools\SpecialChar menuseparator
7630 Preferences\SpecialChar menuseparator
7639 \begin_layout Standard
7640 Note, by the way, that there is a template which has a particular meaning:
7641 \begin_inset Newline linebreak
7645 \begin_inset Flex Code
7648 \begin_layout Plain Layout
7655 This template is loaded every time you create a new document with
7656 \begin_inset Flex Noun
7659 \begin_layout Plain Layout
7660 File\SpecialChar menuseparator
7666 in order to provide useful defaults.
7667 To create this template from inside \SpecialChar LyX
7668 , all you have to do is to open a document
7669 with the correct settings, and use the
7670 \begin_inset Flex Noun
7673 \begin_layout Plain Layout
7674 Save as Document Defaults
7682 \begin_layout Subsection
7683 Upgrading old layout files
7686 \begin_layout Standard
7687 The format of layout files changes with each \SpecialChar LyX
7688 release, so old layout files
7689 need to be converted to the new format.
7691 reads a layout file in an older format, it automatically calls the
7693 \begin_inset Flex Code
7696 \begin_layout Plain Layout
7702 to convert it to a temporary file in current format.
7703 The original file is left untouched.
7704 If you use the layout file often, then, you may want to convert it permanently,
7705 so that \SpecialChar LyX
7706 does not have to do so itself every time.
7707 To do this, you can call the converter manually:
7710 \begin_layout Enumerate
7712 \begin_inset Flex Code
7715 \begin_layout Plain Layout
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7734 \begin_layout Enumerate
7736 \begin_inset Newline newline
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7744 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7750 \begin_inset Newline newline
7754 \begin_inset Flex Code
7757 \begin_layout Plain Layout
7763 is the name of your \SpecialChar LyX
7767 \begin_layout Standard
7768 Note that manual conversion does not affect included files, so these will
7769 have to be converted separately.
7772 \begin_layout Subsection
7773 \begin_inset CommandInset label
7775 name "subsec:Cite-Engine-Files"
7782 \begin_layout Standard
7783 A specific form of layout files are the so-called
7784 \begin_inset Flex Code
7787 \begin_layout Plain Layout
7793 files that are located in the
7794 \begin_inset Flex Code
7797 \begin_layout Plain Layout
7804 Their purpose is to define the specifics of \SpecialChar LaTeX
7805 packages aimed at bibliography
7818 , but also the way how normal Bib\SpecialChar TeX
7819 citations (without additional packages)
7820 are handled in \SpecialChar LyX
7821 is defined in such a file.
7825 \begin_layout Standard
7826 More specifically, it is defined which packages \SpecialChar LyX
7827 needs to load, which citation
7828 commands are available, how these are to be displayed in \SpecialChar LyX
7830 the dialogs, the context menus) as well as in the XHTML and plain text
7832 Furthermore, the files specify available style variants (author-year, numerical
7833 , etc.) and their specifics.
7834 The cite engine files are also used to generate the options that are available
7837 Document\SpecialChar menuseparator
7838 Settings\SpecialChar menuseparator
7839 Bibliography\SpecialChar menuseparator
7845 \begin_layout Standard
7846 Even though a cite engine file is essentially a normal layout file that
7847 could theoretically include any layout information, it usually primarily
7848 includes some specific parameters such as
7849 \begin_inset Flex Code
7852 \begin_layout Plain Layout
7859 \begin_inset Flex Code
7862 \begin_layout Plain Layout
7869 \begin_inset Flex Code
7872 \begin_layout Plain Layout
7879 \begin_inset Flex Code
7882 \begin_layout Plain Layout
7889 The syntax of the latter two is described in
7890 \begin_inset CommandInset ref
7892 reference "subsec:Citation-engine-description"
7900 \begin_inset CommandInset ref
7902 reference "subsec:Citation-format-description"
7906 , as well as in the files themselves.
7909 \begin_layout Section
7910 \begin_inset CommandInset label
7912 name "sec:TextClass"
7916 The layout file format
7919 \begin_layout Standard
7920 The following sections describe how layout files are structured and written.
7921 Our advice is to go slowly, save and test often.
7922 It is really not that hard, except that the multitude of options can become
7923 overwhelming, especially if you try to check out too many at once.
7924 It becomes easier if you use existing layouts of \SpecialChar LyX
7925 as examples/reference
7926 or if you modify an existing layout to your needs.
7929 \begin_layout Standard
7930 Note that all the tags used in layout files are case-insensitive.
7932 \begin_inset Flex Code
7935 \begin_layout Plain Layout
7942 \begin_inset Flex Code
7945 \begin_layout Plain Layout
7952 \begin_inset Flex Code
7955 \begin_layout Plain Layout
7961 are really the same tag.
7962 The possible arguments are printed in brackets after the tag's name.
7963 The default argument is typeset
7964 \begin_inset Flex Code
7967 \begin_layout Plain Layout
7976 If the argument has a data type like
7977 \begin_inset Quotes eld
7981 \begin_inset Quotes erd
7985 \begin_inset Quotes eld
7989 \begin_inset Quotes erd
7992 , the default is shown like this:
7993 \begin_inset Flex Code
7996 \begin_layout Plain Layout
8007 \begin_layout Subsection
8008 The document class declaration and classification
8011 \begin_layout Standard
8012 Lines in a layout file which begin with
8013 \begin_inset Flex Code
8016 \begin_layout Plain Layout
8023 There is one exception to this rule.
8025 \begin_inset Flex Code
8028 \begin_layout Plain Layout
8034 files should begin with lines like:
8037 \begin_layout LyX-Code
8040 #% Do not delete the line below; configure depends on this
8043 \begin_layout LyX-Code
8048 DeclareLaTeXClass{Article (Standard Class)}
8051 \begin_layout LyX-Code
8056 DeclareCategory{Articles}
8059 \begin_layout Standard
8060 The second and third lines are used when you (re)configure \SpecialChar LyX
8062 The layout file is read by the \SpecialChar LaTeX
8064 \begin_inset Flex Code
8067 \begin_layout Plain Layout
8073 , in a special mode where
8074 \begin_inset Flex Code
8077 \begin_layout Plain Layout
8084 The first line is just a \SpecialChar LaTeX
8085 comment, the second one contains the mandatory
8086 declaration of the text class and the third line contains the optional
8087 classification of the class.
8088 If these lines appear in a file named
8089 \begin_inset Flex Code
8092 \begin_layout Plain Layout
8098 , then they define a text class of name
8099 \begin_inset Flex Code
8102 \begin_layout Plain Layout
8108 (the name of the layout file) which uses the \SpecialChar LaTeX
8110 \begin_inset Flex Code
8113 \begin_layout Plain Layout
8119 (the default is to use the same name as the layout).
8121 \begin_inset Quotes eld
8124 Article (Standard Class)
8125 \begin_inset Quotes erd
8128 that appears above is used as a description of the text class in the
8129 \begin_inset Flex Noun
8132 \begin_layout Plain Layout
8133 Document\SpecialChar menuseparator
8141 \begin_inset Quotes eld
8145 \begin_inset Quotes erd
8148 in the example) is also used in the
8149 \begin_inset Flex Noun
8152 \begin_layout Plain Layout
8153 Document\SpecialChar menuseparator
8159 dialog: the text classes are grouped by these categories (which are usually
8160 genres, so typical categories are
8161 \begin_inset Quotes eld
8165 \begin_inset Quotes erd
8169 \begin_inset Quotes eld
8173 \begin_inset Quotes erd
8177 \begin_inset Quotes eld
8181 \begin_inset Quotes erd
8185 \begin_inset Quotes eld
8189 \begin_inset Quotes erd
8193 \begin_inset Quotes eld
8197 \begin_inset Quotes erd
8201 \begin_inset Quotes eld
8205 \begin_inset Quotes erd
8209 If no category has been declared, the class will be put in the
8210 \begin_inset Quotes eld
8214 \begin_inset Quotes erd
8220 \begin_layout Standard
8221 Let's assume that you wrote your own text class that uses the
8222 \begin_inset Flex Code
8225 \begin_layout Plain Layout
8231 document class, but where you changed the appearance of the section headings.
8232 If you put it in a file
8233 \begin_inset Flex Code
8236 \begin_layout Plain Layout
8242 , the header of this file should be:
8245 \begin_layout LyX-Code
8248 #% Do not delete the line below; configure depends on this
8251 \begin_layout LyX-Code
8256 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8259 \begin_layout LyX-Code
8264 DeclareCategory{Articles}
8267 \begin_layout Standard
8268 This declares a text class
8269 \begin_inset Flex Code
8272 \begin_layout Plain Layout
8278 , associated with the \SpecialChar LaTeX
8280 \begin_inset Flex Code
8283 \begin_layout Plain Layout
8290 \begin_inset Quotes eld
8293 Article (with My Own Headings)
8294 \begin_inset Quotes erd
8298 If your text class depends on several packages, you can declare it as:
8301 \begin_layout LyX-Code
8304 #% Do not delete the line below; configure depends on this
8307 \begin_layout LyX-Code
8312 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8315 \begin_layout LyX-Code
8320 DeclareCategory{Articles}
8323 \begin_layout Standard
8324 This indicates that your text class uses the
8325 \begin_inset Flex Code
8328 \begin_layout Plain Layout
8335 Finally, it is also possible to declare classes for DocBook code.
8336 Typical declarations will look like:
8339 \begin_layout LyX-Code
8342 #% Do not delete the line below; configure depends on this
8345 \begin_layout LyX-Code
8350 DeclareDocBookClass[article]{SGML (DocBook Article)}
8353 \begin_layout LyX-Code
8358 DeclareCategory{Articles (DocBook)}
8361 \begin_layout Standard
8362 Note that these declarations can also be given an optional parameter declaring
8363 the name of the document class (but not a list).
8366 \begin_layout Standard
8367 So, to be as explicit as possible, the form of the layout declaration is:
8370 \begin_layout LyX-Code
8375 DeclareLaTeXClass[class,package.sty]{layout description}
8378 \begin_layout LyX-Code
8383 DeclareCategory{category}
8386 \begin_layout Standard
8387 The class need only be specified if the name of the \SpecialChar LaTeX
8389 name of the layout file are different or if there are packages to load.
8390 If the name of the class file is not specified, then \SpecialChar LyX
8392 that it is the same as the name of the layout file.
8395 \begin_layout Standard
8396 When the text class has been modified to your taste, all you have to do
8397 is to copy it either to
8398 \begin_inset Flex Code
8401 \begin_layout Plain Layout
8408 \begin_inset Flex Code
8411 \begin_layout Plain Layout
8418 \begin_inset Flex Noun
8421 \begin_layout Plain Layout
8422 Tools\SpecialChar menuseparator
8428 , exit \SpecialChar LyX
8430 Then your new text class should be available along with the others.
8433 \begin_layout Standard
8434 Once the layout file is installed, you can edit it and see your changes
8435 without having to reconfigure or to restart \SpecialChar LyX
8440 \begin_layout Plain Layout
8441 In versions of \SpecialChar LyX
8442 prior to 1.6, this was not true.
8443 As a result, editing layout files was very time consuming, since you had
8444 constantly to restart \SpecialChar LyX
8450 You can force a reload of the current layout by using the \SpecialChar LyX
8452 \begin_inset Flex Noun
8455 \begin_layout Plain Layout
8462 There is no default binding for this function—though, of course, you can
8463 bind it to a key yourself.
8464 But you will normally use this function simply by entering it in the mini-buffe
8469 \begin_layout Standard
8475 \begin_inset Flex Noun
8478 \begin_layout Plain Layout
8484 is very much an `advanced feature'.
8489 recommended that you save your work before using this function.
8494 recommended that you not attempt to edit layout information while simultaneousl
8495 y working on a document that you care about.
8496 Use a test document.
8497 Syntax errors and the like in your layout file could cause peculiar behavior.
8498 In particular, such errors could cause \SpecialChar LyX
8499 to regard the current layout as
8500 invalid and to attempt to switch to some other layout.
8504 \begin_layout Plain Layout
8505 Really bad syntax errors may even caused \SpecialChar LyX
8507 This is because certain sorts of errors may make \SpecialChar LyX
8518 The \SpecialChar LyX
8519 team strives to keep \SpecialChar LyX
8520 stable in such situations, but safe is better
8525 \begin_layout Plain Layout
8526 While we're giving advice: make regular backups.
8527 And be nice to your mother.
8535 \begin_layout Subsection
8536 The Module declaration
8539 \begin_layout Standard
8540 A module must begin with a line like the following:
8543 \begin_layout LyX-Code
8546 DeclareLyXModule[endnotes.sty]{Endnotes}
8549 \begin_layout Standard
8550 The mandatory argument, in curly brackets, is the name of the module, as
8552 \begin_inset Flex Noun
8555 \begin_layout Plain Layout
8556 Document\SpecialChar menuseparator
8557 Settings\SpecialChar menuseparator
8564 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8566 on which the module depends.
8567 It is also possible to use the form
8568 \begin_inset Flex Noun
8571 \begin_layout Plain Layout
8577 as an optional argument, which declares that the module can only be used
8578 when there exists a conversion chain between the formats `
8579 \begin_inset Flex Code
8582 \begin_layout Plain Layout
8589 \begin_inset Flex Code
8592 \begin_layout Plain Layout
8601 \begin_layout Standard
8602 The module declaration should then be followed by lines like the following:
8606 \begin_layout Plain Layout
8607 Preferably in English if the module should be published with \SpecialChar LyX
8609 This description will appear in the list of messages to be translated and
8610 will be thus translated with the next interface update.
8618 \begin_layout LyX-Code
8622 \begin_layout LyX-Code
8623 #Adds an endnote command, in addition to footnotes.
8627 \begin_layout LyX-Code
8628 #You will need to add
8630 theendnotes in TeX code where you
8633 \begin_layout LyX-Code
8634 #want the endnotes to appear.
8638 \begin_layout LyX-Code
8642 \begin_layout LyX-Code
8643 #Requires: somemodule | othermodule
8646 \begin_layout LyX-Code
8647 #Excludes: badmodule
8650 \begin_layout Standard
8651 The description is used in
8652 \begin_inset Flex Noun
8655 \begin_layout Plain Layout
8656 Document\SpecialChar menuseparator
8657 Settings\SpecialChar menuseparator
8663 to provide the user with information about what the module does.
8665 \begin_inset Flex Code
8668 \begin_layout Plain Layout
8674 line is used to identify other modules with which this one must be used;
8676 \begin_inset Flex Code
8679 \begin_layout Plain Layout
8685 line is used to identify modules with which this one may not be used.
8686 Both are optional, and, as shown, multiple modules should be separated
8687 with the pipe symbol: |.
8688 Note that the required modules are treated disjunctively:
8692 of the required modules must be used.
8697 excluded module may be used.
8698 Note that modules are identified here by their filenames without the
8699 \begin_inset Flex Code
8702 \begin_layout Plain Layout
8710 \begin_inset Flex Code
8713 \begin_layout Plain Layout
8720 \begin_inset Flex Code
8723 \begin_layout Plain Layout
8732 \begin_layout Subsection
8733 The CiteEngine file declaration
8736 \begin_layout Standard
8737 A cite engine file must begin with a line like the following:
8740 \begin_layout LyX-Code
8743 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8746 \begin_layout Standard
8747 The mandatory argument, in curly brackets, is the name of the cite style,
8748 as it should appear in
8749 \begin_inset Flex Noun
8752 \begin_layout Plain Layout
8753 Document\SpecialChar menuseparator
8754 Settings\SpecialChar menuseparator
8761 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8763 on which the cite engine depends.
8766 \begin_layout Standard
8767 The cite engine declaration should then be followed by lines like the following:
8771 \begin_layout Plain Layout
8772 Preferably in English if the module should be published with \SpecialChar LyX
8774 This description will appear in the list of messages to be translated and
8775 will be thus translated with the next interface update.
8783 \begin_layout LyX-Code
8787 \begin_layout LyX-Code
8788 # Biblatex supports many author-year and numerical styles.
8791 \begin_layout LyX-Code
8792 # It is mainly aimed at the Humanities.
8796 \begin_layout LyX-Code
8797 # customizable, fully localized and provides many features
8800 \begin_layout LyX-Code
8801 # that are not possible with BibTeX.
8802 The use of 'biber' as
8805 \begin_layout LyX-Code
8806 # bibliography processor is advised.
8809 \begin_layout LyX-Code
8813 \begin_layout Standard
8814 The description is used in
8815 \begin_inset Flex Noun
8818 \begin_layout Plain Layout
8819 Document\SpecialChar menuseparator
8820 Settings\SpecialChar menuseparator
8826 to provide the user with information about the cite engine.
8829 \begin_layout Subsection
8833 \begin_layout Standard
8834 The first non-comment line of any layout file, included file, or module
8839 contain the file format number:
8842 \begin_layout Description
8843 \begin_inset Flex Code
8846 \begin_layout Plain Layout
8853 \begin_inset Flex Code
8856 \begin_layout Plain Layout
8862 ] The format number of the layout file.
8865 \begin_layout Standard
8866 This tag was introduced with \SpecialChar LyX
8868 \begin_inset space ~
8872 Layout files from older \SpecialChar LyX
8873 versions do not have an explicit file format and
8874 are considered to have
8875 \begin_inset Flex Code
8878 \begin_layout Plain Layout
8880 \begin_inset space ~
8889 The format for the present version of \SpecialChar LyX
8891 But each version of \SpecialChar LyX
8892 is capable of reading earlier versions' layout files,
8893 just as they are capable of reading files produced by earlier versions
8896 There is, however, no provision for converting to earlier formats.
8899 \begin_layout Subsection
8900 \begin_inset CommandInset label
8902 name "subsec:General-text-class"
8906 General text class parameters
8909 \begin_layout Standard
8910 These are general parameters that govern the behavior of an entire document
8916 mean that they must appear in
8917 \begin_inset Flex Code
8920 \begin_layout Plain Layout
8926 files rather than in modules.
8927 A module can contain any layout tag.)
8930 \begin_layout Description
8932 \change_inserted -712698321 1526899478
8933 \begin_inset Flex Code
8936 \begin_layout Plain Layout
8938 \change_inserted -712698321 1526898610
8939 AddToCiteEngine <engine>
8944 Extends the possibilities for displaying citation references.
8946 \begin_inset CommandInset ref
8948 reference "subsec:Citation-engine-description"
8957 \begin_inset Flex Code
8960 \begin_layout Plain Layout
8962 \change_inserted -712698321 1526898823
8973 \begin_layout Description
8974 \begin_inset Flex Code
8977 \begin_layout Plain Layout
8983 Adds information that will be output in the
8984 \begin_inset Flex Code
8987 \begin_layout Plain Layout
8993 block when the document is output to XHTML.
8994 Typically, this would be used to output CSS style information, but it can
8995 be used for anything that can appear in
8996 \begin_inset Flex Code
8999 \begin_layout Plain Layout
9007 \begin_inset Quotes eld
9011 \begin_inset Flex Code
9014 \begin_layout Plain Layout
9021 \begin_inset Quotes erd
9027 \begin_layout Description
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9037 Adds information to the document preamble.
9039 \begin_inset Newline newline
9043 \begin_inset Quotes eld
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9057 \begin_inset Quotes erd
9063 \begin_layout Description
9064 \begin_inset Flex Code
9067 \begin_layout Plain Layout
9073 Defines the possibilities for displaying citation references.
9075 \begin_inset CommandInset ref
9077 reference "subsec:Citation-engine-description"
9086 \begin_inset Quotes eld
9090 \begin_inset Flex Code
9093 \begin_layout Plain Layout
9100 \begin_inset Quotes erd
9104 Primarily used in cite engine files (see
9105 \begin_inset CommandInset ref
9107 reference "subsec:Cite-Engine-Files"
9116 \change_inserted -712698321 1526898530
9117 Note that if you specify this in a layout file or module, any cite engine
9118 definition will be overridden.
9120 \begin_inset Flex Code
9123 \begin_layout Plain Layout
9125 \change_inserted -712698321 1526898530
9138 \begin_layout Description
9139 \begin_inset Flex Code
9142 \begin_layout Plain Layout
9148 Defines formats for use in the display of bibliographic information.
9150 \begin_inset CommandInset ref
9152 reference "subsec:Citation-format-description"
9158 \begin_inset Quotes eld
9162 \begin_inset Flex Code
9165 \begin_layout Plain Layout
9172 \begin_inset Quotes erd
9176 Primarily used in cite engine files (see
9177 \begin_inset CommandInset ref
9179 reference "subsec:Cite-Engine-Files"
9188 \change_inserted -712698321 1526898585
9189 A cite format defined in a layout or module will override the cite engine
9195 \begin_layout Description
9196 \begin_inset Flex Code
9199 \begin_layout Plain Layout
9206 \begin_inset Flex Code
9209 \begin_layout Plain Layout
9218 \begin_inset Flex Code
9221 \begin_layout Plain Layout
9227 ] Determines whether
9231 or Bib\SpecialChar TeX
9232 is used to generate a Bibliography.
9233 Primarily used in cite engine files (see
9234 \begin_inset CommandInset ref
9236 reference "subsec:Cite-Engine-Files"
9246 \begin_layout Description
9247 \begin_inset Flex Code
9250 \begin_layout Plain Layout
9256 Describes various global options supported by the document class.
9258 \begin_inset CommandInset ref
9260 reference "subsec:ClassOptions"
9266 \begin_inset Quotes eld
9270 \begin_inset Flex Code
9273 \begin_layout Plain Layout
9280 \begin_inset Quotes erd
9286 \begin_layout Description
9287 \begin_inset Flex Code
9290 \begin_layout Plain Layout
9297 \begin_inset Flex Code
9300 \begin_layout Plain Layout
9309 \begin_inset space \thinspace{}
9313 \begin_inset Flex Code
9316 \begin_layout Plain Layout
9322 ] Whether the class should
9326 to having one or two columns.
9327 Can be changed in the
9328 \begin_inset Flex Noun
9331 \begin_layout Plain Layout
9332 Document\SpecialChar menuseparator
9341 \begin_layout Description
9342 \begin_inset Flex Code
9345 \begin_layout Plain Layout
9352 \begin_inset Flex Code
9355 \begin_layout Plain Layout
9361 ] This sequence defines the properties for a counter.
9362 If the counter does not yet exist, it is created; if it does exist, it
9365 \begin_inset Quotes eld
9369 \begin_inset Flex Code
9372 \begin_layout Plain Layout
9379 \begin_inset Quotes erd
9383 \begin_inset Newline newline
9387 \begin_inset CommandInset ref
9389 reference "subsec:Counters"
9393 for details on counters.
9396 \begin_layout Description
9397 \begin_inset Flex Code
9400 \begin_layout Plain Layout
9406 Sets the default font used to display the document.
9408 \begin_inset CommandInset ref
9410 reference "subsec:Font-description"
9414 for how to declare fonts.
9416 \begin_inset Quotes eld
9420 \begin_inset Flex Code
9423 \begin_layout Plain Layout
9430 \begin_inset Quotes erd
9436 \begin_layout Description
9437 \begin_inset Flex Code
9440 \begin_layout Plain Layout
9447 \begin_inset Flex Code
9450 \begin_layout Plain Layout
9456 ] Specifies a module to be included by default with this document class.
9457 The module is specified as filename without the
9458 \begin_inset Flex Code
9461 \begin_layout Plain Layout
9468 The user can still remove the module, but it will be active at the outset.
9469 (This applies only when new files are created, or when this class is chosen
9470 for an existing document.)
9473 \begin_layout Description
9474 \begin_inset Flex Code
9477 \begin_layout Plain Layout
9484 \begin_inset Flex Code
9487 \begin_layout Plain Layout
9493 ] This is the style that will be assigned to new paragraphs, usually
9494 \begin_inset Flex Noun
9497 \begin_layout Plain Layout
9504 This will default to the first defined style if not given, but you are
9505 encouraged to use this directive.
9508 \begin_layout Description
9509 \begin_inset Flex Code
9512 \begin_layout Plain Layout
9519 \begin_inset Flex Code
9522 \begin_layout Plain Layout
9528 ] This tag indicates that the module (which is specified by filename without
9530 \begin_inset Flex Code
9533 \begin_layout Plain Layout
9539 extension) cannot be used with this document class.
9540 This might be used in a journal-specific layout file to prevent, say, the
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9551 module that numbers theorems by section.
9556 be used in a module.
9557 Modules have their own way of excluding other modules (see
9558 \begin_inset CommandInset ref
9560 reference "subsec:Layout-modules"
9567 \begin_layout Description
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9577 Defines a new float.
9579 \begin_inset CommandInset ref
9581 reference "subsec:Floats"
9587 \begin_inset Quotes eld
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9601 \begin_inset Quotes erd
9607 \begin_layout Description
9608 \begin_inset Flex Code
9611 \begin_layout Plain Layout
9617 Sets the information that will be output in the
9618 \begin_inset Flex Code
9621 \begin_layout Plain Layout
9627 block when this document class is output to XHTML.
9628 Note that this will completely override any prior
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9650 \begin_inset Newline newline
9654 \begin_inset Flex Code
9657 \begin_layout Plain Layout
9663 if you just want to add material to the preamble.) Must end with
9664 \begin_inset Quotes eld
9668 \begin_inset Flex Code
9671 \begin_layout Plain Layout
9678 \begin_inset Quotes erd
9684 \begin_layout Description
9685 \begin_inset Flex Code
9688 \begin_layout Plain Layout
9695 \begin_inset Flex Code
9698 \begin_layout Plain Layout
9704 ] The style to use for the table of contents, bibliography, and so forth,
9705 when the document is output to HTML.
9706 For articles, this should normally be
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9727 If it is not given, then \SpecialChar LyX
9728 will attempt to figure out which layout to use.
9731 \begin_layout Description
9732 \begin_inset Flex Code
9735 \begin_layout Plain Layout
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9751 ] Modifies the properties of the given counter.
9752 If the counter does not exist, the statement is ignored.
9754 \begin_inset Quotes eld
9758 \begin_inset Flex Code
9761 \begin_layout Plain Layout
9768 \begin_inset Quotes erd
9772 \begin_inset Newline newline
9776 \begin_inset CommandInset ref
9778 reference "subsec:Counters"
9782 for details on counters.
9785 \begin_layout Description
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9796 \begin_inset Flex Code
9799 \begin_layout Plain Layout
9805 ] This allows you to include another layout definition file within yours
9806 to avoid duplicating commands.
9807 Common examples are the standard layout files, for example,
9808 \begin_inset Flex Code
9811 \begin_layout Plain Layout
9817 , which contains most of the basic layouts.
9820 \begin_layout Description
9821 \begin_inset Flex Code
9824 \begin_layout Plain Layout
9831 \begin_inset Flex Code
9834 \begin_layout Plain Layout
9840 ] This section (re-)defines the layout of an inset.
9841 It can be applied to an existing inset or to a new, user-defined inset,
9842 e.g., a new character style.
9844 \begin_inset Quotes eld
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9858 \begin_inset Quotes erd
9862 \begin_inset Newline newline
9866 \begin_inset CommandInset ref
9868 reference "subsec:Flex-insets-and"
9872 for more information.
9876 \begin_layout Description
9877 \begin_inset Flex Code
9880 \begin_layout Plain Layout
9887 \begin_inset Flex Code
9890 \begin_layout Plain Layout
9896 ] A string that indicates the width of the left margin on the screen, for
9898 \begin_inset Quotes eld
9902 \begin_inset Flex Code
9905 \begin_layout Plain Layout
9912 \begin_inset Quotes erd
9916 (Note that this is not a `length', like
9917 \begin_inset Quotes eld
9921 \begin_inset Quotes erd
9927 \begin_layout Description
9928 \begin_inset Flex Code
9931 \begin_layout Plain Layout
9938 \begin_inset Flex Code
9941 \begin_layout Plain Layout
9947 ] An integer that determines the maximal number of names displayed in an
9948 author-year citation before the citation switches to
9949 \begin_inset Quotes eld
9953 \begin_inset Quotes erd
9957 Primarily used in cite engine files (see
9958 \begin_inset CommandInset ref
9960 reference "subsec:Cite-Engine-Files"
9970 \begin_layout Description
9971 \begin_inset Flex Code
9974 \begin_layout Plain Layout
9981 \begin_inset Flex Code
9984 \begin_layout Plain Layout
9990 ] Modifies the properties of the given paragraph style.
9991 If the style does not exist, this section is ignored.
9993 \begin_inset Quotes eld
9997 \begin_inset Flex Code
10000 \begin_layout Plain Layout
10007 \begin_inset Quotes erd
10013 \begin_layout Description
10014 \begin_inset Flex Code
10017 \begin_layout Plain Layout
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10033 ] Deletes an existing counter, usually one defined in an included file.
10036 \begin_layout Description
10037 \begin_inset Flex Code
10040 \begin_layout Plain Layout
10047 \begin_inset Flex Code
10050 \begin_layout Plain Layout
10056 ] Deletes an existing float.
10057 This is particularly useful when you want to suppress a float that has
10058 been defined in an input file.
10061 \begin_layout Description
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10081 ] Deletes an existing style.
10084 \begin_layout Description
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 \begin_inset Flex Code
10098 \begin_layout Plain Layout
10105 \begin_inset Flex Code
10108 \begin_layout Plain Layout
10114 ] Define a new table of contents with type
10115 \begin_inset Flex Code
10118 \begin_layout Plain Layout
10125 \begin_inset Flex Code
10128 \begin_layout Plain Layout
10135 See also the AddToToc commands.
10138 \begin_layout Description
10139 \begin_inset Flex Code
10142 \begin_layout Plain Layout
10149 \begin_inset Flex Code
10152 \begin_layout Plain Layout
10158 ] The file format (as defined in the \SpecialChar LyX
10159 preferences) produced by this document
10161 It is mainly useful when
10162 \begin_inset Flex Code
10165 \begin_layout Plain Layout
10172 \begin_inset Flex Code
10175 \begin_layout Plain Layout
10181 and one wants to define a new type of literate document.
10182 The format is reset to
10183 \begin_inset Quotes eld
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10197 \begin_inset Quotes erd
10201 \begin_inset Quotes eld
10205 \begin_inset Flex Code
10208 \begin_layout Plain Layout
10215 \begin_inset Quotes erd
10218 when the corresponding
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10228 parameter is encountered.
10231 \begin_layout Description
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10266 \begin_inset Flex Code
10269 \begin_layout Plain Layout
10275 ] Specifies what sort of output documents using this class will produce.
10278 \begin_layout Description
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10299 \begin_inset Flex Code
10302 \begin_layout Plain Layout
10308 ] Specifies options, given in the second string, for the package named by
10311 \begin_inset Quotes eld
10315 \begin_inset Flex Code
10318 \begin_layout Plain Layout
10319 PackageOptions natbib square
10325 \begin_inset Quotes erd
10329 \begin_inset Flex Code
10332 \begin_layout Plain Layout
10338 to be loaded with the
10339 \begin_inset Flex Code
10342 \begin_layout Plain Layout
10349 (For \SpecialChar TeX
10350 perts, this causes \SpecialChar LyX
10352 \begin_inset Flex Code
10355 \begin_layout Plain Layout
10358 PassOptionsToPackage{natbib}{square}
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10376 \begin_layout Description
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10418 ] The default pagestyle.
10419 Can be changed in the
10420 \begin_inset Flex Noun
10423 \begin_layout Plain Layout
10424 Document\SpecialChar menuseparator
10433 \begin_layout Description
10434 \begin_inset Flex Code
10437 \begin_layout Plain Layout
10443 Sets the preamble for the \SpecialChar LaTeX
10445 Note that this will completely override any prior
10446 \begin_inset Flex Code
10449 \begin_layout Plain Layout
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10467 \begin_inset Flex Code
10470 \begin_layout Plain Layout
10476 if you just want to add material to the preamble.) Must end with
10477 \begin_inset Quotes eld
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10491 \begin_inset Quotes erd
10497 \begin_layout Description
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10508 \begin_inset Flex Code
10511 \begin_layout Plain Layout
10518 \begin_inset Flex Code
10521 \begin_layout Plain Layout
10530 \begin_inset space \thinspace{}
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10543 ] Whether the class already provides the feature
10544 \begin_inset Flex Code
10547 \begin_layout Plain Layout
10554 A feature is in general the name of a package (e.
10555 \begin_inset space \thinspace{}
10559 \begin_inset space \space{}
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10573 \begin_inset Flex Code
10576 \begin_layout Plain Layout
10583 \begin_inset space \thinspace{}
10587 \begin_inset space \space{}
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10612 \begin_inset CommandInset ref
10614 reference "chap:List-of-functions"
10618 for the list of features.
10621 \begin_layout Description
10622 \begin_inset Flex Code
10625 \begin_layout Plain Layout
10632 \begin_inset Flex Code
10635 \begin_layout Plain Layout
10641 ] Indicates that this layout provides the functionality of the module mentioned,
10642 which should be specified by the filename without the
10643 \begin_inset Flex Code
10646 \begin_layout Plain Layout
10653 This will typically be used if the layout includes the module directly,
10654 rather than using the
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10664 tag to indicate that it ought to be used.
10665 It could also be used in a module that provided an alternate implementation
10666 of the same functionality.
10669 \begin_layout Description
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 \begin_inset Flex Code
10683 \begin_layout Plain Layout
10689 ] Creates a new paragraph style if it does not already exist.
10690 If the style does exist, this section is ignored.
10692 \begin_inset Quotes eld
10696 \begin_inset Flex Code
10699 \begin_layout Plain Layout
10706 \begin_inset Quotes erd
10712 \begin_layout Description
10713 \begin_inset Flex Code
10716 \begin_layout Plain Layout
10723 \begin_inset Flex Code
10726 \begin_layout Plain Layout
10732 ] Whether the class requires the feature
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 Multiple features must be separated by commas.
10744 Note that you can only request supported features.
10746 \begin_inset CommandInset ref
10748 reference "chap:List-of-functions"
10752 for the list of features.).
10753 If you require a package with specific options, you can additionally use
10755 \begin_inset Flex Code
10758 \begin_layout Plain Layout
10767 \begin_layout Description
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10778 \begin_inset Flex Code
10781 \begin_layout Plain Layout
10787 ] A string that indicates the width of the right margin on the screen, for
10789 \begin_inset Quotes eld
10793 \begin_inset Flex Code
10796 \begin_layout Plain Layout
10803 \begin_inset Quotes erd
10809 \begin_layout Description
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10829 ] Sets which divisions get numbered.
10831 \begin_inset Newline newline
10835 \begin_inset Flex Code
10838 \begin_layout Plain Layout
10844 counter in \SpecialChar LaTeX
10848 \begin_layout Description
10849 \begin_inset Flex Code
10852 \begin_layout Plain Layout
10859 \begin_inset Flex Code
10862 \begin_layout Plain Layout
10871 \begin_inset space \thinspace{}
10875 \begin_inset Flex Code
10878 \begin_layout Plain Layout
10884 ] Whether the class-default should be printing on one or both sides of the
10886 Can be changed in the
10887 \begin_inset Flex Noun
10890 \begin_layout Plain Layout
10891 Document\SpecialChar menuseparator
10900 \begin_layout Description
10901 \begin_inset Flex Code
10904 \begin_layout Plain Layout
10911 \begin_inset Flex Code
10914 \begin_layout Plain Layout
10920 ] This sequence defines a paragraph style.
10921 If the style does not yet exist, it is created; if it does exist, its parameter
10924 \begin_inset Quotes eld
10928 \begin_inset Flex Code
10931 \begin_layout Plain Layout
10938 \begin_inset Quotes erd
10942 \begin_inset Newline newline
10946 \begin_inset CommandInset ref
10948 reference "subsec:Paragraph-Styles"
10952 for details on paragraph styles.
10955 \begin_layout Description
10956 \begin_inset Flex Code
10959 \begin_layout Plain Layout
10966 \begin_inset Flex Code
10969 \begin_layout Plain Layout
10975 ] The name of the command or environment to be used with
10976 \begin_inset Flex Code
10979 \begin_layout Plain Layout
10988 \begin_layout Description
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
10999 \begin_inset Flex Code
11002 \begin_layout Plain Layout
11011 \begin_inset Flex Code
11014 \begin_layout Plain Layout
11020 ] Indicates what kind of markup is used to define the title of a document.
11022 \begin_inset Flex Code
11025 \begin_layout Plain Layout
11031 means that the macro with name
11032 \begin_inset Flex Code
11035 \begin_layout Plain Layout
11041 will be inserted after the last layout which has
11042 \begin_inset Quotes eld
11046 \begin_inset Flex Code
11049 \begin_layout Plain Layout
11051 \begin_inset space ~
11060 \begin_inset Quotes erd
11065 \begin_inset Flex Code
11068 \begin_layout Plain Layout
11074 corresponds to the case where all layouts which have
11075 \begin_inset Quotes eld
11079 \begin_inset Flex Code
11082 \begin_layout Plain Layout
11084 \begin_inset space ~
11093 \begin_inset Quotes erd
11096 should be enclosed into the
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11109 \begin_layout Description
11110 \begin_inset Flex Code
11113 \begin_layout Plain Layout
11120 \begin_inset Flex Code
11123 \begin_layout Plain Layout
11129 ] Sets which divisions are included in the table of contents.
11131 \begin_inset Flex Code
11134 \begin_layout Plain Layout
11140 counter in \SpecialChar LaTeX
11144 \begin_layout Subsection
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11155 \begin_inset CommandInset label
11157 name "subsec:ClassOptions"
11164 \begin_layout Standard
11166 \begin_inset Flex Code
11169 \begin_layout Plain Layout
11175 section can contain the following entries:
11178 \begin_layout Description
11179 \begin_inset Flex Code
11182 \begin_layout Plain Layout
11189 \begin_inset Flex Code
11192 \begin_layout Plain Layout
11198 ] The list of available font sizes for the document's main font, separated
11200 \begin_inset Quotes eld
11204 \begin_inset Flex Code
11207 \begin_layout Plain Layout
11214 \begin_inset Quotes erd
11220 \begin_layout Description
11221 \begin_inset Flex Code
11224 \begin_layout Plain Layout
11230 Used to set the DTD line with XML-based output classes.
11232 \begin_inset space \thinspace{}
11236 \begin_inset Quotes eld
11239 -//OASIS//DTD DocBook V4.2//EN
11240 \begin_inset Quotes erd
11246 \begin_layout Description
11247 \begin_inset Flex Code
11250 \begin_layout Plain Layout
11257 \begin_inset Flex Code
11260 \begin_layout Plain Layout
11261 string="empty|plain|headings|fancy"
11266 ] The list of available page sty\SpecialChar softhyphen
11268 \begin_inset Quotes eld
11272 \begin_inset Flex Code
11275 \begin_layout Plain Layout
11282 \begin_inset Quotes erd
11288 \begin_layout Description
11289 \begin_inset Flex Code
11292 \begin_layout Plain Layout
11299 \begin_inset Flex Code
11302 \begin_layout Plain Layout
11308 ] Some document class options, separated by a comma, that will be added
11309 to the optional part of the
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11324 \begin_layout Standard
11326 \begin_inset Flex Code
11329 \begin_layout Plain Layout
11335 section must end with
11336 \begin_inset Quotes eld
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11350 \begin_inset Quotes erd
11356 \begin_layout Subsection
11358 \begin_inset CommandInset label
11360 name "subsec:Paragraph-Styles"
11367 \begin_layout Standard
11368 A paragraph style description looks like this:
11372 \begin_layout Plain Layout
11373 Note that this will either define a new style or modify an existing one.
11381 \begin_layout LyX-Code
11388 \begin_layout LyX-Code
11392 \begin_layout LyX-Code
11396 \begin_layout Standard
11397 where the following commands are allowed:
11400 \begin_layout Description
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 \begin_inset Flex Code
11414 \begin_layout Plain Layout
11420 =""] This paragraph will appear in the table of contents of the given type.
11421 An empty string disables.
11422 See also the OutlinerName and the IsTocCaption commands.
11426 \begin_layout Description
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11445 , left, right, center
11450 ] Paragraph alignment.
11453 \begin_layout Description
11454 \begin_inset Flex Code
11457 \begin_layout Plain Layout
11464 \begin_inset Flex Code
11467 \begin_layout Plain Layout
11472 , left, right, center
11477 ] A comma separated list of permitted alignments.
11478 (Some \SpecialChar LaTeX
11479 styles prohibit certain alignments, since those wouldn't make sense.
11480 For example a right-aligned or centered enumeration isn't possible.)
11483 \begin_layout Description
11484 \begin_inset Flex Code
11487 \begin_layout Plain Layout
11494 \begin_inset Flex Code
11497 \begin_layout Plain Layout
11503 ] Defines argument number <int> of a command\SpecialChar breakableslash
11504 environment associated with
11506 This is useful for things like section headings, and only makes sense with
11509 Every (optional or required) argument of a command or environment – except
11510 for the required argument that is associated with the content of the paragraph
11511 itself – has a separate definition, where the number specifies the order
11513 The definition must end with
11514 \begin_inset Flex Code
11517 \begin_layout Plain Layout
11524 So a command with two optional arguments has:
11528 \begin_layout Quote
11534 \begin_layout Quote
11540 \begin_layout Quote
11546 \begin_layout Quote
11552 \begin_layout Quote
11558 \begin_layout Quote
11564 \begin_layout Standard
11566 \begin_inset Flex Code
11569 \begin_layout Plain Layout
11575 definition, the following specifications are possible:
11578 \begin_layout Itemize
11579 \begin_inset Flex Code
11582 \begin_layout Plain Layout
11589 \begin_inset Flex Code
11592 \begin_layout Plain Layout
11598 The string that will appear both in the menu (to insert this argument)
11599 and on the argument inset button (unless you also specify a separate
11600 \begin_inset Flex Code
11603 \begin_layout Plain Layout
11610 For the menu, you can define an accelerator by appending the respective
11611 character to the string, divided by
11612 \begin_inset Quotes eld
11616 \begin_inset Quotes erd
11620 \begin_inset space \thinspace{}
11624 \begin_inset space \space{}
11628 \begin_inset Quotes eld
11632 \begin_inset Flex Code
11635 \begin_layout Plain Layout
11642 \begin_inset Quotes erd
11648 \begin_layout Itemize
11649 \begin_inset Flex Code
11652 \begin_layout Plain Layout
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11668 A separate string for the menu.
11669 You can define an accelerator by appending the respective character to
11670 the string, divided by
11671 \begin_inset Quotes eld
11675 \begin_inset Quotes erd
11679 \begin_inset space \thinspace{}
11683 \begin_inset space \space{}
11687 \begin_inset Quotes eld
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11701 \begin_inset Quotes erd
11705 This specification is optional.
11706 If it is not given the
11707 \begin_inset Flex Code
11710 \begin_layout Plain Layout
11716 will be used instead for the menu.
11719 \begin_layout Itemize
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11739 A longer explanatory text that appears in the tooltip when hovering over
11740 the argument inset.
11743 \begin_layout Itemize
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11766 \begin_inset space \thinspace{}
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11779 ] Declare if this is a mandatory (1) or an optional (0) argument.
11780 Mandatory arguments will be output empty if not given, while optional arguments
11781 will not be output at all.
11782 By default, mandatory arguments are delimited by
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11792 , while optional arguments are delimited by
11793 \begin_inset Flex Code
11796 \begin_layout Plain Layout
11805 \begin_layout Itemize
11806 \begin_inset Flex Code
11809 \begin_layout Plain Layout
11816 \begin_inset Flex Code
11819 \begin_layout Plain Layout
11825 defines another argument (by its number) which this argument requires to
11826 be output if it is itself output.
11828 \begin_inset space \thinspace{}
11831 g., in \SpecialChar LaTeX
11832 commands, optional arguments often require previous optional arguments
11833 to be output (at least empty), as in
11834 \begin_inset Flex Code
11837 \begin_layout Plain Layout
11840 command[][argument]{text}
11846 This can be achieved by the statement
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11869 \begin_layout Itemize
11870 \begin_inset Flex Code
11873 \begin_layout Plain Layout
11880 \begin_inset Flex Code
11883 \begin_layout Plain Layout
11889 defines a custom left delimiter (instead of
11890 \begin_inset Flex Code
11893 \begin_layout Plain Layout
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11910 A line break in the output can be indicated by
11911 \begin_inset Flex Code
11914 \begin_layout Plain Layout
11923 \begin_layout Itemize
11924 \begin_inset Flex Code
11927 \begin_layout Plain Layout
11934 \begin_inset Flex Code
11937 \begin_layout Plain Layout
11943 defines a custom right delimiter (instead of
11944 \begin_inset Flex Code
11947 \begin_layout Plain Layout
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11964 A line break in the output can be indicated by
11965 \begin_inset Flex Code
11968 \begin_layout Plain Layout
11977 \begin_layout Itemize
11978 \begin_inset Flex Code
11981 \begin_layout Plain Layout
11988 \begin_inset Flex Code
11991 \begin_layout Plain Layout
11997 defines an argument that is inserted if and only if no user-specified arguments
11999 \begin_inset space \thinspace{}
12003 \begin_inset space \space{}
12006 if no argument inset has been inserted (note that also an empty argument
12007 inset omits the DefaultArg).
12008 Multiple arguments need to be separated by comma.
12011 \begin_layout Itemize
12012 \begin_inset Flex Code
12015 \begin_layout Plain Layout
12022 \begin_inset Flex Code
12025 \begin_layout Plain Layout
12031 defines an argument that is inserted in any case (alone or in addition
12032 to user-specified arguments).
12033 Multiple arguments need to be separated by comma.
12036 \begin_layout Itemize
12037 \begin_inset Flex Code
12040 \begin_layout Plain Layout
12046 The font used for the argument content, see
12047 \begin_inset CommandInset ref
12049 reference "subsec:Font-description"
12056 \begin_layout Itemize
12057 \begin_inset Flex Code
12060 \begin_layout Plain Layout
12066 The font used for the label; see
12067 \begin_inset CommandInset ref
12069 reference "subsec:Font-description"
12076 \begin_layout Itemize
12077 \begin_inset Flex Code
12080 \begin_layout Plain Layout
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12095 , Minimalistic, Conglomerate
12100 ] describes the rendering style used for the inset's frame and buttons.
12103 \begin_layout Itemize
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12124 \begin_inset Flex Code
12127 \begin_layout Plain Layout
12133 , this argument is automatically inserted when the respective style is selected.
12134 Currently, only one argument per style\SpecialChar breakableslash
12135 layout can be automatically inserted.
12138 \begin_layout Itemize
12139 \begin_inset Flex Code
12142 \begin_layout Plain Layout
12149 \begin_inset Flex Code
12152 \begin_layout Plain Layout
12159 \begin_inset Flex Code
12162 \begin_layout Plain Layout
12168 , this argument will be inserted with a copy of the co-text (either selected
12169 text or the whole paragraph) as content.
12172 \begin_layout Itemize
12173 \begin_inset Flex Code
12176 \begin_layout Plain Layout
12183 \begin_inset Flex Code
12186 \begin_layout Plain Layout
12196 ] Whether the contents of this argument should be output in raw form, meaning
12197 without special translations that \SpecialChar LaTeX
12200 \begin_inset Flex Code
12203 \begin_layout Plain Layout
12209 status is inherited by the inset or paragraph layout the argument belongs
12210 to, true and false change the status for the given argument only.
12213 \begin_layout Itemize
12214 \begin_inset Flex Code
12217 \begin_layout Plain Layout
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12228 string of characters
12237 Defines individual characters
12238 \begin_inset Newline linebreak
12241 that should be output in raw form, meaning without special translations
12242 that \SpecialChar LaTeX
12244 Note that, contrary to PassThru, this needs to be explicitly defined for
12246 That is, arguments do not inherit PassThruChars from their parent inset
12250 \begin_layout Itemize
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12261 \begin_inset Flex Code
12264 \begin_layout Plain Layout
12273 \begin_inset space \thinspace{}
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12286 ] If this is set to 1, the argument will output its content in the corresponding
12287 item in the table of contents.
12291 \begin_layout Standard
12292 By default, the text entered in the \SpecialChar LyX
12293 workarea in the respective layout is
12294 the last (mandatory) argument of a command if the
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12305 \begin_inset Flex Code
12308 \begin_layout Plain Layout
12315 However, arguments with the prefix
12316 \begin_inset Flex Code
12319 \begin_layout Plain Layout
12325 are output after this workarea argument.
12326 Note that post-argument numbering restarts at 1, so the first argument
12327 following the workarea argument is
12328 \begin_inset Flex Code
12331 \begin_layout Plain Layout
12338 Post-arguments are ignored in any other
12339 \begin_inset Flex Code
12342 \begin_layout Plain Layout
12349 \begin_inset Flex Code
12352 \begin_layout Plain Layout
12361 \begin_layout Standard
12363 \begin_inset Flex Code
12366 \begin_layout Plain Layout
12375 \begin_inset Flex Code
12378 \begin_layout Plain Layout
12387 \begin_inset Flex Code
12390 \begin_layout Plain Layout
12396 followed by the number (e.
12397 \begin_inset space \thinspace{}
12401 \begin_inset space \space{}
12405 \begin_inset Flex Code
12408 \begin_layout Plain Layout
12415 \change_inserted -712698321 1534487781
12419 \begin_layout Standard
12421 \change_inserted -712698321 1534488561
12422 Finally, there is a special argument type with the prefix
12423 \begin_inset Flex Code
12426 \begin_layout Plain Layout
12428 \change_inserted -712698321 1534487844
12437 It is not really an argument, but uses the argument interface (thus, the
12438 prefix is also followed by a number, e.
12439 \begin_inset space \thinspace{}
12444 \begin_inset Flex Code
12447 \begin_layout Plain Layout
12449 \change_inserted -712698321 1534488412
12450 Argument listpreamble:1
12456 As the name implies, it is targeted at lists such as
12473 Its content will be output at the list start, before the first
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12479 \change_inserted -712698321 1534488058
12489 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12491 This way, users can insert redefinitions (of lengths etc.) to individual
12493 By default, these arguments do not have a delimiter.
12499 \begin_layout Description
12500 \begin_inset Flex Code
12503 \begin_layout Plain Layout
12509 Includes a comma-separated list of layouts that should be nested in and
12510 after the current layout.
12511 Only makes sense for nestable layouts (such as environments).
12513 \begin_inset Quotes eld
12517 \begin_inset Flex Code
12520 \begin_layout Plain Layout
12527 \begin_inset Quotes erd
12532 \begin_inset Flex Code
12535 \begin_layout Plain Layout
12544 \begin_layout Description
12545 \begin_inset Flex Code
12548 \begin_layout Plain Layout
12554 Note that this will completely override any prior
12555 \begin_inset Flex Code
12558 \begin_layout Plain Layout
12564 declaration for this style.
12566 \begin_inset Quotes eld
12570 \begin_inset Flex Code
12573 \begin_layout Plain Layout
12580 \begin_inset Quotes erd
12585 \begin_inset CommandInset ref
12587 reference "subsec:I18n"
12591 for details on its use.
12594 \begin_layout Description
12595 \begin_inset Flex Code
12598 \begin_layout Plain Layout
12605 \begin_inset Flex Code
12608 \begin_layout Plain Layout
12618 \begin_layout Plain Layout
12619 Note that a `float' here is a real number, such as: 1.5.
12624 The vertical space with which the last of a chain of paragraphs with this
12625 style is separated from the following paragraph.
12626 If the next paragraph has another style, the separations are not simply
12627 added, but the maximum is taken.
12630 \begin_layout Description
12631 \begin_inset Flex Code
12634 \begin_layout Plain Layout
12641 \begin_inset Flex Code
12644 \begin_layout Plain Layout
12650 ] The category for this style.
12651 This is used to group related styles in the style combobox on the toolbar.
12652 Any string can be used, but you may want to use existing categories with
12657 \begin_layout Description
12658 \begin_inset Flex Code
12661 \begin_layout Plain Layout
12667 Depth of XML command.
12668 Used only with XML-type formats.
12671 \begin_layout Description
12672 \begin_inset Flex Code
12675 \begin_layout Plain Layout
12682 \begin_inset Flex Code
12685 \begin_layout Plain Layout
12691 ] Copies all the features of an existing style into the current one.
12695 \begin_layout Description
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12715 ] The name of a style whose preamble should be output
12720 This allows to ensure some ordering of the preamble snippets when macros
12721 definitions depend on one another.
12725 \begin_layout Plain Layout
12726 Note that, besides that functionality, there is no way to ensure any ordering
12728 The ordering that you see in a given version of \SpecialChar LyX
12729 may change without warning
12738 \begin_layout Description
12739 \begin_inset Flex Code
12742 \begin_layout Plain Layout
12749 \begin_inset Flex Code
12752 \begin_layout Plain Layout
12757 , Box, Filled_Box, Static
12762 ] The type of label that stands at the end of the paragraph (or sequence
12764 \begin_inset Flex Code
12767 \begin_layout Plain Layout
12774 \begin_inset Newline newline
12778 \begin_inset Flex Code
12781 \begin_layout Plain Layout
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12809 \begin_inset Flex Code
12812 \begin_layout Plain Layout
12819 \begin_inset Quotes eld
12823 \begin_inset Quotes erd
12827 \begin_inset Flex Code
12830 \begin_layout Plain Layout
12837 \begin_inset space \space{}
12841 \begin_inset Flex Code
12844 \begin_layout Plain Layout
12850 ) is a white (resp.
12851 \begin_inset space ~
12854 black) square suitable for end of proof markers,
12855 \begin_inset Flex Code
12858 \begin_layout Plain Layout
12864 is an explicit text string.
12867 \begin_layout Description
12868 \begin_inset Flex Code
12871 \begin_layout Plain Layout
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12887 ] The string used for a label with a
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12898 \begin_inset Newline newline
12902 \begin_inset Flex Code
12905 \begin_layout Plain Layout
12915 \begin_layout Description
12916 \begin_inset Flex Code
12919 \begin_layout Plain Layout
12925 The font used for both the text body
12931 \begin_inset CommandInset ref
12933 reference "subsec:Font-description"
12938 Note that defining this font automatically defines the
12939 \begin_inset Flex Code
12942 \begin_layout Plain Layout
12949 So you should define this one first if you also want to define
12950 \begin_inset Flex Code
12953 \begin_layout Plain Layout
12962 \begin_layout Description
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12982 ] Used for backporting new styles to stable \SpecialChar LyX
12984 The first stable version that supports this tag is \SpecialChar LyX
12986 The argument is a number which may either be 0, -1 or any value greater
12989 \begin_inset Flex Code
12992 \begin_layout Plain Layout
12998 flag of a style is greater than zero, it will always be written to the
13000 If a .lyx file is read, the style definitions from the document header are
13001 added to the document class.
13002 Therefore even older \SpecialChar LyX
13003 versions can handle the style.
13005 \begin_inset Flex Code
13008 \begin_layout Plain Layout
13014 is a version number: if the style is read, and the version number is less
13015 than the version number of the already existing style in the document class,
13016 the new style is ignored.
13017 If the version number is greater, the new style replaces the existing style.
13018 A value of -1 means an infinite version number, i.
13019 \begin_inset space \thinspace{}
13023 \begin_inset space \space{}
13026 the style is always used.
13029 \begin_layout Description
13030 \begin_inset Flex Code
13033 \begin_layout Plain Layout
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13052 \begin_inset space \thinspace{}
13056 \begin_inset Flex Code
13059 \begin_layout Plain Layout
13065 ] Usually \SpecialChar LyX
13066 does not allow you to insert more than one space between words,
13067 since a space is considered as the separation between two words, not a
13068 character or symbol of its own.
13069 This is a very fine thing but sometimes annoying, for example, when typing
13070 program code or plain \SpecialChar LaTeX
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13083 Note that \SpecialChar LyX
13084 will create protected blanks for the additional blanks when
13085 in another mode than \SpecialChar LaTeX
13089 \begin_layout Description
13090 \begin_inset Flex Code
13093 \begin_layout Plain Layout
13099 These tags are used with XHTML output.
13101 \begin_inset CommandInset ref
13103 reference "subsec:Paragraph-Style-XHTML"
13110 \begin_layout Description
13111 \begin_inset Flex Code
13114 \begin_layout Plain Layout
13120 [FIXME] (Used only with XML-type formats.)
13123 \begin_layout Description
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13134 \begin_inset Flex Code
13137 \begin_layout Plain Layout
13146 \begin_inset space \thinspace{}
13150 \begin_inset Flex Code
13153 \begin_layout Plain Layout
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13169 , marks the style as to be included in the document preamble and not in
13171 This is useful for document classes that want such information as the title
13172 and author to appear in the preamble.
13173 Note that this works only for styles for which the
13174 \begin_inset Flex Code
13177 \begin_layout Plain Layout
13184 \begin_inset Flex Code
13187 \begin_layout Plain Layout
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13206 \begin_layout Description
13207 \begin_inset Flex Code
13210 \begin_layout Plain Layout
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13229 \begin_inset space \thinspace{}
13233 \begin_inset Flex Code
13236 \begin_layout Plain Layout
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13252 , marks the style as being part of a title block (see also the
13253 \begin_inset Flex Code
13256 \begin_layout Plain Layout
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13275 \begin_layout Description
13276 \begin_inset Flex Code
13279 \begin_layout Plain Layout
13285 Includes a comma-separated list of layouts after which this one should
13287 Only makes sense with regard to nestable layouts (such as environments).
13289 \begin_inset Quotes eld
13293 \begin_inset Flex Code
13296 \begin_layout Plain Layout
13303 \begin_inset Quotes erd
13308 \begin_inset Flex Code
13311 \begin_layout Plain Layout
13320 \begin_layout Description
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13343 \begin_inset space \thinspace{}
13347 \begin_inset Flex Code
13350 \begin_layout Plain Layout
13356 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13357 of its contents in its item in the table of contents.
13358 Otherwise, only the label, if it exists, appears.
13361 \begin_layout Description
13362 \begin_inset Flex Code
13365 \begin_layout Plain Layout
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13381 ] The \SpecialChar LaTeX
13382 command sequence declaring an item in a list.
13383 The command is to be defined without the preceding backslash (the default
13385 \begin_inset Quotes eld
13389 \begin_inset Quotes erd
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13404 in the \SpecialChar LaTeX
13408 \begin_layout Description
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13428 ] This provides extra space between paragraphs that have the same style.
13429 If you put other styles into an environment, each is separated with the
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 But the whole items of the environment are additionally separated with
13443 \begin_inset Flex Code
13446 \begin_layout Plain Layout
13453 Note that this is a
13458 \begin_layout Description
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13468 [FIXME] (Used only with XML-type formats.)
13471 \begin_layout Description
13472 \begin_inset Flex Code
13475 \begin_layout Plain Layout
13482 \begin_inset Flex Code
13485 \begin_layout Plain Layout
13494 \begin_inset space \thinspace{}
13498 \begin_inset Flex Code
13501 \begin_layout Plain Layout
13507 ] Usually \SpecialChar LyX
13508 does not allow you to leave a paragraph empty, since it would
13509 lead to empty \SpecialChar LaTeX
13511 There are some cases where this could be desirable however: in a letter
13512 template, the required fields can be provided as empty fields, so that
13513 people do not forget them; in some special classes, a style can be used
13514 as some kind of break, which does not contain actual text.
13517 \begin_layout Description
13518 \begin_inset Flex Code
13521 \begin_layout Plain Layout
13528 \begin_inset Flex Code
13531 \begin_layout Plain Layout
13537 ] The vertical space between the label and the text body.
13538 Only used for labels that are above the text body (
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13549 \begin_inset Newline newline
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13557 Centered_Top_Environment
13565 \begin_layout Description
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13576 \begin_inset Flex Code
13579 \begin_layout Plain Layout
13585 ] The name of the counter for automatic numbering.
13586 In order to have the counter appear with your label, you will need to reference
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13600 This will work with
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 \begin_inset Flex Code
13634 \begin_layout Plain Layout
13641 \begin_inset Newline newline
13649 \begin_inset Flex Code
13652 \begin_layout Plain Layout
13659 \begin_inset Flex Code
13662 \begin_layout Plain Layout
13668 , though this case is a bit complicated.
13669 Suppose you declare
13670 \begin_inset Quotes eld
13674 \begin_inset Flex Code
13677 \begin_layout Plain Layout
13678 LabelCounter myenum
13684 \begin_inset Quotes erd
13688 Then the actual counters used are
13689 \begin_inset Flex Code
13692 \begin_layout Plain Layout
13699 \begin_inset Flex Code
13702 \begin_layout Plain Layout
13709 \begin_inset Flex Code
13712 \begin_layout Plain Layout
13719 \begin_inset Flex Code
13722 \begin_layout Plain Layout
13728 , much as in \SpecialChar LaTeX
13730 These counters must all be declared separately.
13731 \begin_inset Newline newline
13735 \begin_inset CommandInset ref
13737 reference "subsec:Counters"
13741 for details on counters.
13744 \begin_layout Description
13745 \begin_inset Flex Code
13748 \begin_layout Plain Layout
13754 The font used for the label.
13756 \begin_inset CommandInset ref
13758 reference "subsec:Font-description"
13765 \begin_layout Description
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13785 ] Text that indicates how far a label should be indented.
13788 \begin_layout Description
13789 \begin_inset Flex Code
13792 \begin_layout Plain Layout
13799 \begin_inset Flex Code
13802 \begin_layout Plain Layout
13808 ] Text that indicates the amount of horizontal space between the label and
13810 Only used for labels that are not above the text body.
13813 \begin_layout Description
13814 \begin_inset Flex Code
13817 \begin_layout Plain Layout
13824 \begin_inset Flex Code
13827 \begin_layout Plain Layout
13833 ] The string used for the label.
13835 \begin_inset Flex Code
13838 \begin_layout Plain Layout
13844 is set, this string can be contain the special formatting commands described
13846 \begin_inset CommandInset ref
13848 reference "subsec:Counters"
13855 \begin_layout Description
13856 \begin_inset Flex Code
13859 \begin_layout Plain Layout
13860 LabelStringAppendix
13866 \begin_inset Flex Code
13869 \begin_layout Plain Layout
13875 ] This is used inside the appendix instead of
13876 \begin_inset Newline newline
13880 \begin_inset Flex Code
13883 \begin_layout Plain Layout
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13901 \begin_inset Newline newline
13905 \begin_inset Flex Code
13908 \begin_layout Plain Layout
13909 LabelStringAppendix
13917 \begin_layout Description
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13927 [FIXME] (Used only with XML-type formats.)
13930 \begin_layout Description
13931 \begin_inset Flex Code
13934 \begin_layout Plain Layout
13941 \begin_inset Flex Code
13944 \begin_layout Plain Layout
13949 , Manual, Static, Above,
13950 \begin_inset Newline newline
13953 Centered, Sensitive, Enumerate,
13954 \begin_inset Newline newline
13957 Itemize, Bibliography
13966 \begin_layout Description
13967 \begin_inset Flex Code
13970 \begin_layout Plain Layout
13976 means the label is the very first word (up to the first real blank).
13977 Use protected spaces if you want more than one word as the label.
13981 \begin_layout Description
13982 \begin_inset Flex Code
13985 \begin_layout Plain Layout
13991 means the label is simply what is declared as
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14002 This will be displayed
14003 \begin_inset Quotes eld
14007 \begin_inset Quotes erd
14010 , at the beginning of the paragraph.
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14022 \begin_inset Flex Code
14025 \begin_layout Plain Layout
14031 , then it will be displayed only in the first paragraph of any sequence
14032 of paragraphs with the same
14033 \begin_inset Flex Code
14036 \begin_layout Plain Layout
14045 \begin_layout Description
14046 \begin_inset Flex Code
14049 \begin_layout Plain Layout
14056 \begin_inset space ~
14060 \begin_inset space ~
14064 \begin_inset Flex Code
14067 \begin_layout Plain Layout
14073 are special cases of
14074 \begin_inset Flex Code
14077 \begin_layout Plain Layout
14084 The label will be printed above the paragraph either at the beginning of
14085 the line or centered.
14088 \begin_layout Description
14089 \begin_inset Flex Code
14092 \begin_layout Plain Layout
14098 is a special case for the caption-labels
14099 \begin_inset Quotes eld
14103 \begin_inset Quotes erd
14107 \begin_inset Quotes eld
14111 \begin_inset Quotes erd
14115 \begin_inset Newline newline
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14128 means the (hardcoded) label string depends on the kind of float: It is
14129 hardcoded to be `FloatType N', where N is the value of the counter associated
14131 For the case that a caption is inserted outside of a float the
14132 \begin_inset Flex Code
14135 \begin_layout Plain Layout
14142 \begin_inset Quotes eld
14146 \begin_inset Quotes erd
14152 \begin_layout Description
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14162 produces the usual sort of enumeration labels.
14163 The number type needs to be set in the
14168 \begin_inset CommandInset ref
14170 reference "subsec:Counters"
14177 \begin_layout Description
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14187 produces various bullets at the different levels.
14188 The bullet types displayed can be set via
14189 \begin_inset Flex Noun
14192 \begin_layout Plain Layout
14193 Document\SpecialChar menuseparator
14194 Settings\SpecialChar menuseparator
14203 \begin_layout Description
14204 \begin_inset Flex Code
14207 \begin_layout Plain Layout
14213 should be used only with
14214 \begin_inset Flex Code
14217 \begin_layout Plain Layout
14218 LatexType BibEnvironment
14227 \begin_layout Description
14228 \begin_inset Flex Code
14231 \begin_layout Plain Layout
14237 Note that this will completely override any prior
14238 \begin_inset Flex Code
14241 \begin_layout Plain Layout
14247 declaration for this style.
14249 \begin_inset Quotes eld
14253 \begin_inset Flex Code
14256 \begin_layout Plain Layout
14263 \begin_inset Quotes erd
14268 \begin_inset CommandInset ref
14270 reference "subsec:I18n"
14274 for details on its use.
14277 \begin_layout Description
14278 \begin_inset Flex Code
14281 \begin_layout Plain Layout
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14297 ] The name of the corresponding \SpecialChar LaTeX
14299 Either the environment or command name.
14302 \begin_layout Description
14303 \begin_inset Flex Code
14306 \begin_layout Plain Layout
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14322 ] An optional parameter for the corresponding
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14333 This parameter cannot be changed from within \SpecialChar LyX
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14344 for customizable parameters).
14345 This will be output as is after all \SpecialChar LaTeX
14347 \begin_inset Flex Code
14350 \begin_layout Plain Layout
14359 \begin_layout Description
14360 \begin_inset Flex Code
14363 \begin_layout Plain Layout
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14378 , Command, Environment, Item_Environment,
14379 \begin_inset Newline newline
14382 List_Environment, Bib_Environment
14387 ] How the style should be translated into \SpecialChar LaTeX
14392 \begin_layout Plain Layout
14393 \begin_inset Flex Code
14396 \begin_layout Plain Layout
14402 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14403 Visit the SGML class files for specific examples.
14412 \begin_layout Description
14413 \begin_inset Flex Code
14416 \begin_layout Plain Layout
14422 means nothing special.
14425 \begin_layout Description
14426 \begin_inset Flex Code
14429 \begin_layout Plain Layout
14436 \begin_inset Flex Code
14439 \begin_layout Plain Layout
14446 {\SpecialChar ldots
14455 \begin_layout Description
14456 \begin_inset Flex Code
14459 \begin_layout Plain Layout
14466 \begin_inset Flex Code
14469 \begin_layout Plain Layout
14476 }\SpecialChar ldots
14492 \begin_layout Description
14493 \begin_inset Flex Code
14496 \begin_layout Plain Layout
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14513 \begin_inset Flex Code
14516 \begin_layout Plain Layout
14524 is generated for each paragraph of this environment.
14528 \begin_layout Description
14529 \begin_inset Flex Code
14532 \begin_layout Plain Layout
14539 \begin_inset Flex Code
14542 \begin_layout Plain Layout
14549 \begin_inset Newline newline
14553 \begin_inset Flex Code
14556 \begin_layout Plain Layout
14562 is passed as an argument to the environment.
14563 \begin_inset Newline newline
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14576 can be defined in the
14577 \begin_inset Flex Noun
14580 \begin_layout Plain Layout
14581 Edit\SpecialChar menuseparator
14583 \begin_inset space ~
14594 \begin_layout Description
14595 \begin_inset Flex Code
14598 \begin_layout Plain Layout
14605 \begin_inset Flex Code
14608 \begin_layout Plain Layout
14614 but adds the necessary mandatory argument (the longest label) to the begin
14615 statement of the bibliography environment:
14616 \begin_inset Newline newline
14620 \begin_inset Flex Code
14623 \begin_layout Plain Layout
14626 begin{thebibliography}{99}
14632 It is therefore only useful for bibliography environments.
14633 The default longest label
14634 \begin_inset Quotes eld
14638 \begin_inset Quotes erd
14641 can be changed by the user in the paragraph settings of a bibliography
14645 \begin_layout Standard
14646 Putting the last few things together, the \SpecialChar LaTeX
14647 output will be either:
14650 \begin_layout LyX-Code
14653 LatexName[LatexParam]{\SpecialChar ldots
14657 \begin_layout Standard
14661 \begin_layout LyX-Code
14664 begin{LatexName}[LatexParam] \SpecialChar ldots
14670 \begin_layout Standard
14671 depending upon the \SpecialChar LaTeX
14676 \begin_layout Description
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14687 \begin_inset Flex Code
14690 \begin_layout Plain Layout
14696 ] A string that is put at the beginning of the style content.
14697 A line break in the output can be indicated by
14698 \begin_inset Flex Code
14701 \begin_layout Plain Layout
14710 \begin_layout Description
14711 \begin_inset Flex Code
14714 \begin_layout Plain Layout
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14730 ] If you put styles into environments, the different
14731 \begin_inset Flex Code
14734 \begin_layout Plain Layout
14740 are not simply added, but added with a factor
14741 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14745 Note that this parameter is also used when
14746 \begin_inset Flex Code
14749 \begin_layout Plain Layout
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14776 Then it is added to the manual or dynamic margin.
14777 \begin_inset Newline newline
14781 \begin_inset Quotes eld
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14795 \begin_inset Quotes erd
14798 means that the paragraph is indented with the width of
14799 \begin_inset Quotes eld
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14813 \begin_inset Quotes erd
14816 in the normal font.
14817 You can get a negative width by prefixing the string with
14818 \begin_inset Quotes eld
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14832 \begin_inset Quotes erd
14836 This way was chosen so that the look is the same with each used screen
14840 \begin_layout Description
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14851 \begin_inset Flex Code
14854 \begin_layout Plain Layout
14859 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14865 \begin_inset Newline newline
14868 The kind of margin that the style has on the left side.
14872 \begin_layout Description
14873 \begin_inset Flex Code
14876 \begin_layout Plain Layout
14882 just means a fixed margin.
14885 \begin_layout Description
14886 \begin_inset Flex Code
14889 \begin_layout Plain Layout
14895 means that the left margin depends on the string entered in the
14896 \begin_inset Flex Noun
14899 \begin_layout Plain Layout
14900 Edit\SpecialChar menuseparator
14902 \begin_inset space ~
14911 This is used to typeset nice lists without tabulators.
14914 \begin_layout Description
14915 \begin_inset Flex Code
14918 \begin_layout Plain Layout
14924 means that the margin depends on the size of the label.
14925 This is used for automatic enumerated headlines.
14926 It is obvious that the headline
14927 \begin_inset Quotes eld
14930 5.4.3.2.1 Very long headline
14931 \begin_inset Quotes erd
14934 must have a wider left margin (as wide as
14935 \begin_inset Quotes eld
14939 \begin_inset Quotes erd
14942 plus the space) than
14943 \begin_inset Quotes eld
14946 3.2 Very long headline
14947 \begin_inset Quotes erd
14951 \begin_inset Quotes eld
14955 \begin_inset Quotes erd
14958 are not able to do this.
14961 \begin_layout Description
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14971 is similar, but only the very first row of the paragraph is dynamic, while
14972 the others are static; this is used, for example, for descriptions.
14975 \begin_layout Description
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14985 means the margin is chosen in a way that the longest row of this paragraph
14986 fits to the right margin.
14987 This is used to typeset an address on the right edge of the page.
14991 \begin_layout Description
14992 \begin_inset Flex Code
14995 \begin_layout Plain Layout
15002 \begin_inset Flex Code
15005 \begin_layout Plain Layout
15014 \begin_inset space \thinspace{}
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15027 ] Whether fragile commands in this style should be
15028 \begin_inset Flex Code
15031 \begin_layout Plain Layout
15044 whether this command should itself be protected.)
15045 \change_inserted -712698321 1523696949
15049 \begin_layout Description
15051 \change_inserted -712698321 1523696969
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15057 \change_inserted -712698321 1523696950
15064 \begin_inset Flex Code
15067 \begin_layout Plain Layout
15069 \change_inserted -712698321 1523696950
15078 \begin_inset space \thinspace{}
15082 \begin_inset Flex Code
15085 \begin_layout Plain Layout
15087 \change_inserted -712698321 1523696950
15093 ] This causes macros that contain this layout to be protected with
15094 \begin_inset Flex Code
15097 \begin_layout Plain Layout
15099 \change_inserted -712698321 1523696950
15112 ) if necessary and thus allows (some) verbatim stuff in macros.
15117 \begin_layout Description
15118 \begin_inset Flex Code
15121 \begin_layout Plain Layout
15128 \begin_inset Flex Code
15131 \begin_layout Plain Layout
15138 \begin_inset space \thinspace{}
15142 \begin_inset Flex Code
15145 \begin_layout Plain Layout
15153 ] Whether newlines are translated into \SpecialChar LaTeX
15155 \begin_inset Flex Code
15158 \begin_layout Plain Layout
15169 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15171 inside \SpecialChar LyX
15175 \begin_layout Description
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15186 \begin_inset Flex Code
15189 \begin_layout Plain Layout
15198 \begin_inset space \thinspace{}
15202 \begin_inset Flex Code
15205 \begin_layout Plain Layout
15211 ] If set to true, and if
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15231 ) paragraphs are being indented, then the indentation of such a paragraph
15232 following one of this type will be suppressed.
15233 (So this will not affect the display of non-default paragraphs.)
15236 \begin_layout Description
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15256 ] Name of a style that has replaced this style.
15257 This is used to rename a style, while keeping backward compatibility.
15260 \begin_layout Description
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15281 \begin_inset space \thinspace{}
15285 \begin_inset Flex Code
15288 \begin_layout Plain Layout
15294 ] Determines whether consecutive paragraphs of the same type are treated
15295 as belonging together.
15296 This has the effect that the
15297 \begin_inset Flex Code
15300 \begin_layout Plain Layout
15306 is only printed once before such a group.
15307 By default, this is true for
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15318 \begin_inset Flex Code
15321 \begin_layout Plain Layout
15328 \begin_inset Flex Code
15331 \begin_layout Plain Layout
15337 and false for all other types.
15340 \begin_layout Description
15341 \begin_inset Flex Code
15344 \begin_layout Plain Layout
15351 \begin_inset Flex Code
15354 \begin_layout Plain Layout
15363 \begin_inset space \thinspace{}
15367 \begin_inset Flex Code
15370 \begin_layout Plain Layout
15376 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15378 but only by a line break; together with
15379 \begin_inset Flex Code
15382 \begin_layout Plain Layout
15388 , this allows to emulate a plain text editor (like the ERT inset).
15391 \begin_layout Description
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15402 \begin_inset Flex Code
15405 \begin_layout Plain Layout
15411 ] The indent of the very first line of a paragraph.
15413 \begin_inset Newline newline
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15426 will be fixed for a certain style.
15427 The exception is the default style, since the indentation for these paragraphs
15428 can be prohibited with
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15440 \begin_inset Flex Code
15443 \begin_layout Plain Layout
15449 style paragraphs inside environments use the
15450 \begin_inset Flex Code
15453 \begin_layout Plain Layout
15459 of the environment, not their native one.
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15470 paragraphs inside an enumeration are not indented.
15473 \begin_layout Description
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15484 \begin_inset Flex Code
15487 \begin_layout Plain Layout
15493 ] The vertical space between two paragraphs of this style.
15496 \begin_layout Description
15497 \begin_inset Flex Code
15500 \begin_layout Plain Layout
15507 \begin_inset Flex Code
15510 \begin_layout Plain Layout
15517 allows the user to choose either
15518 \begin_inset Quotes eld
15522 \begin_inset Quotes erd
15526 \begin_inset Quotes eld
15530 \begin_inset Quotes erd
15533 to separate paragraphs.
15535 \begin_inset Quotes eld
15539 \begin_inset Quotes erd
15543 \begin_inset Flex Code
15546 \begin_layout Plain Layout
15554 \begin_inset Quotes eld
15558 \begin_inset Quotes erd
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15571 is ignored and all paragraphs are separated by the
15572 \begin_inset Flex Code
15575 \begin_layout Plain Layout
15582 The vertical space is calculated with
15583 \begin_inset Flex Code
15586 \begin_layout Plain Layout
15588 \begin_inset space ~
15597 \begin_inset Flex Code
15600 \begin_layout Plain Layout
15606 is the height of a row with the normal font.
15607 This way, the look stays the same with different screen fonts.
15610 \begin_layout Description
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15633 \begin_inset space \thinspace{}
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15646 ] Whether the contents of this paragraph should be output in raw form, meaning
15647 without special translations that \SpecialChar LaTeX
15651 \begin_layout Description
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15662 \begin_inset Flex Code
15665 \begin_layout Plain Layout
15675 Defines individual characters that should be output in raw form, meaning
15676 without special translations that \SpecialChar LaTeX
15680 \begin_layout Description
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 Information to be included in the \SpecialChar LaTeX
15691 preamble when this style is used.
15692 Used to define macros, load packages, etc., required by this particular
15695 \begin_inset Quotes eld
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15709 \begin_inset Quotes erd
15715 \begin_layout Description
15716 \begin_inset Flex Code
15719 \begin_layout Plain Layout
15726 \begin_inset Flex Code
15729 \begin_layout Plain Layout
15735 ] The prefix to use when creating labels referring to paragraphs of this
15737 This allows the use of formatted references.
15740 \begin_layout Description
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15751 \begin_inset Flex Code
15754 \begin_layout Plain Layout
15760 ] Whether the style requires the feature
15761 \begin_inset Flex Code
15764 \begin_layout Plain Layout
15771 \begin_inset CommandInset ref
15773 reference "chap:List-of-functions"
15777 for the list of features).
15778 If you require a package with specific options, you can additionally use
15780 \begin_inset Flex Code
15783 \begin_layout Plain Layout
15789 as a general text class parameter (see
15790 \begin_inset CommandInset ref
15792 reference "subsec:General-text-class"
15799 \begin_layout Description
15800 \begin_inset Flex Code
15803 \begin_layout Plain Layout
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15822 \begin_inset Flex Code
15825 \begin_layout Plain Layout
15831 ] Resets the \SpecialChar LaTeX
15832 arguments of this style (as defined via the
15833 \begin_inset Flex Code
15836 \begin_layout Plain Layout
15843 This is useful if you have copied a style via
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15853 , but you do not want to inherit its (required and optional) arguments.
15856 \begin_layout Description
15857 \begin_inset Flex Code
15860 \begin_layout Plain Layout
15867 \begin_inset Flex Code
15870 \begin_layout Plain Layout
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 ] Resumes a counter that is usually reset at each new sequence of layouts.
15889 This is currently only useful when
15890 \begin_inset Flex Code
15893 \begin_layout Plain Layout
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15912 \begin_layout Description
15913 \begin_inset Flex Code
15916 \begin_layout Plain Layout
15923 \begin_inset Flex Code
15926 \begin_layout Plain Layout
15932 ] A string that is put at the end of the layout content.
15933 A line break in the output can be indicated by
15934 \begin_inset Flex Code
15937 \begin_layout Plain Layout
15946 \begin_layout Description
15947 \begin_inset Flex Code
15950 \begin_layout Plain Layout
15957 \begin_inset Flex Code
15960 \begin_layout Plain Layout
15967 \begin_inset Flex Code
15970 \begin_layout Plain Layout
15979 \begin_layout Description
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15990 \begin_inset Flex Code
15993 \begin_layout Plain Layout
16002 \begin_inset Flex Code
16005 \begin_layout Plain Layout
16012 \begin_inset Flex Code
16015 \begin_layout Plain Layout
16022 \begin_inset Flex Code
16025 \begin_layout Plain Layout
16027 \begin_inset space ~
16035 ] This defines what the default spacing should be in the style.
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16047 \begin_inset Flex Code
16050 \begin_layout Plain Layout
16057 \begin_inset Flex Code
16060 \begin_layout Plain Layout
16066 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16067 If you specify the argument
16068 \begin_inset Flex Code
16071 \begin_layout Plain Layout
16077 , then you must also provide a value argument which will be the actual multiplie
16079 Note that, contrary to other parameters,
16080 \begin_inset Flex Code
16083 \begin_layout Plain Layout
16089 implies the generation of specific \SpecialChar LaTeX
16090 code, using the \SpecialChar LaTeX
16094 \begin_inset Flex Code
16097 \begin_layout Plain Layout
16106 \begin_layout Description
16107 \begin_inset Flex Code
16110 \begin_layout Plain Layout
16117 \begin_inset Flex Code
16120 \begin_layout Plain Layout
16127 \begin_inset space \thinspace{}
16131 \begin_inset Flex Code
16134 \begin_layout Plain Layout
16142 ] Allow spell-checking paragraphs of this style.
16146 \begin_layout Description
16147 \begin_inset Flex Code
16150 \begin_layout Plain Layout
16157 \begin_inset Flex Code
16160 \begin_layout Plain Layout
16169 \begin_inset Flex Code
16172 \begin_layout Plain Layout
16178 ] Steps the master counter of a given counter at the beginning of a new
16179 sequence of layouts.
16180 This is currently only useful when
16181 \begin_inset Flex Code
16184 \begin_layout Plain Layout
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16203 \begin_layout Description
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 The font used for the text body .
16215 \begin_inset CommandInset ref
16217 reference "subsec:Font-description"
16224 \begin_layout Description
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16250 The level of the style in the table of contents.
16251 This is used for automatic numbering of section headings.
16254 \begin_layout Description
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16291 \begin_inset Flex Code
16294 \begin_layout Plain Layout
16300 ] This tag determines whether the first line indentation of this paragraph
16301 can be toggled via the Paragraph settings dialog.
16305 \begin_inset Flex Code
16308 \begin_layout Plain Layout
16318 is set, indentation can be toggled if the document settings use
16319 \begin_inset Quotes eld
16323 \begin_inset Quotes erd
16326 paragraph style, with
16327 \begin_inset Flex Code
16330 \begin_layout Plain Layout
16336 , indentation can always be toggled, notwithstanding the document settings,
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 , indentation can never be toggled.
16350 \begin_layout Description
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 ] The vertical space with which the very first of a chain of paragraphs
16371 with this style is separated from the previous paragraph.
16372 If the previous paragraph has another style, the separations are not simply
16373 added, but the maximum is taken.
16376 \begin_layout Subsection
16377 \begin_inset CommandInset label
16383 Internationalization of Paragraph Styles
16386 \begin_layout Standard
16388 has long supported internationalization of layout information, but, until
16389 version 2.0, this applied only to the user interface and not to, say, PDF
16391 Thus, French authors were forced to resort to ugly hacks if they wanted
16396 1' instead of `Theorem 1'.
16397 Thanks to Georg Baum, that is no longer the case.
16400 \begin_layout Standard
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16411 defines text that is to appear in the typeset document, it may use
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16422 \begin_inset Flex Code
16425 \begin_layout Plain Layout
16431 to support non-English and even multi-language documents correctly.
16432 The following excerpt (from the
16433 \begin_inset Flex Code
16436 \begin_layout Plain Layout
16442 file) shows how this works:
16445 \begin_layout LyX-Code
16450 \begin_layout LyX-Code
16453 theoremstyle{remark}
16456 \begin_layout LyX-Code
16459 newtheorem{claim}[thm]{
16466 \begin_layout LyX-Code
16470 \begin_layout LyX-Code
16474 \begin_layout LyX-Code
16479 claimname}{_(Claim)}
16482 \begin_layout LyX-Code
16486 \begin_layout LyX-Code
16490 \begin_layout LyX-Code
16499 claimname}{_(Claim)}}
16502 \begin_layout LyX-Code
16507 \begin_layout Standard
16508 In principle, any legal \SpecialChar LaTeX
16510 \begin_inset Flex Code
16513 \begin_layout Plain Layout
16520 \begin_inset Flex Code
16523 \begin_layout Plain Layout
16529 tags, but in practice they will typically look as they do here.
16530 The key to correct translation of the typeset text is the definition of
16531 the \SpecialChar LaTeX
16533 \begin_inset Flex Code
16536 \begin_layout Plain Layout
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16560 \begin_layout Standard
16562 \begin_inset Flex Code
16565 \begin_layout Plain Layout
16571 tag provides for internationalization based upon the overall language of
16573 The contents of the tag will be included in the preamble, just as with
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16585 What makes it special is the use of the
16586 \begin_inset Quotes eld
16590 \begin_inset Quotes erd
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16603 , which will be replaced, when \SpecialChar LyX
16604 produces \SpecialChar LaTeX
16605 output, with the translation of
16606 its argument into the document language.
16609 \begin_layout Standard
16611 \begin_inset Flex Code
16614 \begin_layout Plain Layout
16620 tag is more complex, since it is meant to provide support for multi-language
16621 documents and so offers an interface to the
16622 \begin_inset Flex Code
16625 \begin_layout Plain Layout
16632 Its contents will be added to the preamble once for each language that
16633 appears in the document.
16634 In this case, the argument to
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16644 will be replaced with its translation into the language in question; the
16646 \begin_inset Flex Code
16649 \begin_layout Plain Layout
16655 is replaced by the language name (as used by the babel package).
16658 \begin_layout Standard
16659 A German document that also included a French section would thus have the
16660 following in the preamble:
16663 \begin_layout LyX-Code
16672 claimname}{Affirmation}}
16673 \begin_inset Newline newline
16684 claimname}{Behauptung}}
16685 \begin_inset Newline newline
16692 claimname}{Behauptung}
16695 \begin_layout Standard
16698 \begin_inset Flex Code
16701 \begin_layout Plain Layout
16707 will then conspire to produce the correct text in the output.
16710 \begin_layout Standard
16711 One important point to note here is that the translations are provided by
16713 itself, through the file
16714 \begin_inset Flex Code
16717 \begin_layout Plain Layout
16724 This means, in effect, that
16725 \begin_inset Flex Code
16728 \begin_layout Plain Layout
16735 \begin_inset Flex Code
16738 \begin_layout Plain Layout
16744 are really only of use in layout files that are provided with \SpecialChar LyX
16746 entered in user-created layout files will not be seen by \SpecialChar LyX
16747 's internationalizatio
16748 n routines unless the
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16758 file is modified accordingly.
16759 That said, however, any layout created with the intention that it will
16760 be included with \SpecialChar LyX
16761 should use these tags where appropriate.
16762 Please note that the paragraph style translations provided by \SpecialChar LyX
16764 change with a minor update (e.
16765 \begin_inset space \thinspace{}
16769 \begin_inset space \space{}
16772 from version 2.1.x to 2.1.y).
16773 It is however quite likely that a major update (e.
16774 \begin_inset space \thinspace{}
16778 \begin_inset space \space{}
16781 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16784 \begin_layout Subsection
16786 \begin_inset CommandInset label
16788 name "subsec:Floats"
16795 \begin_layout Standard
16796 It is necessary to define the floats (
16797 \begin_inset Flex Noun
16800 \begin_layout Plain Layout
16807 \begin_inset Flex Noun
16810 \begin_layout Plain Layout
16816 , \SpecialChar ldots
16817 ) in the text class itself.
16818 Standard floats are included in the file
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16828 , so you may have to do no more than add
16831 \begin_layout LyX-Code
16832 Input stdfloats.inc
16835 \begin_layout Standard
16836 to your layout file.
16837 If you want to implement a text class that proposes some other float types
16838 (like the AGU class bundled with \SpecialChar LyX
16839 ), the information below will hopefully
16843 \begin_layout Description
16844 \begin_inset Flex Code
16847 \begin_layout Plain Layout
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16863 =!htbpH] Allowed placement options for this float type.
16864 The value is a string of placement characters.
16865 Possible characters include:
16870 \begin_inset Quotes eld
16874 \begin_inset Quotes erd
16882 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16894 \begin_inset Quotes eld
16898 \begin_inset Quotes erd
16906 \begin_inset Quotes eld
16910 \begin_inset Quotes erd
16918 \begin_inset Quotes eld
16922 \begin_inset Quotes erd
16930 \begin_inset Quotes eld
16934 \begin_inset Quotes erd
16938 The order of the characters in the string does not matter.
16939 If no placement options are allowed, use the string
16946 \begin_layout Description
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16957 \begin_inset Flex Code
16960 \begin_layout Plain Layout
16969 \begin_inset space \thinspace{}
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16988 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17004 if the float does not support this feature.
17007 \begin_layout Description
17008 \begin_inset Flex Code
17011 \begin_layout Plain Layout
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17030 \begin_inset space \thinspace{}
17036 \begin_inset Flex Code
17039 \begin_layout Plain Layout
17049 ] Defines whether the float has a starred variant that spans columns in
17050 a two column paragraph.
17052 \begin_inset Flex Code
17055 \begin_layout Plain Layout
17061 if the float does not support this feature.
17064 \begin_layout Description
17065 \begin_inset Flex Code
17068 \begin_layout Plain Layout
17075 \begin_inset Flex Code
17078 \begin_layout Plain Layout
17085 \begin_inset Quotes erd
17089 \begin_inset Quotes erd
17092 ] The file name extension of an auxiliary file for the list of figures (or
17095 writes the captions to this file.
17098 \begin_layout Description
17099 \begin_inset Flex Code
17102 \begin_layout Plain Layout
17109 \begin_inset Flex Code
17112 \begin_layout Plain Layout
17119 \begin_inset Quotes erd
17123 \begin_inset Quotes erd
17126 ] The string that will be used in the menus and also for the caption.
17127 This is translated to the current language if babel is used.
17130 \begin_layout Description
17131 \begin_inset Flex Code
17134 \begin_layout Plain Layout
17140 These tags control the XHTML output.
17142 \begin_inset CommandInset ref
17144 reference "sec:Tags-for-XHTML"
17151 \begin_layout Description
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17176 \begin_inset space \thinspace{}
17180 \begin_inset Flex Code
17183 \begin_layout Plain Layout
17189 ] Indicates whether the float is already defined in the document class or
17190 if instead the \SpecialChar LaTeX
17192 \begin_inset Flex Code
17195 \begin_layout Plain Layout
17201 needs to be loaded to define it on-the-fly.
17203 \begin_inset Flex Code
17206 \begin_layout Plain Layout
17213 \begin_inset Flex Code
17216 \begin_layout Plain Layout
17223 It should be set to
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17233 if the float is already defined by the \SpecialChar LaTeX
17237 \begin_layout Description
17238 \begin_inset Flex Code
17241 \begin_layout Plain Layout
17248 \begin_inset Flex Code
17251 \begin_layout Plain Layout
17258 \begin_inset Quotes erd
17262 \begin_inset Quotes erd
17265 ] The command used to generate a list of floats of this type; the leading
17274 \begin_inset Flex Code
17277 \begin_layout Plain Layout
17283 is false, since there is no standard way to generate this command.
17285 \begin_inset Flex Code
17288 \begin_layout Plain Layout
17294 is true, since in that case there is a standard way to define the command.
17297 \begin_layout Description
17298 \begin_inset Flex Code
17301 \begin_layout Plain Layout
17308 \begin_inset Flex Code
17311 \begin_layout Plain Layout
17318 \begin_inset Quotes erd
17322 \begin_inset Quotes erd
17325 ] A title for a list of floats of this kind (list of figures, tables, or
17327 It is used for the screen label within \SpecialChar LyX
17328 , it is used by \SpecialChar LaTeX
17330 it is used as the title in the XHTML output.
17331 It will be translated to the document language.
17334 \begin_layout Description
17335 \begin_inset Flex Code
17338 \begin_layout Plain Layout
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17355 \begin_inset Quotes erd
17359 \begin_inset Quotes erd
17362 ] This (optional) argument determines whether floats of this class will
17363 be numbered within some sectional unit of the document.
17365 \begin_inset Flex Code
17368 \begin_layout Plain Layout
17375 \begin_inset Quotes eld
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17389 \begin_inset Quotes erd
17392 , the floats will be numbered within chapters.
17396 \begin_layout Description
17397 \begin_inset Flex Code
17400 \begin_layout Plain Layout
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17417 \begin_inset Quotes erd
17421 \begin_inset Quotes erd
17424 ] The default placement for the given class of floats.
17425 The string should be as in standard \SpecialChar LaTeX
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17437 \begin_inset Flex Code
17440 \begin_layout Plain Layout
17447 \begin_inset Flex Code
17450 \begin_layout Plain Layout
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17466 for top, bottom, page, and here, respectively.
17470 \begin_layout Plain Layout
17471 Note that the order of these letters in the string is irrelevant, like in
17478 On top of that there is a new type,
17479 \begin_inset Flex Code
17482 \begin_layout Plain Layout
17488 , which does not really correspond to a float, since it means: put it
17489 \begin_inset Quotes eld
17493 \begin_inset Quotes erd
17497 Note however that the
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17507 specifier is special and, because of implementation details, cannot be
17508 used in non-built in float types.
17509 If you do not understand what this means, just use
17510 \begin_inset Quotes eld
17514 \begin_inset Flex Code
17517 \begin_layout Plain Layout
17524 \begin_inset Quotes erd
17530 \begin_layout Description
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17550 ] The prefix to use when creating labels referring to floats of this type.
17551 This allows the use of formatted references.
17552 Note that you can remove any
17553 \begin_inset Flex Code
17556 \begin_layout Plain Layout
17562 set by a copied style by using the special value
17563 \begin_inset Quotes eld
17567 \begin_inset Quotes erd
17570 , which must be all caps.
17573 \begin_layout Description
17574 \begin_inset Flex Code
17577 \begin_layout Plain Layout
17584 \begin_inset Flex Code
17587 \begin_layout Plain Layout
17594 \begin_inset Quotes erd
17598 \begin_inset Quotes erd
17601 ] The style used when defining the float using
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17616 \begin_layout Description
17617 \begin_inset Flex Code
17620 \begin_layout Plain Layout
17627 \begin_inset Flex Code
17630 \begin_layout Plain Layout
17637 \begin_inset Quotes erd
17641 \begin_inset Quotes erd
17645 \begin_inset Quotes eld
17649 \begin_inset Quotes erd
17652 of the new class of floats, like program or algorithm.
17653 After the appropriate
17654 \begin_inset Flex Code
17657 \begin_layout Plain Layout
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17692 \begin_layout Description
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17703 \begin_inset Flex Code
17706 \begin_layout Plain Layout
17713 \begin_inset space \thinspace{}
17717 \begin_inset Flex Code
17720 \begin_layout Plain Layout
17728 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17730 \begin_inset Flex Code
17733 \begin_layout Plain Layout
17739 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17743 \begin_layout Standard
17744 Note that defining a float with type
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17756 automatically defines the corresponding counter with name
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17771 \begin_layout Subsection
17772 Flex insets and InsetLayout
17773 \begin_inset CommandInset label
17775 name "subsec:Flex-insets-and"
17782 \begin_layout Standard
17783 Flex insets come in three different kinds:
17786 \begin_layout Itemize
17788 \begin_inset Flex Code
17791 \begin_layout Plain Layout
17797 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17799 \begin_inset Flex Code
17802 \begin_layout Plain Layout
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17825 \begin_layout Itemize
17827 \begin_inset Flex Code
17830 \begin_layout Plain Layout
17836 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17838 footnote, and the like.
17839 An obvious example is an endnote inset, which is defined in the
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17852 \begin_layout Itemize
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17863 ): For use with DocBook classes.
17866 \begin_layout Standard
17867 Flex insets are defined using the
17868 \begin_inset Flex Code
17871 \begin_layout Plain Layout
17877 tag, which shall be explained in a moment.
17880 \begin_layout Standard
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17891 tag also serves another function: It can be used to customize the general
17892 layout of many different types of insets.
17894 \begin_inset Flex Code
17897 \begin_layout Plain Layout
17903 can be used to customize the layout parameters for footnotes, marginal
17904 notes, note insets, \SpecialChar TeX
17905 code (ERT) insets, branches, listings, indexes, boxes,
17906 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17909 \begin_layout Standard
17911 \begin_inset Flex Code
17914 \begin_layout Plain Layout
17920 definition must begin with a line of the form:
17923 \begin_layout LyX-Code
17927 \begin_layout Standard
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17938 indicates the inset whose layout is being defined, and here there are four
17942 \begin_layout Enumerate
17943 The layout for a pre-existing inset is being modified.
17944 In this case, can be
17945 \begin_inset Flex Code
17948 \begin_layout Plain Layout
17954 any one of the following:
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17965 \begin_inset Flex Code
17968 \begin_layout Plain Layout
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18005 \begin_inset Flex Code
18008 \begin_layout Plain Layout
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18055 \begin_inset Flex Code
18058 \begin_layout Plain Layout
18065 \begin_inset Flex Code
18068 \begin_layout Plain Layout
18075 \begin_inset Flex Code
18078 \begin_layout Plain Layout
18085 \begin_inset Flex Code
18088 \begin_layout Plain Layout
18095 \begin_inset Flex Code
18098 \begin_layout Plain Layout
18105 \begin_inset Flex Code
18108 \begin_layout Plain Layout
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18125 \begin_inset Flex Code
18128 \begin_layout Plain Layout
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18145 \begin_inset Flex Code
18148 \begin_layout Plain Layout
18157 \begin_layout Enumerate
18158 The layout for a Flex inset is being defined.
18160 \begin_inset Flex Code
18163 \begin_layout Plain Layout
18169 must be of the form
18170 \begin_inset Quotes eld
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18184 \begin_inset Quotes erd
18188 \begin_inset Flex Code
18191 \begin_layout Plain Layout
18197 may be be any valid identifier not used by a pre-existing Flex inset.
18198 The identifier may include spaces, but in that case the whole thing must
18199 be wrapped in quotes.
18200 Note that the definition of a flex inset
18205 \begin_inset Flex Code
18208 \begin_layout Plain Layout
18214 entry, declaring which type of inset it defines.
18217 \begin_layout Enumerate
18218 The layout for user specific branch is being defined.
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18229 must be of the form
18230 \begin_inset Quotes eld
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18244 \begin_inset Quotes erd
18248 \begin_inset Flex Code
18251 \begin_layout Plain Layout
18257 may be be any valid identifier of branch defined in user's document.
18258 The identifier may include spaces, but in that case the whole thing must
18259 be wrapped in quotes.
18260 The main purpose of this feature is to allow \SpecialChar LaTeX
18261 wrapping around specific
18262 branches as user needs.
18265 \begin_layout Enumerate
18266 The layout of a user (or class) specific caption is being defined.
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18277 must be of the form
18278 \begin_inset Quotes eld
18282 \begin_inset Flex Code
18285 \begin_layout Plain Layout
18292 \begin_inset Quotes erd
18296 \begin_inset Flex Code
18299 \begin_layout Plain Layout
18305 specifies the name of the caption as it appears in the menu.
18306 Have a look at the standard caption (
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18316 ), the specific captions of the KOMA-Script classes (
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18327 \begin_inset Flex Code
18330 \begin_layout Plain Layout
18339 \begin_inset space ~
18343 \begin_inset Newline linebreak
18349 \begin_inset Flex Code
18352 \begin_layout Plain Layout
18358 ) for applications.
18361 \begin_layout Standard
18363 \begin_inset Flex Code
18366 \begin_layout Plain Layout
18372 definition can contain the following entries:
18375 \begin_layout Description
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18395 =""] This inset will appear in the table of contents of the given type.
18396 An empty string disables.
18397 See also the OutlinerName and the IsTocCaption commands.
18398 This is only implemented for Flex insets.
18402 \begin_layout Description
18403 \begin_inset Flex Code
18406 \begin_layout Plain Layout
18413 \begin_inset Flex Code
18416 \begin_layout Plain Layout
18422 ] Defines argument number of a command\SpecialChar breakableslash
18423 environment associated with the current
18425 The definition must end with
18426 \begin_inset Flex Code
18429 \begin_layout Plain Layout
18437 \begin_inset CommandInset ref
18439 reference "subsec:Paragraph-Styles"
18446 \begin_layout Description
18447 \begin_inset Flex Code
18450 \begin_layout Plain Layout
18456 Preamble for changing language commands; see
18457 \begin_inset CommandInset ref
18459 reference "subsec:I18n"
18466 \begin_layout Description
18467 \begin_inset Flex Code
18470 \begin_layout Plain Layout
18477 \begin_inset Flex Code
18480 \begin_layout Plain Layout
18486 ] The color for the inset's background.
18488 \begin_inset CommandInset ref
18490 reference "chap:Names-of-colors"
18494 for a list of the available color names.
18497 \begin_layout Description
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18508 \begin_inset Flex Code
18511 \begin_layout Plain Layout
18520 \begin_inset space \thinspace{}
18524 \begin_inset Flex Code
18527 \begin_layout Plain Layout
18533 ] Whether to use the content of the inset as the label, when the inset is
18538 \begin_layout Description
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18549 \begin_inset Flex Code
18552 \begin_layout Plain Layout
18558 ] As with paragraph styles, see
18559 \begin_inset CommandInset ref
18561 reference "subsec:Paragraph-Styles"
18566 Note that you need to specify the complete type, e.
18567 \begin_inset space \thinspace{}
18571 \begin_inset space ~
18575 \begin_inset Flex Code
18578 \begin_layout Plain Layout
18579 CopyStyle Flex:<name>
18587 \begin_layout Description
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18610 \begin_inset space \thinspace{}
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 ] Indicates whether the user may employ the Paragraph Settings dialog to
18624 customize the paragraph.
18627 \begin_layout Description
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18648 \begin_inset Flex Code
18651 \begin_layout Plain Layout
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18667 , describing the rendering style used for the inset's frame and buttons.
18668 Footnotes generally use
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18678 , ERT insets generally
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18688 , and character styles
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18701 \begin_layout Description
18702 \begin_inset Flex Code
18705 \begin_layout Plain Layout
18712 \begin_inset Flex Code
18715 \begin_layout Plain Layout
18724 \begin_inset space \thinspace{}
18730 \begin_inset Flex Code
18733 \begin_layout Plain Layout
18742 \begin_inset Flex Code
18745 \begin_layout Plain Layout
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18762 Indicates whether the environment will stand on its own in the output or
18763 will appear inline with the surrounding text.
18764 If set to false, it is supposed that the \SpecialChar LaTeX
18765 environment ignores white space
18766 (including one newline character) after the
18767 \begin_inset Flex Code
18770 \begin_layout Plain Layout
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18800 \change_inserted 731793113 1538674858
18804 \begin_layout Description
18806 \change_inserted 731793113 1538674891
18807 \begin_inset Flex Code
18810 \begin_layout Plain Layout
18812 \change_inserted 731793113 1538674863
18824 ,1] Allow the contents of the inset to be edited externally (using whatever
18825 editor is defined for the document's output format).
18830 \begin_layout Description
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18840 Required at the end of the
18841 \begin_inset Flex Code
18844 \begin_layout Plain Layout
18853 \begin_layout Description
18854 \begin_inset Flex Code
18857 \begin_layout Plain Layout
18863 The font used for both the text body
18869 \begin_inset CommandInset ref
18871 reference "subsec:Font-description"
18876 Note that defining this font automatically defines the
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18886 to the same value, so define this first and define
18887 \begin_inset Flex Code
18890 \begin_layout Plain Layout
18896 later if you want them to be different.
18899 \begin_layout Description
18900 \begin_inset Flex Code
18903 \begin_layout Plain Layout
18904 FixedWidthPreambleEncoding
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18922 \begin_inset space \thinspace{}
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 ] Force a fixed width encoding for the translated contents of
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18955 code generated by this layout.
18956 This is needed for special \SpecialChar LaTeX
18961 that do not work with variable width encodings such as
18966 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18967 backends such as Xe\SpecialChar TeX
18969 Lua\SpecialChar TeX
18973 \begin_layout Description
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18978 ForceLocalFontSwitch
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18996 \begin_inset space \thinspace{}
19000 \begin_inset Flex Code
19003 \begin_layout Plain Layout
19009 ] When using babel, always use a local font switch (
19010 \begin_inset Flex Code
19013 \begin_layout Plain Layout
19021 ), never a global one (such as
19022 \begin_inset Flex Code
19025 \begin_layout Plain Layout
19036 \begin_layout Description
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19047 \begin_inset Flex Code
19050 \begin_layout Plain Layout
19059 \begin_inset space \thinspace{}
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19073 \begin_inset Quotes eld
19077 \begin_inset Quotes erd
19080 language, leading to Left-to-Right (Latin) output, e.
19081 \begin_inset space \thinspace{}
19085 \begin_inset space \space{}
19088 in \SpecialChar TeX
19093 \begin_layout Description
19094 \begin_inset Flex Code
19097 \begin_layout Plain Layout
19104 \begin_inset Flex Code
19107 \begin_layout Plain Layout
19116 \begin_inset space \thinspace{}
19120 \begin_inset Flex Code
19123 \begin_layout Plain Layout
19129 ] Force a a line break in the \SpecialChar LaTeX
19130 output before the inset starts and after
19132 This assures the inset itself is output on its own lines, for parsing purposes.
19135 \begin_layout Description
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19158 \begin_inset space \thinspace{}
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19171 ] Indicates whether the
19172 \begin_inset Flex Code
19175 \begin_layout Plain Layout
19181 should be used or, instead, the user can change the paragraph style used
19186 \begin_layout Description
19187 \begin_inset Flex Code
19190 \begin_layout Plain Layout
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19209 \begin_inset space \thinspace{}
19213 \begin_inset Flex Code
19216 \begin_layout Plain Layout
19222 ] As with paragraph styles, see
19223 \begin_inset CommandInset ref
19225 reference "subsec:Paragraph-Styles"
19232 \begin_layout Description
19233 \begin_inset Flex Code
19236 \begin_layout Plain Layout
19242 These tags control the XHTML output.
19244 \begin_inset CommandInset ref
19246 reference "sec:Tags-for-XHTML"
19253 \begin_layout Description
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19264 \begin_inset Flex Code
19267 \begin_layout Plain Layout
19276 \begin_inset space \thinspace{}
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 ] Whether to include the contents of this inset in the strings generated
19290 for the `Outline' pane for all table of contents, regardless of the AddToToc
19292 One would not, for example, want the content of a footnote in a section
19293 header to be included in the TOC displayed in the outline, but one would
19294 normally want the content of a character style displayed.
19295 Default is false: not to include.
19298 \begin_layout Description
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19309 \begin_inset Flex Code
19312 \begin_layout Plain Layout
19321 \begin_inset space \thinspace{}
19325 \begin_inset Flex Code
19328 \begin_layout Plain Layout
19334 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19335 of its contents in its item in the table of contents.
19336 Otherwise, only the label appears.
19339 \begin_layout Description
19340 \begin_inset Flex Code
19343 \begin_layout Plain Layout
19352 \begin_inset Flex Code
19355 \begin_layout Plain Layout
19364 \begin_inset space \thinspace{}
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19377 ] As with paragraph styles, see
19378 \begin_inset CommandInset ref
19380 reference "subsec:Paragraph-Styles"
19387 \begin_layout Description
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19397 The font used for the label.
19399 \begin_inset CommandInset ref
19401 reference "subsec:Font-description"
19406 Note that this definition can never appear before
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19416 , lest it be ineffective.
19419 \begin_layout Description
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19430 \begin_inset Flex Code
19433 \begin_layout Plain Layout
19440 \begin_inset Quotes erd
19444 \begin_inset Quotes erd
19447 ] What will be displayed on the button or elsewhere as the inset label.
19449 \begin_inset Flex Code
19452 \begin_layout Plain Layout
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19469 ) modify this label on the fly.
19472 \begin_layout Description
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19482 Language dependent preamble; see
19483 \begin_inset CommandInset ref
19485 reference "subsec:I18n"
19492 \begin_layout Description
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset Flex Code
19506 \begin_layout Plain Layout
19512 ] The name of the corresponding \SpecialChar LaTeX
19514 Either the environment or command name.
19517 \begin_layout Description
19518 \begin_inset Flex Code
19521 \begin_layout Plain Layout
19528 \begin_inset Flex Code
19531 \begin_layout Plain Layout
19537 ] The optional parameter for the corresponding
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19547 stuff, including possible bracket pairs like
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19558 This parameter cannot be changed from within \SpecialChar LyX
19560 \begin_inset Flex Code
19563 \begin_layout Plain Layout
19569 for customizable parameters).
19570 It will be output as is after all \SpecialChar LaTeX
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19584 \begin_layout Description
19585 \begin_inset Flex Code
19588 \begin_layout Plain Layout
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19599 Command, Environment, None
19604 ] How the style should be translated into \SpecialChar LaTeX
19609 \begin_layout Plain Layout
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19619 is perhaps a bit misleading, since these rules apply to SGML classes too.
19620 Visit the SGML class files for specific examples.
19629 \begin_layout Description
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19639 means nothing special
19642 \begin_layout Description
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19663 {\SpecialChar ldots
19672 \begin_layout Description
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19683 \begin_inset Flex Code
19686 \begin_layout Plain Layout
19693 }\SpecialChar ldots
19708 \begin_layout Standard
19709 Putting the last few things together, the \SpecialChar LaTeX
19710 output will be either:
19713 \begin_layout LyX-Code
19716 LatexName[LatexParam]{\SpecialChar ldots
19720 \begin_layout Standard
19724 \begin_layout LyX-Code
19727 begin{LatexName}[LatexParam] \SpecialChar ldots
19733 \begin_layout Standard
19734 depending upon the \SpecialChar LaTeX
19739 \begin_layout Description
19740 \begin_inset Flex Code
19743 \begin_layout Plain Layout
19750 \begin_inset Flex Code
19753 \begin_layout Plain Layout
19759 ] A string that is put at the beginning of the layout content.
19760 A line break in the output can be indicated by
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19773 \begin_layout Description
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19804 \begin_inset Flex Code
19807 \begin_layout Plain Layout
19814 \begin_inset Flex Code
19817 \begin_layout Plain Layout
19823 (indicating a dummy definition ending definitions of charstyles, etc).
19824 This entry is required in and is only meaningful for Flex insets.
19825 Among other things, it determines on which menu this inset will appear.
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19846 will automatically set
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19877 can be set to true, or
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19897 insets by setting it
19902 \begin_inset Flex Code
19905 \begin_layout Plain Layout
19914 \begin_layout Description
19915 \begin_inset Flex Code
19918 \begin_layout Plain Layout
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19937 \begin_inset space \thinspace{}
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19950 ] Whether multiple paragraphs are permitted in this inset.
19952 \begin_inset Flex Code
19955 \begin_layout Plain Layout
19961 to the same value and
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19971 to the opposite value.
19972 These can be reset to other values, if they are used
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19990 \begin_layout Description
19991 \begin_inset Flex Code
19994 \begin_layout Plain Layout
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20013 \begin_inset space \thinspace{}
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20026 ] Whether fragile commands in this inset should be
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20043 whether the command should itself be protected.) Default is false.
20044 \change_inserted -712698321 1523633958
20048 \begin_layout Description
20050 \change_inserted -712698321 1523634088
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20056 \change_inserted -712698321 1523633961
20063 \begin_inset Flex Code
20066 \begin_layout Plain Layout
20068 \change_inserted -712698321 1523633958
20077 \begin_inset space \thinspace{}
20081 \begin_inset Flex Code
20084 \begin_layout Plain Layout
20086 \change_inserted -712698321 1523633958
20092 ] This causes macros that contain this inset to be protected with
20093 \begin_inset Flex Code
20096 \begin_layout Plain Layout
20098 \change_inserted -712698321 1523634038
20113 ) if necessary and thus allows (some) verbatim stuff in macros.
20119 \begin_layout Description
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20139 ] Deletes an existing
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20152 \begin_layout Description
20153 \begin_inset Flex Code
20156 \begin_layout Plain Layout
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20173 \begin_inset Flex Code
20176 \begin_layout Plain Layout
20182 that has replaced this
20183 \begin_inset Flex Code
20186 \begin_layout Plain Layout
20193 This is used to rename an
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20203 , while keeping backward compatibility.
20206 \begin_layout Description
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20229 \begin_inset space \thinspace{}
20233 \begin_inset Flex Code
20236 \begin_layout Plain Layout
20242 ] As with paragraph styles, see
20243 \begin_inset CommandInset ref
20245 reference "subsec:Paragraph-Styles"
20253 \begin_layout Description
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20276 \begin_inset space \thinspace{}
20280 \begin_inset Flex Code
20283 \begin_layout Plain Layout
20289 ] As with paragraph styles, see
20290 \begin_inset CommandInset ref
20292 reference "subsec:Paragraph-Styles"
20300 \begin_layout Description
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20310 As with paragraph styles, see
20311 \begin_inset CommandInset ref
20313 reference "subsec:Paragraph-Styles"
20320 \begin_layout Description
20321 \begin_inset Flex Code
20324 \begin_layout Plain Layout
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20340 ] The prefix to use when creating labels referring to insets of this type.
20341 This allows the use of formatted references.
20344 \begin_layout Description
20345 \begin_inset Flex Code
20348 \begin_layout Plain Layout
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20364 ] As with paragraph styles, see
20365 \begin_inset CommandInset ref
20367 reference "subsec:Paragraph-Styles"
20374 \begin_layout Description
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20397 \begin_inset space \thinspace{}
20401 \begin_inset Flex Code
20404 \begin_layout Plain Layout
20410 ] Resets the \SpecialChar LaTeX
20411 arguments of this layout (as defined via the
20412 \begin_inset Flex Code
20415 \begin_layout Plain Layout
20422 This is useful if you have copied a style via
20423 \begin_inset Flex Code
20426 \begin_layout Plain Layout
20432 , but you do not want to inherit its (required and optional) arguments.
20435 \begin_layout Description
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20456 \begin_inset space \thinspace{}
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20471 ] Whether this inset should use the font of its surrounding environment
20473 Default is false: use the font of the surrounding environment.
20476 \begin_layout Description
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20487 \begin_inset Flex Code
20490 \begin_layout Plain Layout
20496 ] A string that is put at the end of the layout content.
20497 A line break in the output can be indicated by
20498 \begin_inset Flex Code
20501 \begin_layout Plain Layout
20510 \begin_layout Description
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20521 \begin_inset Flex Code
20524 \begin_layout Plain Layout
20531 \begin_inset space \thinspace{}
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20546 ] Allow spell-checking the contents of this inset.
20550 \begin_layout Subsection
20552 \begin_inset CommandInset label
20554 name "subsec:Counters"
20561 \begin_layout Standard
20562 It is necessary to define the counters (
20563 \begin_inset Flex Noun
20566 \begin_layout Plain Layout
20573 \begin_inset Flex Noun
20576 \begin_layout Plain Layout
20582 , \SpecialChar ldots
20583 ) in the text class itself.
20584 The standard counters are defined in the file
20585 \begin_inset Flex Code
20588 \begin_layout Plain Layout
20594 , so you may have to do no more than add
20597 \begin_layout LyX-Code
20598 Input stdcounters.inc
20601 \begin_layout Standard
20602 to your layout file to get them to work.
20603 But if you want to define custom counters, then you can do so.
20604 The counter declaration must begin with:
20607 \begin_layout LyX-Code
20608 Counter CounterName
20611 \begin_layout Standard
20613 \begin_inset Flex Code
20616 \begin_layout Plain Layout
20622 ' is replaced by the name of the counter.
20623 And it must end with
20624 \begin_inset Quotes eld
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20638 \begin_inset Quotes erd
20642 The following parameters can also be used:
20645 \begin_layout Description
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20665 ] Sets the initial value for the counter, to which it will be reset whenever
20667 Normally, one will want the default, 1.
20670 \begin_layout Description
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20691 \begin_inset Quotes erd
20695 \begin_inset Quotes erd
20698 ] When defined, this string defines how the counter is displayed.
20699 Setting this value sets
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20704 LabelStringAppendix
20710 The following special constructs can be used in the string:
20714 \begin_layout Itemize
20715 \begin_inset Flex Code
20718 \begin_layout Plain Layout
20726 will be replaced by the expansion of the
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20741 LabelStringAppendix
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20760 \begin_layout Itemize
20761 counter values can be expressed using \SpecialChar LaTeX
20763 \begin_inset Newline newline
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20802 \begin_layout Plain Layout
20812 Actually, the situation is a bit more complicated: any
20831 other than those described below will produce arabic numerals.
20832 It would not be surprising to see this change in the future.
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20847 : 1, 2, 3,\SpecialChar ldots
20849 \begin_inset Flex Code
20852 \begin_layout Plain Layout
20858 for lower-case letters: a, b, c, \SpecialChar ldots
20860 \begin_inset Flex Code
20863 \begin_layout Plain Layout
20869 for upper-case letters: A, B, C, \SpecialChar ldots
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20880 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20882 \begin_inset Flex Code
20885 \begin_layout Plain Layout
20891 for upper-case roman numerals: I, II, III\SpecialChar ldots
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20902 for hebrew numerals.
20906 \begin_layout Standard
20907 If LabelString is not defined, a default value is constructed as follows:
20908 if the counter has a master counter
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20929 \begin_inset Newline newline
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20946 is used; otherwise the string
20947 \begin_inset Flex Code
20950 \begin_layout Plain Layout
20961 \begin_layout Description
20962 \begin_inset Flex Code
20965 \begin_layout Plain Layout
20966 LabelStringAppendix
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20982 \begin_inset Quotes erd
20986 \begin_inset Quotes erd
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
20999 , but for use in the Appendix.
21002 \begin_layout Description
21003 \begin_inset Flex Code
21006 \begin_layout Plain Layout
21013 \begin_inset Flex Code
21016 \begin_layout Plain Layout
21023 \begin_inset Quotes erd
21027 \begin_inset Quotes erd
21030 ] A format for use with formatted references to this counter.
21031 For example, one might want to have references to section numbers appear
21033 \begin_inset Quotes eld
21037 \begin_inset Quotes erd
21041 The string should contain
21042 \begin_inset Quotes eld
21046 \begin_inset Quotes erd
21050 This will be replaced by the counter number itself.
21051 So, for sections, it would be: Section ##.
21054 \begin_layout Description
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Quotes erd
21079 \begin_inset Quotes erd
21082 ] If this is set to the name of another counter, the present counter will
21083 be reset every time the other one is increased.
21085 \begin_inset Flex Code
21088 \begin_layout Plain Layout
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21107 \begin_layout Subsection
21109 \begin_inset CommandInset label
21111 name "subsec:Font-description"
21118 \begin_layout Standard
21119 A font description looks like this:
21122 \begin_layout LyX-Code
21139 \begin_layout LyX-Code
21143 \begin_layout LyX-Code
21147 \begin_layout Standard
21148 The following commands are available:
21151 \begin_layout Description
21152 \begin_inset Flex Code
21155 \begin_layout Plain Layout
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21204 \begin_inset Flex Code
21207 \begin_layout Plain Layout
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21264 \begin_inset Flex Code
21267 \begin_layout Plain Layout
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21294 \begin_inset Flex Code
21297 \begin_layout Plain Layout
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21334 \begin_inset Flex Code
21337 \begin_layout Plain Layout
21344 \begin_inset Flex Code
21347 \begin_layout Plain Layout
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21366 \begin_layout Description
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21399 \begin_inset Flex Code
21402 \begin_layout Plain Layout
21411 \begin_layout Description
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21431 ] Valid arguments are:
21432 \begin_inset Flex Code
21435 \begin_layout Plain Layout
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21452 \begin_inset Flex Code
21455 \begin_layout Plain Layout
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21492 \begin_inset Flex Code
21495 \begin_layout Plain Layout
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21512 \begin_inset Flex Code
21515 \begin_layout Plain Layout
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21532 \begin_inset Flex Code
21535 \begin_layout Plain Layout
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21552 Each of these turns on or off the corresponding attribute.
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21563 turns on emphasis, and
21564 \begin_inset Flex Code
21567 \begin_layout Plain Layout
21575 \begin_inset Newline newline
21578 If the latter seems puzzling, remember that the font settings for the present
21579 context are generally inherited from the surrounding context.
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21590 would turn off the emphasis that was anyway in effect, say, in a theorem
21594 \begin_layout Description
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21605 \begin_inset Flex Code
21608 \begin_layout Plain Layout
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21629 \begin_layout Description
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21640 \begin_inset Flex Code
21643 \begin_layout Plain Layout
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21684 \begin_layout Description
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21715 \begin_inset Flex Code
21718 \begin_layout Plain Layout
21727 \begin_inset Flex Code
21730 \begin_layout Plain Layout
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21747 \begin_inset Flex Code
21750 \begin_layout Plain Layout
21757 \begin_inset Flex Code
21760 \begin_layout Plain Layout
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21779 \begin_layout Subsection
21780 \begin_inset CommandInset label
21782 name "subsec:Citation-engine-description"
21786 Cite engine description
21789 \begin_layout Standard
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21800 blocks, as used mainly in cite engine files (see
21801 \begin_inset CommandInset ref
21803 reference "subsec:Cite-Engine-Files"
21810 ), define the citation commands provided by a specific
21811 \begin_inset Quotes eld
21815 \begin_inset Quotes erd
21819 A cite engine, in \SpecialChar LyX
21820 terms, is way specific way to format citations, using
21821 numbers, author names and/or years.
21822 Currently, \SpecialChar LyX
21823 supports three such engine types, namely:
21826 \begin_layout Enumerate
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21836 : the default Bib\SpecialChar TeX
21837 way to format citations, a simple numeric style (e.
21838 \begin_inset space \thinspace{}
21842 \begin_inset Quotes eld
21846 \begin_inset Quotes erd
21852 \begin_layout Enumerate
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21862 : Harvard-styled citations using author names and publication year (e.
21863 \begin_inset space \thinspace{}
21867 \begin_inset Quotes eld
21870 Smith and Miller (2017b)
21871 \begin_inset Quotes erd
21877 \begin_layout Enumerate
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21887 : extended numerical citations that also allow for author or title next
21889 \begin_inset space \thinspace{}
21893 \begin_inset Quotes eld
21896 Smith and Miller [1]
21897 \begin_inset Quotes erd
21903 \begin_layout Standard
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21913 blocks look like this:
21916 \begin_layout LyX-Code
21920 \begin_layout LyX-Code
21924 \begin_layout LyX-Code
21928 \begin_layout LyX-Code
21929 citeyearpar[][]=parencite*
21932 \begin_layout LyX-Code
21936 \begin_layout LyX-Code
21940 \begin_layout Standard
21942 \begin_inset Flex Code
21945 \begin_layout Plain Layout
21951 denotes the engine.
21952 The individual lines respectively define a cite command or cite command
21953 paradigm supported by this engine.
21954 The line can be as simple as a cite command that is used both to name the
21955 respective \SpecialChar LyX
21956 command and the \SpecialChar LaTeX
21957 output or more complex in order to differentiate
21959 The full syntax is:
21962 \begin_layout LyX-Code
21963 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21966 \begin_layout Itemize
21967 \begin_inset Flex Code
21970 \begin_layout Plain Layout
21976 : The name as used in the
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21990 \begin_layout Standard
21991 For portability reasons, we try to use the same name for same-formatted
21992 commands in different cite packages (thus many names stem from natbib,
21993 and thus we need to differentiate a
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22003 sometimes, if the \SpecialChar LaTeX
22004 command names differ).
22008 \begin_layout Itemize
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22018 : a (comma-separated) list of commands that fall back to the given
22019 \begin_inset Flex Code
22022 \begin_layout Plain Layout
22028 in the current engine.
22029 This eases the switch of citation packages and engines.
22031 \begin_inset Flex Code
22034 \begin_layout Plain Layout
22041 \begin_inset Flex Code
22044 \begin_layout Plain Layout
22050 in layout definitions.
22053 \begin_layout Itemize
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22063 : The actual \SpecialChar LaTeX
22064 command that is output.
22068 \begin_layout Standard
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22109 will be output to \SpecialChar LaTeX
22113 \begin_layout Standard
22117 \begin_layout Itemize
22118 Capitalization indicates that the command also has a capitalized form (
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22144 These usually enforce up-casing of name prefixes (
22149 \begin_inset Formula $\Rightarrow$
22159 \begin_layout Itemize
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22170 indicate the number of optional arguments (there can be 0–2).
22173 \begin_layout Itemize
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22184 indicates there is a starred version of the command (
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22198 \begin_inset Flex Code
22201 \begin_layout Plain Layout
22214 \begin_layout Standard
22215 By default, the starred version means: Output all authors even if it should
22217 \begin_inset Quotes eld
22221 \begin_inset Quotes erd
22225 \begin_inset Flex Code
22228 \begin_layout Plain Layout
22237 \begin_layout Standard
22238 If the star has a different meaning for a given command, it can be specified
22240 \begin_inset Flex Code
22243 \begin_layout Plain Layout
22244 <!_stardesc!_stardesctooltip>
22250 Maximal two translatable macro keywords, marked by the prefix
22251 \begin_inset Flex Code
22254 \begin_layout Plain Layout
22261 The first points to the string that replaces the
22262 \begin_inset Quotes eld
22266 \begin_inset Quotes erd
22269 checkbox label in the citation dialog, the second one to an optional tool
22270 tip for this checkbox.
22274 \begin_layout Standard
22275 Note that these two macros have to be defined in a
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22285 (see next section), dropping the
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22295 from the prefix, like this:
22298 \begin_layout LyX-Code
22299 _stardesc Sta&rred command label
22302 \begin_layout LyX-Code
22303 _stardesctooltip Tooltip for the starred command checkbox.
22307 \begin_layout Itemize
22309 \begin_inset Flex Code
22312 \begin_layout Plain Layout
22318 indicates that this command features
22319 \begin_inset Quotes eld
22322 qualified citation lists
22323 \begin_inset Quotes erd
22331 -specific feature for multi-reference citations where an individual pre-
22332 and postnote can be given to each reference in the list.
22333 Please refer to the
22337 manual for details.
22338 \change_inserted -712698321 1526898670
22342 \begin_layout Standard
22344 \change_inserted -712698321 1526899524
22345 If you want to add a cite command to a cite engine (e.
22346 \begin_inset space \thinspace{}
22349 g., add a specific command provided by a class), you can use
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22355 \change_inserted -712698321 1526898768
22356 AddToCiteEngine <engine type> \SpecialChar ldots
22365 Note that only cite commands that do not exist yet are added.
22370 \begin_layout Subsection
22371 \begin_inset CommandInset label
22373 name "subsec:Citation-format-description"
22377 Cite format description
22380 \begin_layout Standard
22382 \begin_inset Flex Code
22385 \begin_layout Plain Layout
22391 blocks are used to describe how bibliographic information should be displayed,
22392 both within \SpecialChar LyX
22393 itself (in the citation dialog and in tooltips, for example)
22394 and in XHTML output.
22395 Such a block might look like this:
22398 \begin_layout LyX-Code
22402 \begin_layout LyX-Code
22406 \begin_layout LyX-Code
22410 \begin_layout LyX-Code
22414 \begin_layout Standard
22418 \begin_layout LyX-Code
22422 \begin_layout LyX-Code
22426 \begin_layout LyX-Code
22430 \begin_layout LyX-Code
22434 \begin_layout Standard
22435 In the first case, the individual lines define how the bibliographic information
22436 associated with an article or book, respectively, is to be displayed, and
22437 such a definition can be given for any
22438 \begin_inset Quotes els
22442 \begin_inset Quotes ers
22445 that might be present in a Bib\SpecialChar TeX
22448 defines a default format in the source code that will be used if no specific
22449 definition has been given.
22451 predefines several formats in the file
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22461 , which is included in most of \SpecialChar LyX
22462 's document classes.
22465 \begin_layout Standard
22466 In the second case, the lines define how a specific citation command (in
22468 \begin_inset Flex Code
22471 \begin_layout Plain Layout
22480 \begin_inset Flex Code
22483 \begin_layout Plain Layout
22491 ) is to be displayed on the citation inset label, in the citation dialog,
22492 menu or XHTML output.
22494 defines such formats for the citation style variants it supports via
22496 Document\SpecialChar menuseparator
22497 Setting\SpecialChar menuseparator
22498 Bibliography\SpecialChar ldots
22502 \begin_inset Flex Code
22505 \begin_layout Plain Layout
22511 files that are shipped with \SpecialChar LyX
22513 \begin_inset CommandInset ref
22515 reference "subsec:Cite-Engine-Files"
22525 \begin_layout Standard
22526 The definitions use a simple language that allows Bib\SpecialChar TeX
22527 keys to be replaced
22529 Keys should be enclosed in
22530 \begin_inset Flex Code
22533 \begin_layout Plain Layout
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22550 So a simple definition might look like this:
22553 \begin_layout LyX-Code
22555 \begin_inset Quotes eld
22559 \begin_inset Quotes erd
22565 \begin_layout Standard
22566 This would print the author, followed by a comma, followed by the title,
22567 in quotes, followed by a period.
22570 \begin_layout Standard
22571 Of course, sometimes you may want to print a key only if it exists.
22572 This can be done by using a conditional construction, such as:
22573 \begin_inset Flex Code
22576 \begin_layout Plain Layout
22578 \begin_inset space ~
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22597 key exists, then print
22598 \begin_inset Quotes eld
22602 \begin_inset space ~
22606 \begin_inset Quotes erd
22609 followed by the volume key.
22610 It is also possible to have an else clause in the conditional, such as:
22611 \begin_inset Newline newline
22615 \begin_inset Flex Code
22618 \begin_layout Plain Layout
22619 {%author%[[%author%]][[%editor%, ed.]]}
22625 \begin_inset Newline newline
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22638 key is printed if it exists; otherwise, the editor key is printed, followed
22640 \begin_inset Quotes eld
22644 \begin_inset space ~
22648 \begin_inset Quotes erd
22651 Note that the key is again enclosed in
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22661 signs; the entire conditional is enclosed in braces; and the if and else
22662 clauses are enclosed in double brackets,
22663 \begin_inset Quotes eld
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22677 \begin_inset Quotes eld
22681 \begin_inset Quotes eld
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Quotes erd
22699 There must be no space between any of these.
22702 \begin_layout Standard
22703 Next to the entry keys, there are some special keys that can be used for
22704 these conditionals:
22707 \begin_layout Itemize
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22712 {%dialog%[[true]][[false]]}
22718 \begin_inset Quotes eld
22722 \begin_inset Quotes erd
22725 part for dialogs and menus, the
22726 \begin_inset Quotes eld
22730 \begin_inset Quotes erd
22733 part for other contexts (workarea, export)
22736 \begin_layout Itemize
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22741 {%export%[[true]][[false]]}
22747 \begin_inset Quotes eld
22751 \begin_inset Quotes erd
22754 part for export and menus, the
22755 \begin_inset Quotes eld
22759 \begin_inset Quotes erd
22762 part for other contexts (workarea, dialog)
22765 \begin_layout Itemize
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22776 \begin_inset Quotes eld
22780 \begin_inset Quotes erd
22783 part if another item follows (e.
22784 \begin_inset space \thinspace{}
22787 g., in a citation with multiple keys)
22790 \begin_layout Itemize
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22795 {%second%[[true]][[false]]}
22801 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22808 if this is the second of multiple items, else the
22809 \begin_inset Quotes eld
22813 \begin_inset Quotes erd
22819 \begin_layout Itemize
22820 \begin_inset Flex Code
22823 \begin_layout Plain Layout
22824 {%ifstar%[[true]][[false]]}
22830 \begin_inset Quotes eld
22834 \begin_inset Quotes erd
22837 part for starred citation commands (such as
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22849 ), the false part for unstarred
22852 \begin_layout Itemize
22853 \begin_inset Flex Code
22856 \begin_layout Plain Layout
22857 {%ifentrytype:<type>%[[true]][[false]]}
22863 \begin_inset Quotes eld
22867 \begin_inset Quotes erd
22870 if the current entry type matches
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22880 , else the false part (e.g., in a citation definition:
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22885 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22893 \begin_layout Itemize
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22898 {%ifmultiple:<authortype>%[[true]][[false]]}
22904 \begin_inset Quotes eld
22908 \begin_inset Quotes erd
22911 if the current author type (author, editor etc.) has multiple authors, else
22912 the false part (e.g., in a bibliography definition:
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22917 {%ifmultiple:editor%[[eds.]][[ed.]]}
22925 \begin_layout Itemize
22926 \begin_inset Flex Code
22929 \begin_layout Plain Layout
22930 {%ifqualified%[[true]][[false]]}
22936 \begin_inset Quotes eld
22940 \begin_inset Quotes erd
22943 part if the current citation is a qualified citation list (a specific
22947 format for multi-reference citations), the false part if this is not the
22951 \begin_layout Standard
22953 \begin_inset Flex Code
22956 \begin_layout Plain Layout
22962 prints the author key as it is recorded in the bibliography file.
22963 This might not be what you want, since it will result in a string such
22965 \begin_inset Quotes eld
22968 Miller, Peter and Smith, Mary and White, Jane
22969 \begin_inset Quotes erd
22973 \begin_inset Quotes eld
22977 \begin_inset Quotes erd
22980 is used by Bib\SpecialChar TeX
22981 to delimit authors).
22983 therefore provides some methods to get properly formatted name lists (which
22984 will also get translated).
22985 The following keys are provided:
22988 \begin_layout Enumerate
22989 For name lists with pre- and surname, suitable for the main authors/editors
22990 of a bibliography item.
22992 \begin_inset Flex Code
22995 \begin_layout Plain Layout
23001 part denotes the kind of list that is requested (e.g.
23003 \begin_inset Flex Code
23006 \begin_layout Plain Layout
23016 \begin_layout Itemize
23017 \begin_inset Flex Code
23020 \begin_layout Plain Layout
23021 %abbrvnames:<nametype>%
23026 : Provides a name list which is abbreviated (with
23027 \begin_inset Quotes eld
23031 \begin_inset Quotes erd
23035 \begin_inset Flex Code
23038 \begin_layout Plain Layout
23047 \begin_layout Itemize
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23052 %fullnames:<nametype>%
23057 : Provides a full name list (never abbreviated with
23058 \begin_inset Quotes eld
23062 \begin_inset Quotes erd
23068 \begin_layout Itemize
23069 \begin_inset Flex Code
23072 \begin_layout Plain Layout
23073 %forceabbrvnames:<nametype>%
23078 : Provides a name list which is always abbreviated (with
23079 \begin_inset Quotes eld
23083 \begin_inset Quotes erd
23087 \begin_inset Flex Code
23090 \begin_layout Plain Layout
23100 \begin_layout Enumerate
23101 Alternative name lists with pre- and surname, if the order of pre- and surname
23102 inside the bibliography item differs (as in:
23103 \begin_inset Quotes eld
23106 Miller, John: Some text, in: Mary Smith, ed.: A volume
23107 \begin_inset Quotes erd
23114 \begin_layout Itemize
23115 \begin_inset Flex Code
23118 \begin_layout Plain Layout
23119 %abbrvbynames:<nametype>%
23124 : Provides a name list which is abbreviated (with
23125 \begin_inset Quotes eld
23129 \begin_inset Quotes erd
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23145 \begin_layout Itemize
23146 \begin_inset Flex Code
23149 \begin_layout Plain Layout
23150 %fullbynames:<nametype>%
23155 : Provides a full name list (never abbreviated with
23156 \begin_inset Quotes eld
23160 \begin_inset Quotes erd
23166 \begin_layout Itemize
23167 \begin_inset Flex Code
23170 \begin_layout Plain Layout
23171 %forceabbrvbynames:<nametype>%
23176 : Provides a name list which is always abbreviated (with
23177 \begin_inset Quotes eld
23181 \begin_inset Quotes erd
23185 \begin_inset Flex Code
23188 \begin_layout Plain Layout
23198 \begin_layout Enumerate
23199 And finally name lists which consist of family names only, as used in author-yea
23201 These do not take a
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23211 part, but always return either an author list or, if this does not exist,
23212 an editor list (as common in author-year labels):
23216 \begin_layout Itemize
23217 \begin_inset Flex Code
23220 \begin_layout Plain Layout
23226 : Provides a name list which is abbreviated (with
23227 \begin_inset Quotes eld
23231 \begin_inset Quotes erd
23235 \begin_inset Flex Code
23238 \begin_layout Plain Layout
23247 \begin_layout Itemize
23248 \begin_inset Flex Code
23251 \begin_layout Plain Layout
23257 : Provides a full name list (never abbreviated with
23258 \begin_inset Quotes eld
23262 \begin_inset Quotes erd
23268 \begin_layout Itemize
23269 \begin_inset Flex Code
23272 \begin_layout Plain Layout
23273 %forceabbrvciteauthor%
23278 : Provides a name list which is always abbreviated (with
23279 \begin_inset Quotes eld
23283 \begin_inset Quotes erd
23287 \begin_inset Flex Code
23290 \begin_layout Plain Layout
23300 \begin_layout Standard
23301 The order of pre- and surname in the former two lists can be adjusted by
23305 \begin_layout Itemize
23306 \begin_inset Flex Code
23309 \begin_layout Plain Layout
23310 !firstnameform %surname%, %prename%
23315 (first author in lists of type 1)
23318 \begin_layout Itemize
23319 \begin_inset Flex Code
23322 \begin_layout Plain Layout
23323 !othernameform %surname%, %prename%
23328 (other authors in lists of type 1)
23331 \begin_layout Itemize
23332 \begin_inset Flex Code
23335 \begin_layout Plain Layout
23336 !firstbynameform %prename% %surname%
23341 (first author in lists of type 2)
23344 \begin_layout Itemize
23345 \begin_inset Flex Code
23348 \begin_layout Plain Layout
23349 !otherbynameform %prename% %surname%
23354 (other authors in lists of type 2)
23357 \begin_layout Standard
23358 This allows you to configure namings like
23359 \begin_inset Quotes eld
23362 Miller, Peter and Mary Smith: \SpecialChar ldots
23363 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23365 \begin_inset Quotes erd
23371 \begin_layout Standard
23372 There is one other piece of syntax available in definitions, which looks
23374 \begin_inset Flex Code
23377 \begin_layout Plain Layout
23384 This defines a piece of formatting information that is to be used when
23386 \begin_inset Quotes eld
23390 \begin_inset Quotes erd
23394 Obviously, we do not want to output HTML tags when writing plain text,
23395 so they should be wrapped in
23396 \begin_inset Quotes eld
23400 \begin_inset Quotes erd
23404 \begin_inset Quotes eld
23408 \begin_inset Quotes erd
23414 \begin_layout Standard
23415 Two special sorts of definitions are also possible in a
23416 \begin_inset Flex Code
23419 \begin_layout Plain Layout
23426 An example of the first would be:
23429 \begin_layout LyX-Code
23431 \begin_inset Quotes eld
23435 \begin_inset Quotes erd
23441 \begin_layout Standard
23442 This is an abbreviation, or macro, and it can be used by treating it as
23444 \begin_inset Flex Code
23447 \begin_layout Plain Layout
23456 \begin_inset Flex Code
23459 \begin_layout Plain Layout
23465 exactly as it would treat its definition.
23466 So, let us issue the obvious
23474 \begin_layout LyX-Code
23478 \begin_layout Standard
23479 or anything like it.
23481 shouldn't go into an infinite loop, but it may go into a long one before
23485 \begin_layout Standard
23486 The second sort of special definition might look like this:
23489 \begin_layout LyX-Code
23493 \begin_layout Standard
23494 This defines a translatable piece of text, which allows relevant parts of
23495 the bibliography or citation to be translated.
23496 It can be included in a definition by treating it as a key:
23497 \begin_inset Flex Code
23500 \begin_layout Plain Layout
23507 Note that there are two different translation paths: All definitions starting
23509 \begin_inset Flex Code
23512 \begin_layout Plain Layout
23518 , such as in the example above, will be translated to the currently active
23519 buffer language (so the translation will match the generated document).
23520 All definitions starting with underscore only will be translated to the
23522 This is the proper translation for strings that only occur in the dialogs
23523 or on buttons, such as this one:
23526 \begin_layout LyX-Code
23527 _addtobib Add to bibliography only.
23530 \begin_layout Standard
23531 Several of these translatable strings are predefined in
23532 \begin_inset Flex Code
23535 \begin_layout Plain Layout
23542 \begin_inset Flex Code
23545 \begin_layout Plain Layout
23552 Note that these are not macros, in the sense just defined.
23553 They will not be expanded.
23556 \begin_layout Standard
23557 So here then is an example that uses several of these features:
23558 \begin_inset VSpace defskip
23564 \begin_layout Standard
23568 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23571 \begin_layout Standard
23572 \begin_inset VSpace defskip
23575 This defines a macro that prints the author, followed by a comma, if the
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23586 key is defined, or else prints the name of the editor, followed by the
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23597 or its translation (it is by default
23598 \begin_inset Quotes eld
23602 \begin_inset Quotes erd
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 Note that this is in fact defined in
23617 \begin_inset Flex Code
23620 \begin_layout Plain Layout
23626 , so you can use it in your own definitions, or re-definitions, if you load
23630 \begin_layout Section
23631 \begin_inset CommandInset label
23633 name "sec:Tags-for-XHTML"
23637 Tags for XHTML output
23640 \begin_layout Standard
23641 As with \SpecialChar LaTeX
23642 or DocBook, the format of \SpecialChar LyX
23643 's XHTML output is also controlled by
23644 layout information.
23645 In general, \SpecialChar LyX
23646 provides sensible defaults and, as mentioned earlier, it will
23647 even construct default CSS style rules from the other layout tags.
23648 For example, \SpecialChar LyX
23649 will attempt to use the information provided in the
23650 \begin_inset Flex Code
23653 \begin_layout Plain Layout
23659 declaration for the Chapter style to write CSS that will appropriately
23660 format chapter headings.
23663 \begin_layout Standard
23664 In many cases, then, you may not have to do anything at all to get acceptable
23665 XHTML output for your own environments, custom insets, and so forth.
23666 But in some cases you will, and so \SpecialChar LyX
23667 provides a number of layout tags that
23668 can be used to customize the XHTML and CSS that are generated.
23671 \begin_layout Standard
23672 Note that there are two tags,
23673 \begin_inset Flex Code
23676 \begin_layout Plain Layout
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23692 that may appear outside style and inset declarations.
23694 \begin_inset CommandInset ref
23696 reference "subsec:General-text-class"
23700 for details on these.
23703 \begin_layout Subsection
23704 \begin_inset CommandInset label
23706 name "subsec:Paragraph-Style-XHTML"
23713 \begin_layout Standard
23714 The sort of XHTML \SpecialChar LyX
23715 outputs for a paragraph depends upon whether we are dealing
23716 with a normal paragraph, a command, or an environment, where this is itself
23717 determined by the contents of the corresponding
23718 \begin_inset Flex Code
23721 \begin_layout Plain Layout
23732 \begin_layout Standard
23733 For a command or normal paragraph, the output XHTML has the following form:
23736 \begin_layout LyX-Code
23740 \begin_inset Quotes erd
23744 \begin_inset Quotes erd
23750 \begin_layout LyX-Code
23754 \begin_inset Quotes erd
23758 \begin_inset Quotes erd
23764 \begin_layout LyX-Code
23767 Contents of the paragraph.
23770 \begin_layout LyX-Code
23776 \begin_layout Standard
23777 The label tags are of course omitted if the paragraph does not have a label.
23780 \begin_layout Standard
23781 For an environment that is not some sort of list, the XHTML takes this form:
23784 \begin_layout LyX-Code
23788 \begin_inset Quotes erd
23792 \begin_inset Quotes erd
23798 \begin_layout LyX-Code
23802 \begin_inset Quotes erd
23806 \begin_inset Quotes erd
23810 \begin_inset Quotes erd
23814 \begin_inset Quotes erd
23817 >Environment Label</labeltag>First paragraph.</itemtag>
23820 \begin_layout LyX-Code
23823 <itemtag>Second paragraph.</itemtag>
23826 \begin_layout LyX-Code
23832 \begin_layout Standard
23833 Note that the label is output only for the first paragraph, as it should
23834 be for a theorem, for example.
23838 \begin_layout Standard
23839 For a list, we have one of these forms:
23842 \begin_layout LyX-Code
23846 \begin_inset Quotes erd
23850 \begin_inset Quotes erd
23856 \begin_layout LyX-Code
23860 \begin_inset Quotes erd
23864 \begin_inset Quotes erd
23868 \begin_inset Quotes erd
23872 \begin_inset Quotes erd
23875 >List Label</labeltag>First item.</itemtag>
23878 \begin_layout LyX-Code
23882 \begin_inset Quotes erd
23886 \begin_inset Quotes erd
23890 \begin_inset Quotes erd
23894 \begin_inset Quotes erd
23897 >List Label</labeltag>Second item.</itemtag>
23900 \begin_layout LyX-Code
23906 \begin_layout LyX-Code
23910 \begin_layout LyX-Code
23914 \begin_inset Quotes erd
23918 \begin_inset Quotes erd
23924 \begin_layout LyX-Code
23928 \begin_inset Quotes erd
23932 \begin_inset Quotes erd
23935 >List Label</labeltag><itemtag attr=
23936 \begin_inset Quotes erd
23940 \begin_inset Quotes erd
23943 >First item.</itemtag>
23946 \begin_layout LyX-Code
23950 \begin_inset Quotes erd
23954 \begin_inset Quotes erd
23957 >List Label</labeltag><itemtag attr=
23958 \begin_inset Quotes erd
23962 \begin_inset Quotes erd
23965 >Second item.</itemtag>
23968 \begin_layout LyX-Code
23974 \begin_layout Standard
23975 Note the different orders of
23976 \begin_inset Flex Code
23979 \begin_layout Plain Layout
23986 \begin_inset Flex Code
23989 \begin_layout Plain Layout
23996 Which order we get depends upon the setting of
23997 \begin_inset Flex Code
24000 \begin_layout Plain Layout
24007 \begin_inset Flex Code
24010 \begin_layout Plain Layout
24016 is false (the default), you get the first of these, with the label within
24017 the item; if true, you get the second, with the label outside the item.
24020 \begin_layout Standard
24021 The specific tags and attributes output for each paragraph type can be controlle
24022 d by means of the layout tags we are about to describe.
24023 As mentioned earlier, however, \SpecialChar LyX
24024 uses sensible defaults for many of these,
24025 so you often may not need to do very much to get good XHTML output.
24026 Think of the available tags as there so you can tweak things to your liking.
24029 \begin_layout Description
24030 \begin_inset Flex Code
24033 \begin_layout Plain Layout
24040 \begin_inset Flex Code
24043 \begin_layout Plain Layout
24049 ] Specifies attribute information to be output with the main tag.
24051 \begin_inset Quotes eld
24055 \begin_inset Flex Code
24058 \begin_layout Plain Layout
24065 \begin_inset Quotes erd
24069 By default, \SpecialChar LyX
24071 \begin_inset Quotes eld
24075 \begin_inset Flex Code
24078 \begin_layout Plain Layout
24085 \begin_inset Quotes erd
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24098 is the \SpecialChar LyX
24099 name of the layout, made lowercase, for example: chapter.
24104 contain any style information.
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24118 \begin_layout Description
24119 \begin_inset Flex Code
24122 \begin_layout Plain Layout
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24142 ] Whether to output the default CSS information \SpecialChar LyX
24143 generates for this layout,
24144 even if additional information is explicitly provided via
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24165 allows you to alter or augment the generated CSS, rather than to override
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24180 \begin_layout Description
24181 \begin_inset Flex Code
24184 \begin_layout Plain Layout
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24200 ] The tag to be used for individual paragraphs of environments, replacing
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24211 in the examples above.
24213 \begin_inset Flex Code
24216 \begin_layout Plain Layout
24225 \begin_layout Description
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24245 ] Attributes for the item tag.
24247 \begin_inset Newline newline
24251 \begin_inset Quotes eld
24255 \begin_inset Flex Code
24258 \begin_layout Plain Layout
24259 class=`layoutname_item'
24265 \begin_inset Quotes erd
24273 contain any style information.
24275 \begin_inset Flex Code
24278 \begin_layout Plain Layout
24287 \begin_layout Description
24288 \begin_inset Flex Code
24291 \begin_layout Plain Layout
24298 \begin_inset Flex Code
24301 \begin_layout Plain Layout
24307 ] The tag to be used for paragraph and item labels, replacing
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24317 in the examples above.
24319 \begin_inset Flex Code
24322 \begin_layout Plain Layout
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24339 \begin_inset Flex Code
24342 \begin_layout Plain Layout
24349 \begin_inset Flex Code
24352 \begin_layout Plain Layout
24353 Centered_Top_Environment
24358 , in which case it defaults to
24359 \begin_inset Flex Code
24362 \begin_layout Plain Layout
24371 \begin_layout Description
24372 \begin_inset Flex Code
24375 \begin_layout Plain Layout
24382 \begin_inset Flex Code
24385 \begin_layout Plain Layout
24391 ] Attributes for the label tag.
24393 \begin_inset Newline newline
24397 \begin_inset Quotes eld
24401 \begin_inset Flex Code
24404 \begin_layout Plain Layout
24405 class=`layoutname_label'
24411 \begin_inset Quotes erd
24419 contain any style information.
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24433 \begin_layout Description
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24444 \begin_inset Flex Code
24447 \begin_layout Plain Layout
24457 ] Meaningful only for list-like environments, this tag controls whether
24458 the label tag is output before or inside the item tag.
24459 This is used, for example, in the description environment, where we want
24461 \begin_inset Flex Code
24464 \begin_layout Plain Layout
24465 <dt>\SpecialChar ldots
24466 </dt><dd>\SpecialChar ldots
24474 \begin_inset Flex Code
24477 \begin_layout Plain Layout
24483 : The label tag is output inside the item tag.
24486 \begin_layout Description
24487 \begin_inset Flex Code
24490 \begin_layout Plain Layout
24496 Information to be output in the
24497 \begin_inset Flex Code
24500 \begin_layout Plain Layout
24506 section when this style is used.
24507 This might, for example, be used to include a
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24530 \begin_layout Description
24531 \begin_inset Flex Code
24534 \begin_layout Plain Layout
24540 CSS style information to be included when this style is used.
24541 Note that this will automatically be wrapped in a layout-generated
24542 \begin_inset Flex Code
24545 \begin_layout Plain Layout
24551 block, so only the CSS itself need be included.
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24565 \begin_layout Description
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24576 \begin_inset Flex Code
24579 \begin_layout Plain Layout
24585 ] The tag to be used for the main label, replacing
24586 \begin_inset Flex Code
24589 \begin_layout Plain Layout
24595 in the examples above.
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24609 \begin_layout Description
24610 \begin_inset Flex Code
24613 \begin_layout Plain Layout
24620 \begin_inset Flex Code
24623 \begin_layout Plain Layout
24633 ] Marks this style as the one to be used to generate the
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24643 tag for the XHTML file.
24644 By default, it is false.
24646 \begin_inset Flex Code
24649 \begin_layout Plain Layout
24655 file sets it to true for the
24656 \begin_inset Flex Code
24659 \begin_layout Plain Layout
24669 \begin_layout Subsection
24673 \begin_layout Standard
24674 The XHTML output of insets can also be controlled by information in layout
24679 \begin_layout Plain Layout
24680 At present, this is true only for
24681 \begin_inset Quotes eld
24685 \begin_inset Quotes erd
24688 insets (insets you can type into) and is not true for
24689 \begin_inset Quotes eld
24693 \begin_inset Quotes erd
24696 insets (insets that are associated with dialog boxes).
24701 Here, too, \SpecialChar LyX
24702 tries to provide sensible defaults, and it constructs default
24704 But everything can be customized.
24707 \begin_layout Standard
24708 The XHTML \SpecialChar LyX
24709 outputs for an inset has the following form:
24712 \begin_layout LyX-Code
24714 \begin_inset Quotes erd
24718 \begin_inset Quotes erd
24724 \begin_layout LyX-Code
24725 <labeltag>Label</labeltag>
24728 \begin_layout LyX-Code
24730 \begin_inset Quotes erd
24734 \begin_inset Quotes erd
24737 >Contents of the inset.</innertag>
24740 \begin_layout LyX-Code
24744 \begin_layout Standard
24745 If the inset permits multiple paragraphs—that is, if
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24755 is true—then the contents of the inset will itself be output as paragraphs
24756 formatted according to the styles used for those paragraphs (standard,
24757 quote, and the like).
24758 The label tag is of course omitted if the paragraph does not have a label
24759 and, at present, is always
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24770 The inner tag is optional and, by default, does not appear.
24773 \begin_layout Standard
24774 The specific tags and attributes output for each inset can be controlled
24775 by means of the following layout tags.
24778 \begin_layout Description
24779 \begin_inset Flex Code
24782 \begin_layout Plain Layout
24789 \begin_inset Flex Code
24792 \begin_layout Plain Layout
24798 ] Specifies attribute information to be output with the main tag.
24800 \begin_inset Quotes eld
24804 \begin_inset Flex Code
24807 \begin_layout Plain Layout
24808 class=`myinset' onclick=`\SpecialChar ldots
24815 \begin_inset Quotes erd
24819 By default, \SpecialChar LyX
24821 \begin_inset Quotes eld
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24835 \begin_inset Quotes erd
24839 \begin_inset Flex Code
24842 \begin_layout Plain Layout
24848 is the \SpecialChar LyX
24849 name of the inset, made lowercase and with non-alphanumeric characters
24850 converted to underscores, for example: footnote.
24853 \begin_layout Description
24854 \begin_inset Flex Code
24857 \begin_layout Plain Layout
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24877 ] Whether to output the default CSS information \SpecialChar LyX
24878 generates for this layout,
24879 even if additional information is explicitly provided via
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24900 allows you to alter or augment the generated CSS, rather than to override
24905 \begin_layout Description
24906 \begin_inset Flex Code
24909 \begin_layout Plain Layout
24916 \begin_inset Flex Code
24919 \begin_layout Plain Layout
24925 ] Attributes for the inner tag.
24927 \begin_inset Newline newline
24931 \begin_inset Quotes eld
24935 \begin_inset Flex Code
24938 \begin_layout Plain Layout
24939 class=`insetname_inner'
24945 \begin_inset Quotes erd
24951 \begin_layout Description
24952 \begin_inset Flex Code
24955 \begin_layout Plain Layout
24962 \begin_inset Flex Code
24965 \begin_layout Plain Layout
24971 ] The inner tag, replacing
24972 \begin_inset Flex Code
24975 \begin_layout Plain Layout
24981 in the examples above.
24982 By default, there is none.
24985 \begin_layout Description
24986 \begin_inset Flex Code
24989 \begin_layout Plain Layout
24996 \begin_inset Flex Code
24999 \begin_layout Plain Layout
25007 ] Whether this inset represents a standalone block of text (such as a footnote)
25008 or instead represents material that is included in the surrounding text
25009 (such as a branch).
25013 \begin_layout Description
25014 \begin_inset Flex Code
25017 \begin_layout Plain Layout
25024 \begin_inset Flex Code
25027 \begin_layout Plain Layout
25033 ] A label for this inset, possibly including a reference to a counter.
25034 For example, for footnote, it might be:
25035 \begin_inset Flex Code
25038 \begin_layout Plain Layout
25047 This is optional, and there is no default.
25050 \begin_layout Description
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25060 Information to be output in the
25061 \begin_inset Flex Code
25064 \begin_layout Plain Layout
25070 section when this style is used.
25071 This might, for example, be used to include a
25072 \begin_inset Flex Code
25075 \begin_layout Plain Layout
25082 \begin_inset Flex Code
25085 \begin_layout Plain Layout
25094 \begin_layout Description
25095 \begin_inset Flex Code
25098 \begin_layout Plain Layout
25104 CSS style information to be included when this style is used.
25105 Note that this will automatically be wrapped in a layout-generated
25106 \begin_inset Flex Code
25109 \begin_layout Plain Layout
25115 block, so only the CSS itself need be included.
25118 \begin_layout Description
25119 \begin_inset Flex Code
25122 \begin_layout Plain Layout
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25138 ] The tag to be used for the main label, replacing
25139 \begin_inset Flex Code
25142 \begin_layout Plain Layout
25148 in the examples above.
25149 The default depends upon the setting of
25150 \begin_inset Flex Code
25153 \begin_layout Plain Layout
25160 \begin_inset Flex Code
25163 \begin_layout Plain Layout
25169 is true, the default is
25170 \begin_inset Flex Code
25173 \begin_layout Plain Layout
25179 ; if it is false, the default is
25180 \begin_inset Flex Code
25183 \begin_layout Plain Layout
25192 \begin_layout Subsection
25196 \begin_layout Standard
25197 The XHTML output for floats too can be controlled by layout information.
25198 The output has the following form:
25201 \begin_layout LyX-Code
25203 \begin_inset Quotes erd
25207 \begin_inset Quotes erd
25213 \begin_layout LyX-Code
25214 Contents of the float.
25217 \begin_layout LyX-Code
25221 \begin_layout Standard
25222 The caption, if there is one, is a separate inset and will be output as
25224 Its appearance can be controlled via the InsetLayout for caption insets.
25228 \begin_layout Description
25229 \begin_inset Flex Code
25232 \begin_layout Plain Layout
25239 \begin_inset Flex Code
25242 \begin_layout Plain Layout
25248 ] Specifies attribute information to be output with the main tag.
25250 \begin_inset Quotes eld
25254 \begin_inset Flex Code
25257 \begin_layout Plain Layout
25258 class=`myfloat' onclick=`\SpecialChar ldots
25265 \begin_inset Quotes erd
25269 By default, \SpecialChar LyX
25271 \begin_inset Quotes eld
25275 \begin_inset Flex Code
25278 \begin_layout Plain Layout
25279 class=`float float-floattype'
25285 \begin_inset Quotes erd
25289 \begin_inset Flex Code
25292 \begin_layout Plain Layout
25298 is \SpecialChar LyX
25299 's name for this type of float, as determined by the float declaration
25301 \begin_inset CommandInset ref
25303 reference "subsec:Floats"
25307 ), though made lowercase and with non-alphanumeric characters converted
25308 to underscores, for example: float-table.
25311 \begin_layout Description
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25321 CSS style information to be included when this float is used.
25322 Note that this will automatically be wrapped in a layout-generated
25323 \begin_inset Flex Code
25326 \begin_layout Plain Layout
25332 block, so only the CSS itself need be included.
25335 \begin_layout Description
25336 \begin_inset Flex Code
25339 \begin_layout Plain Layout
25346 \begin_inset Flex Code
25349 \begin_layout Plain Layout
25355 ] The tag to be used for this float, replacing
25356 \begin_inset Quotes eld
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25370 \begin_inset Quotes erd
25373 in the example above.
25375 \begin_inset Flex Code
25378 \begin_layout Plain Layout
25384 and will rarely need changing.
25387 \begin_layout Subsection
25388 Bibliography formatting
25391 \begin_layout Standard
25392 The bibliography can be formatted using
25393 \begin_inset Flex Code
25396 \begin_layout Plain Layout
25404 \begin_inset CommandInset ref
25406 reference "subsec:Citation-format-description"
25413 \begin_layout Subsection
25418 \begin_layout Standard
25419 We have several times mentioned that \SpecialChar LyX
25420 will generate default CSS style rules
25421 for both insets and paragraph styles, based upon the other layout information
25423 In this section, we shall say a word about which layout information \SpecialChar LyX
25428 \begin_layout Standard
25429 At present, \SpecialChar LyX
25430 auto-generates CSS only for font information, making use of
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25462 \begin_inset Flex Code
25465 \begin_layout Plain Layout
25472 \begin_inset Flex Code
25475 \begin_layout Plain Layout
25482 \begin_inset CommandInset ref
25484 reference "subsec:Font-description"
25489 The translation is mostly straightforward and obvious.
25491 \begin_inset Quotes eld
25495 \begin_inset Flex Code
25498 \begin_layout Plain Layout
25505 \begin_inset Quotes erd
25509 \begin_inset Quotes eld
25513 \begin_inset Flex Code
25516 \begin_layout Plain Layout
25517 font-family: sans-serif;
25523 \begin_inset Quotes erd
25527 The correspondence of \SpecialChar LyX
25528 sizes and CSS sizes is a little less obvious but
25529 nonetheless intuitive.
25531 \begin_inset Flex Code
25534 \begin_layout Plain Layout
25541 \begin_inset Flex URL
25544 \begin_layout Plain Layout
25554 \begin_layout Chapter
25555 Including External Material
25556 \begin_inset CommandInset label
25558 name "chap:Including-External-Material"
25565 \begin_layout Standard
25566 \begin_inset Box Shadowbox
25576 height_special "totalheight"
25581 backgroundcolor "none"
25584 \begin_layout Plain Layout
25585 WARNING: This portion of the documentation has not been updated for some
25587 We certainly hope that it is still accurate, but there are no guarantees.
25595 \begin_layout Standard
25596 The use of material from sources external to \SpecialChar LyX
25597 is covered in detail in the
25603 This part of the manual covers what needs to happen behind the scenes for
25604 new sorts of material to be included.
25607 \begin_layout Section
25611 \begin_layout Standard
25612 The external material feature is based on the concept of a
25617 A template is a specification of how \SpecialChar LyX
25618 should interface with a certain kind
25620 As bundled, \SpecialChar LyX
25621 comes with predefined templates for Xfig figures, various
25622 raster format images, chess diagrams, and LilyPond music notation.
25623 You can check the actual list by using the menu
25624 \begin_inset Flex Noun
25627 \begin_layout Plain Layout
25628 Insert\SpecialChar menuseparator
25629 File\SpecialChar menuseparator
25636 Furthermore, it is possible to roll your own template to support a specific
25638 Later we'll describe in more detail what is involved, and hopefully you
25639 will submit all the templates you create so we can include them in a later
25644 \begin_layout Standard
25645 Another basic idea of the external material feature is to distinguish between
25646 the original file that serves as a base for final material and the produced
25647 file that is included in your exported or printed document.
25648 For example, consider the case of a figure produced with
25649 \begin_inset Flex Code
25652 \begin_layout Plain Layout
25659 The Xfig application itself works on an original file with the
25660 \begin_inset Flex Code
25663 \begin_layout Plain Layout
25670 Within Xfig, you create and change your figure, and when you are done,
25672 \begin_inset Flex Code
25675 \begin_layout Plain Layout
25682 When you want to include the figure in your document, you invoke
25683 \begin_inset Flex Code
25686 \begin_layout Plain Layout
25692 in order to create a PostScript file that can readily be included in your
25696 \begin_inset Flex Code
25699 \begin_layout Plain Layout
25705 file is the original file, and the PostScript file is the produced file.
25708 \begin_layout Standard
25709 This distinction is important in order to allow updating of the material
25710 while you are in the process of writing the document.
25711 Furthermore, it provides us with the flexibility that is needed to support
25712 multiple export formats.
25713 For instance, in the case of a plain text file, it is not exactly an award-winn
25714 ing idea to include the figure as raw PostScript.
25715 Instead, you would either prefer to just include a reference to the figure
25716 or try to invoke some graphics to ASCII converter to make the final result
25717 look similar to the real graphics.
25718 The external material management allows you to do this, because it is parametri
25719 zed on the different export formats that \SpecialChar LyX
25723 \begin_layout Standard
25724 Besides supporting the production of different products according to the
25725 exported format, it supports tight integration with editing and viewing
25727 In the case of an Xfig figure, you are able to invoke Xfig on the original
25728 file with a single click from within the external material dialog in \SpecialChar LyX
25730 and also preview the produced PostScript file with Ghostview with another
25732 No more fiddling around with the command line and/or file browsers to locate
25733 and manipulate the original or produced files.
25734 In this way, you are finally able to take full advantage of the many different
25735 applications that are relevant to use when you write your documents, and
25736 ultimately be more productive.
25739 \begin_layout Section
25740 The external template configuration files
25743 \begin_layout Standard
25744 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25746 However, be aware that doing this in an careless manner most probably
25750 introduce an easily exploitable security hole.
25751 So before you do this, please read the discussion about security in
25752 \begin_inset CommandInset ref
25754 reference "sec:Security-discussion"
25761 \begin_layout Standard
25762 Having said that, we encourage you to submit any interesting templates that
25767 \begin_layout Standard
25768 The external templates are defined in the
25769 \begin_inset Flex Code
25772 \begin_layout Plain Layout
25778 files that are stored in the
25779 \begin_inset Flex Code
25782 \begin_layout Plain Layout
25783 LyXDir/lib/xtemplates/
25789 Each template is defined in a file of its own.
25790 You can place your own templates in
25791 \begin_inset Flex Code
25794 \begin_layout Plain Layout
25795 UserDir/xtemplates/
25800 or copy existing templates to that directory in order to modify them.
25803 \begin_layout Standard
25804 A typical template looks like this:
25807 \begin_layout LyX-Code
25811 \begin_layout LyX-Code
25812 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25815 \begin_layout LyX-Code
25819 \begin_layout LyX-Code
25823 \begin_layout LyX-Code
25827 \begin_layout LyX-Code
25831 \begin_layout LyX-Code
25835 \begin_layout LyX-Code
25836 AutomaticProduction true
25839 \begin_layout LyX-Code
25843 \begin_layout LyX-Code
25847 \begin_layout LyX-Code
25851 \begin_layout LyX-Code
25852 TransformCommand Rotate RotationLatexCommand
25855 \begin_layout LyX-Code
25856 TransformCommand Resize ResizeLatexCommand
25859 \begin_layout LyX-Code
25860 Product "$$RotateFront$$ResizeFront
25863 \begin_layout LyX-Code
25868 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25871 \begin_layout LyX-Code
25872 $$ResizeBack$$RotateBack"
25875 \begin_layout LyX-Code
25879 \begin_layout LyX-Code
25880 UpdateResult "$$AbsPath$$Basename.pstex_t"
25883 \begin_layout LyX-Code
25884 Requirement "graphicx"
25887 \begin_layout LyX-Code
25888 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25891 \begin_layout LyX-Code
25892 ReferencedFile latex "$$AbsPath$$Basename.eps"
25895 \begin_layout LyX-Code
25896 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25899 \begin_layout LyX-Code
25903 \begin_layout LyX-Code
25907 \begin_layout LyX-Code
25908 TransformCommand Rotate RotationLatexCommand
25911 \begin_layout LyX-Code
25912 TransformCommand Resize ResizeLatexCommand
25915 \begin_layout LyX-Code
25916 Product "$$RotateFront$$ResizeFront
25919 \begin_layout LyX-Code
25924 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25927 \begin_layout LyX-Code
25928 $$ResizeBack$$RotateBack"
25931 \begin_layout LyX-Code
25932 UpdateFormat pdftex
25935 \begin_layout LyX-Code
25936 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25939 \begin_layout LyX-Code
25940 Requirement "graphicx"
25943 \begin_layout LyX-Code
25944 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25947 \begin_layout LyX-Code
25948 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25951 \begin_layout LyX-Code
25955 \begin_layout LyX-Code
25959 \begin_layout LyX-Code
25960 Product "[XFig: $$FName]"
25963 \begin_layout LyX-Code
25967 \begin_layout LyX-Code
25971 \begin_layout LyX-Code
25972 Product "<graphic fileref=
25974 "$$AbsOrRelPathMaster$$Basename.eps
25979 \begin_layout LyX-Code
25983 \begin_layout LyX-Code
25987 \begin_layout LyX-Code
25988 UpdateResult "$$AbsPath$$Basename.eps"
25991 \begin_layout LyX-Code
25992 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25995 \begin_layout LyX-Code
25996 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25999 \begin_layout LyX-Code
26003 \begin_layout LyX-Code
26007 \begin_layout Standard
26008 As you can see, the template is enclosed in
26009 \begin_inset Flex Code
26012 \begin_layout Plain Layout
26020 \begin_inset Flex Code
26023 \begin_layout Plain Layout
26030 It contains a header specifying some general settings and, for each supported
26031 primary document file format, a section
26032 \begin_inset Flex Code
26035 \begin_layout Plain Layout
26043 \begin_inset Flex Code
26046 \begin_layout Plain Layout
26055 \begin_layout Subsection
26056 The template header
26059 \begin_layout Description
26060 \begin_inset Flex Code
26063 \begin_layout Plain Layout
26064 AutomaticProduction
26065 \begin_inset space ~
26073 Whether the file represented by the template must be generated by \SpecialChar LyX
26075 This command must occur exactly once.
26078 \begin_layout Description
26079 \begin_inset Flex Code
26082 \begin_layout Plain Layout
26084 \begin_inset space ~
26092 A glob pattern that is used in the file dialog to filter out the desired
26094 If there is more than one possible file extension (e.
26095 \begin_inset space \thinspace{}
26099 \begin_inset space \space{}
26103 \begin_inset Flex Code
26106 \begin_layout Plain Layout
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26122 ), use something like
26123 \begin_inset Flex Code
26126 \begin_layout Plain Layout
26133 This command must occur exactly once.
26136 \begin_layout Description
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26142 \begin_inset space ~
26150 The text that is displayed on the button.
26151 This command must occur exactly once.
26154 \begin_layout Description
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26160 \begin_inset space ~
26164 \begin_inset space ~
26172 The help text that is used in the External dialog.
26173 Provide enough information to explain to the user just what the template
26174 can provide him with.
26175 This command must occur exactly once.
26178 \begin_layout Description
26179 \begin_inset Flex Code
26182 \begin_layout Plain Layout
26184 \begin_inset space ~
26192 The file format of the original file.
26193 This must be the name of a format that is known to \SpecialChar LyX
26195 \begin_inset CommandInset ref
26197 reference "sec:Formats"
26203 \begin_inset Quotes eld
26207 \begin_inset Flex Code
26210 \begin_layout Plain Layout
26217 \begin_inset Quotes erd
26220 if the template can handle original files of more than one format.
26222 will attempt to interrogate the file itself in order to deduce its format
26224 This command must occur exactly once.
26227 \begin_layout Description
26228 \begin_inset Flex Code
26231 \begin_layout Plain Layout
26233 \begin_inset space ~
26241 A unique name for the template.
26242 It must not contain substitution macros (see below).
26245 \begin_layout Description
26246 \begin_inset Flex Code
26249 \begin_layout Plain Layout
26251 \begin_inset space ~
26254 Rotate|Resize|Clip|Extra
26259 This command specifies which transformations are supported by this template.
26260 It may occur zero or more times.
26261 This command enables the corresponding tabs in the external dialog.
26263 \begin_inset Flex Code
26266 \begin_layout Plain Layout
26272 command must have either a corresponding
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26283 \begin_inset Flex Code
26286 \begin_layout Plain Layout
26293 \begin_inset Flex Code
26296 \begin_layout Plain Layout
26303 Otherwise the transformation will not be supported by that format.
26306 \begin_layout Subsection
26310 \begin_layout Description
26311 \begin_inset Flex Code
26314 \begin_layout Plain Layout
26316 \begin_inset space ~
26319 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26324 The primary document file format that this format definition is for.
26325 Not every template has a sensible representation in all document file formats.
26326 Please define nevertheless a
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26336 section for all templates.
26337 Use a dummy text when no representation is available.
26338 Then you can at least see a reference to the external material in the exported
26342 \begin_layout Description
26343 \begin_inset Flex Code
26346 \begin_layout Plain Layout
26348 \begin_inset space ~
26352 \begin_inset space ~
26360 This command defines an additional macro
26361 \begin_inset Flex Code
26364 \begin_layout Plain Layout
26370 for substitution in
26371 \begin_inset Flex Code
26374 \begin_layout Plain Layout
26382 \begin_inset Flex Code
26385 \begin_layout Plain Layout
26391 itself may contain substitution macros.
26392 The advantage over using
26393 \begin_inset Flex Code
26396 \begin_layout Plain Layout
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26412 is that the substituted value of
26413 \begin_inset Flex Code
26416 \begin_layout Plain Layout
26422 is sanitized so that it is a valid optional argument in the document format.
26423 This command may occur zero or more times.
26426 \begin_layout Description
26427 \begin_inset Flex Code
26430 \begin_layout Plain Layout
26432 \begin_inset space ~
26440 The text that is inserted in the exported document.
26441 This is actually the most important command and can be quite complex.
26442 This command must occur exactly once.
26445 \begin_layout Description
26446 \begin_inset Flex Code
26449 \begin_layout Plain Layout
26451 \begin_inset space ~
26459 This command specifies a preamble snippet that will be included in the
26462 It has to be defined using
26463 \begin_inset Flex Code
26466 \begin_layout Plain Layout
26474 \begin_inset Flex Code
26477 \begin_layout Plain Layout
26484 This command may occur zero or more times.
26487 \begin_layout Description
26488 \begin_inset Flex Code
26491 \begin_layout Plain Layout
26493 \begin_inset space ~
26497 \begin_inset space ~
26505 This command denotes files that are created by the conversion process and
26506 are needed for a particular export format.
26507 If the filename is relative, it is interpreted relative to the master document.
26508 This command may be given zero or more times.
26511 \begin_layout Description
26512 \begin_inset Flex Code
26515 \begin_layout Plain Layout
26517 \begin_inset space ~
26525 The name of a required \SpecialChar LaTeX
26527 The package is included via
26528 \begin_inset Flex Code
26531 \begin_layout Plain Layout
26539 in the \SpecialChar LaTeX
26541 This command may occur zero or more times.
26544 \begin_layout Description
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26550 \begin_inset space ~
26554 \begin_inset space ~
26557 RotationLatexCommand
26562 This command specifies that the built in \SpecialChar LaTeX
26563 command should be used for rotation.
26564 This command may occur once or not at all.
26567 \begin_layout Description
26568 \begin_inset Flex Code
26571 \begin_layout Plain Layout
26573 \begin_inset space ~
26577 \begin_inset space ~
26585 This command specifies that the built in \SpecialChar LaTeX
26586 command should be used for resizing.
26587 This command may occur once or not at all.
26590 \begin_layout Description
26591 \begin_inset Flex Code
26594 \begin_layout Plain Layout
26596 \begin_inset space ~
26600 \begin_inset space ~
26603 RotationLatexOption
26608 This command specifies that rotation is done via an optional argument.
26609 This command may occur once or not at all.
26612 \begin_layout Description
26613 \begin_inset Flex Code
26616 \begin_layout Plain Layout
26618 \begin_inset space ~
26622 \begin_inset space ~
26630 This command specifies that resizing is done via an optional argument.
26631 This command may occur once or not at all.
26634 \begin_layout Description
26635 \begin_inset Flex Code
26638 \begin_layout Plain Layout
26640 \begin_inset space ~
26644 \begin_inset space ~
26652 This command specifies that clipping is done via an optional argument.
26653 This command may occur once or not at all.
26656 \begin_layout Description
26657 \begin_inset Flex Code
26660 \begin_layout Plain Layout
26662 \begin_inset space ~
26666 \begin_inset space ~
26674 This command specifies that an extra optional argument is used.
26675 This command may occur once or not at all.
26678 \begin_layout Description
26679 \begin_inset Flex Code
26682 \begin_layout Plain Layout
26684 \begin_inset space ~
26692 The file format of the converted file.
26693 This must be the name of a format that is known to \SpecialChar LyX
26695 \begin_inset Flex Noun
26698 \begin_layout Plain Layout
26699 Tools\SpecialChar menuseparator
26700 Preferences\SpecialChar menuseparator
26701 File Handling\SpecialChar menuseparator
26708 This command must occur exactly once.
26709 If the resulting file format is PDF, you need to specify the format
26710 \begin_inset Flex Code
26713 \begin_layout Plain Layout
26720 This is the PDF format used for including graphics.
26721 The other defined PDF formats are for document export.
26724 \begin_layout Description
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26730 \begin_inset space ~
26738 The file name of the converted file.
26739 The file name must be absolute.
26740 This command must occur exactly once.
26743 \begin_layout Subsection
26744 Preamble definitions
26747 \begin_layout Standard
26748 The external template configuration file may contain additional preamble
26749 definitions enclosed by
26750 \begin_inset Flex Code
26753 \begin_layout Plain Layout
26761 \begin_inset Flex Code
26764 \begin_layout Plain Layout
26771 They can be used by the templates in the
26772 \begin_inset Flex Code
26775 \begin_layout Plain Layout
26784 \begin_layout Section
26785 The substitution mechanism
26788 \begin_layout Standard
26789 When the external material facility invokes an external program, it is done
26790 on the basis of a command defined in the template configuration file.
26791 These commands can contain various macros that are expanded before execution.
26792 Execution always take place in the directory of the containing document.
26795 \begin_layout Standard
26796 Also, whenever external material is to be displayed, the name will be produced
26797 by the substitution mechanism, and most other commands in the template
26798 definition support substitution as well.
26801 \begin_layout Standard
26802 The available macros are the following:
26805 \begin_layout Description
26806 \begin_inset Flex Code
26809 \begin_layout Plain Layout
26810 $$AbsOrRelPathMaster
26815 The file path, absolute or relative to the master \SpecialChar LyX
26819 \begin_layout Description
26820 \begin_inset Flex Code
26823 \begin_layout Plain Layout
26824 $$AbsOrRelPathParent
26829 The file path, absolute or relative to the \SpecialChar LyX
26833 \begin_layout Description
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26843 The absolute file path.
26846 \begin_layout Description
26847 \begin_inset Flex Code
26850 \begin_layout Plain Layout
26856 The filename without path and without the extension.
26859 \begin_layout Description
26860 \begin_inset Flex Code
26863 \begin_layout Plain Layout
26865 \begin_inset Quotes eld
26869 \begin_inset Quotes erd
26877 This macro will expand to the contents of the file with the name
26878 \begin_inset Flex Code
26881 \begin_layout Plain Layout
26890 \begin_layout Description
26891 \begin_inset Flex Code
26894 \begin_layout Plain Layout
26900 The file extension (including the dot).
26903 \begin_layout Description
26904 \begin_inset Flex Code
26907 \begin_layout Plain Layout
26913 This will be the string
26914 \begin_inset Quotes eld
26918 \begin_inset Quotes erd
26921 if the file is in JPEG format, otherwise it will be the string
26922 \begin_inset Quotes eld
26926 \begin_inset Quotes erd
26930 This is useful to avoid uneeded conversions for output formats that support
26931 both PNG and JPEG fomats.
26932 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26937 \begin_layout Description
26938 \begin_inset Flex Code
26941 \begin_layout Plain Layout
26947 The filename of the file specified in the external material dialog.
26948 This is either an absolute name, or it is relative to the \SpecialChar LyX
26952 \begin_layout Description
26953 \begin_inset Flex Code
26956 \begin_layout Plain Layout
26963 \begin_inset Flex Code
26966 \begin_layout Plain Layout
26972 (absolute name or relative to the \SpecialChar LyX
26976 \begin_layout Description
26977 \begin_inset Flex Code
26980 \begin_layout Plain Layout
26986 The file path, relative to the master \SpecialChar LyX
26990 \begin_layout Description
26991 \begin_inset Flex Code
26994 \begin_layout Plain Layout
27000 The file path, relative to the \SpecialChar LyX
27004 \begin_layout Description
27005 \begin_inset Flex Code
27008 \begin_layout Plain Layout
27014 This macro will expand to the absolute path of the system directory.
27015 This is typically used to point to the various helper scripts that are
27016 bundled with \SpecialChar LyX
27020 \begin_layout Description
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27030 A name and full path to a temporary file which will be automatically deleted
27031 whenever the containing document is closed, or the external material insertion
27035 \begin_layout Standard
27036 All path macros contain a trailing directory separator, so you can construct
27038 \begin_inset space \thinspace{}
27042 \begin_inset space \space{}
27045 the absolute filename with
27046 \begin_inset Flex Code
27049 \begin_layout Plain Layout
27050 $$AbsPath$$Basename$$Extension
27058 \begin_layout Standard
27059 The macros above are substituted in all commands unless otherwise noted.
27061 \begin_inset Flex Code
27064 \begin_layout Plain Layout
27070 supports additionally the following substitutions if they are enabled by
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27082 \begin_inset Flex Code
27085 \begin_layout Plain Layout
27094 \begin_layout Description
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27104 The front part of the resize command.
27107 \begin_layout Description
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27117 The back part of the resize command.
27120 \begin_layout Description
27121 \begin_inset Flex Code
27124 \begin_layout Plain Layout
27130 The front part of the rotation command.
27133 \begin_layout Description
27134 \begin_inset Flex Code
27137 \begin_layout Plain Layout
27143 The back part of the rotation command.
27146 \begin_layout Standard
27147 The value string of the
27148 \begin_inset Flex Code
27151 \begin_layout Plain Layout
27157 command supports additionally the following substitutions if they are enabled
27159 \begin_inset Flex Code
27162 \begin_layout Plain Layout
27169 \begin_inset Flex Code
27172 \begin_layout Plain Layout
27181 \begin_layout Description
27182 \begin_inset Flex Code
27185 \begin_layout Plain Layout
27194 \begin_layout Description
27195 \begin_inset Flex Code
27198 \begin_layout Plain Layout
27207 \begin_layout Description
27208 \begin_inset Flex Code
27211 \begin_layout Plain Layout
27220 \begin_layout Description
27221 \begin_inset Flex Code
27224 \begin_layout Plain Layout
27230 The rotation option.
27233 \begin_layout Standard
27234 You may ask why there are so many path macros.
27235 There are mainly two reasons:
27238 \begin_layout Enumerate
27239 Relative and absolute file names should remain relative or absolute, respectivel
27241 Users may have reasons to prefer either form.
27242 Relative names are useful for portable documents that should work on different
27243 machines, for example.
27244 Absolute names may be required by some programs.
27247 \begin_layout Enumerate
27249 treats relative file names differently than \SpecialChar LyX
27250 and other programs in nested
27252 For \SpecialChar LyX
27253 , a relative file name is always relative to the document that contains
27255 For \SpecialChar LaTeX
27256 , it is always relative to the master document.
27257 These two definitions are identical if you have only one document, but
27258 differ if you have a master document that includes part documents.
27259 That means that relative filenames must be transformed when presented to
27262 Fortunately \SpecialChar LyX
27263 does this automatically for you if you choose the right macros.
27266 \begin_layout Standard
27267 So which path macro should be used in new template definitions? The rule
27271 \begin_layout Itemize
27273 \begin_inset Flex Code
27276 \begin_layout Plain Layout
27282 if an absolute path is required.
27285 \begin_layout Itemize
27287 \begin_inset Flex Code
27290 \begin_layout Plain Layout
27291 $$AbsOrRelPathMaster
27296 if the substituted string is some kind of \SpecialChar LaTeX
27300 \begin_layout Itemize
27302 \begin_inset Flex Code
27305 \begin_layout Plain Layout
27306 $$AbsOrRelPathParent
27311 in order to preserve the user's choice.
27314 \begin_layout Standard
27315 There are special cases where this rule does not work and e.
27316 \begin_inset space \thinspace{}
27320 \begin_inset space \space{}
27323 relative names are needed, but normally it will work just fine.
27324 One example for such a case is the command
27325 \begin_inset Flex Code
27328 \begin_layout Plain Layout
27329 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27334 in the XFig template above: We can't use the absolute name because the
27336 \begin_inset Flex Code
27339 \begin_layout Plain Layout
27345 files needs the relative name in order to rewrite the file content.
27348 \begin_layout Section
27349 Security discussion
27350 \begin_inset CommandInset label
27352 name "sec:Security-discussion"
27359 \begin_layout Standard
27360 The external material feature interfaces with a lot of external programs
27361 and does so automatically, so we have to consider the security implications
27363 In particular, since you have the option of including your own filenames
27364 and/or parameter strings and those are expanded into a command, it seems
27365 that it would be possible to create a malicious document which executes
27366 arbitrary commands when a user views or prints the document.
27367 This is something we definitely want to avoid.
27370 \begin_layout Standard
27371 However, since the external program commands are specified in the template
27372 configuration file only, there are no security issues if \SpecialChar LyX
27373 is properly configure
27374 d with safe templates only.
27375 This is so because the external programs are invoked with the
27376 \begin_inset Flex Code
27379 \begin_layout Plain Layout
27385 -system call rather than the
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27395 system-call, so it's not possible to execute arbitrary commands from the
27396 filename or parameter section via the shell.
27399 \begin_layout Standard
27400 This also implies that you are restricted in what command strings you can
27401 use in the external material templates.
27402 In particular, pipes and redirection are not readily available.
27403 This has to be so if \SpecialChar LyX
27404 should remain safe.
27405 If you want to use some of the shell features, you should write a safe
27406 script to do this in a controlled manner, and then invoke the script from
27407 the command string.
27411 \begin_layout Standard
27412 It is possible to design a template that interacts directly with the shell,
27413 but since this would allow a malicious user to execute arbitrary commands
27414 by writing clever filenames and/or parameters, we generally recommend that
27415 you only use safe scripts that work with the
27416 \begin_inset Flex Code
27419 \begin_layout Plain Layout
27425 system call in a controlled manner.
27426 Of course, for use in a controlled environment, it can be tempting to just
27427 fall back to use ordinary shell scripts.
27428 If you do so, be aware that you
27432 provide an easily exploitable security hole in your system.
27433 Of course it stands to reason that such unsafe templates will never be
27434 included in the standard \SpecialChar LyX
27435 distribution, although we do encourage people
27436 to submit new templates in the open source tradition.
27437 But \SpecialChar LyX
27438 as shipped from the official distribution channels will never have
27442 \begin_layout Standard
27443 Including external material provides a lot of power, and you have to be
27444 careful not to introduce security hazards with this power.
27445 A subtle error in a single line in an innocent looking script can open
27446 the door to huge security problems.
27447 So if you do not fully understand the issues, we recommend that you consult
27448 a knowledgeable security professional or the \SpecialChar LyX
27449 development team if you have
27450 any questions about whether a given template is safe or not.
27451 And do this before you use it in an uncontrolled environment.
27454 \begin_layout Chapter
27456 List of supported \SpecialChar LyX
27457 functions to be used in layouts
27458 \begin_inset CommandInset label
27460 name "chap:List-of-functions"
27467 \begin_layout Standard
27469 \begin_inset Tabular
27470 <lyxtabular version="3" rows="11" columns="8">
27471 <features tabularvalignment="middle">
27472 <column alignment="left" valignment="top">
27473 <column alignment="left" valignment="top">
27474 <column alignment="left" valignment="top">
27475 <column alignment="left" valignment="top">
27476 <column alignment="left" valignment="top">
27477 <column alignment="left" valignment="top">
27478 <column alignment="left" valignment="top">
27479 <column alignment="left" valignment="top">
27481 <cell alignment="left" valignment="top" usebox="none">
27484 \begin_layout Plain Layout
27490 <cell alignment="left" valignment="top" usebox="none">
27493 \begin_layout Plain Layout
27499 <cell alignment="left" valignment="top" usebox="none">
27502 \begin_layout Plain Layout
27508 <cell alignment="left" valignment="top" usebox="none">
27511 \begin_layout Plain Layout
27517 <cell alignment="center" valignment="top" usebox="none">
27520 \begin_layout Plain Layout
27526 <cell alignment="center" valignment="top" usebox="none">
27529 \begin_layout Plain Layout
27535 <cell alignment="center" valignment="top" usebox="none">
27538 \begin_layout Plain Layout
27544 <cell alignment="center" valignment="top" usebox="none">
27547 \begin_layout Plain Layout
27555 <cell alignment="left" valignment="top" usebox="none">
27558 \begin_layout Plain Layout
27564 <cell alignment="left" valignment="top" usebox="none">
27567 \begin_layout Plain Layout
27573 <cell alignment="left" valignment="top" usebox="none">
27576 \begin_layout Plain Layout
27582 <cell alignment="left" valignment="top" usebox="none">
27585 \begin_layout Plain Layout
27591 <cell alignment="center" valignment="top" usebox="none">
27594 \begin_layout Plain Layout
27600 <cell alignment="center" valignment="top" usebox="none">
27603 \begin_layout Plain Layout
27609 <cell alignment="center" valignment="top" usebox="none">
27612 \begin_layout Plain Layout
27618 <cell alignment="center" valignment="top" usebox="none">
27621 \begin_layout Plain Layout
27629 <cell alignment="left" valignment="top" usebox="none">
27632 \begin_layout Plain Layout
27638 <cell alignment="left" valignment="top" usebox="none">
27641 \begin_layout Plain Layout
27647 <cell alignment="left" valignment="top" usebox="none">
27650 \begin_layout Plain Layout
27656 <cell alignment="left" valignment="top" usebox="none">
27659 \begin_layout Plain Layout
27665 <cell alignment="center" valignment="top" usebox="none">
27668 \begin_layout Plain Layout
27674 <cell alignment="center" valignment="top" usebox="none">
27677 \begin_layout Plain Layout
27683 <cell alignment="center" valignment="top" usebox="none">
27686 \begin_layout Plain Layout
27692 <cell alignment="center" valignment="top" usebox="none">
27695 \begin_layout Plain Layout
27703 <cell alignment="left" valignment="top" usebox="none">
27706 \begin_layout Plain Layout
27712 <cell alignment="left" valignment="top" usebox="none">
27715 \begin_layout Plain Layout
27721 <cell alignment="left" valignment="top" usebox="none">
27724 \begin_layout Plain Layout
27730 <cell alignment="left" valignment="top" usebox="none">
27733 \begin_layout Plain Layout
27739 <cell alignment="center" valignment="top" usebox="none">
27742 \begin_layout Plain Layout
27748 <cell alignment="center" valignment="top" usebox="none">
27751 \begin_layout Plain Layout
27757 <cell alignment="center" valignment="top" usebox="none">
27760 \begin_layout Plain Layout
27766 <cell alignment="center" valignment="top" usebox="none">
27769 \begin_layout Plain Layout
27777 <cell alignment="left" valignment="top" usebox="none">
27780 \begin_layout Plain Layout
27786 <cell alignment="left" valignment="top" usebox="none">
27789 \begin_layout Plain Layout
27795 <cell alignment="left" valignment="top" usebox="none">
27798 \begin_layout Plain Layout
27804 <cell alignment="left" valignment="top" usebox="none">
27807 \begin_layout Plain Layout
27813 <cell alignment="center" valignment="top" usebox="none">
27816 \begin_layout Plain Layout
27822 <cell alignment="center" valignment="top" usebox="none">
27825 \begin_layout Plain Layout
27831 <cell alignment="center" valignment="top" usebox="none">
27834 \begin_layout Plain Layout
27840 <cell alignment="center" valignment="top" usebox="none">
27843 \begin_layout Plain Layout
27851 <cell alignment="left" valignment="top" usebox="none">
27854 \begin_layout Plain Layout
27860 <cell alignment="left" valignment="top" usebox="none">
27863 \begin_layout Plain Layout
27869 <cell alignment="left" valignment="top" usebox="none">
27872 \begin_layout Plain Layout
27878 <cell alignment="left" valignment="top" usebox="none">
27881 \begin_layout Plain Layout
27887 <cell alignment="center" valignment="top" usebox="none">
27890 \begin_layout Plain Layout
27896 <cell alignment="center" valignment="top" usebox="none">
27899 \begin_layout Plain Layout
27905 <cell alignment="center" valignment="top" usebox="none">
27908 \begin_layout Plain Layout
27914 <cell alignment="center" valignment="top" usebox="none">
27917 \begin_layout Plain Layout
27925 <cell alignment="left" valignment="top" usebox="none">
27928 \begin_layout Plain Layout
27934 <cell alignment="left" valignment="top" usebox="none">
27937 \begin_layout Plain Layout
27943 <cell alignment="left" valignment="top" usebox="none">
27946 \begin_layout Plain Layout
27952 <cell alignment="left" valignment="top" usebox="none">
27955 \begin_layout Plain Layout
27961 <cell alignment="center" valignment="top" usebox="none">
27964 \begin_layout Plain Layout
27970 <cell alignment="center" valignment="top" usebox="none">
27973 \begin_layout Plain Layout
27979 <cell alignment="center" valignment="top" usebox="none">
27982 \begin_layout Plain Layout
27988 <cell alignment="center" valignment="top" usebox="none">
27991 \begin_layout Plain Layout
27999 <cell alignment="left" valignment="top" usebox="none">
28002 \begin_layout Plain Layout
28008 <cell alignment="left" valignment="top" usebox="none">
28011 \begin_layout Plain Layout
28017 <cell alignment="left" valignment="top" usebox="none">
28020 \begin_layout Plain Layout
28026 <cell alignment="left" valignment="top" usebox="none">
28029 \begin_layout Plain Layout
28035 <cell alignment="center" valignment="top" usebox="none">
28038 \begin_layout Plain Layout
28044 <cell alignment="center" valignment="top" usebox="none">
28047 \begin_layout Plain Layout
28053 <cell alignment="center" valignment="top" usebox="none">
28056 \begin_layout Plain Layout
28062 <cell alignment="center" valignment="top" usebox="none">
28065 \begin_layout Plain Layout
28073 <cell alignment="left" valignment="top" usebox="none">
28076 \begin_layout Plain Layout
28082 <cell alignment="left" valignment="top" usebox="none">
28085 \begin_layout Plain Layout
28091 <cell alignment="left" valignment="top" usebox="none">
28094 \begin_layout Plain Layout
28100 <cell alignment="left" valignment="top" usebox="none">
28103 \begin_layout Plain Layout
28109 <cell alignment="center" valignment="top" usebox="none">
28112 \begin_layout Plain Layout
28118 <cell alignment="center" valignment="top" usebox="none">
28121 \begin_layout Plain Layout
28127 <cell alignment="center" valignment="top" usebox="none">
28130 \begin_layout Plain Layout
28136 <cell alignment="center" valignment="top" usebox="none">
28139 \begin_layout Plain Layout
28147 <cell alignment="left" valignment="top" usebox="none">
28150 \begin_layout Plain Layout
28156 <cell alignment="left" valignment="top" usebox="none">
28159 \begin_layout Plain Layout
28165 <cell alignment="left" valignment="top" usebox="none">
28168 \begin_layout Plain Layout
28174 <cell alignment="left" valignment="top" usebox="none">
28177 \begin_layout Plain Layout
28183 <cell alignment="center" valignment="top" usebox="none">
28186 \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
28221 <cell alignment="center" valignment="top" usebox="none">
28224 \begin_layout Plain Layout
28230 <cell alignment="center" valignment="top" usebox="none">
28233 \begin_layout Plain Layout
28239 <cell alignment="center" valignment="top" usebox="none">
28242 \begin_layout Plain Layout
28248 <cell alignment="center" valignment="top" usebox="none">
28251 \begin_layout Plain Layout
28257 <cell alignment="center" valignment="top" usebox="none">
28260 \begin_layout Plain Layout
28266 <cell alignment="center" valignment="top" usebox="none">
28269 \begin_layout Plain Layout
28275 <cell alignment="center" valignment="top" usebox="none">
28278 \begin_layout Plain Layout
28284 <cell alignment="center" valignment="top" usebox="none">
28287 \begin_layout Plain Layout
28301 \begin_layout Chapter
28302 Names of available colors to be used in layouts
28303 \begin_inset CommandInset label
28305 name "chap:Names-of-colors"
28312 \begin_layout Standard
28313 The colors listed below are the standard colors and those that you can adjust
28314 in the \SpecialChar LyX
28318 \begin_layout Section
28322 \begin_layout Standard
28323 The following are no real colors, but rather act on color definitions:
28326 \begin_layout Description
28327 ignore The color is ignored
28330 \begin_layout Description
28331 inherit The color is inherited
28334 \begin_layout Description
28347 No particular color – clear or default
28350 \begin_layout Section
28354 \begin_layout Standard
28355 These are fixed colors that cannot me customized:
28358 \begin_layout Description
28362 \begin_layout Description
28366 \begin_layout Description
28370 \begin_layout Description
28374 \begin_layout Description
28378 \begin_layout Description
28382 \begin_layout Description
28386 \begin_layout Description
28390 \begin_layout Description
28394 \begin_layout Description
28398 \begin_layout Description
28402 \begin_layout Description
28406 \begin_layout Description
28410 \begin_layout Description
28414 \begin_layout Description
28418 \begin_layout Description
28422 \begin_layout Description
28426 \begin_layout Description
28430 \begin_layout Description
28434 \begin_layout Section
28438 \begin_layout Standard
28439 These are the colors allocated to specific elements in
28442 arg "dialog-show prefs"
28448 \begin_layout Description
28449 added_space Added space color
28452 \begin_layout Description
28453 addedtext Added text color
28456 \begin_layout Description
28457 appendix Appendix marker color
28460 \begin_layout Description
28461 background Background color
28464 \begin_layout Description
28465 bottomarea Bottom area color
28468 \begin_layout Description
28469 branchlabel Label color for branches
28472 \begin_layout Description
28473 buttonbg Color used for button background
28476 \begin_layout Description
28477 buttonframe Color for inset button frames
28480 \begin_layout Description
28481 buttonhoverbg Color used for button background under focus
28484 \begin_layout Description
28485 changebar Changebar color
28488 \begin_layout Description
28489 changedtextauthor1 Changed text color author 1
28492 \begin_layout Description
28493 changedtextauthor2 Changed text color author 2
28496 \begin_layout Description
28497 changedtextauthor3 Changed text color author 3
28500 \begin_layout Description
28501 changedtextauthor4 Changed text color author 4
28504 \begin_layout Description
28505 changedtextauthor5 Changed text color author 5
28508 \begin_layout Description
28509 collapsible Collapsible insets text color
28512 \begin_layout Description
28513 collapsibleframe Collapsible insets framecolor
28516 \begin_layout Description
28517 command Text color for command insets
28520 \begin_layout Description
28521 commandbg Background color for command insets
28524 \begin_layout Description
28525 commandframe Frame color for command insets
28528 \begin_layout Description
28529 comment Label color for comments
28532 \begin_layout Description
28533 commentbg Background color of comments
28536 \begin_layout Description
28537 cursor Cursor color
28540 \begin_layout Description
28541 deletedtext Deleted text color
28544 \begin_layout Description
28545 deletedtextmodifier Deleted text modifying color
28548 \begin_layout Description
28549 depthbar Color for the depth bars in the margin
28552 \begin_layout Description
28553 eolmarker End of line marker color
28556 \begin_layout Description
28557 error Color of the \SpecialChar LaTeX
28561 \begin_layout Description
28562 footlabel Label color for footnotes
28565 \begin_layout Description
28566 foreground Foreground color
28569 \begin_layout Description
28570 graphicsbg Graphics inset background color
28573 \begin_layout Description
28574 greyedoutbg Background color of greyedout inset
28577 \begin_layout Description
28578 greyedoutlabel Label color for greyedout insets
28581 \begin_layout Description
28582 greyedouttext Color for greyedout inset text
28585 \begin_layout Description
28586 indexlabel Label color for index insets
28589 \begin_layout Description
28590 inlinecompletion Inline completion color
28593 \begin_layout Description
28594 insetbg Inset marker background color
28597 \begin_layout Description
28598 insetframe Inset marker frame color
28601 \begin_layout Description
28602 language Color for marking foreign language words
28605 \begin_layout Description
28606 latex Text color in \SpecialChar LaTeX
28610 \begin_layout Description
28611 listingsbg Background color of listings inset
28614 \begin_layout Description
28615 marginlabel Label color for margin notes
28618 \begin_layout Description
28619 math Math inset text color
28622 \begin_layout Description
28623 mathbg Math inset background color
28626 \begin_layout Description
28627 mathcorners Math inset frame color not under focus
28630 \begin_layout Description
28631 mathframe Math inset frame color under focus
28634 \begin_layout Description
28635 mathline Math line color
28638 \begin_layout Description
28639 mathmacrobg Macro math inset background color
28642 \begin_layout Description
28643 mathmacroblend Macro math blended color
28646 \begin_layout Description
28647 mathmacroframe Macro math frame color
28650 \begin_layout Description
28651 mathmacrohoverbg Macro math inset background color hovered
28654 \begin_layout Description
28655 mathmacrolabel Macro math label color
28658 \begin_layout Description
28659 mathmacronewarg Macro template color for new parameters
28662 \begin_layout Description
28663 mathmacrooldarg Macro template color for old parameters
28666 \begin_layout Description
28667 newpage New page color
28670 \begin_layout Description
28671 nonunique_inlinecompletion Inline completion color for the non-unique part
28674 \begin_layout Description
28675 note Label color for notes
28678 \begin_layout Description
28679 notebg Background color of notes
28682 \begin_layout Description
28683 pagebreak Page break/line break color
28686 \begin_layout Description
28687 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28690 \begin_layout Description
28691 phantomtext Text color for phantom insets
28694 \begin_layout Description
28695 preview The color used for previews
28698 \begin_layout Description
28699 previewframe Preview frame color
28702 \begin_layout Description
28703 regexpframe Color for regexp frame
28706 \begin_layout Description
28707 scroll Color that indicates when a row can be scrolled
28710 \begin_layout Description
28711 selection Background color of selected text
28714 \begin_layout Description
28715 selectiontext Foreground color of selected text
28718 \begin_layout Description
28719 shadedbg Background color of shaded box
28722 \begin_layout Description
28723 special Special chars text color
28726 \begin_layout Description
28727 tabularline Table line color
28730 \begin_layout Description
28731 tabularonoffline Table line color
28734 \begin_layout Description
28735 urllabel Label color for URL insets
28738 \begin_layout Description
28739 urltext Color for URL inset text