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
107 \notefontcolor #0000ff
119 \paragraph_separation indent
120 \paragraph_indentation default
122 \math_indentation default
123 \math_numbering_side default
124 \quotes_style english
128 \paperpagestyle headings
130 \tracking_changes true
131 \output_changes false
135 \author -712698321 "Jürgen Spitzmüller"
136 \author -495245474 "Jean-Marc Lasgouttes"
137 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
143 Customizing \SpecialChar LyX
144 : Features for the Advanced User
148 by the \SpecialChar LyX
153 \begin_layout Plain Layout
155 If you have comments or error corrections, please send them to the \SpecialChar LyX
158 \begin_inset CommandInset href
160 target "lyx-docs@lists.lyx.org"
168 \begin_inset Quotes eld
172 \begin_inset Quotes erd
175 in the subject header, and please cc the current maintainer of this file,
176 Richard Heck <rgheck@comcast.net>.
182 \begin_inset Newline newline
186 \begin_inset Newline newline
192 \begin_layout Standard
193 \begin_inset CommandInset toc
194 LatexCommand tableofcontents
201 \begin_layout Standard
202 \begin_inset Note Note
205 \begin_layout Plain Layout
206 Please use change tracking when modifying this document.
207 This makes it easier for our translators to recognize things that have
208 been changed, and it helps the maintainer keep up-to-date with what's been
217 \begin_layout Chapter
221 \begin_layout Standard
222 This manual covers the customization features present in \SpecialChar LyX
224 In it, we discuss issues like keyboard shortcuts, screen previewing options,
225 printer options, sending commands to \SpecialChar LyX
226 via the \SpecialChar LyX
227 Server, internationalization,
228 installing new \SpecialChar LaTeX
229 classes and \SpecialChar LyX
231 We can't possibly hope to touch on everything you can change—our developers
232 add new features faster than we can document them—but we will explain the
233 most common customizations and hopefully point you in the right direction
234 for some of the more obscure ones.
237 \begin_layout Standard
238 \begin_inset Branch OutDated
242 \begin_layout Standard
243 Information from previous versions of this document that now seems to be
244 outdated is contained in the OutDated branch of this document.
245 By default, this information will not appear in the \SpecialChar LaTeX
254 \begin_layout Chapter
259 \begin_layout Standard
260 This chapter aims to help you to find your way through the \SpecialChar LyX
263 Before continuing to read this chapter, you should find out where your
265 library and user directories are by using
266 \begin_inset Flex Noun
269 \begin_layout Plain Layout
270 Help\SpecialChar menuseparator
281 The library directory is the place where \SpecialChar LyX
282 places its system-wide configuration
283 files; the user directory is where you can place your modified versions.
284 We will call the former
285 \begin_inset Flex Code
288 \begin_layout Plain Layout
295 \begin_inset Flex Noun
298 \begin_layout Plain Layout
304 in the remainder of this document.
308 \begin_layout Section
310 \begin_inset Flex Code
313 \begin_layout Plain Layout
322 \begin_layout Standard
323 \begin_inset Flex Code
326 \begin_layout Plain Layout
332 and its sub-directories contain a number of files and that can be used
333 to customize \SpecialChar LyX
335 You can change many of these files from within \SpecialChar LyX
337 \begin_inset Flex Noun
340 \begin_layout Plain Layout
341 Tools\SpecialChar menuseparator
348 Most customization that you will want to do in \SpecialChar LyX
349 is possible through this
351 However, many other inner aspects of \SpecialChar LyX
352 can be customized by modifying the
354 \begin_inset Flex Code
357 \begin_layout Plain Layout
364 These files fall in different categories, described in the following subsection
368 \begin_layout Subsection
369 Automatically generated files
372 \begin_layout Standard
373 The files, which are to be found in
374 \begin_inset Flex Noun
377 \begin_layout Plain Layout
383 , are generated when you configure \SpecialChar LyX
385 They contain various default values that are guessed by inspection.
386 In general, it is not a good idea to modify them, since they might be overwritt
390 \begin_layout Labeling
391 \labelwidthstring 00.00.0000
392 \begin_inset Flex Code
395 \begin_layout Plain Layout
401 contains defaults for various commands.
404 \begin_layout Labeling
405 \labelwidthstring 00.00.0000
406 \begin_inset Flex Code
409 \begin_layout Plain Layout
415 contains the list of packages that have been recognized by \SpecialChar LyX
417 It is currently unused by the \SpecialChar LyX
418 program itself, but the information extracted,
419 and more, is made available with
420 \begin_inset Flex Noun
423 \begin_layout Plain Layout
424 Help\SpecialChar menuseparator
438 \begin_layout Labeling
439 \labelwidthstring 00.00.0000
440 \begin_inset Flex Code
443 \begin_layout Plain Layout
449 the list of text classes that have been found in your
450 \begin_inset Flex Code
453 \begin_layout Plain Layout
459 directories, along with the associated \SpecialChar LaTeX
460 document class and their description.
463 \begin_layout Labeling
464 \labelwidthstring 00.00.0000
465 \begin_inset Flex Code
468 \begin_layout Plain Layout
474 the list of layout modules found in your
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
487 \begin_layout Labeling
488 \labelwidthstring 00.00.0000
489 \begin_inset Flex Code
492 \begin_layout Plain Layout
498 lists of various sorts of \SpecialChar LaTeX
499 -related files found on your system
502 \begin_layout Labeling
503 \labelwidthstring 00.00.0000
504 \begin_inset Flex Code
507 \begin_layout Plain Layout
508 doc/\SpecialChar LaTeX
514 is automatically generated during configuration from the file
515 \begin_inset Flex Code
518 \begin_layout Plain Layout
526 It contains information on your \SpecialChar LaTeX
530 \begin_layout Subsection
534 \begin_layout Standard
535 These directories are duplicated between
536 \begin_inset Flex Code
539 \begin_layout Plain Layout
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
556 If a particular files exists in both places, the one in
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
569 \begin_layout Labeling
570 \labelwidthstring 00.00.0000
571 \begin_inset Flex Code
574 \begin_layout Plain Layout
580 this directory contains files with the extension
581 \begin_inset Flex Code
584 \begin_layout Plain Layout
590 that define the keybindings used in \SpecialChar LyX
592 If there exists an internationalized version of the bind file named
593 \begin_inset Flex Code
596 \begin_layout Plain Layout
602 , that will be used first.
605 \begin_layout Labeling
606 \labelwidthstring 00.00.0000
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
616 contains files with the extension
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
626 which define the diverse citation possibilities (natbib, biblatex etc.).
628 \begin_inset CommandInset ref
630 reference "subsec:Cite-Engine-Files"
640 \begin_layout Labeling
641 \labelwidthstring 00.00.0000
642 \begin_inset Flex Code
645 \begin_layout Plain Layout
651 contains graphics files that can be included in documents.
655 \begin_layout Labeling
656 \labelwidthstring 00.00.0000
657 \begin_inset Flex Code
660 \begin_layout Plain Layout
666 contains \SpecialChar LyX
667 documentation files (including the one you are currently reading).
669 \begin_inset Flex Code
672 \begin_layout Plain Layout
679 deserves special attention, as noted above.
680 The internationalized help docs are in subdirectories
681 \begin_inset Flex Code
684 \begin_layout Plain Layout
691 \begin_inset Quotes eld
695 \begin_inset Quotes erd
698 is the ISO language code.
700 \begin_inset CommandInset ref
702 reference "cha:Internationalizing-LyX"
709 \begin_layout Labeling
710 \labelwidthstring 00.00.0000
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 contains example files that explain how to use some features.
721 In the file browser, press the
722 \begin_inset Flex Noun
725 \begin_layout Plain Layout
734 \begin_layout Labeling
735 \labelwidthstring 00.00.0000
736 \begin_inset Flex Code
739 \begin_layout Plain Layout
745 contains image files that are used by the
746 \begin_inset Flex Noun
749 \begin_layout Plain Layout
756 In addition, it also contains the individual icons used in the toolbar
757 and the banners that can be shown when \SpecialChar LyX
761 \begin_layout Labeling
762 \labelwidthstring 00.00.0000
763 \begin_inset Flex Code
766 \begin_layout Plain Layout
772 contains keyboard keymapping files.
774 \begin_inset CommandInset ref
776 reference "sec:International-Keymap-Stuff"
783 \begin_layout Labeling
784 \labelwidthstring 00.00.0000
785 \begin_inset Flex Code
788 \begin_layout Plain Layout
794 contains the text class and module files described in
795 \begin_inset CommandInset ref
797 reference "cha:Installing-New-Document"
804 \begin_layout Labeling
805 \labelwidthstring 00.00.0000
806 \begin_inset Flex Code
809 \begin_layout Plain Layout
816 \begin_inset Flex Code
819 \begin_layout Plain Layout
825 Python scripts used to convert between \SpecialChar LyX
827 These can be run from the command line if, say, you want to batch-convert
831 \begin_layout Labeling
832 \labelwidthstring 00.00.0000
833 \begin_inset Flex Code
836 \begin_layout Plain Layout
842 contains some files that demonstrate the capabilities of the
843 \begin_inset Flex Noun
846 \begin_layout Plain Layout
857 Also contains some scripts used by \SpecialChar LyX
861 \begin_layout Labeling
862 \labelwidthstring 00.00.0000
863 \begin_inset Flex Code
866 \begin_layout Plain Layout
872 contains the standard \SpecialChar LyX
873 template files described in
874 \begin_inset CommandInset ref
876 reference "subsec:Creating-Templates"
883 \begin_layout Labeling
884 \labelwidthstring 00.00.0000
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
894 contains files with the extension
895 \begin_inset Flex Code
898 \begin_layout Plain Layout
904 that define the user interface to \SpecialChar LyX
906 That is, the files define which items appear in which menus and the items
907 appearing on the toolbar.
910 \begin_layout Labeling
911 \labelwidthstring 00.00.0000
912 \begin_inset Flex Code
915 \begin_layout Plain Layout
921 contains files with the extension
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 which define the templates for the insertion of external material to a
934 \begin_inset CommandInset ref
936 reference "chap:Including-External-Material"
943 \begin_layout Subsection
944 Files you don't want to modify
947 \begin_layout Standard
948 These files are used internally by \SpecialChar LyX
949 and you generally do not need to modify
950 them unless you are a developer.
953 \begin_layout Labeling
954 \labelwidthstring 00.00.0000
955 \begin_inset Flex Code
958 \begin_layout Plain Layout
964 this file contains the list of \SpecialChar LyX
966 The contents are displayed with the menu entry
967 \begin_inset Flex Noun
970 \begin_layout Plain Layout
971 Help\SpecialChar menuseparator
984 \begin_layout Labeling
985 \labelwidthstring 00.00.0000
986 \begin_inset Flex Code
989 \begin_layout Plain Layout
995 this is a \SpecialChar LaTeX
996 script used during the configuration process.
1000 \begin_layout Labeling
1001 \labelwidthstring 00.00.0000
1002 \begin_inset Flex Code
1005 \begin_layout Plain Layout
1011 this is a Python script that is used to re-configure \SpecialChar LyX
1013 It creates configuration files in the directory it was run from.
1016 \begin_layout Subsection
1017 Other files needing a line or two
1020 \begin_layout Labeling
1021 \labelwidthstring 00.00.0000
1022 \begin_inset Flex Code
1025 \begin_layout Plain Layout
1031 this contains tables describing how different character encodings can be
1035 \begin_layout Labeling
1036 \labelwidthstring 00.00.0000
1037 \begin_inset Flex Code
1040 \begin_layout Plain Layout
1046 this file contains a list of all the languages currently supported by \SpecialChar LyX
1050 \begin_layout Labeling
1051 \labelwidthstring 00.00.0000
1052 \begin_inset Flex Code
1055 \begin_layout Plain Layout
1061 contains information about the supported fonts.
1064 \begin_layout Labeling
1065 \labelwidthstring 00.00.0000
1066 \begin_inset Flex Code
1069 \begin_layout Plain Layout
1075 this file contains translations for internationalized paragraph styles
1077 \begin_inset CommandInset ref
1079 reference "subsec:I18n"
1086 \begin_layout Labeling
1087 \labelwidthstring 00.00.0000
1088 \begin_inset Flex Code
1091 \begin_layout Plain Layout
1097 this file contains information about Unicode-encoded glyphs and the way
1098 they are supported by \SpecialChar LyX
1099 via \SpecialChar LaTeX
1103 \begin_layout Section
1104 Your local configuration directory
1107 \begin_layout Standard
1108 Even if you are using \SpecialChar LyX
1109 as an unprivileged user, you might want to change
1111 configuration for your own use.
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1122 directory contains all your personal configuration files.
1123 This is the directory described as
1124 \begin_inset Quotes eld
1128 \begin_inset Quotes erd
1132 \begin_inset Flex Noun
1135 \begin_layout Plain Layout
1136 Help\SpecialChar menuseparator
1138 \begin_inset space ~
1147 This directory is used as a mirror of
1148 \begin_inset Flex Code
1151 \begin_layout Plain Layout
1157 , which means that every file in
1158 \begin_inset Flex Code
1161 \begin_layout Plain Layout
1167 is a replacement for the corresponding file in
1168 \begin_inset Flex Code
1171 \begin_layout Plain Layout
1178 Any configuration file described in the above sections can be placed either
1179 in the system-wide directory, in which case it will affect all users, or
1180 in your local directory for your own use.
1183 \begin_layout Standard
1184 To make things clearer, let's provide a few examples:
1187 \begin_layout Itemize
1188 The preferences set in the
1189 \begin_inset Flex Noun
1192 \begin_layout Plain Layout
1193 Tools\SpecialChar menuseparator
1199 dialog are saved to a file
1200 \begin_inset Flex Code
1203 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_layout Itemize
1223 When you reconfigure using
1224 \begin_inset Flex Noun
1227 \begin_layout Plain Layout
1228 Tools\SpecialChar menuseparator
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1245 script, and the resulting files are written in your local configuration
1247 This means that any additional text class file that you might have added
1249 \begin_inset Flex Code
1252 \begin_layout Plain Layout
1258 will be added to the list of classes in the
1259 \begin_inset Flex Noun
1262 \begin_layout Plain Layout
1263 Document\SpecialChar menuseparator
1272 \begin_layout Itemize
1273 If you get some updated documentation from \SpecialChar LyX
1274 ftp site and cannot install
1275 it because you do not have sysadmin rights on your system, you can just
1277 \begin_inset Flex Code
1280 \begin_layout Plain Layout
1286 and the items in the
1287 \begin_inset Flex Noun
1290 \begin_layout Plain Layout
1296 menu will open them!
1299 \begin_layout Section
1300 Running \SpecialChar LyX
1301 with multiple configurations
1304 \begin_layout Standard
1305 The configuration freedom of the local configuration directory may not suffice
1306 if you want to have more than one configuration at your disposal.
1307 For example, you may want to be use different key bindings or printer settings
1309 You can achieve this by having several such directories.
1310 You then specify which directory to use at run-time.
1313 \begin_layout Standard
1314 Invoking \SpecialChar LyX
1315 with the command line switch
1316 \begin_inset Flex Code
1319 \begin_layout Plain Layout
1329 instructs the program to read the configuration from that directory, and
1330 not from the default directory.
1331 (You can determine the default directory by running \SpecialChar LyX
1333 \begin_inset Flex Code
1336 \begin_layout Plain Layout
1342 switch.) If the specified directory does not exist, \SpecialChar LyX
1344 for you, just like it does for the default directory on the first time
1345 you run the program.
1346 You can modify the configuration options in this additional user directory
1347 exactly as you would for the default directory.
1348 These directories are completely independent (but read on).
1349 Note that setting the environment variable
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1359 to some value has exactly the same effect.
1362 \begin_layout Standard
1363 Having several configurations also requires more maintenance: if you want
1364 to add a new layout to
1365 \begin_inset Flex Code
1368 \begin_layout Plain Layout
1374 which you want available from all your configurations, you must add it
1375 to each directory separately.
1376 You can avoid this with the following trick: after \SpecialChar LyX
1377 creates the additional
1378 directory, most of the subdirectories (see above) are empty.
1379 If you want the new configuration to mirror an existing one, replace the
1380 empty subdirectory with a symbolic link to the matching subdirectory in
1381 the existing configuration.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1392 subdirectory, however, since it contains a file written by the configuration
1393 script (also accessible through
1394 \begin_inset Flex Noun
1397 \begin_layout Plain Layout
1398 Tools\SpecialChar menuseparator
1404 ) which is configuration-specific.
1407 \begin_layout Chapter
1408 The Preferences dialog
1411 \begin_layout Standard
1412 All options of the preferences dialog are described in the Appendix
1414 The Preferences Dialog
1421 For some options you might find here more details.
1424 \begin_layout Section
1426 \begin_inset CommandInset label
1435 \begin_layout Standard
1436 The first step is to define your file formats if they are not already defined.
1438 \begin_inset Flex Noun
1441 \begin_layout Plain Layout
1442 Tools\SpecialChar menuseparator
1450 \begin_inset Flex Noun
1453 \begin_layout Plain Layout
1454 File Handling\SpecialChar menuseparator
1461 \begin_inset Flex Noun
1464 \begin_layout Plain Layout
1470 button to define your new format.
1472 \begin_inset Flex Noun
1475 \begin_layout Plain Layout
1481 field contains the name used to identify the format in the GUI.
1483 \begin_inset Flex Noun
1486 \begin_layout Plain Layout
1492 is used to identify the format internally.
1493 You will also need to enter a file extension.
1494 These are all required.
1496 \begin_inset Flex Noun
1499 \begin_layout Plain Layout
1505 field is used to provide a keyboard shortcut on the menus.
1506 (For example, pressing
1507 \begin_inset Flex Noun
1510 \begin_layout Plain Layout
1517 \begin_inset Flex Noun
1520 \begin_layout Plain Layout
1521 Document\SpecialChar menuseparator
1522 View (Other Formats)\SpecialChar menuseparator
1531 \begin_layout Standard
1533 \begin_inset Flex Noun
1536 \begin_layout Plain Layout
1543 \begin_inset Flex Noun
1546 \begin_layout Plain Layout
1553 For example, you might want to use
1554 \begin_inset Flex Noun
1557 \begin_layout Plain Layout
1563 to view PostScript files.
1564 You can enter the command needed to start the program in the corresponding
1566 In defining this command, you can use the four variables listed in the
1568 The viewer is launched when you view an image in \SpecialChar LyX
1570 \begin_inset Flex Noun
1573 \begin_layout Plain Layout
1574 Document\SpecialChar menuseparator
1581 The editor is for example launched when you right-click on an image and
1583 \begin_inset Flex Noun
1586 \begin_layout Plain Layout
1592 in the appearing context menu.
1595 \begin_layout Standard
1597 \begin_inset Flex Noun
1600 \begin_layout Plain Layout
1606 type of a format is optional, but if it is specified, it must be unique
1608 It is used to detect files of this format from the file contents.
1609 For some important file formats there is no MIME type officially registered
1611 \begin_inset CommandInset href
1614 target "http://www.iana.org/assignments/media-types/"
1620 Therefore \SpecialChar LyX
1621 uses the extended list of MIME types as specified by
1622 \begin_inset CommandInset href
1624 name "freedesktop.org"
1625 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1633 \begin_layout Standard
1635 \begin_inset Flex Noun
1638 \begin_layout Plain Layout
1644 option tells \SpecialChar LyX
1645 that a format is suitable for document export.
1646 If this is set and if a suitable conversion route exists (see
1647 \begin_inset CommandInset ref
1649 reference "sec:Converters"
1653 ), the format will appear in the
1654 \begin_inset Flex Noun
1657 \begin_layout Plain Layout
1658 File\SpecialChar menuseparator
1665 The format will also appear in the
1666 \begin_inset Flex Noun
1669 \begin_layout Plain Layout
1670 Document\SpecialChar menuseparator
1676 menu if a viewer is specified for the format.
1677 Pure image formats, such as
1678 \begin_inset Flex Code
1681 \begin_layout Plain Layout
1687 , should not use this option.
1688 Formats that can both represent vector graphics and documents like
1689 \begin_inset Flex Code
1692 \begin_layout Plain Layout
1701 \begin_layout Standard
1703 \begin_inset Flex Noun
1706 \begin_layout Plain Layout
1707 Vector graphics format
1712 tells \SpecialChar LyX
1713 that a format can contain vector graphics.
1714 This information is used to determine the target format of included graphics
1716 \begin_inset Flex Noun
1719 \begin_layout Plain Layout
1726 Included graphics may need to be converted to either
1727 \begin_inset Flex Noun
1730 \begin_layout Plain Layout
1737 \begin_inset Flex Noun
1740 \begin_layout Plain Layout
1747 \begin_inset Flex Noun
1750 \begin_layout Plain Layout
1757 \begin_inset Flex Noun
1760 \begin_layout Plain Layout
1766 cannot handle other image formats.
1767 If an included graphic is not already in
1768 \begin_inset Flex Noun
1771 \begin_layout Plain Layout
1778 \begin_inset Flex Noun
1781 \begin_layout Plain Layout
1788 \begin_inset Flex Noun
1791 \begin_layout Plain Layout
1797 format, it is converted to
1798 \begin_inset Flex Noun
1801 \begin_layout Plain Layout
1807 if the vector format option is set, and otherwise to
1808 \begin_inset Flex Noun
1811 \begin_layout Plain Layout
1820 \begin_layout Section
1824 \begin_layout Standard
1825 Since all conversions from one format to another take place in \SpecialChar LyX
1827 directory, it is sometimes necessary to modify a file before copying it
1828 to the temporary directory in order that the conversion may be performed.
1832 \begin_layout Plain Layout
1833 For example, the file may refer to other files—images, for example—using
1834 relative file names, and these may become invalid when the file is copied
1835 to the temporary directory.
1840 This is done by a Copier: It copies a file to (or from) the temporary directory
1841 and may modify it in the process.
1844 \begin_layout Standard
1845 The definitions of the copiers may use eight variables:
1848 \begin_layout Labeling
1849 \labelwidthstring 00.00.0000
1850 \begin_inset Flex Code
1853 \begin_layout Plain Layout
1859 The \SpecialChar LyX
1860 system directory (e.
1861 \begin_inset space \thinspace{}
1865 \begin_inset space \space{}
1869 \begin_inset Flex Noun
1872 \begin_layout Plain Layout
1881 \begin_layout Labeling
1882 \labelwidthstring 00.00.0000
1883 \begin_inset Flex Code
1886 \begin_layout Plain Layout
1895 \begin_layout Labeling
1896 \labelwidthstring 00.00.0000
1897 \begin_inset Flex Code
1900 \begin_layout Plain Layout
1909 \begin_layout Labeling
1910 \labelwidthstring 00.00.0000
1911 \begin_inset Flex Code
1914 \begin_layout Plain Layout
1920 The base name (without filename extension) in the \SpecialChar LyX
1924 \begin_layout Labeling
1925 \labelwidthstring 00.00.0000
1926 \begin_inset Flex Code
1929 \begin_layout Plain Layout
1935 The full directory path of the \SpecialChar LyX
1939 \begin_layout Labeling
1940 \labelwidthstring 00.00.0000
1941 \begin_inset Flex Code
1944 \begin_layout Plain Layout
1950 The full pathname to the original \SpecialChar LyX
1951 file being processed
1954 \begin_layout Labeling
1955 \labelwidthstring 00.00.0000
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1965 The filename (without any directory path) of the \SpecialChar LyX
1969 \begin_layout Labeling
1970 \labelwidthstring 00.00.0000
1971 \begin_inset Flex Code
1974 \begin_layout Plain Layout
1980 The `\SpecialChar LaTeX
1984 \begin_layout Standard
1985 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1993 It is relevant only when exporting files suitable for such inclusion.
1996 \begin_layout Standard
1997 Copiers can be used to do almost anything with output files.
1998 For example, suppose you want generated pdf files to be copied to a special
2000 \begin_inset Flex Code
2003 \begin_layout Plain Layout
2010 Then you could write a shell script such as this one:
2013 \begin_layout Standard
2014 \begin_inset listings
2018 \begin_layout Plain Layout
2023 \begin_layout Plain Layout
2028 \begin_layout Plain Layout
2030 TOFILE=`basename $2`
2033 \begin_layout Plain Layout
2035 cp $FROMFILE /home/you/pdf/$TOFILE
2040 Save it in your local \SpecialChar LyX
2042 \begin_inset Flex Code
2045 \begin_layout Plain Layout
2046 /home/you/.lyx/scripts/pdfcopier.sh
2051 —and make it executable, if you need to do so on your platform.
2053 \begin_inset Flex Noun
2056 \begin_layout Plain Layout
2057 Tools\SpecialChar menuseparator
2063 dialog, select under
2064 \begin_inset Flex Noun
2067 \begin_layout Plain Layout
2068 File Handling\SpecialChar menuseparator
2075 \begin_inset Flex Noun
2078 \begin_layout Plain Layout
2084 format—or one of the other pdf formats—and enter
2085 \begin_inset Flex Code
2088 \begin_layout Plain Layout
2089 pdfcopier.sh $$i $$o
2095 \begin_inset Flex Noun
2098 \begin_layout Plain Layout
2108 \begin_layout Standard
2109 Copiers are used by \SpecialChar LyX
2110 in various of its own conversions.
2111 For example, if appropriate programs are found, \SpecialChar LyX
2112 will automatically install
2114 \begin_inset Flex Noun
2117 \begin_layout Plain Layout
2124 \begin_inset Flex Noun
2127 \begin_layout Plain Layout
2129 \begin_inset space ~
2138 When these formats are exported, the copier sees that not just the main
2139 HTML file but various associated files (style files, images, etc.) are also
2141 All these files are written to a subdirectory of the directory in which
2142 the original \SpecialChar LyX
2147 \begin_layout Plain Layout
2148 This copier can be customized.
2150 \begin_inset Quotes eld
2154 \begin_inset Quotes erd
2157 argument takes a comma-separated list of extensions to be copied; if it
2158 is omitted, all files will be copied.
2160 \begin_inset Quotes eld
2164 \begin_inset Quotes erd
2167 argument determines the extension added to the generated directory.
2169 \begin_inset Quotes eld
2173 \begin_inset Flex Noun
2176 \begin_layout Plain Layout
2183 \begin_inset Quotes erd
2186 , so HTML generated from
2187 \begin_inset Flex Noun
2190 \begin_layout Plain Layout
2191 /path/to/filename.lyx
2197 \begin_inset Flex Noun
2200 \begin_layout Plain Layout
2201 /path/to/filename.html.LyXconv
2215 \begin_layout Section
2217 \begin_inset CommandInset label
2219 name "sec:Converters"
2226 \begin_layout Standard
2227 You can define your own Converters to convert files between different formats.
2229 \begin_inset Flex Noun
2232 \begin_layout Plain Layout
2233 Tools\SpecialChar menuseparator
2234 Preferences\SpecialChar menuseparator
2235 File Handling\SpecialChar menuseparator
2244 \begin_layout Standard
2245 To define a new converter, select the
2246 \begin_inset Flex Noun
2249 \begin_layout Plain Layout
2251 \begin_inset space ~
2260 \begin_inset Flex Noun
2263 \begin_layout Plain Layout
2265 \begin_inset space ~
2273 from the drop-down lists, enter the command needed for the conversion,
2275 \begin_inset Flex Noun
2278 \begin_layout Plain Layout
2285 Several variables can be used in the definition of converters:
2288 \begin_layout Labeling
2289 \labelwidthstring 00.00.0000
2290 \begin_inset Flex Code
2293 \begin_layout Plain Layout
2299 The \SpecialChar LyX
2303 \begin_layout Labeling
2304 \labelwidthstring 00.00.0000
2305 \begin_inset Flex Code
2308 \begin_layout Plain Layout
2317 \begin_layout Labeling
2318 \labelwidthstring 00.00.0000
2319 \begin_inset Flex Code
2322 \begin_layout Plain Layout
2331 \begin_layout Labeling
2332 \labelwidthstring 00.00.0000
2333 \begin_inset Flex Code
2336 \begin_layout Plain Layout
2342 The base filename of the input file (i.
2343 \begin_inset space \thinspace{}
2346 g., without the extension)
2349 \begin_layout Labeling
2350 \labelwidthstring 00.00.0000
2351 \begin_inset Flex Code
2354 \begin_layout Plain Layout
2360 The path to the input file
2363 \begin_layout Labeling
2364 \labelwidthstring 00.00.0000
2365 \begin_inset Flex Code
2368 \begin_layout Plain Layout
2374 The path to the original input file (this is different from $$p when a
2375 chain of converters is called)
2378 \begin_layout Labeling
2379 \labelwidthstring 00.00.0000
2380 \begin_inset Flex Code
2383 \begin_layout Plain Layout
2389 The iconv name for the encoding of the document.
2392 \begin_layout Standard
2394 \begin_inset Flex Noun
2397 \begin_layout Plain Layout
2399 \begin_inset space ~
2407 field you can enter the following flags, separated by commas:
2410 \begin_layout Labeling
2411 \labelwidthstring 00.00.0000
2412 \begin_inset Flex Code
2415 \begin_layout Plain Layout
2417 \change_inserted -712698321 1524656940
2425 This converter runs some form of \SpecialChar LaTeX
2427 This will make \SpecialChar LyX
2428 's \SpecialChar LaTeX
2429 error logs available.
2431 \change_inserted -712698321 1524657018
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2438 \change_inserted -712698321 1524657012
2446 value specifies the form of \SpecialChar LaTeX
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2453 \change_inserted -712698321 1524657005
2454 latex, pdflatex, platex, xetex, luatex
2462 If no value is specified,
2463 \begin_inset Flex Code
2466 \begin_layout Plain Layout
2468 \change_inserted -712698321 1524657018
2481 \begin_layout Labeling
2482 \labelwidthstring 00.00.0000
2483 \begin_inset Flex Code
2486 \begin_layout Plain Layout
2488 \change_inserted -712698321 1524656935
2496 Needs the \SpecialChar LaTeX
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2507 file for the conversion.
2509 \change_inserted -712698321 1524657047
2511 \begin_inset Flex Code
2514 \begin_layout Plain Layout
2516 \change_inserted -712698321 1524657030
2522 value specifies the form of \SpecialChar LaTeX
2523 that is run in order to generate the
2524 \begin_inset Flex Noun
2527 \begin_layout Plain Layout
2529 \change_inserted -712698321 1524657047
2536 \begin_inset Flex Code
2539 \begin_layout Plain Layout
2541 \change_inserted -712698321 1524657030
2542 latex, pdflatex, platex, xetex, luatex
2548 If no value is specified,
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2554 \change_inserted -712698321 1524657030
2565 \begin_layout Labeling
2566 \labelwidthstring 00.00.0000
2567 \begin_inset Flex Code
2570 \begin_layout Plain Layout
2577 \begin_inset Quotes eld
2581 \begin_inset Quotes erd
2584 file from the backend, which in practice means a \SpecialChar LaTeX
2585 file like the one we
2586 would export, without
2587 \begin_inset Flex Code
2590 \begin_layout Plain Layout
2599 \begin_layout Labeling
2600 \labelwidthstring 00.00.0000
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2613 \begin_layout Standard
2614 The following three flags are not really flags at all because they take
2616 \begin_inset Flex Noun
2619 \begin_layout Plain Layout
2621 \begin_inset space ~
2625 \begin_inset space ~
2636 \begin_layout Labeling
2637 \labelwidthstring 00.00.0000
2639 \change_inserted -712698321 1523206314
2640 \begin_inset Flex Code
2643 \begin_layout Plain Layout
2645 \change_inserted -712698321 1523206193
2651 The name of the driver that needs to be loaded with the
2655 package for this converter.
2656 The loading of the correct driver is necessary to get some PDF-specific
2665 \begin_layout Labeling
2666 \labelwidthstring 00.00.0000
2667 \begin_inset Flex Code
2670 \begin_layout Plain Layout
2676 If set, the converter's standard error will be redirected to a file
2677 \begin_inset Flex Code
2680 \begin_layout Plain Layout
2686 , and the script given as argument will be run as:
2687 \begin_inset Flex Code
2690 \begin_layout Plain Layout
2691 script < infile.out > infile.log
2697 The argument may contain
2698 \begin_inset Flex Code
2701 \begin_layout Plain Layout
2710 \begin_layout Labeling
2711 \labelwidthstring 00.00.0000
2712 \begin_inset Flex Code
2715 \begin_layout Plain Layout
2721 The name of the directory in which the converter will dump the generated
2724 will not create this directory, and it does not copy anything into it,
2725 though it will copy this directory to the destination.
2726 The argument may contain
2727 \begin_inset Flex Code
2730 \begin_layout Plain Layout
2736 , which will be replaced by the base name of the input and output files,
2737 respectively, when the directory is copied.
2738 \begin_inset Newline newline
2741 Note that resultdir and usetempdir make no sense together.
2742 The latter will be ignored if the former is given.
2745 \begin_layout Labeling
2746 \labelwidthstring 00.00.0000
2747 \begin_inset Flex Code
2750 \begin_layout Plain Layout
2756 Determines the output file name and may, contain
2757 \begin_inset Flex Code
2760 \begin_layout Plain Layout
2767 Sensible only with resultdir and optional even then; if not given, it defaults
2771 \begin_layout Standard
2773 \change_inserted -712698321 1523206384
2774 A suitable hyperref-driver is set for some converters that are installed
2775 with \SpecialChar LyX
2778 \change_deleted -712698321 1523206388
2780 \change_inserted -712698321 1523206389
2784 \change_inserted -712698321 1523206400
2788 \change_inserted -712698321 1523206407
2792 \change_inserted -712698321 1523206437
2796 \change_deleted -712698321 1523206442
2797 that are installed with \SpecialChar LyX
2804 \begin_layout Standard
2805 You do not have to define converters for all formats between which you want
2807 For example, you will note that there is no `\SpecialChar LyX
2808 to PostScript' converter,
2809 but \SpecialChar LyX
2810 will export PostScript.
2811 It does so by first creating a \SpecialChar LaTeX
2812 file (no converter needs to be defined
2813 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2815 and finally converting the resulting DVI file to PostScript.
2817 finds such `chains' of converters automatically, and it will always choose
2818 the shortest possible chain.
2819 You can, though, still define multiple conversion methods between file
2821 For example, the standard \SpecialChar LyX
2822 configuration provides five ways to convert
2827 \begin_layout Enumerate
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2841 \begin_layout Enumerate
2842 via (DVI and) PostScript, using
2843 \begin_inset Flex Noun
2846 \begin_layout Plain Layout
2855 \begin_layout Enumerate
2857 \begin_inset Flex Noun
2860 \begin_layout Plain Layout
2869 \begin_layout Enumerate
2871 \begin_inset Flex Noun
2874 \begin_layout Plain Layout
2884 \begin_layout Enumerate
2886 \begin_inset Flex Noun
2889 \begin_layout Plain Layout
2899 \begin_layout Standard
2900 To define such alternate chains, you must define multiple target `file formats',
2902 \begin_inset CommandInset ref
2904 reference "sec:Formats"
2909 For example, in the standard configuration, the formats named
2910 \begin_inset Flex Noun
2913 \begin_layout Plain Layout
2920 \begin_inset Flex Noun
2923 \begin_layout Plain Layout
2930 \begin_inset Flex Noun
2933 \begin_layout Plain Layout
2940 \begin_inset Flex Noun
2943 \begin_layout Plain Layout
2950 \begin_inset Flex Noun
2953 \begin_layout Plain Layout
2960 \begin_inset Flex Noun
2963 \begin_layout Plain Layout
2970 \begin_inset Flex Noun
2973 \begin_layout Plain Layout
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2991 \begin_inset Flex Noun
2994 \begin_layout Plain Layout
3001 \begin_inset Flex Noun
3004 \begin_layout Plain Layout
3011 ) are defined, all of which share the extension
3012 \begin_inset Flex Noun
3015 \begin_layout Plain Layout
3021 , and which correspond to the conversion methods just mentioned.
3024 \begin_layout Chapter
3025 Internationalizing \SpecialChar LyX
3027 \begin_inset CommandInset label
3029 name "cha:Internationalizing-LyX"
3036 \begin_layout Standard
3038 supports using a translated interface.
3039 Last time we checked, \SpecialChar LyX
3040 provided text in thirty languages.
3041 The language of choice is called your
3046 (For further reading on locale settings, see also the documentation for
3047 locale that comes with your operating system.
3048 For Linux, the manual page for
3049 \begin_inset Flex Code
3052 \begin_layout Plain Layout
3058 could be a good place to start).
3061 \begin_layout Standard
3062 Notice that these translations will work, but do contain a few flaws.
3063 In particular, all dialogs have been designed with the English text in
3064 mind, which means that some of the translated text will be too large to
3065 fit within the space allocated.
3066 This is only a display problem and will not cause any harm.
3067 Also, you will find that some of the translations do not define shortcut
3068 keys for everything.
3069 Sometimes, there are simply not enough free letters to do it.
3070 Other times, the translator just hasn't got around to doing it yet.
3071 Our localization team, which you may wish to join,
3075 \begin_layout Plain Layout
3076 If you are a fluent speaker of a language other than English, joining these
3077 teams is a great way to give back to the \SpecialChar LyX
3083 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3087 \begin_layout Section
3088 Translating \SpecialChar LyX
3092 \begin_layout Subsection
3093 Translating the graphical user interface (text messages).
3096 \begin_layout Standard
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3108 library to handle the internationalization of the interface.
3109 To have \SpecialChar LyX
3110 speak your favorite language in all menus and dialogs, you need
3112 \begin_inset Flex Code
3115 \begin_layout Plain Layout
3121 -file for that language.
3122 When this is available, you'll have to generate a
3123 \begin_inset Flex Code
3126 \begin_layout Plain Layout
3132 -file from it and install the
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3143 The process of doing all of this is explained in the documentation for
3145 \begin_inset Flex Code
3148 \begin_layout Plain Layout
3155 It is possible to do this just for yourself, but if you're going to do
3156 it, you might as well share the results of your labors with the rest of
3157 the \SpecialChar LyX
3159 Send a message to the \SpecialChar LyX
3160 developers' list for more information about how
3164 \begin_layout Standard
3165 In short, this is what you should do (xx denotes the language code):
3168 \begin_layout Itemize
3169 Check out the \SpecialChar LyX
3172 \begin_inset CommandInset href
3174 name "information on the web"
3175 target "https://www.lyx.org/HowToUseGIT"
3183 \begin_layout Itemize
3185 \begin_inset Flex Code
3188 \begin_layout Plain Layout
3194 to the folder of the
3195 \begin_inset Flex Code
3198 \begin_layout Plain Layout
3206 \begin_inset Flex Code
3209 \begin_layout Plain Layout
3217 \begin_inset Flex Code
3220 \begin_layout Plain Layout
3226 doesn't exist anywhere, it can be remade with the console command
3227 \begin_inset Flex Code
3230 \begin_layout Plain Layout
3236 in that directory, or you can use an existing po-file for some other language
3240 \begin_layout Itemize
3242 \begin_inset Flex Code
3245 \begin_layout Plain Layout
3255 \begin_layout Plain Layout
3256 This is just a text file, so it can be edited in any text editor.
3257 But there are also specialized programs that support such editing, such
3262 (for all platforms) or
3271 contains a `mode' for editing
3272 \begin_inset Flex Code
3275 \begin_layout Plain Layout
3282 \begin_inset Flex URL
3285 \begin_layout Plain Layout
3287 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3297 For some menu- and widget-labels, there are also shortcut keys that should
3299 Those keys are marked after a `|', and should be translated according to
3300 the words and phrases of the language.
3301 You should also fill also out the information at the beginning of the new
3303 \begin_inset Flex Code
3306 \begin_layout Plain Layout
3312 -file with your email-address, etc., so people know where to reach you with
3313 suggestions and entertaining flames.
3316 \begin_layout Standard
3317 If you are just doing this on your own, then:
3320 \begin_layout Itemize
3322 \begin_inset Flex Code
3325 \begin_layout Plain Layout
3332 This can be done with
3333 \begin_inset Flex Code
3336 \begin_layout Plain Layout
3337 msgfmt -o xx.mo < xx.po
3345 \begin_layout Itemize
3347 \begin_inset Flex Code
3350 \begin_layout Plain Layout
3356 -file to your locale-tree, at the correct directory for application messages
3361 xx, and under the name
3362 \begin_inset Flex Code
3365 \begin_layout Plain Layout
3372 \begin_inset space \thinspace{}
3376 \begin_inset space \space{}
3380 \begin_inset Flex Code
3383 \begin_layout Plain Layout
3384 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3394 \begin_layout Standard
3395 As said, however, it would be best if the new
3396 \begin_inset Flex Code
3399 \begin_layout Plain Layout
3405 file could be added to the \SpecialChar LyX
3406 distribution, so others can use it.
3407 Adding it involves making additional changes to \SpecialChar LyX
3409 So send an email to the developers' mailing list if you're interested in
3413 \begin_layout Subsubsection
3417 \begin_layout Standard
3418 Sometimes it turns out that one English message needs to be translated into
3419 different messages in the target language.
3420 One example is the message
3421 \begin_inset Flex Code
3424 \begin_layout Plain Layout
3430 which has the German translation
3438 , depending upon exactly what the English
3439 \begin_inset Quotes eld
3443 \begin_inset Quotes erd
3448 \begin_inset Flex Code
3451 \begin_layout Plain Layout
3457 does not handle such ambiguous translations.
3458 Therefore you have to add some context information to the message: Instead
3460 \begin_inset Flex Code
3463 \begin_layout Plain Layout
3470 \begin_inset Flex Code
3473 \begin_layout Plain Layout
3474 To[[as in 'From format x to format y']]
3480 \begin_inset Flex Code
3483 \begin_layout Plain Layout
3484 To[[as in 'From page x to page y']].
3489 Now the two occurrences of
3490 \begin_inset Flex Code
3493 \begin_layout Plain Layout
3500 \begin_inset Flex Code
3503 \begin_layout Plain Layout
3509 and can be translated correctly to
3520 \begin_layout Standard
3521 Of course the context information needs to be stripped off the original
3522 message when no translation is used.
3523 Therefore you have to put it in double square brackets at the end of the
3524 message (see the example above).
3525 The translation mechanism of \SpecialChar LyX
3526 ensures that everything in double square
3527 brackets at the end of messages is removed before displaying the message.
3530 \begin_layout Subsection
3531 Translating the documentation.
3534 \begin_layout Standard
3535 The online documentation (in the
3536 \begin_inset Flex Noun
3539 \begin_layout Plain Layout
3545 -menu) can (and should!) be translated.
3546 If there are translated versions of the documentation available
3550 \begin_layout Plain Layout
3551 As of March 2008, at least some of the documents have been translated into
3552 fourteen languages, with the Tutorial available in a few more.
3557 and the locale is set accordingly, these will be used automagically by
3561 looks for translated versions as
3562 \begin_inset Flex Code
3565 \begin_layout Plain Layout
3566 LyXDir/doc/xx/DocName.lyx
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3581 is the code for the language currently in use.
3582 If there are no translated documents, the default English versions will
3584 Note that the translated versions must have the same filenames (
3585 \begin_inset Flex Code
3588 \begin_layout Plain Layout
3594 above) as the original.
3595 If you feel up to translating the documentation (an excellent way to proof-read
3596 the original documentation by the way!), there are a few things you should
3600 \begin_layout Itemize
3601 Check out the documentation translation web page at
3602 \begin_inset CommandInset href
3604 name "https://www.lyx.org/Translation"
3605 target "https://www.lyx.org/Translation"
3611 That way, you can find out which (if any) documents have already been translate
3612 d into your language.
3613 You can also find out who (if anyone) is organizing the effort to translate
3614 the documentation into your language.
3615 If no one is organizing the effort, please let us know that you're interested.
3618 \begin_layout Standard
3619 Once you get to actually translating, here's a few hints for you that may
3623 \begin_layout Itemize
3624 Join the documentation team! There is information on how to do that in
3625 \begin_inset Flex Code
3628 \begin_layout Plain Layout
3635 \begin_inset Flex Noun
3638 \begin_layout Plain Layout
3639 Help\SpecialChar menuseparator
3645 ), which by the way is the first document you should translate.
3648 \begin_layout Itemize
3649 Learn the typographic conventions for the language you are translating to.
3650 Typography is an ancient art and over the centuries, a great variety of
3651 conventions have developed throughout different parts of the world.
3652 Also study the professional terminology amongst typographers in your country.
3653 Inventing your own terminology will only confuse the users.
3656 (Warning! Typography is addictive!)
3659 \begin_layout Itemize
3660 Make a copy of the document.
3661 This will be your working copy.
3662 You can use this as your personal translated help-file by placing it in
3664 \begin_inset Flex Code
3667 \begin_layout Plain Layout
3674 \begin_inset Note Greyedout
3677 \begin_layout Plain Layout
3682 For a complex document with external material (images, etc.), if you make
3684 \begin_inset space \thinspace{}
3688 \begin_inset space \space{}
3691 in a temp dir, beware that the links to external material may be broken
3692 when the document is moved to a different place.
3693 The best way is to retrieve the \SpecialChar LyX
3695 \begin_inset Flex URL
3698 \begin_layout Plain Layout
3700 https://www.lyx.org/HowToUseGIT
3705 ) and to edit the doc file in place.
3713 \begin_layout Itemize
3714 Sometimes the original document (from the \SpecialChar LyX
3715 team) will be updated.
3716 Use the source viewer at
3717 \begin_inset CommandInset href
3719 name "https://www.lyx.org/trac/timeline"
3720 target "https://www.lyx.org/trac/timeline"
3725 to see what has been changed.
3726 That way you can easily see which parts of the translated document need
3730 \begin_layout Standard
3731 If you ever find an error in the original document, fix it and notify the
3732 rest of the documentation team of the changes! (You didn't forget to join
3733 the documentation team, did you?)
3736 \begin_layout Standard
3737 \begin_inset Branch OutDated
3741 \begin_layout Section
3742 International Keyboard Support
3745 \begin_layout Standard
3748 [Editor's Note: The following section is by
3756 It needs to be fixed to conform to the new Documentation Style sheet and
3757 to make use of the new v1.0 features.
3758 The whole thing also needs to be merged with the section following it.-jw
3759 It may also be badly out of date.-rh (2008)]
3762 \begin_layout Subsection
3763 Defining Own Keymaps: Keymap File Format
3766 \begin_layout Standard
3767 Let's look at a keyboard definition file a little closer.
3768 It is a plain text file defining
3771 \begin_layout Itemize
3772 key-to-key or key-to-string translations
3775 \begin_layout Itemize
3779 \begin_layout Itemize
3780 dead keys exceptions
3783 \begin_layout Standard
3784 To define key-to-key or key-to-string translation, use this command:
3787 \begin_layout Quotation
3788 \begin_inset Flex Code
3791 \begin_layout Plain Layout
3800 \begin_inset Flex Code
3803 \begin_layout Plain Layout
3812 \begin_layout Standard
3814 \begin_inset Flex Code
3817 \begin_layout Plain Layout
3823 is the key to be translated and
3824 \begin_inset Flex Code
3827 \begin_layout Plain Layout
3833 is the string to be inserted into the document.
3834 To define dead keys, use:
3837 \begin_layout Quotation
3838 \begin_inset Flex Code
3841 \begin_layout Plain Layout
3850 \begin_inset Flex Code
3853 \begin_layout Plain Layout
3862 \begin_layout Standard
3864 \begin_inset Flex Code
3867 \begin_layout Plain Layout
3873 is a keyboard key and
3874 \begin_inset Flex Code
3877 \begin_layout Plain Layout
3884 The following dead keys are supported (shortcut name is in parentheses):
3887 \begin_layout Quotation
3891 \begin_inset space \hfill{}
3897 \begin_layout Quotation
3899 \begin_inset space \hfill{}
3905 \begin_layout Quotation
3907 \begin_inset space \hfill{}
3913 \begin_layout Quotation
3915 \begin_inset space \hfill{}
3921 \begin_layout Quotation
3923 \begin_inset space \hfill{}
3929 \begin_layout Quotation
3931 \begin_inset space \hfill{}
3938 \begin_layout Plain Layout
3950 \begin_layout Quotation
3952 \begin_inset space \hfill{}
3958 \begin_layout Quotation
3960 \begin_inset space \hfill{}
3967 \begin_layout Plain Layout
3979 \begin_layout Quotation
3981 \begin_inset space \hfill{}
3987 \begin_layout Quotation
3989 \begin_inset space \hfill{}
3995 \begin_layout Quotation
3997 \begin_inset space \hfill{}
4004 \begin_layout Plain Layout
4016 \begin_layout Quotation
4018 \begin_inset space \hfill{}
4025 \begin_layout Plain Layout
4037 \begin_layout Quotation
4039 \begin_inset space \hfill{}
4045 \begin_layout Quotation
4046 hungarian umlaut (hug)
4047 \begin_inset space \hfill{}
4053 \begin_layout Quotation
4055 \begin_inset space \hfill{}
4061 \begin_layout Quotation
4063 \begin_inset space \hfill{}
4070 \begin_layout Plain Layout
4082 \begin_layout Standard
4083 Since in many international keyboards there are exceptions to what some
4084 dead keys should do, you can define them using
4087 \begin_layout Quotation
4088 \begin_inset Flex Code
4091 \begin_layout Plain Layout
4099 deadkey key outstring
4102 \begin_layout Standard
4103 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4107 \begin_layout Quotation
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4124 \begin_layout Standard
4125 to make it work correctly.
4126 Also, you have to define as exceptions dead keys over i and j, to remove
4127 the dot from them before inserting an accent mark.
4128 I will change this when the time comes, but so far I haven't had time.
4131 \begin_layout Standard
4132 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4135 \begin_inset Flex Code
4138 \begin_layout Plain Layout
4144 have different meaning.
4146 \begin_inset Flex Code
4149 \begin_layout Plain Layout
4155 marks comments, quotes start and end \SpecialChar LaTeX
4157 To enter quote, you'll need to use
4158 \begin_inset Flex Code
4161 \begin_layout Plain Layout
4170 \begin_inset Flex Code
4173 \begin_layout Plain Layout
4180 \begin_inset Flex Code
4183 \begin_layout Plain Layout
4194 \begin_layout Standard
4195 If you make a keyboard description file that works for your language, please
4196 mail it to me, so I can include it in the next keymap distribution.
4199 \begin_layout Standard
4200 More keywords will be supported in keymap configuration file in future,
4204 \begin_layout Itemize
4205 \begin_inset Flex Code
4208 \begin_layout Plain Layout
4219 \begin_inset space \hfill{}
4223 \begin_inset Flex Code
4226 \begin_layout Plain Layout
4235 \begin_layout Itemize
4236 \begin_inset Flex Code
4239 \begin_layout Plain Layout
4250 \begin_inset space \hfill{}
4254 \begin_inset Flex Code
4257 \begin_layout Plain Layout
4263 an external keymap translation program
4266 \begin_layout Standard
4267 Also, it should look into
4268 \begin_inset Flex Code
4271 \begin_layout Plain Layout
4277 file for defaults, too (for example, a
4278 \begin_inset Flex Code
4281 \begin_layout Plain Layout
4289 option to include default keyboard).
4297 \begin_layout Section
4298 International Keymap Stuff
4299 \begin_inset CommandInset label
4301 name "sec:International-Keymap-Stuff"
4308 \begin_layout Standard
4309 \begin_inset Note Note
4312 \begin_layout Plain Layout
4313 In doing the revisions on this document in March 2008, I did not look over
4314 this stuff, as I do not understand it.
4315 It would be good if someone else could do so.
4324 \begin_layout Standard
4325 The next two sections describe the
4326 \begin_inset Flex Code
4329 \begin_layout Plain Layout
4338 \begin_inset Flex Code
4341 \begin_layout Plain Layout
4349 file syntax in detail.
4350 These sections should help you design your own key map if the ones provided
4351 do not meet your needs.
4354 \begin_layout Subsection
4358 \begin_layout Standard
4362 \begin_inset Flex Code
4365 \begin_layout Plain Layout
4371 file maps keystrokes to characters or strings.
4372 As the name suggests, it sets a keyboard mapping.
4374 \begin_inset Flex Code
4377 \begin_layout Plain Layout
4388 \begin_inset Flex Code
4391 \begin_layout Plain Layout
4406 \begin_inset Flex Code
4409 \begin_layout Plain Layout
4422 \begin_inset Flex Code
4425 \begin_layout Plain Layout
4434 \begin_inset Flex Code
4437 \begin_layout Plain Layout
4445 are described in this section.
4448 \begin_layout Labeling
4449 \labelwidthstring 00.00.0000
4450 \begin_inset Flex Code
4453 \begin_layout Plain Layout
4461 Map a character to a string
4464 \begin_layout LyX-Code
4479 \begin_layout Standard
4512 the double-quote (")
4529 must be escaped with a preceding backslash (
4540 \begin_layout Standard
4542 \begin_inset Flex Noun
4545 \begin_layout Plain Layout
4553 statement to cause the symbol
4554 \begin_inset Flex Noun
4557 \begin_layout Plain Layout
4565 to be output for the keystroke
4566 \begin_inset Flex Noun
4569 \begin_layout Plain Layout
4580 \begin_layout LyX-Code
4586 \begin_layout Labeling
4587 \labelwidthstring 00.00.0000
4588 \begin_inset Flex Code
4591 \begin_layout Plain Layout
4599 Specify an accent character
4602 \begin_layout LyX-Code
4611 \begin_layout Standard
4612 This will make the cha
4650 This is the dead key
4654 \begin_layout Plain Layout
4661 refers to a key that does not produce a character by itself, but when followed
4662 with another key, produces the desired accent character.
4663 For example, a German characte
4665 r with an umlaut like
4675 can be produced in this manner.
4684 \begin_layout Standard
4697 and then another key not in
4714 followed by the other, not allowed key, as output.
4718 \begin_inset Flex Noun
4721 \begin_layout Plain Layout
4729 cancels a dead key, so if
4740 \begin_inset Flex Noun
4743 \begin_layout Plain Layout
4752 , the cursor will not go one position backwards but will instead cancel
4768 might have had on the next keystroke.
4772 \begin_layout Standard
4773 The following example specifies that the character ' is to be an acute accent,
4774 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4777 \begin_layout LyX-Code
4780 kmod ' acute aeiouAEIOU
4783 \begin_layout Labeling
4784 \labelwidthstring 00.00.0000
4785 \begin_inset Flex Code
4788 \begin_layout Plain Layout
4794 Specify an exception to the accent character
4797 \begin_layout LyX-Code
4806 \begin_layout Standard
4807 This defines an exce
4848 have been assigned a keystroke with a previous
4851 \begin_inset Flex Code
4854 \begin_layout Plain Layout
4878 must not belong in the
4925 If such a declaration does not exist in
4933 \begin_inset Flex Code
4936 \begin_layout Plain Layout
4970 \begin_inset Flex Code
4973 \begin_layout Plain Layout
4987 \begin_layout Standard
4988 The following command produces causes äi to be produced when you enter acute-i
4992 \begin_layout LyX-Code
5006 \begin_layout Labeling
5007 \labelwidthstring 00.00.0000
5008 \begin_inset Flex Code
5011 \begin_layout Plain Layout
5017 Combine two accent characters
5020 \begin_layout LyX-Code
5026 accent1 accent2 allowed
5029 \begin_layout Standard
5030 This one is getting pretty esoteric.
5031 It allows you to combine the effect
5087 \begin_inset Flex Code
5090 \begin_layout Plain Layout
5118 \begin_layout Standard
5119 Consider this example from the
5120 \begin_inset Flex Code
5123 \begin_layout Plain Layout
5134 \begin_layout LyX-Code
5137 kmod ; acute aeioyvhAEIOYVH
5141 kcomb acute umlaut iyIY
5144 \begin_layout Standard
5145 This allows you to press
5146 \begin_inset Flex Noun
5149 \begin_layout Plain Layout
5157 and get the effect of
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5180 in this case cancels the last dead key, so if you press
5181 \begin_inset Flex Noun
5184 \begin_layout Plain Layout
5193 \begin_inset Flex Code
5196 \begin_layout Plain Layout
5209 \begin_layout Subsection
5213 \begin_layout Standard
5215 \begin_inset Flex Code
5218 \begin_layout Plain Layout
5226 mapping is performed, a
5227 \begin_inset Flex Code
5230 \begin_layout Plain Layout
5240 file maps the strings that the symbols generate to characters in the current
5242 The \SpecialChar LyX
5243 distribution currently includes at least the
5244 \begin_inset Flex Code
5247 \begin_layout Plain Layout
5256 \begin_inset Flex Code
5259 \begin_layout Plain Layout
5270 \begin_layout Standard
5272 \begin_inset Flex Code
5275 \begin_layout Plain Layout
5283 file is a sequence of declarations of the form
5286 \begin_layout LyX-Code
5299 \begin_layout Standard
5300 For example, in order to map
5301 \begin_inset Flex Noun
5304 \begin_layout Plain Layout
5314 to the corresponding character in the iso-8859-1 set (233), the following
5318 \begin_layout LyX-Code
5326 \begin_layout Standard
5328 \begin_inset Flex Code
5331 \begin_layout Plain Layout
5340 \begin_inset Flex Code
5343 \begin_layout Plain Layout
5361 the same character can apply to more than one string.
5363 \begin_inset Flex Code
5366 \begin_layout Plain Layout
5377 \begin_layout LyX-Code
5389 \begin_inset Newline newline
5405 \begin_layout Standard
5407 cannot find a mapping for the string produced by the keystroke or a
5408 deadkey sequence, it will check if it looks like an accented char and try
5409 to draw an accent over the character on screen.
5412 \begin_layout Subsection
5416 \begin_layout Standard
5417 There is a second way to add support for international characters through
5418 so-called dead-keys.
5419 A dead-key works in combination with a letter to produce an accented character.
5420 Here, we'll explain how to create a really simple dead-key to illustrate
5424 \begin_layout Standard
5425 Suppose you happen to need the circumflex character,
5426 \begin_inset Quotes eld
5430 \begin_inset Quotes erd
5435 \begin_inset Flex Noun
5438 \begin_layout Plain Layout
5445 \begin_inset space ~
5449 \begin_inset Flex Noun
5452 \begin_layout Plain Layout
5458 ] to the \SpecialChar LyX
5460 \begin_inset Flex Code
5463 \begin_layout Plain Layout
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5480 Now, whenever you type the
5481 \begin_inset Flex Noun
5484 \begin_layout Plain Layout
5490 -key followed by a letter, that letter will have a circumflex accent on
5492 For example, the sequence
5493 \begin_inset Quotes eld
5497 \begin_inset Flex Noun
5500 \begin_layout Plain Layout
5507 \begin_inset Quotes erd
5510 produces the letter:
5511 \begin_inset Quotes eld
5515 \begin_inset Quotes erd
5519 If you tried to type
5520 \begin_inset Quotes eld
5524 \begin_inset Flex Noun
5527 \begin_layout Plain Layout
5534 \begin_inset Quotes erd
5537 , however, \SpecialChar LyX
5538 will complain with a beep, since a
5539 \begin_inset Quotes eld
5543 \begin_inset Flex Noun
5546 \begin_layout Plain Layout
5553 \begin_inset Quotes erd
5556 never takes a circumflex accent.
5558 \begin_inset Flex Noun
5561 \begin_layout Plain Layout
5567 after a dead-key produces the bare-accent.
5568 Please note this last point! If you bind a key to a dead-key, you'll need
5569 to rebind the character on that key to yet another key.
5571 \begin_inset Flex Noun
5574 \begin_layout Plain Layout
5580 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5583 \begin_layout Standard
5584 One common way to bind dead-keys is to use
5585 \begin_inset Flex Noun
5588 \begin_layout Plain Layout
5595 \begin_inset Flex Noun
5598 \begin_layout Plain Layout
5605 \begin_inset Flex Noun
5608 \begin_layout Plain Layout
5614 in combination with an accent, like
5615 \begin_inset Quotes eld
5619 \begin_inset Flex Noun
5622 \begin_layout Plain Layout
5629 \begin_inset Quotes erd
5633 \begin_inset Quotes eld
5637 \begin_inset Flex Noun
5640 \begin_layout Plain Layout
5647 \begin_inset Quotes erd
5651 \begin_inset Quotes eld
5655 \begin_inset Flex Noun
5658 \begin_layout Plain Layout
5665 \begin_inset Quotes erd
5669 Another way involves using
5670 \begin_inset Flex Code
5673 \begin_layout Plain Layout
5680 \begin_inset Flex Code
5683 \begin_layout Plain Layout
5689 to set up the special
5690 \begin_inset Flex Code
5693 \begin_layout Plain Layout
5701 \begin_inset Flex Code
5704 \begin_layout Plain Layout
5710 acts in some ways just like
5711 \begin_inset Flex Noun
5714 \begin_layout Plain Layout
5720 and permits you to bind keys to accented characters.
5721 You can also turn keys into dead-keys by binding them to something like
5723 \begin_inset Flex Code
5726 \begin_layout Plain Layout
5732 and then binding this symbolic key to the corresponding \SpecialChar LyX
5737 \begin_layout Plain Layout
5742 : This is exactly what I do in my
5743 \begin_inset Flex Code
5746 \begin_layout Plain Layout
5753 \begin_inset Flex Code
5756 \begin_layout Plain Layout
5764 \begin_inset Flex Noun
5767 \begin_layout Plain Layout
5769 \begin_inset space ~
5778 \begin_inset Flex Code
5781 \begin_layout Plain Layout
5787 and a bunch of these
5788 \begin_inset Quotes eld
5792 \begin_inset Flex Code
5795 \begin_layout Plain Layout
5802 \begin_inset Quotes erd
5805 symbolic keys bound such things as
5806 \begin_inset Flex Noun
5809 \begin_layout Plain Layout
5811 \begin_inset space ~
5820 \begin_inset Flex Noun
5823 \begin_layout Plain Layout
5825 \begin_inset space ~
5834 This is how I produce my accented characters.
5839 You can make just about anything into the
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5850 \begin_inset Flex Noun
5853 \begin_layout Plain Layout
5859 keys, a spare function key, etc.
5860 As for the \SpecialChar LyX
5861 commands that produce accents, check the entry for
5862 \begin_inset Flex Code
5865 \begin_layout Plain Layout
5876 You'll find the complete list there.
5879 \begin_layout Subsection
5880 Saving your Language Configuration
5883 \begin_layout Standard
5884 You can edit your preferences so that your desired language environment
5885 is automatically configured when \SpecialChar LyX
5887 \begin_inset Flex Noun
5890 \begin_layout Plain Layout
5891 Edit\SpecialChar menuseparator
5900 \begin_layout Chapter
5901 Installing New Document Classes, Layouts, and Templates
5902 \begin_inset CommandInset label
5904 name "cha:Installing-New-Document"
5909 \begin_inset Argument 1
5912 \begin_layout Plain Layout
5913 Installing New Document Classes
5921 \begin_layout Standard
5922 In this chapter, we describe the procedures for creating and installing
5923 new \SpecialChar LyX
5924 layout and template files, as well as offer a refresher on correctly
5925 installing new \SpecialChar LaTeX
5930 \begin_layout Standard
5931 First, let us a say a few words about how one ought to think about the relation
5932 between \SpecialChar LyX
5933 and \SpecialChar LaTeX
5935 The thing to understand is that, in a certain sense, \SpecialChar LyX
5936 doesn't know anything
5937 about \SpecialChar LaTeX
5939 Indeed, from \SpecialChar LyX
5940 's point of view, \SpecialChar LaTeX
5941 is just one of several
5942 \begin_inset Quotes eld
5946 \begin_inset Quotes erd
5949 in which it is capable of producing output.
5950 Other such formats are DocBook, plaintext, and XHTML.
5952 is, of course, a particularly important format, but very little of the
5953 information \SpecialChar LyX
5954 has about \SpecialChar LaTeX
5955 is actually contained in the program itself.
5959 \begin_layout Plain Layout
5960 Some commands are sufficiently complex that they are
5961 \begin_inset Quotes eld
5965 \begin_inset Quotes erd
5968 into \SpecialChar LyX
5970 But the developers generally regard this as a Bad Thing.
5975 Rather, that information, even for the standard classes like
5976 \begin_inset Flex Code
5979 \begin_layout Plain Layout
5985 , is contained in `layout files'.
5986 Similarly, \SpecialChar LyX
5987 itself does not know much about DocBook or XHTML.
5988 What it knows is contained in layout files.
5991 \begin_layout Standard
5992 You can think of the layout file for a given document class as a translation
5993 manual between \SpecialChar LyX
5994 constructs—paragraphs with their corresponding styles,
5995 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5998 Almost everything \SpecialChar LyX
6000 \begin_inset Flex Code
6003 \begin_layout Plain Layout
6009 , for example, is contained in the file
6010 \begin_inset Flex Code
6013 \begin_layout Plain Layout
6019 and in various other files it includes.
6020 For this reason, anyone intending to write layout files should plan to
6021 study the existing files.
6022 A good place to start is with
6023 \begin_inset Flex Code
6026 \begin_layout Plain Layout
6032 , which is included in
6033 \begin_inset Flex Code
6036 \begin_layout Plain Layout
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6052 , and many of the other layout files for document classes.
6053 This file is where sections and the like are defined:
6054 \begin_inset Flex Code
6057 \begin_layout Plain Layout
6063 tells \SpecialChar LyX
6064 how paragraphs that are marked with the Section, Subsection, etc,
6065 styles can be translated into corresponding \SpecialChar LaTeX
6066 , DocBook, and XHTML commands
6069 \begin_inset Flex Code
6072 \begin_layout Plain Layout
6078 file basically just includes several of these
6079 \begin_inset Flex Code
6082 \begin_layout Plain Layout
6091 \begin_layout Standard
6092 Defining the \SpecialChar LyX
6094 correspondence is not the only thing layout files do, though.
6095 Their other job is to define how the \SpecialChar LyX
6096 constructs themselves will appear
6098 The fact that layout files have these two jobs is often a source of confusion,
6099 because they are completely separate.
6100 Telling \SpecialChar LyX
6101 how to translate a certain paragraph style into \SpecialChar LaTeX
6104 how to display it; conversely, telling \SpecialChar LyX
6105 how to display a certain paragraph
6106 style does not tell \SpecialChar LyX
6107 how to translate it into \SpecialChar LaTeX
6108 (let alone tell \SpecialChar LaTeX
6111 So, in general, when you define a new \SpecialChar LyX
6112 construct, you must always do two
6113 quite separate things: (i)
6114 \begin_inset space ~
6117 tell \SpecialChar LyX
6118 how to translate it into \SpecialChar LaTeX
6120 \begin_inset space ~
6123 tell \SpecialChar LyX
6127 \begin_layout Standard
6128 Much the same is true, of course, as regards \SpecialChar LyX
6129 's other backend formats, though
6130 XHTML is in some ways different, because in that case \SpecialChar LyX
6135 able, to some extent, to use information about how it should display a
6136 paragraph on the screen to output information (in the form of CSS) about
6137 how the paragraph should be displayed in a browser.
6138 Even in this case, however, the distinction between what \SpecialChar LyX
6140 and how things are rendered externally remains in force, and the two can
6141 be controlled separately.
6143 \begin_inset CommandInset ref
6145 reference "sec:Tags-for-XHTML"
6152 \begin_layout Section
6153 Installing new \SpecialChar LaTeX
6157 \begin_layout Standard
6158 Some installations may not include a \SpecialChar LaTeX
6159 package or class file that you would
6160 like to use within \SpecialChar LyX
6162 For example, you might need Foil\SpecialChar TeX
6163 , a package for preparing slides for overhead
6165 Modern \SpecialChar LaTeX
6166 distributions like \SpecialChar TeX
6167 Live (2008 or newer) or MiK\SpecialChar TeX
6168 provide a user interface
6169 for installing such packages.
6170 For example, with MiK\SpecialChar TeX
6171 , you start the program
6172 \begin_inset Quotes eld
6176 \begin_inset space ~
6180 \begin_inset Quotes erd
6183 to get a list of available packages.
6184 To install one of them, right click on it or use the corresponding toolbar
6188 \begin_layout Standard
6189 If your \SpecialChar LaTeX
6190 distribution does not provide such a `package manager', or if the
6191 package is not available from your distribution, then follow these steps
6192 to install it manually:
6195 \begin_layout Enumerate
6196 Get the package from
6197 \begin_inset CommandInset href
6200 target "http://www.ctan.org/"
6208 \begin_layout Enumerate
6209 If the package contains a file with the ending
6210 \begin_inset Quotes eld
6214 \begin_inset Flex Code
6217 \begin_layout Plain Layout
6224 \begin_inset Quotes erd
6227 (is the case for Foil\SpecialChar TeX
6228 ) then open a console, change to the folder of this
6229 file and execute the command
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6240 You have now unpacked the package and have all files to install it.
6241 Most \SpecialChar LaTeX
6242 -packages are not packed and you can skip this step.
6245 \begin_layout Enumerate
6246 Now you need to decide if the package should be available for all users
6251 \begin_layout Enumerate
6252 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6253 for all users on your system, then install it in your `local' \SpecialChar TeX
6255 install it in your own `user' \SpecialChar TeX
6257 Where these trees should be created, if they do not already exist, depends
6259 To find this out, look in the file
6260 \begin_inset Flex Code
6263 \begin_layout Plain Layout
6273 \begin_layout Plain Layout
6274 This is usually in the directory
6275 \begin_inset Flex Code
6278 \begin_layout Plain Layout
6284 , though you can execute the command
6285 \begin_inset Flex Code
6288 \begin_layout Plain Layout
6299 The location of the `local' \SpecialChar TeX
6300 tree is defined by the
6301 \begin_inset Flex Code
6304 \begin_layout Plain Layout
6310 variable; this is usually somewhere like
6311 \begin_inset Flex Code
6314 \begin_layout Plain Layout
6315 /usr/local/share/texmf
6320 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6323 The location of the `user' \SpecialChar TeX
6325 \begin_inset Flex Code
6328 \begin_layout Plain Layout
6335 \begin_inset Flex Code
6338 \begin_layout Plain Layout
6345 \begin_inset Flex Code
6348 \begin_layout Plain Layout
6357 (If these variables are not predefined, you have to define them.) You'll
6358 probably need root permissions to create or modify the `local' tree, but
6359 not for your `user' tree.
6360 \begin_inset Newline newline
6363 In general, it is recommended to install in the user tree because your user
6364 will not be modified or even overwritten when you upgrade your system.
6365 It will typically also be backed up together with everything else when
6366 you backup your home directory (which, of course, you do on a regular basis).
6369 \begin_layout Enumerate
6370 On Windows, if you want the new package to be available for all users on
6371 your system, change to the folder where \SpecialChar LaTeX
6372 is installed and then change to
6374 \begin_inset Flex Code
6377 \begin_layout Plain Layout
6388 (For MiK\SpecialChar TeX
6389 , this would be by default the folder
6390 \begin_inset Flex Code
6393 \begin_layout Plain Layout
6411 \begin_layout Plain Layout
6412 Note that this will be the correct path only on English installations.
6413 On a German one, it would be
6414 \begin_inset Flex Code
6417 \begin_layout Plain Layout
6431 , and similarly for other languages.
6436 Create there a new folder
6437 \begin_inset Flex Code
6440 \begin_layout Plain Layout
6446 and copy all files of the package into it.
6448 \begin_inset Newline newline
6451 If the package should only available for you or you don't have admin permissions
6452 , do the same, but in the local \SpecialChar LaTeX
6455 \begin_inset space \thinspace{}
6458 g., for MiK\SpecialChar TeX
6460 \begin_inset space ~
6463 2.8 under Windows XP, this would be the folder:
6464 \begin_inset Newline newline
6470 \begin_inset Flex Code
6473 \begin_layout Plain Layout
6476 Documents and Settings
6488 \begin_inset Newline newline
6494 \begin_inset Phantom HPhantom
6497 \begin_layout Plain Layout
6508 \begin_inset Flex Code
6511 \begin_layout Plain Layout
6524 \begin_inset Newline newline
6527 On Vista, it would be:
6528 \begin_inset Newline newline
6532 \begin_inset Flex Code
6535 \begin_layout Plain Layout
6561 \begin_layout Enumerate
6562 Now one only need to tell \SpecialChar LaTeX
6563 that there are new files.
6564 This depends on the used \SpecialChar LaTeX
6569 \begin_layout Enumerate
6570 For \SpecialChar TeX
6571 Live execute the command
6572 \begin_inset Flex Code
6575 \begin_layout Plain Layout
6582 If you installed the package for all users, then you will probably need
6583 to have root permissions for that.
6586 \begin_layout Enumerate
6587 For MiK\SpecialChar TeX
6588 , if you have installed the package for all users, start the program
6590 \begin_inset Quotes eld
6594 \begin_inset space ~
6598 \begin_inset Quotes erd
6601 and press the button marked
6602 \begin_inset Quotes eld
6606 \begin_inset Quotes erd
6610 Otherwise start the program
6611 \begin_inset Quotes eld
6615 \begin_inset Quotes erd
6622 \begin_layout Enumerate
6623 Finally, you need to tell \SpecialChar LyX
6624 that there are new packages available.
6625 So, in \SpecialChar LyX
6627 \begin_inset Flex Noun
6630 \begin_layout Plain Layout
6633 \SpecialChar menuseparator
6639 and then restart \SpecialChar LyX
6643 \begin_layout Standard
6644 Now the package is installed.
6645 In our example, the document class
6646 \begin_inset Flex Code
6649 \begin_layout Plain Layout
6655 will now be available under
6656 \begin_inset Flex Noun
6659 \begin_layout Plain Layout
6660 Document\SpecialChar menuseparator
6661 Settings\SpecialChar menuseparator
6668 \begin_inset Quotes eld
6672 \begin_inset Quotes erd
6679 \begin_layout Standard
6680 If you would like to use a \SpecialChar LaTeX
6681 document class that is not even listed in the
6683 \begin_inset Flex Noun
6686 \begin_layout Plain Layout
6687 Document\SpecialChar menuseparator
6688 Settings\SpecialChar menuseparator
6694 , then you need to create a `layout' file for it.
6695 That is the topic of the next section.
6698 \begin_layout Section
6699 Types of layout files
6702 \begin_layout Standard
6703 This section describes the various sorts of \SpecialChar LyX
6704 files that contain layout informati
6706 These files describe various paragraph and character styles, determining
6707 how \SpecialChar LyX
6708 should display them and how they should be translated into \SpecialChar LaTeX
6710 XHTML, or whatever output format is being used.
6714 \begin_layout Standard
6715 We shall try to provide a thorough description of the process of writing
6717 However, there are so many different types of documents supported even
6718 by just \SpecialChar LaTeX
6719 that we can't hope to cover every different possibility or problem
6720 you might encounter.
6721 The \SpecialChar LyX
6722 users' list is frequented by people with lots of experience with layout
6723 design who are willing to share what they've learned, so please feel free
6724 to ask questions there.
6727 \begin_layout Standard
6728 As you prepare to write a new layout, it is extremely helpful to look at
6729 the layouts distributed with \SpecialChar LyX
6731 If you write a \SpecialChar LyX
6732 layout for a \SpecialChar LaTeX
6733 document class that might also be used by
6734 others, or write a module that might be useful to others, then you should
6735 consider posting your layout to the
6736 \begin_inset CommandInset href
6738 name "layout section on the LyX wiki"
6739 target "https://wiki.lyx.org/Layouts/Layouts"
6744 or even to the \SpecialChar LyX
6745 developers' list, so that it might be included in \SpecialChar LyX
6750 \begin_layout Plain Layout
6751 Note that \SpecialChar LyX
6752 is licensed under the General Public License, so any material
6753 that is contributed to \SpecialChar LyX
6754 must be similarly licensed.
6762 \begin_layout Subsection
6764 \begin_inset CommandInset label
6766 name "subsec:Layout-modules"
6773 \begin_layout Standard
6774 We have spoken to this point about `layout files'.
6775 But there are different sorts of files that contain layout information.
6776 Layout files, strictly so called, have the
6777 \begin_inset Flex Code
6780 \begin_layout Plain Layout
6786 extension and provide \SpecialChar LyX
6787 with information about document classes.
6788 Since \SpecialChar LyX
6789 1.6 layout information can also be contained in layout
6794 \begin_inset Flex Code
6797 \begin_layout Plain Layout
6804 Modules are to \SpecialChar LaTeX
6805 packages much as layouts are to \SpecialChar LaTeX
6806 classes, and some modules—such
6808 \begin_inset Flex Code
6811 \begin_layout Plain Layout
6817 module—specifically provide support for one package.
6818 In a sense, layout modules are similar to included
6822 \begin_layout Plain Layout
6823 These can have any extension, but by convention have the
6824 \begin_inset Flex Code
6827 \begin_layout Plain Layout
6839 \begin_inset Flex Code
6842 \begin_layout Plain Layout
6848 —in that modules are not specific to a given document class but may be used
6849 with many different classes.
6850 The difference is that using an included file with
6851 \begin_inset Flex Code
6854 \begin_layout Plain Layout
6860 requires editing that file.
6861 Modules, by contrast, are selected in the
6862 \begin_inset Flex Noun
6865 \begin_layout Plain Layout
6866 Document\SpecialChar menuseparator
6875 \begin_layout Standard
6876 Building modules is the easiest way to get started with layout editing,
6877 since it can be as simple as adding a single new paragraph style or flex
6879 But modules may, in principle, contain anything a layout file can contain.
6882 \begin_layout Standard
6883 After creating a new module and copying it to the
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6893 folder, you will need to reconfigure and then restart \SpecialChar LyX
6896 However, changes you make to the module will be seen immediately, if you
6898 \begin_inset Flex Noun
6901 \begin_layout Plain Layout
6902 Document\SpecialChar menuseparator
6908 , highlight something, and then hit
6909 \begin_inset Quotes eld
6913 \begin_inset Quotes erd
6919 It is strongly recommended that you save your work before doing this
6924 it is strongly recommended that you not attempt to edit modules while simultaneo
6925 usly working on actual documents
6928 Though of course the developers strive to keep \SpecialChar LyX
6929 stable in such situations,
6930 syntax errors and the like in your module file could cause strange behavior.
6933 \begin_layout Subsubsection
6937 \begin_layout Standard
6938 Modules are to \SpecialChar LyX
6939 as packages are to \SpecialChar LaTeX
6941 Sometimes, however, you find yourself wanting a specific inset or character
6942 style just for one document and writing a module that will also be available
6943 to other documents makes little sense.
6944 What you need is \SpecialChar LyX
6946 \begin_inset Quotes eld
6950 \begin_inset Quotes erd
6956 \begin_layout Standard
6957 You will find it under
6959 Document\SpecialChar menuseparator
6960 Settings\SpecialChar menuseparator
6964 The large text box allows you to enter anything that you might enter in
6965 a layout file or module.
6966 You can think of a document's local layout, in fact, as a module that belongs
6968 So, in particular, you must enter a
6969 \begin_inset Flex Code
6972 \begin_layout Plain Layout
6979 Any format is acceptable, but one would normally use the format current
6981 (In \SpecialChar LyX
6988 , the current layout format is
6997 \begin_layout Standard
6998 When you have entered something in the
6999 \begin_inset Flex Code
7002 \begin_layout Plain Layout
7008 pane, \SpecialChar LyX
7010 \begin_inset Quotes eld
7014 \begin_inset Quotes erd
7017 button at the bottom.
7018 Clicking this button will cause \SpecialChar LyX
7019 to determine whether what you have entered
7020 is valid layout information for the chosen format.
7022 will report the result but, unfortunately, will not tell you what errors
7023 there might have been.
7024 These will be written to the terminal, however, if \SpecialChar LyX
7025 is started from a terminal.
7026 You will not be permitted to save your local layout until you have entered
7030 \begin_layout Standard
7031 The warnings at the end of the previous section apply here, too.
7032 Do not play with local layout while you are actually working, especially
7033 if you have not saved your document.
7034 That said, using local layout with a test document can be a very convenient
7035 way to try out layout ideas, or even to start developing a module.
7038 \begin_layout Subsection
7040 \begin_inset Flex Noun
7043 \begin_layout Plain Layout
7052 \begin_layout Standard
7053 There are two situations you are likely to encounter when wanting to support
7054 a new \SpecialChar LaTeX
7055 document class, involving style (
7056 \begin_inset Flex Code
7059 \begin_layout Plain Layout
7065 ) files and \SpecialChar LaTeX2e
7067 \begin_inset Flex Code
7070 \begin_layout Plain Layout
7077 Supporting a style file is usually fairly easy.
7078 Supporting a new class file is a bit harder.
7079 We'll discuss the former in this section and the latter in the next.
7080 Similar remarks apply, of course, if you want to support a new DocBook
7084 \begin_layout Standard
7085 The easier case is the one in which your new document class is provided
7086 as a style file that is to be used in conjunction with an already supported
7088 For the sake of the example, we'll assume that the style file is called
7090 \begin_inset Flex Noun
7093 \begin_layout Plain Layout
7099 and that it is meant to be used with
7100 \begin_inset Flex Noun
7103 \begin_layout Plain Layout
7109 , which is a standard class.
7113 \begin_layout Standard
7114 Start by copying the existing class's layout file into your local directory:
7118 \begin_layout Plain Layout
7119 Of course, which directory is your local directory will vary by platform,
7120 and \SpecialChar LyX
7121 allows you to specify your local directory on startup, too, using
7123 \begin_inset Flex Code
7126 \begin_layout Plain Layout
7140 \begin_layout LyX-Code
7141 cp report.layout ~/.lyx/layouts/myclass.layout
7144 \begin_layout Standard
7146 \begin_inset Flex Code
7149 \begin_layout Plain Layout
7155 and change the line:
7158 \begin_layout LyX-Code
7161 DeclareLaTeXClass{Report (Standard Class)}
7164 \begin_layout Standard
7168 \begin_layout LyX-Code
7171 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7174 \begin_layout Standard
7178 \begin_layout LyX-Code
7180 \begin_inset Newline newline
7186 \begin_inset Newline newline
7192 \begin_layout Standard
7193 near the top of the file.
7196 \begin_layout Standard
7197 Start \SpecialChar LyX
7199 \begin_inset Flex Noun
7202 \begin_layout Plain Layout
7203 Tools\SpecialChar menuseparator
7210 Then restart \SpecialChar LyX
7211 and try creating a new document.
7213 \begin_inset Flex Noun
7216 \begin_layout Plain Layout
7222 " as a document class option in the
7223 \begin_inset Flex Noun
7226 \begin_layout Plain Layout
7227 Document\SpecialChar menuseparator
7234 It is likely that some of the sectioning commands and such in your new
7235 class will work differently from how they worked in the base class—
7236 \begin_inset Flex Code
7239 \begin_layout Plain Layout
7245 in this example—so you can fiddle around with the settings for the different
7246 sections if you wish.
7247 The layout information for sections is contained in
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7257 , but you do not need to copy and change this file.
7258 Instead, you can simply add your changes to your layout file, after the
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7269 , which itself includes
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7280 For example, you might add these lines:
7283 \begin_layout LyX-Code
7287 \begin_layout LyX-Code
7291 \begin_layout LyX-Code
7295 \begin_layout LyX-Code
7299 \begin_layout LyX-Code
7303 \begin_layout Standard
7304 to change the font for chapter headings to sans-serif.
7305 This will override (or, in this case, add to) the existing declaration
7306 for the Chapter style.
7310 \begin_layout Standard
7311 Your new package may also provide commands or environments not present in
7313 In this case, you will want to add these to the layout file.
7315 \begin_inset CommandInset ref
7317 reference "sec:TextClass"
7321 for information on how to do so.
7324 \begin_layout Standard
7326 \begin_inset Flex Noun
7329 \begin_layout Plain Layout
7335 can be used with several different document classes, and even if it cannot,
7336 you might find it easiest just to write a module that you can load with
7338 The simplest possible such module would be:
7341 \begin_layout LyX-Code
7344 DeclareLyXModule{My Class}
7347 \begin_layout LyX-Code
7351 \begin_layout LyX-Code
7352 #Support for myclass.sty.
7355 \begin_layout LyX-Code
7357 \begin_inset Newline newline
7363 \begin_layout LyX-Code
7371 \begin_inset Newline newline
7377 \begin_layout LyX-Code
7379 \begin_inset Newline newline
7385 \begin_inset Newline newline
7391 \begin_layout Standard
7392 A more complex module might modify the behavior of some existing constructs
7393 or define some new ones.
7395 \begin_inset CommandInset ref
7397 reference "sec:TextClass"
7404 \begin_layout Subsection
7406 \begin_inset Flex Noun
7409 \begin_layout Plain Layout
7418 \begin_layout Standard
7419 There are two possibilities here.
7420 One is that the class file is itself based upon an existing document class.
7421 For example, many thesis classes are based upon
7422 \begin_inset Flex Noun
7425 \begin_layout Plain Layout
7432 To see whether yours is, look for a line like
7435 \begin_layout LyX-Code
7441 \begin_layout Standard
7443 If so, then you may proceed largely as in the previous section, though
7445 \begin_inset Flex Code
7448 \begin_layout Plain Layout
7449 Declare\SpecialChar LaTeX
7455 line will be different.
7456 If your new class is
7457 \begin_inset Flex Code
7460 \begin_layout Plain Layout
7466 and it is based upon
7467 \begin_inset Flex Code
7470 \begin_layout Plain Layout
7476 , then the line should read:
7480 \begin_layout Plain Layout
7481 And it will be easiest if you save the file to
7482 \begin_inset Flex Code
7485 \begin_layout Plain Layout
7492 assumes that the document class has the same name as the layout file.
7501 \begin_layout LyX-Code
7504 DeclareLaTeXClass[thesis,book]{thesis}
7507 \begin_layout Standard
7508 If, on the other hand, the new class is not based upon an existing class,
7509 you will probably have to
7510 \begin_inset Quotes eld
7514 \begin_inset Quotes erd
7518 We strongly suggest copying an existing layout file which uses a similar
7520 class and then modifying it, if you can do so.
7521 At least use an existing file as a starting point so you can find out what
7522 items you need to worry about.
7523 Again, the specifics are covered below.
7526 \begin_layout Subsection
7528 \begin_inset CommandInset label
7530 name "subsec:Creating-Templates"
7537 \begin_layout Standard
7538 Once you have written a layout file for a new document class, you might
7539 want to consider writing a
7544 A template acts as a kind of tutorial for your layout, showing how it might
7545 be used, though containing dummy content.
7546 You can of course look at the various templates included with \SpecialChar LyX
7550 \begin_layout Standard
7551 Templates are created just like usual documents: using \SpecialChar LyX
7553 The only difference is that usual documents contain all possible settings,
7554 including the font scheme and the paper size.
7555 Usually a user doesn't want a template to overwrite his preferred settings
7556 for such parameters.
7557 For that reason, the designer of a template should remove the corresponding
7559 \begin_inset Flex Code
7562 \begin_layout Plain Layout
7571 \begin_inset Flex Code
7574 \begin_layout Plain Layout
7582 from the template \SpecialChar LyX
7584 This can be done with any simple text-editor, for example
7585 \begin_inset Flex Code
7588 \begin_layout Plain Layout
7595 \begin_inset Flex Code
7598 \begin_layout Plain Layout
7607 \begin_layout Standard
7608 Put the edited template files you create in
7609 \begin_inset Flex Code
7612 \begin_layout Plain Layout
7618 , copy the ones you use from the global template directory in
7619 \begin_inset Flex Code
7622 \begin_layout Plain Layout
7628 to the same place, and redefine the template path in the
7629 \begin_inset Flex Noun
7632 \begin_layout Plain Layout
7633 Tools\SpecialChar menuseparator
7634 Preferences\SpecialChar menuseparator
7643 \begin_layout Standard
7644 Note, by the way, that there is a template which has a particular meaning:
7645 \begin_inset Newline linebreak
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7659 This template is loaded every time you create a new document with
7660 \begin_inset Flex Noun
7663 \begin_layout Plain Layout
7664 File\SpecialChar menuseparator
7670 in order to provide useful defaults.
7671 To create this template from inside \SpecialChar LyX
7672 , all you have to do is to open a document
7673 with the correct settings, and use the
7674 \begin_inset Flex Noun
7677 \begin_layout Plain Layout
7678 Save as Document Defaults
7686 \begin_layout Subsection
7687 Upgrading old layout files
7690 \begin_layout Standard
7691 The format of layout files changes with each \SpecialChar LyX
7692 release, so old layout files
7693 need to be converted to the new format.
7695 reads a layout file in an older format, it automatically calls the
7697 \begin_inset Flex Code
7700 \begin_layout Plain Layout
7706 to convert it to a temporary file in current format.
7707 The original file is left untouched.
7708 If you use the layout file often, then, you may want to convert it permanently,
7709 so that \SpecialChar LyX
7710 does not have to do so itself every time.
7711 To do this, you can call the converter manually:
7714 \begin_layout Enumerate
7716 \begin_inset Flex Code
7719 \begin_layout Plain Layout
7726 \begin_inset Flex Code
7729 \begin_layout Plain Layout
7738 \begin_layout Enumerate
7740 \begin_inset Newline newline
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7748 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7754 \begin_inset Newline newline
7758 \begin_inset Flex Code
7761 \begin_layout Plain Layout
7767 is the name of your \SpecialChar LyX
7771 \begin_layout Standard
7772 Note that manual conversion does not affect included files, so these will
7773 have to be converted separately.
7776 \begin_layout Subsection
7777 \begin_inset CommandInset label
7779 name "subsec:Cite-Engine-Files"
7786 \begin_layout Standard
7787 A specific form of layout files are the so-called
7788 \begin_inset Flex Code
7791 \begin_layout Plain Layout
7797 files that are located in the
7798 \begin_inset Flex Code
7801 \begin_layout Plain Layout
7808 Their purpose is to define the specifics of \SpecialChar LaTeX
7809 packages aimed at bibliography
7822 , but also the way how normal Bib\SpecialChar TeX
7823 citations (without additional packages)
7824 are handled in \SpecialChar LyX
7825 is defined in such a file.
7829 \begin_layout Standard
7830 More specifically, it is defined which packages \SpecialChar LyX
7831 needs to load, which citation
7832 commands are available, how these are to be displayed in \SpecialChar LyX
7834 the dialogs, the context menus) as well as in the XHTML and plain text
7836 Furthermore, the files specify available style variants (author-year, numerical
7837 , etc.) and their specifics.
7838 The cite engine files are also used to generate the options that are available
7841 Document\SpecialChar menuseparator
7842 Settings\SpecialChar menuseparator
7843 Bibliography\SpecialChar menuseparator
7849 \begin_layout Standard
7850 Even though a cite engine file is essentially a normal layout file that
7851 could theoretically include any layout information, it usually primarily
7852 includes some specific parameters such as
7853 \begin_inset Flex Code
7856 \begin_layout Plain Layout
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7883 \begin_inset Flex Code
7886 \begin_layout Plain Layout
7893 The syntax of the latter two is described in
7894 \begin_inset CommandInset ref
7896 reference "subsec:Citation-engine-description"
7904 \begin_inset CommandInset ref
7906 reference "subsec:Citation-format-description"
7910 , as well as in the files themselves.
7913 \begin_layout Section
7914 \begin_inset CommandInset label
7916 name "sec:TextClass"
7920 The layout file format
7923 \begin_layout Standard
7924 The following sections describe how layout files are structured and written.
7925 Our advice is to go slowly, save and test often.
7926 It is really not that hard, except that the multitude of options can become
7927 overwhelming, especially if you try to check out too many at once.
7928 It becomes easier if you use existing layouts of \SpecialChar LyX
7929 as examples/reference
7930 or if you modify an existing layout to your needs.
7933 \begin_layout Standard
7934 Note that all the tags used in layout files are case-insensitive.
7936 \begin_inset Flex Code
7939 \begin_layout Plain Layout
7946 \begin_inset Flex Code
7949 \begin_layout Plain Layout
7956 \begin_inset Flex Code
7959 \begin_layout Plain Layout
7965 are really the same tag.
7966 The possible arguments are printed in brackets after the tag's name.
7967 The default argument is typeset
7968 \begin_inset Flex Code
7971 \begin_layout Plain Layout
7980 If the argument has a data type like
7981 \begin_inset Quotes eld
7985 \begin_inset Quotes erd
7989 \begin_inset Quotes eld
7993 \begin_inset Quotes erd
7996 , the default is shown like this:
7997 \begin_inset Flex Code
8000 \begin_layout Plain Layout
8011 \begin_layout Subsection
8012 The document class declaration and classification
8015 \begin_layout Standard
8016 Lines in a layout file which begin with
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8027 There is one exception to this rule.
8029 \begin_inset Flex Code
8032 \begin_layout Plain Layout
8038 files should begin with lines like:
8041 \begin_layout LyX-Code
8044 #% Do not delete the line below; configure depends on this
8047 \begin_layout LyX-Code
8052 DeclareLaTeXClass{Article (Standard Class)}
8055 \begin_layout LyX-Code
8060 DeclareCategory{Articles}
8063 \begin_layout Standard
8064 The second and third lines are used when you (re)configure \SpecialChar LyX
8066 The layout file is read by the \SpecialChar LaTeX
8068 \begin_inset Flex Code
8071 \begin_layout Plain Layout
8077 , in a special mode where
8078 \begin_inset Flex Code
8081 \begin_layout Plain Layout
8088 The first line is just a \SpecialChar LaTeX
8089 comment, the second one contains the mandatory
8090 declaration of the text class and the third line contains the optional
8091 classification of the class.
8092 If these lines appear in a file named
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8102 , then they define a text class of name
8103 \begin_inset Flex Code
8106 \begin_layout Plain Layout
8112 (the name of the layout file) which uses the \SpecialChar LaTeX
8114 \begin_inset Flex Code
8117 \begin_layout Plain Layout
8123 (the default is to use the same name as the layout).
8125 \begin_inset Quotes eld
8128 Article (Standard Class)
8129 \begin_inset Quotes erd
8132 that appears above is used as a description of the text class in the
8133 \begin_inset Flex Noun
8136 \begin_layout Plain Layout
8137 Document\SpecialChar menuseparator
8145 \begin_inset Quotes eld
8149 \begin_inset Quotes erd
8152 in the example) is also used in the
8153 \begin_inset Flex Noun
8156 \begin_layout Plain Layout
8157 Document\SpecialChar menuseparator
8163 dialog: the text classes are grouped by these categories (which are usually
8164 genres, so typical categories are
8165 \begin_inset Quotes eld
8169 \begin_inset Quotes erd
8173 \begin_inset Quotes eld
8177 \begin_inset Quotes erd
8181 \begin_inset Quotes eld
8185 \begin_inset Quotes erd
8189 \begin_inset Quotes eld
8193 \begin_inset Quotes erd
8197 \begin_inset Quotes eld
8201 \begin_inset Quotes erd
8205 \begin_inset Quotes eld
8209 \begin_inset Quotes erd
8213 If no category has been declared, the class will be put in the
8214 \begin_inset Quotes eld
8218 \begin_inset Quotes erd
8224 \begin_layout Standard
8225 Let's assume that you wrote your own text class that uses the
8226 \begin_inset Flex Code
8229 \begin_layout Plain Layout
8235 document class, but where you changed the appearance of the section headings.
8236 If you put it in a file
8237 \begin_inset Flex Code
8240 \begin_layout Plain Layout
8246 , the header of this file should be:
8249 \begin_layout LyX-Code
8252 #% Do not delete the line below; configure depends on this
8255 \begin_layout LyX-Code
8260 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8263 \begin_layout LyX-Code
8268 DeclareCategory{Articles}
8271 \begin_layout Standard
8272 This declares a text class
8273 \begin_inset Flex Code
8276 \begin_layout Plain Layout
8282 , associated with the \SpecialChar LaTeX
8284 \begin_inset Flex Code
8287 \begin_layout Plain Layout
8294 \begin_inset Quotes eld
8297 Article (with My Own Headings)
8298 \begin_inset Quotes erd
8302 If your text class depends on several packages, you can declare it as:
8305 \begin_layout LyX-Code
8308 #% Do not delete the line below; configure depends on this
8311 \begin_layout LyX-Code
8316 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8319 \begin_layout LyX-Code
8324 DeclareCategory{Articles}
8327 \begin_layout Standard
8328 This indicates that your text class uses the
8329 \begin_inset Flex Code
8332 \begin_layout Plain Layout
8339 Finally, it is also possible to declare classes for DocBook code.
8340 Typical declarations will look like:
8343 \begin_layout LyX-Code
8346 #% Do not delete the line below; configure depends on this
8349 \begin_layout LyX-Code
8354 DeclareDocBookClass[article]{SGML (DocBook Article)}
8357 \begin_layout LyX-Code
8362 DeclareCategory{Articles (DocBook)}
8365 \begin_layout Standard
8366 Note that these declarations can also be given an optional parameter declaring
8367 the name of the document class (but not a list).
8370 \begin_layout Standard
8371 So, to be as explicit as possible, the form of the layout declaration is:
8374 \begin_layout LyX-Code
8379 DeclareLaTeXClass[class,package.sty]{layout description}
8382 \begin_layout LyX-Code
8387 DeclareCategory{category}
8390 \begin_layout Standard
8391 The class need only be specified if the name of the \SpecialChar LaTeX
8393 name of the layout file are different or if there are packages to load.
8394 If the name of the class file is not specified, then \SpecialChar LyX
8396 that it is the same as the name of the layout file.
8399 \begin_layout Standard
8400 When the text class has been modified to your taste, all you have to do
8401 is to copy it either to
8402 \begin_inset Flex Code
8405 \begin_layout Plain Layout
8412 \begin_inset Flex Code
8415 \begin_layout Plain Layout
8422 \begin_inset Flex Noun
8425 \begin_layout Plain Layout
8426 Tools\SpecialChar menuseparator
8432 , exit \SpecialChar LyX
8434 Then your new text class should be available along with the others.
8437 \begin_layout Standard
8438 Once the layout file is installed, you can edit it and see your changes
8439 without having to reconfigure or to restart \SpecialChar LyX
8444 \begin_layout Plain Layout
8445 In versions of \SpecialChar LyX
8446 prior to 1.6, this was not true.
8447 As a result, editing layout files was very time consuming, since you had
8448 constantly to restart \SpecialChar LyX
8454 You can force a reload of the current layout by using the \SpecialChar LyX
8456 \begin_inset Flex Noun
8459 \begin_layout Plain Layout
8466 There is no default binding for this function—though, of course, you can
8467 bind it to a key yourself.
8468 But you will normally use this function simply by entering it in the mini-buffe
8473 \begin_layout Standard
8479 \begin_inset Flex Noun
8482 \begin_layout Plain Layout
8488 is very much an `advanced feature'.
8493 recommended that you save your work before using this function.
8498 recommended that you not attempt to edit layout information while simultaneousl
8499 y working on a document that you care about.
8500 Use a test document.
8501 Syntax errors and the like in your layout file could cause peculiar behavior.
8502 In particular, such errors could cause \SpecialChar LyX
8503 to regard the current layout as
8504 invalid and to attempt to switch to some other layout.
8508 \begin_layout Plain Layout
8509 Really bad syntax errors may even caused \SpecialChar LyX
8511 This is because certain sorts of errors may make \SpecialChar LyX
8522 The \SpecialChar LyX
8523 team strives to keep \SpecialChar LyX
8524 stable in such situations, but safe is better
8529 \begin_layout Plain Layout
8530 While we're giving advice: make regular backups.
8531 And be nice to your mother.
8539 \begin_layout Subsection
8540 The Module declaration
8543 \begin_layout Standard
8544 A module must begin with a line like the following:
8547 \begin_layout LyX-Code
8550 DeclareLyXModule[endnotes.sty]{Endnotes}
8551 \change_inserted -712698321 1554395911
8555 \begin_layout LyX-Code
8557 \change_inserted -712698321 1554395924
8562 DeclareCategory{Foot- and Endnotes}
8563 \change_deleted -712698321 1554395911
8571 \begin_layout Standard
8572 The mandatory argument
8573 \change_inserted -712698321 1554395956
8582 , in curly brackets, is the name of the module, as it should appear in
8583 \begin_inset Flex Noun
8586 \begin_layout Plain Layout
8587 Document\SpecialChar menuseparator
8588 Settings\SpecialChar menuseparator
8595 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8597 on which the module depends.
8598 It is also possible to use the form
8599 \begin_inset Flex Noun
8602 \begin_layout Plain Layout
8608 as an optional argument, which declares that the module can only be used
8609 when there exists a conversion chain between the formats `
8610 \begin_inset Flex Code
8613 \begin_layout Plain Layout
8620 \begin_inset Flex Code
8623 \begin_layout Plain Layout
8631 \change_inserted -712698321 1554396133
8638 declaration is not strictly mandatory, but you should add it, since it
8639 is helpful to find the module.
8640 Please have a look at the existing module categories and if appropriate,
8646 \begin_layout Standard
8648 \change_inserted -712698321 1554395988
8651 declaration should then be followed by lines like the following:
8655 \begin_layout Plain Layout
8656 Preferably in English if the module should be published with \SpecialChar LyX
8658 This description will appear in the list of messages to be translated and
8659 will be thus translated with the next interface update.
8667 \begin_layout LyX-Code
8671 \begin_layout LyX-Code
8672 #Adds an endnote command, in addition to footnotes.
8676 \begin_layout LyX-Code
8677 #You will need to add
8679 theendnotes in TeX code where you
8682 \begin_layout LyX-Code
8683 #want the endnotes to appear.
8687 \begin_layout LyX-Code
8691 \begin_layout LyX-Code
8692 #Requires: somemodule | othermodule
8695 \begin_layout LyX-Code
8696 #Excludes: badmodule
8699 \begin_layout Standard
8700 The description is used in
8701 \begin_inset Flex Noun
8704 \begin_layout Plain Layout
8705 Document\SpecialChar menuseparator
8706 Settings\SpecialChar menuseparator
8712 to provide the user with information about what the module does.
8714 \begin_inset Flex Code
8717 \begin_layout Plain Layout
8723 line is used to identify other modules with which this one must be used;
8725 \begin_inset Flex Code
8728 \begin_layout Plain Layout
8734 line is used to identify modules with which this one may not be used.
8735 Both are optional, and, as shown, multiple modules should be separated
8736 with the pipe symbol: |.
8737 Note that the required modules are treated disjunctively:
8741 of the required modules must be used.
8746 excluded module may be used.
8747 Note that modules are identified here by their filenames without the
8748 \begin_inset Flex Code
8751 \begin_layout Plain Layout
8759 \begin_inset Flex Code
8762 \begin_layout Plain Layout
8769 \begin_inset Flex Code
8772 \begin_layout Plain Layout
8781 \begin_layout Subsection
8782 The CiteEngine file declaration
8785 \begin_layout Standard
8786 A cite engine file must begin with a line like the following:
8789 \begin_layout LyX-Code
8792 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8795 \begin_layout Standard
8796 The mandatory argument, in curly brackets, is the name of the cite style,
8797 as it should appear in
8798 \begin_inset Flex Noun
8801 \begin_layout Plain Layout
8802 Document\SpecialChar menuseparator
8803 Settings\SpecialChar menuseparator
8810 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8812 on which the cite engine depends.
8815 \begin_layout Standard
8816 The cite engine declaration should then be followed by lines like the following:
8820 \begin_layout Plain Layout
8821 Preferably in English if the module should be published with \SpecialChar LyX
8823 This description will appear in the list of messages to be translated and
8824 will be thus translated with the next interface update.
8832 \begin_layout LyX-Code
8836 \begin_layout LyX-Code
8837 # Biblatex supports many author-year and numerical styles.
8840 \begin_layout LyX-Code
8841 # It is mainly aimed at the Humanities.
8845 \begin_layout LyX-Code
8846 # customizable, fully localized and provides many features
8849 \begin_layout LyX-Code
8850 # that are not possible with BibTeX.
8851 The use of 'biber' as
8854 \begin_layout LyX-Code
8855 # bibliography processor is advised.
8858 \begin_layout LyX-Code
8862 \begin_layout Standard
8863 The description is used in
8864 \begin_inset Flex Noun
8867 \begin_layout Plain Layout
8868 Document\SpecialChar menuseparator
8869 Settings\SpecialChar menuseparator
8875 to provide the user with information about the cite engine.
8878 \begin_layout Subsection
8882 \begin_layout Standard
8883 The first non-comment line of any layout file, included file, or module
8888 contain the file format number:
8891 \begin_layout Description
8892 \begin_inset Flex Code
8895 \begin_layout Plain Layout
8902 \begin_inset Flex Code
8905 \begin_layout Plain Layout
8911 ] The format number of the layout file.
8914 \begin_layout Standard
8915 This tag was introduced with \SpecialChar LyX
8917 \begin_inset space ~
8921 Layout files from older \SpecialChar LyX
8922 versions do not have an explicit file format and
8923 are considered to have
8924 \begin_inset Flex Code
8927 \begin_layout Plain Layout
8929 \begin_inset space ~
8938 The format for the present version of \SpecialChar LyX
8940 But each version of \SpecialChar LyX
8941 is capable of reading earlier versions' layout files,
8942 just as they are capable of reading files produced by earlier versions
8945 There is, however, no provision for converting to earlier formats.
8948 \begin_layout Subsection
8949 \begin_inset CommandInset label
8951 name "subsec:General-text-class"
8955 General text class parameters
8958 \begin_layout Standard
8959 These are general parameters that govern the behavior of an entire document
8965 mean that they must appear in
8966 \begin_inset Flex Code
8969 \begin_layout Plain Layout
8975 files rather than in modules.
8976 A module can contain any layout tag.)
8979 \begin_layout Description
8981 \change_inserted -712698321 1526899478
8982 \begin_inset Flex Code
8985 \begin_layout Plain Layout
8987 \change_inserted -712698321 1526898610
8988 AddToCiteEngine <engine>
8993 Extends the possibilities for displaying citation references.
8995 \begin_inset CommandInset ref
8997 reference "subsec:Citation-engine-description"
9006 \begin_inset Flex Code
9009 \begin_layout Plain Layout
9011 \change_inserted -712698321 1526898823
9022 \begin_layout Description
9023 \begin_inset Flex Code
9026 \begin_layout Plain Layout
9032 Adds information that will be output in the
9033 \begin_inset Flex Code
9036 \begin_layout Plain Layout
9042 block when the document is output to XHTML.
9043 Typically, this would be used to output CSS style information, but it can
9044 be used for anything that can appear in
9045 \begin_inset Flex Code
9048 \begin_layout Plain Layout
9056 \begin_inset Quotes eld
9060 \begin_inset Flex Code
9063 \begin_layout Plain Layout
9070 \begin_inset Quotes erd
9076 \begin_layout Description
9077 \begin_inset Flex Code
9080 \begin_layout Plain Layout
9086 Adds information to the document preamble.
9088 \begin_inset Newline newline
9092 \begin_inset Quotes eld
9096 \begin_inset Flex Code
9099 \begin_layout Plain Layout
9106 \begin_inset Quotes erd
9112 \begin_layout Description
9113 \begin_inset Flex Code
9116 \begin_layout Plain Layout
9122 Defines the possibilities for displaying citation references.
9124 \begin_inset CommandInset ref
9126 reference "subsec:Citation-engine-description"
9135 \begin_inset Quotes eld
9139 \begin_inset Flex Code
9142 \begin_layout Plain Layout
9149 \begin_inset Quotes erd
9153 Primarily used in cite engine files (see
9154 \begin_inset CommandInset ref
9156 reference "subsec:Cite-Engine-Files"
9165 \change_inserted -712698321 1526898530
9166 Note that if you specify this in a layout file or module, any cite engine
9167 definition will be overridden.
9169 \begin_inset Flex Code
9172 \begin_layout Plain Layout
9174 \change_inserted -712698321 1526898530
9187 \begin_layout Description
9188 \begin_inset Flex Code
9191 \begin_layout Plain Layout
9197 Defines formats for use in the display of bibliographic information.
9199 \begin_inset CommandInset ref
9201 reference "subsec:Citation-format-description"
9207 \begin_inset Quotes eld
9211 \begin_inset Flex Code
9214 \begin_layout Plain Layout
9221 \begin_inset Quotes erd
9225 Primarily used in cite engine files (see
9226 \begin_inset CommandInset ref
9228 reference "subsec:Cite-Engine-Files"
9237 \change_inserted -712698321 1526898585
9238 A cite format defined in a layout or module will override the cite engine
9244 \begin_layout Description
9245 \begin_inset Flex Code
9248 \begin_layout Plain Layout
9255 \begin_inset Flex Code
9258 \begin_layout Plain Layout
9267 \begin_inset Flex Code
9270 \begin_layout Plain Layout
9276 ] Determines whether
9280 or Bib\SpecialChar TeX
9281 is used to generate a Bibliography.
9282 Primarily used in cite engine files (see
9283 \begin_inset CommandInset ref
9285 reference "subsec:Cite-Engine-Files"
9295 \begin_layout Description
9296 \begin_inset Flex Code
9299 \begin_layout Plain Layout
9305 Describes various global options supported by the document class.
9307 \begin_inset CommandInset ref
9309 reference "subsec:ClassOptions"
9315 \begin_inset Quotes eld
9319 \begin_inset Flex Code
9322 \begin_layout Plain Layout
9329 \begin_inset Quotes erd
9335 \begin_layout Description
9336 \begin_inset Flex Code
9339 \begin_layout Plain Layout
9346 \begin_inset Flex Code
9349 \begin_layout Plain Layout
9358 \begin_inset space \thinspace{}
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9371 ] Whether the class should
9375 to having one or two columns.
9376 Can be changed in the
9377 \begin_inset Flex Noun
9380 \begin_layout Plain Layout
9381 Document\SpecialChar menuseparator
9390 \begin_layout Description
9391 \begin_inset Flex Code
9394 \begin_layout Plain Layout
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9410 ] This sequence defines the properties for a counter.
9411 If the counter does not yet exist, it is created; if it does exist, it
9414 \begin_inset Quotes eld
9418 \begin_inset Flex Code
9421 \begin_layout Plain Layout
9428 \begin_inset Quotes erd
9432 \begin_inset Newline newline
9436 \begin_inset CommandInset ref
9438 reference "subsec:Counters"
9442 for details on counters.
9445 \begin_layout Description
9446 \begin_inset Flex Code
9449 \begin_layout Plain Layout
9455 Sets the default font used to display the document.
9457 \begin_inset CommandInset ref
9459 reference "subsec:Font-description"
9463 for how to declare fonts.
9465 \begin_inset Quotes eld
9469 \begin_inset Flex Code
9472 \begin_layout Plain Layout
9479 \begin_inset Quotes erd
9485 \begin_layout Description
9486 \begin_inset Flex Code
9489 \begin_layout Plain Layout
9496 \begin_inset Flex Code
9499 \begin_layout Plain Layout
9505 ] Specifies a module to be included by default with this document class.
9506 The module is specified as filename without the
9507 \begin_inset Flex Code
9510 \begin_layout Plain Layout
9517 The user can still remove the module, but it will be active at the outset.
9518 (This applies only when new files are created, or when this class is chosen
9519 for an existing document.)
9522 \begin_layout Description
9523 \begin_inset Flex Code
9526 \begin_layout Plain Layout
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9542 ] This is the style that will be assigned to new paragraphs, usually
9543 \begin_inset Flex Noun
9546 \begin_layout Plain Layout
9553 This will default to the first defined style if not given, but you are
9554 encouraged to use this directive.
9557 \begin_layout Description
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9577 ] This tag indicates that the module (which is specified by filename without
9579 \begin_inset Flex Code
9582 \begin_layout Plain Layout
9588 extension) cannot be used with this document class.
9589 This might be used in a journal-specific layout file to prevent, say, the
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9600 module that numbers theorems by section.
9605 be used in a module.
9606 Modules have their own way of excluding other modules (see
9607 \begin_inset CommandInset ref
9609 reference "subsec:Layout-modules"
9616 \begin_layout Description
9617 \begin_inset Flex Code
9620 \begin_layout Plain Layout
9626 Defines a new float.
9628 \begin_inset CommandInset ref
9630 reference "subsec:Floats"
9636 \begin_inset Quotes eld
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9650 \begin_inset Quotes erd
9656 \begin_layout Description
9657 \begin_inset Flex Code
9660 \begin_layout Plain Layout
9666 Sets the information that will be output in the
9667 \begin_inset Flex Code
9670 \begin_layout Plain Layout
9676 block when this document class is output to XHTML.
9677 Note that this will completely override any prior
9678 \begin_inset Flex Code
9681 \begin_layout Plain Layout
9688 \begin_inset Flex Code
9691 \begin_layout Plain Layout
9699 \begin_inset Newline newline
9703 \begin_inset Flex Code
9706 \begin_layout Plain Layout
9712 if you just want to add material to the preamble.) Must end with
9713 \begin_inset Quotes eld
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9727 \begin_inset Quotes erd
9733 \begin_layout Description
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9744 \begin_inset Flex Code
9747 \begin_layout Plain Layout
9753 ] The style to use for the table of contents, bibliography, and so forth,
9754 when the document is output to HTML.
9755 For articles, this should normally be
9756 \begin_inset Flex Code
9759 \begin_layout Plain Layout
9766 \begin_inset Flex Code
9769 \begin_layout Plain Layout
9776 If it is not given, then \SpecialChar LyX
9777 will attempt to figure out which layout to use.
9780 \begin_layout Description
9781 \begin_inset Flex Code
9784 \begin_layout Plain Layout
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9800 ] Modifies the properties of the given counter.
9801 If the counter does not exist, the statement is ignored.
9803 \begin_inset Quotes eld
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9817 \begin_inset Quotes erd
9821 \begin_inset Newline newline
9825 \begin_inset CommandInset ref
9827 reference "subsec:Counters"
9831 for details on counters.
9834 \begin_layout Description
9835 \begin_inset Flex Code
9838 \begin_layout Plain Layout
9845 \begin_inset Flex Code
9848 \begin_layout Plain Layout
9854 ] This allows you to include another layout definition file within yours
9855 to avoid duplicating commands.
9856 Common examples are the standard layout files, for example,
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9866 , which contains most of the basic layouts.
9869 \begin_layout Description
9870 \begin_inset Flex Code
9873 \begin_layout Plain Layout
9880 \begin_inset Flex Code
9883 \begin_layout Plain Layout
9889 ] This section (re-)defines the layout of an inset.
9890 It can be applied to an existing inset or to a new, user-defined inset,
9891 e.g., a new character style.
9893 \begin_inset Quotes eld
9897 \begin_inset Flex Code
9900 \begin_layout Plain Layout
9907 \begin_inset Quotes erd
9911 \begin_inset Newline newline
9915 \begin_inset CommandInset ref
9917 reference "subsec:Flex-insets-and"
9921 for more information.
9925 \begin_layout Description
9926 \begin_inset Flex Code
9929 \begin_layout Plain Layout
9936 \begin_inset Flex Code
9939 \begin_layout Plain Layout
9945 ] A string that indicates the width of the left margin on the screen, for
9947 \begin_inset Quotes eld
9951 \begin_inset Flex Code
9954 \begin_layout Plain Layout
9961 \begin_inset Quotes erd
9965 (Note that this is not a `length', like
9966 \begin_inset Quotes eld
9970 \begin_inset Quotes erd
9976 \begin_layout Description
9977 \begin_inset Flex Code
9980 \begin_layout Plain Layout
9987 \begin_inset Flex Code
9990 \begin_layout Plain Layout
9996 ] An integer that determines the maximal number of names displayed in an
9997 author-year citation before the citation switches to
9998 \begin_inset Quotes eld
10002 \begin_inset Quotes erd
10006 Primarily used in cite engine files (see
10007 \begin_inset CommandInset ref
10009 reference "subsec:Cite-Engine-Files"
10019 \begin_layout Description
10020 \begin_inset Flex Code
10023 \begin_layout Plain Layout
10030 \begin_inset Flex Code
10033 \begin_layout Plain Layout
10039 ] Modifies the properties of the given paragraph style.
10040 If the style does not exist, this section is ignored.
10042 \begin_inset Quotes eld
10046 \begin_inset Flex Code
10049 \begin_layout Plain Layout
10056 \begin_inset Quotes erd
10062 \begin_layout Description
10063 \begin_inset Flex Code
10066 \begin_layout Plain Layout
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 ] Deletes an existing counter, usually one defined in an included file.
10085 \begin_layout Description
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10105 ] Deletes an existing float.
10106 This is particularly useful when you want to suppress a float that has
10107 been defined in an input file.
10110 \begin_layout Description
10111 \begin_inset Flex Code
10114 \begin_layout Plain Layout
10121 \begin_inset Flex Code
10124 \begin_layout Plain Layout
10130 ] Deletes an existing style.
10133 \begin_layout Description
10134 \begin_inset Flex Code
10137 \begin_layout Plain Layout
10144 \begin_inset Flex Code
10147 \begin_layout Plain Layout
10154 \begin_inset Flex Code
10157 \begin_layout Plain Layout
10163 ] Define a new table of contents with type
10164 \begin_inset Flex Code
10167 \begin_layout Plain Layout
10174 \begin_inset Flex Code
10177 \begin_layout Plain Layout
10184 See also the AddToToc commands.
10187 \begin_layout Description
10188 \begin_inset Flex Code
10191 \begin_layout Plain Layout
10198 \begin_inset Flex Code
10201 \begin_layout Plain Layout
10207 ] The file format (as defined in the \SpecialChar LyX
10208 preferences) produced by this document
10210 It is mainly useful when
10211 \begin_inset Flex Code
10214 \begin_layout Plain Layout
10221 \begin_inset Flex Code
10224 \begin_layout Plain Layout
10230 and one wants to define a new type of literate document.
10231 The format is reset to
10232 \begin_inset Quotes eld
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10246 \begin_inset Quotes erd
10250 \begin_inset Quotes eld
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10264 \begin_inset Quotes erd
10267 when the corresponding
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10277 parameter is encountered.
10280 \begin_layout Description
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10315 \begin_inset Flex Code
10318 \begin_layout Plain Layout
10324 ] Specifies what sort of output documents using this class will produce.
10327 \begin_layout Description
10328 \begin_inset Flex Code
10331 \begin_layout Plain Layout
10338 \begin_inset Flex Code
10341 \begin_layout Plain Layout
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10357 ] Specifies options, given in the second string, for the package named by
10360 \begin_inset Quotes eld
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10368 PackageOptions natbib square
10374 \begin_inset Quotes erd
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10387 to be loaded with the
10388 \begin_inset Flex Code
10391 \begin_layout Plain Layout
10398 (For \SpecialChar TeX
10399 perts, this causes \SpecialChar LyX
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10407 PassOptionsToPackage{natbib}{square}
10413 \begin_inset Flex Code
10416 \begin_layout Plain Layout
10425 \begin_layout Description
10426 \begin_inset Flex Code
10429 \begin_layout Plain Layout
10436 \begin_inset Flex Code
10439 \begin_layout Plain Layout
10448 \begin_inset Flex Code
10451 \begin_layout Plain Layout
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10467 ] The default pagestyle.
10468 Can be changed in the
10469 \begin_inset Flex Noun
10472 \begin_layout Plain Layout
10473 Document\SpecialChar menuseparator
10482 \begin_layout Description
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10492 Sets the preamble for the \SpecialChar LaTeX
10494 Note that this will completely override any prior
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10505 \begin_inset Flex Code
10508 \begin_layout Plain Layout
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10525 if you just want to add material to the preamble.) Must end with
10526 \begin_inset Quotes eld
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10540 \begin_inset Quotes erd
10546 \begin_layout Description
10547 \begin_inset Flex Code
10550 \begin_layout Plain Layout
10557 \begin_inset Flex Code
10560 \begin_layout Plain Layout
10567 \begin_inset Flex Code
10570 \begin_layout Plain Layout
10579 \begin_inset space \thinspace{}
10583 \begin_inset Flex Code
10586 \begin_layout Plain Layout
10592 ] Whether the class already provides the feature
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 A feature is in general the name of a package (e.
10604 \begin_inset space \thinspace{}
10608 \begin_inset space \space{}
10612 \begin_inset Flex Code
10615 \begin_layout Plain Layout
10622 \begin_inset Flex Code
10625 \begin_layout Plain Layout
10632 \begin_inset space \thinspace{}
10636 \begin_inset space \space{}
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10661 \begin_inset CommandInset ref
10663 reference "chap:List-of-functions"
10667 for the list of features.
10670 \begin_layout Description
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Flex Code
10684 \begin_layout Plain Layout
10690 ] Indicates that this layout provides the functionality of the module mentioned,
10691 which should be specified by the filename without the
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10702 This will typically be used if the layout includes the module directly,
10703 rather than using the
10704 \begin_inset Flex Code
10707 \begin_layout Plain Layout
10713 tag to indicate that it ought to be used.
10714 It could also be used in a module that provided an alternate implementation
10715 of the same functionality.
10718 \begin_layout Description
10719 \begin_inset Flex Code
10722 \begin_layout Plain Layout
10729 \begin_inset Flex Code
10732 \begin_layout Plain Layout
10738 ] Creates a new paragraph style if it does not already exist.
10739 If the style does exist, this section is ignored.
10741 \begin_inset Quotes eld
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10755 \begin_inset Quotes erd
10761 \begin_layout Description
10762 \begin_inset Flex Code
10765 \begin_layout Plain Layout
10772 \begin_inset Flex Code
10775 \begin_layout Plain Layout
10781 ] Whether the class requires the feature
10782 \begin_inset Flex Code
10785 \begin_layout Plain Layout
10792 Multiple features must be separated by commas.
10793 Note that you can only request supported features.
10795 \begin_inset CommandInset ref
10797 reference "chap:List-of-functions"
10801 for the list of features.).
10802 If you require a package with specific options, you can additionally use
10804 \begin_inset Flex Code
10807 \begin_layout Plain Layout
10816 \begin_layout Description
10817 \begin_inset Flex Code
10820 \begin_layout Plain Layout
10827 \begin_inset Flex Code
10830 \begin_layout Plain Layout
10836 ] A string that indicates the width of the right margin on the screen, for
10838 \begin_inset Quotes eld
10842 \begin_inset Flex Code
10845 \begin_layout Plain Layout
10852 \begin_inset Quotes erd
10858 \begin_layout Description
10859 \begin_inset Flex Code
10862 \begin_layout Plain Layout
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10878 ] Sets which divisions get numbered.
10880 \begin_inset Newline newline
10884 \begin_inset Flex Code
10887 \begin_layout Plain Layout
10893 counter in \SpecialChar LaTeX
10897 \begin_layout Description
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10920 \begin_inset space \thinspace{}
10924 \begin_inset Flex Code
10927 \begin_layout Plain Layout
10933 ] Whether the class-default should be printing on one or both sides of the
10935 Can be changed in the
10936 \begin_inset Flex Noun
10939 \begin_layout Plain Layout
10940 Document\SpecialChar menuseparator
10949 \begin_layout Description
10950 \begin_inset Flex Code
10953 \begin_layout Plain Layout
10960 \begin_inset Flex Code
10963 \begin_layout Plain Layout
10969 ] This sequence defines a paragraph style.
10970 If the style does not yet exist, it is created; if it does exist, its parameter
10973 \begin_inset Quotes eld
10977 \begin_inset Flex Code
10980 \begin_layout Plain Layout
10987 \begin_inset Quotes erd
10991 \begin_inset Newline newline
10995 \begin_inset CommandInset ref
10997 reference "subsec:Paragraph-Styles"
11001 for details on paragraph styles.
11002 \change_inserted -712698321 1553617804
11006 \begin_layout Description
11008 \change_inserted -712698321 1553617862
11009 \begin_inset Flex Code
11012 \begin_layout Plain Layout
11014 \change_inserted -712698321 1553617809
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11026 \change_inserted -712698321 1553617805
11032 ] defines the default table style that is used when inserting a table.
11033 The following styles are available:
11037 \begin_layout Itemize
11039 \change_inserted -712698321 1554308039
11040 \begin_inset Flex Code
11043 \begin_layout Plain Layout
11045 \change_inserted -712698321 1554307928
11046 Formal_with_Footline
11054 \begin_inset Quotes eld
11058 \begin_inset Quotes erd
11061 ) style with horizontal lines only, using a bold top and bottom line, the
11062 first and last row are additionally separated from the table body with
11063 a thin middle line.
11066 \begin_layout Itemize
11068 \change_inserted -712698321 1554308087
11069 \begin_inset Flex Code
11072 \begin_layout Plain Layout
11074 \change_inserted -712698321 1554308042
11075 Formal_without_Footline
11080 : same as the above, but the last row is not separated with a middle line
11084 \begin_layout Itemize
11086 \change_inserted -712698321 1553618031
11087 \begin_inset Flex Code
11090 \begin_layout Plain Layout
11092 \change_inserted -712698321 1553618006
11098 : Simple table lines.
11101 \begin_layout Itemize
11103 \change_inserted -712698321 1553618309
11104 \begin_inset Flex Code
11107 \begin_layout Plain Layout
11109 \change_inserted -712698321 1553618031
11116 \begin_inset Flex Code
11119 \begin_layout Plain Layout
11121 \change_inserted -712698321 1553618043
11127 , but with the header column offset with a second horizontal line.
11128 This is also the default style of \SpecialChar LyX
11132 \begin_layout Itemize
11134 \change_inserted -712698321 1553618280
11135 \begin_inset Flex Code
11138 \begin_layout Plain Layout
11140 \change_inserted -712698321 1553618261
11146 : Table without lines.
11152 \begin_layout Description
11153 \begin_inset Flex Code
11156 \begin_layout Plain Layout
11163 \begin_inset Flex Code
11166 \begin_layout Plain Layout
11172 ] The name of the command or environment to be used with
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11185 \begin_layout Description
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11208 \begin_inset Flex Code
11211 \begin_layout Plain Layout
11217 ] Indicates what kind of markup is used to define the title of a document.
11219 \begin_inset Flex Code
11222 \begin_layout Plain Layout
11228 means that the macro with name
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11238 will be inserted after the last layout which has
11239 \begin_inset Quotes eld
11243 \begin_inset Flex Code
11246 \begin_layout Plain Layout
11248 \begin_inset space ~
11257 \begin_inset Quotes erd
11262 \begin_inset Flex Code
11265 \begin_layout Plain Layout
11271 corresponds to the case where all layouts which have
11272 \begin_inset Quotes eld
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11281 \begin_inset space ~
11290 \begin_inset Quotes erd
11293 should be enclosed into the
11294 \begin_inset Flex Code
11297 \begin_layout Plain Layout
11306 \begin_layout Description
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11317 \begin_inset Flex Code
11320 \begin_layout Plain Layout
11326 ] Sets which divisions are included in the table of contents.
11328 \begin_inset Flex Code
11331 \begin_layout Plain Layout
11337 counter in \SpecialChar LaTeX
11341 \begin_layout Subsection
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11352 \begin_inset CommandInset label
11354 name "subsec:ClassOptions"
11361 \begin_layout Standard
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11372 section can contain the following entries:
11375 \begin_layout Description
11376 \begin_inset Flex Code
11379 \begin_layout Plain Layout
11386 \begin_inset Flex Code
11389 \begin_layout Plain Layout
11395 ] The list of available font sizes for the document's main font, separated
11397 \begin_inset Quotes eld
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 \begin_inset Quotes erd
11417 \begin_layout Description
11418 \begin_inset Flex Code
11421 \begin_layout Plain Layout
11427 Used to set the DTD line with XML-based output classes.
11429 \begin_inset space \thinspace{}
11433 \begin_inset Quotes eld
11436 -//OASIS//DTD DocBook V4.2//EN
11437 \begin_inset Quotes erd
11443 \begin_layout Description
11444 \begin_inset Flex Code
11447 \begin_layout Plain Layout
11454 \begin_inset Flex Code
11457 \begin_layout Plain Layout
11458 string="empty|plain|headings|fancy"
11463 ] The list of available page sty\SpecialChar softhyphen
11465 \begin_inset Quotes eld
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11479 \begin_inset Quotes erd
11485 \begin_layout Description
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11496 \begin_inset Flex Code
11499 \begin_layout Plain Layout
11505 ] Some document class options, separated by a comma, that will be added
11506 to the optional part of the
11507 \begin_inset Flex Code
11510 \begin_layout Plain Layout
11521 \begin_layout Standard
11523 \begin_inset Flex Code
11526 \begin_layout Plain Layout
11532 section must end with
11533 \begin_inset Quotes eld
11537 \begin_inset Flex Code
11540 \begin_layout Plain Layout
11547 \begin_inset Quotes erd
11553 \begin_layout Subsection
11555 \begin_inset CommandInset label
11557 name "subsec:Paragraph-Styles"
11564 \begin_layout Standard
11565 A paragraph style description looks like this:
11569 \begin_layout Plain Layout
11570 Note that this will either define a new style or modify an existing one.
11578 \begin_layout LyX-Code
11585 \begin_layout LyX-Code
11589 \begin_layout LyX-Code
11593 \begin_layout Standard
11594 where the following commands are allowed:
11597 \begin_layout Description
11598 \begin_inset Flex Code
11601 \begin_layout Plain Layout
11608 \begin_inset Flex Code
11611 \begin_layout Plain Layout
11617 =""] This paragraph will appear in the table of contents of the given type.
11618 An empty string disables.
11619 See also the OutlinerName and the IsTocCaption commands.
11623 \begin_layout Description
11624 \begin_inset Flex Code
11627 \begin_layout Plain Layout
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11642 , left, right, center
11647 ] Paragraph alignment.
11650 \begin_layout Description
11651 \begin_inset Flex Code
11654 \begin_layout Plain Layout
11661 \begin_inset Flex Code
11664 \begin_layout Plain Layout
11669 , left, right, center
11674 ] A comma separated list of permitted alignments.
11675 (Some \SpecialChar LaTeX
11676 styles prohibit certain alignments, since those wouldn't make sense.
11677 For example a right-aligned or centered enumeration isn't possible.)
11680 \begin_layout Description
11681 \begin_inset Flex Code
11684 \begin_layout Plain Layout
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11700 ] Defines argument number <int> of a command\SpecialChar breakableslash
11701 environment associated with
11703 This is useful for things like section headings, and only makes sense with
11706 Every (optional or required) argument of a command or environment – except
11707 for the required argument that is associated with the content of the paragraph
11708 itself – has a separate definition, where the number specifies the order
11710 The definition must end with
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11721 So a command with two optional arguments has:
11725 \begin_layout Quote
11731 \begin_layout Quote
11737 \begin_layout Quote
11743 \begin_layout Quote
11749 \begin_layout Quote
11755 \begin_layout Quote
11761 \begin_layout Standard
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11772 definition, the following specifications are possible:
11775 \begin_layout Itemize
11776 \begin_inset Flex Code
11779 \begin_layout Plain Layout
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11795 The string that will appear both in the menu (to insert this argument)
11796 and on the argument inset button (unless you also specify a separate
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11807 For the menu, you can define an accelerator by appending the respective
11808 character to the string, divided by
11809 \begin_inset Quotes eld
11813 \begin_inset Quotes erd
11817 \begin_inset space \thinspace{}
11821 \begin_inset space \space{}
11825 \begin_inset Quotes eld
11829 \begin_inset Flex Code
11832 \begin_layout Plain Layout
11839 \begin_inset Quotes erd
11845 \begin_layout Itemize
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11865 A separate string for the menu.
11866 You can define an accelerator by appending the respective character to
11867 the string, divided by
11868 \begin_inset Quotes eld
11872 \begin_inset Quotes erd
11876 \begin_inset space \thinspace{}
11880 \begin_inset space \space{}
11884 \begin_inset Quotes eld
11888 \begin_inset Flex Code
11891 \begin_layout Plain Layout
11898 \begin_inset Quotes erd
11902 This specification is optional.
11903 If it is not given the
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11913 will be used instead for the menu.
11916 \begin_layout Itemize
11917 \begin_inset Flex Code
11920 \begin_layout Plain Layout
11927 \begin_inset Flex Code
11930 \begin_layout Plain Layout
11936 A longer explanatory text that appears in the tooltip when hovering over
11937 the argument inset.
11940 \begin_layout Itemize
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11951 \begin_inset Flex Code
11954 \begin_layout Plain Layout
11963 \begin_inset space \thinspace{}
11967 \begin_inset Flex Code
11970 \begin_layout Plain Layout
11976 ] Declare if this is a mandatory (1) or an optional (0) argument.
11977 Mandatory arguments will be output empty if not given, while optional arguments
11978 will not be output at all.
11979 By default, mandatory arguments are delimited by
11980 \begin_inset Flex Code
11983 \begin_layout Plain Layout
11989 , while optional arguments are delimited by
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
12000 \change_inserted -712698321 1555579782
12004 \begin_layout Itemize
12006 \change_inserted -712698321 1555579780
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12012 \change_inserted -712698321 1555579780
12019 \begin_inset Flex Code
12022 \begin_layout Plain Layout
12024 \change_inserted -712698321 1555579780
12030 Option to define a different command (from the default
12031 \begin_inset Flex Code
12034 \begin_layout Plain Layout
12036 \change_inserted -712698321 1555579780
12046 ) to be used for line breaks.
12047 The initial backslash must not be specified.
12052 \begin_layout Itemize
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12063 \begin_inset Flex Code
12066 \begin_layout Plain Layout
12072 defines another argument (by its number) which this argument requires to
12073 be output if it is itself output.
12075 \begin_inset space \thinspace{}
12078 g., in \SpecialChar LaTeX
12079 commands, optional arguments often require previous optional arguments
12080 to be output (at least empty), as in
12081 \begin_inset Flex Code
12084 \begin_layout Plain Layout
12087 command[][argument]{text}
12093 This can be achieved by the statement
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12116 \begin_layout Itemize
12117 \begin_inset Flex Code
12120 \begin_layout Plain Layout
12127 \begin_inset Flex Code
12130 \begin_layout Plain Layout
12136 defines a custom left delimiter (instead of
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12147 \begin_inset Flex Code
12150 \begin_layout Plain Layout
12157 A line break in the output can be indicated by
12158 \begin_inset Flex Code
12161 \begin_layout Plain Layout
12170 \begin_layout Itemize
12171 \begin_inset Flex Code
12174 \begin_layout Plain Layout
12181 \begin_inset Flex Code
12184 \begin_layout Plain Layout
12190 defines a custom right delimiter (instead of
12191 \begin_inset Flex Code
12194 \begin_layout Plain Layout
12201 \begin_inset Flex Code
12204 \begin_layout Plain Layout
12211 A line break in the output can be indicated by
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12224 \begin_layout Itemize
12225 \begin_inset Flex Code
12228 \begin_layout Plain Layout
12235 \begin_inset Flex Code
12238 \begin_layout Plain Layout
12244 defines an argument that is inserted if and only if no user-specified arguments
12246 \begin_inset space \thinspace{}
12250 \begin_inset space \space{}
12253 if no argument inset has been inserted (note that also an empty argument
12254 inset omits the DefaultArg).
12255 Multiple arguments need to be separated by comma.
12258 \begin_layout Itemize
12259 \begin_inset Flex Code
12262 \begin_layout Plain Layout
12269 \begin_inset Flex Code
12272 \begin_layout Plain Layout
12278 defines an argument that is inserted in any case (alone or in addition
12279 to user-specified arguments).
12280 Multiple arguments need to be separated by comma.
12283 \begin_layout Itemize
12284 \begin_inset Flex Code
12287 \begin_layout Plain Layout
12293 The font used for the argument content, see
12294 \begin_inset CommandInset ref
12296 reference "subsec:Font-description"
12301 \change_inserted -712698321 1559484228
12305 \begin_layout Itemize
12307 \change_inserted -712698321 1559484228
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12313 \change_inserted -712698321 1559484228
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12325 \change_inserted -712698321 1559484228
12334 \begin_inset space \thinspace{}
12338 \begin_inset Flex Code
12341 \begin_layout Plain Layout
12343 \change_inserted -712698321 1559484228
12349 ] As with paragraph styles, see
12350 \begin_inset CommandInset ref
12352 reference "subsec:Paragraph-Styles"
12361 \begin_layout Itemize
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12371 The font used for the label; see
12372 \begin_inset CommandInset ref
12374 reference "subsec:Font-description"
12381 \begin_layout Itemize
12382 \begin_inset Flex Code
12385 \begin_layout Plain Layout
12392 \begin_inset Flex Code
12395 \begin_layout Plain Layout
12400 , Minimalistic, Conglomerate
12405 ] describes the rendering style used for the inset's frame and buttons.
12408 \begin_layout Itemize
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12419 \begin_inset Flex Code
12422 \begin_layout Plain Layout
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12438 , this argument is automatically inserted when the respective style is selected.
12440 \change_deleted -712698321 1559484200
12441 Currently, only one argument per style\SpecialChar breakableslash
12442 layout can be automatically inserted.
12447 \begin_layout Itemize
12449 \change_inserted -712698321 1559491402
12450 \begin_inset Flex Code
12453 \begin_layout Plain Layout
12455 \change_inserted -712698321 1559490711
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12467 \change_inserted -712698321 1559490703
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12479 \change_inserted -712698321 1559490703
12485 , this argument will be inserted on a new line with
12486 \begin_inset Flex Code
12489 \begin_layout Plain Layout
12491 \change_inserted -712698321 1559491402
12497 (only available within Flex insets).
12500 \begin_layout Itemize
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12511 \begin_inset Flex Code
12514 \begin_layout Plain Layout
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12530 , this argument will be inserted with a copy of the co-text (either selected
12531 text or the whole paragraph) as content.
12534 \begin_layout Itemize
12535 \begin_inset Flex Code
12538 \begin_layout Plain Layout
12545 \begin_inset Flex Code
12548 \begin_layout Plain Layout
12558 ] Whether the contents of this argument should be output in raw form, meaning
12559 without special translations that \SpecialChar LaTeX
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12571 status is inherited by the inset or paragraph layout the argument belongs
12572 to, true and false change the status for the given argument only.
12575 \begin_layout Itemize
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12586 \begin_inset Flex Code
12589 \begin_layout Plain Layout
12590 string of characters
12599 Defines individual characters
12600 \begin_inset Newline linebreak
12603 that should be output in raw form, meaning without special translations
12604 that \SpecialChar LaTeX
12606 Note that, contrary to PassThru, this needs to be explicitly defined for
12608 That is, arguments do not inherit PassThruChars from their parent inset
12612 \begin_layout Itemize
12613 \begin_inset Flex Code
12616 \begin_layout Plain Layout
12623 \begin_inset Flex Code
12626 \begin_layout Plain Layout
12635 \begin_inset space \thinspace{}
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12648 ] If this is set to 1, the argument will output its content in the corresponding
12649 item in the table of contents.
12653 \begin_layout Standard
12654 By default, the text entered in the \SpecialChar LyX
12655 workarea in the respective layout is
12656 the last (mandatory) argument of a command if the
12657 \begin_inset Flex Code
12660 \begin_layout Plain Layout
12667 \begin_inset Flex Code
12670 \begin_layout Plain Layout
12677 However, arguments with the prefix
12678 \begin_inset Flex Code
12681 \begin_layout Plain Layout
12687 are output after this workarea argument.
12688 Note that post-argument numbering restarts at 1, so the first argument
12689 following the workarea argument is
12690 \begin_inset Flex Code
12693 \begin_layout Plain Layout
12700 Post-arguments are ignored in any other
12701 \begin_inset Flex Code
12704 \begin_layout Plain Layout
12711 \begin_inset Flex Code
12714 \begin_layout Plain Layout
12723 \begin_layout Standard
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12749 \begin_inset Flex Code
12752 \begin_layout Plain Layout
12758 followed by the number (e.
12759 \begin_inset space \thinspace{}
12763 \begin_inset space \space{}
12767 \begin_inset Flex Code
12770 \begin_layout Plain Layout
12777 \change_inserted -712698321 1534487781
12781 \begin_layout Standard
12783 \change_inserted -712698321 1534488561
12784 Finally, there is a special argument type with the prefix
12785 \begin_inset Flex Code
12788 \begin_layout Plain Layout
12790 \change_inserted -712698321 1534487844
12799 It is not really an argument, but uses the argument interface (thus, the
12800 prefix is also followed by a number, e.
12801 \begin_inset space \thinspace{}
12806 \begin_inset Flex Code
12809 \begin_layout Plain Layout
12811 \change_inserted -712698321 1534488412
12812 Argument listpreamble:1
12818 As the name implies, it is targeted at lists such as
12835 Its content will be output at the list start, before the first
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12841 \change_inserted -712698321 1534488058
12851 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12853 This way, users can insert redefinitions (of lengths etc.) to individual
12855 By default, these arguments do not have a delimiter.
12861 \begin_layout Description
12862 \begin_inset Flex Code
12865 \begin_layout Plain Layout
12871 Includes a comma-separated list of layouts that should be nested in and
12872 after the current layout.
12873 Only makes sense for nestable layouts (such as environments).
12875 \begin_inset Quotes eld
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12889 \begin_inset Quotes erd
12894 \begin_inset Flex Code
12897 \begin_layout Plain Layout
12906 \begin_layout Description
12907 \begin_inset Flex Code
12910 \begin_layout Plain Layout
12916 Note that this will completely override any prior
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12926 declaration for this style.
12928 \begin_inset Quotes eld
12932 \begin_inset Flex Code
12935 \begin_layout Plain Layout
12942 \begin_inset Quotes erd
12947 \begin_inset CommandInset ref
12949 reference "subsec:I18n"
12953 for details on its use.
12956 \begin_layout Description
12957 \begin_inset Flex Code
12960 \begin_layout Plain Layout
12967 \begin_inset Flex Code
12970 \begin_layout Plain Layout
12980 \begin_layout Plain Layout
12981 Note that a `float' here is a real number, such as: 1.5.
12986 The vertical space with which the last of a chain of paragraphs with this
12987 style is separated from the following paragraph.
12988 If the next paragraph has another style, the separations are not simply
12989 added, but the maximum is taken.
12992 \begin_layout Description
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13003 \begin_inset Flex Code
13006 \begin_layout Plain Layout
13012 ] The category for this style.
13013 This is used to group related styles in the style combobox on the toolbar.
13014 Any string can be used, but you may want to use existing categories with
13019 \begin_layout Description
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13029 Depth of XML command.
13030 Used only with XML-type formats.
13033 \begin_layout Description
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13044 \begin_inset Flex Code
13047 \begin_layout Plain Layout
13053 ] Copies all the features of an existing style into the current one.
13057 \begin_layout Description
13058 \begin_inset Flex Code
13061 \begin_layout Plain Layout
13068 \begin_inset Flex Code
13071 \begin_layout Plain Layout
13077 ] The name of a style whose preamble should be output
13082 This allows to ensure some ordering of the preamble snippets when macros
13083 definitions depend on one another.
13087 \begin_layout Plain Layout
13088 Note that, besides that functionality, there is no way to ensure any ordering
13090 The ordering that you see in a given version of \SpecialChar LyX
13091 may change without warning
13100 \begin_layout Description
13101 \begin_inset Flex Code
13104 \begin_layout Plain Layout
13111 \begin_inset Flex Code
13114 \begin_layout Plain Layout
13119 , Box, Filled_Box, Static
13124 ] The type of label that stands at the end of the paragraph (or sequence
13126 \begin_inset Flex Code
13129 \begin_layout Plain Layout
13136 \begin_inset Newline newline
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13150 \begin_inset Flex Code
13153 \begin_layout Plain Layout
13160 \begin_inset Flex Code
13163 \begin_layout Plain Layout
13171 \begin_inset Flex Code
13174 \begin_layout Plain Layout
13181 \begin_inset Quotes eld
13185 \begin_inset Quotes erd
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13199 \begin_inset space \space{}
13203 \begin_inset Flex Code
13206 \begin_layout Plain Layout
13212 ) is a white (resp.
13213 \begin_inset space ~
13216 black) square suitable for end of proof markers,
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13226 is an explicit text string.
13229 \begin_layout Description
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13249 ] The string used for a label with a
13250 \begin_inset Flex Code
13253 \begin_layout Plain Layout
13260 \begin_inset Newline newline
13264 \begin_inset Flex Code
13267 \begin_layout Plain Layout
13277 \begin_layout Description
13278 \begin_inset Flex Code
13281 \begin_layout Plain Layout
13287 The font used for both the text body
13293 \begin_inset CommandInset ref
13295 reference "subsec:Font-description"
13300 Note that defining this font automatically defines the
13301 \begin_inset Flex Code
13304 \begin_layout Plain Layout
13311 So you should define this one first if you also want to define
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13324 \begin_layout Description
13325 \begin_inset Flex Code
13328 \begin_layout Plain Layout
13335 \begin_inset Flex Code
13338 \begin_layout Plain Layout
13344 ] Used for backporting new styles to stable \SpecialChar LyX
13346 The first stable version that supports this tag is \SpecialChar LyX
13348 The argument is a number which may either be 0, -1 or any value greater
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13360 flag of a style is greater than zero, it will always be written to the
13362 If a .lyx file is read, the style definitions from the document header are
13363 added to the document class.
13364 Therefore even older \SpecialChar LyX
13365 versions can handle the style.
13367 \begin_inset Flex Code
13370 \begin_layout Plain Layout
13376 is a version number: if the style is read, and the version number is less
13377 than the version number of the already existing style in the document class,
13378 the new style is ignored.
13379 If the version number is greater, the new style replaces the existing style.
13380 A value of -1 means an infinite version number, i.
13381 \begin_inset space \thinspace{}
13385 \begin_inset space \space{}
13388 the style is always used.
13391 \begin_layout Description
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13402 \begin_inset Flex Code
13405 \begin_layout Plain Layout
13414 \begin_inset space \thinspace{}
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13427 ] Usually \SpecialChar LyX
13428 does not allow you to insert more than one space between words,
13429 since a space is considered as the separation between two words, not a
13430 character or symbol of its own.
13431 This is a very fine thing but sometimes annoying, for example, when typing
13432 program code or plain \SpecialChar LaTeX
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13446 \change_deleted -495245474 1550490105
13450 will create protected blanks for the additional blanks when in
13451 \change_inserted -495245474 1550490096
13453 \begin_inset Flex Code
13456 \begin_layout Plain Layout
13458 \change_inserted -495245474 1550490089
13465 \change_deleted -495245474 1550490116
13466 another mode than \SpecialChar LaTeX
13469 \change_inserted -495245474 1550247760
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13476 \change_inserted -495245474 1550247736
13483 \begin_inset Flex Code
13486 \begin_layout Plain Layout
13488 \change_inserted -495245474 1550247755
13499 \begin_layout Description
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13509 These tags are used with XHTML output.
13511 \begin_inset CommandInset ref
13513 reference "subsec:Paragraph-Style-XHTML"
13520 \begin_layout Description
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13530 [FIXME] (Used only with XML-type formats.)
13533 \begin_layout Description
13534 \begin_inset Flex Code
13537 \begin_layout Plain Layout
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13556 \begin_inset space \thinspace{}
13560 \begin_inset Flex Code
13563 \begin_layout Plain Layout
13570 \begin_inset Flex Code
13573 \begin_layout Plain Layout
13579 , marks the style as to be included in the document preamble and not in
13581 This is useful for document classes that want such information as the title
13582 and author to appear in the preamble.
13583 Note that this works only for styles for which the
13584 \begin_inset Flex Code
13587 \begin_layout Plain Layout
13594 \begin_inset Flex Code
13597 \begin_layout Plain Layout
13604 \begin_inset Flex Code
13607 \begin_layout Plain Layout
13616 \begin_layout Description
13617 \begin_inset Flex Code
13620 \begin_layout Plain Layout
13627 \begin_inset Flex Code
13630 \begin_layout Plain Layout
13639 \begin_inset space \thinspace{}
13643 \begin_inset Flex Code
13646 \begin_layout Plain Layout
13653 \begin_inset Flex Code
13656 \begin_layout Plain Layout
13662 , marks the style as being part of a title block (see also the
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13673 \begin_inset Flex Code
13676 \begin_layout Plain Layout
13685 \begin_layout Description
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13695 Includes a comma-separated list of layouts after which this one should
13697 Only makes sense with regard to nestable layouts (such as environments).
13699 \begin_inset Quotes eld
13703 \begin_inset Flex Code
13706 \begin_layout Plain Layout
13713 \begin_inset Quotes erd
13718 \begin_inset Flex Code
13721 \begin_layout Plain Layout
13730 \begin_layout Description
13731 \begin_inset Flex Code
13734 \begin_layout Plain Layout
13741 \begin_inset Flex Code
13744 \begin_layout Plain Layout
13753 \begin_inset space \thinspace{}
13757 \begin_inset Flex Code
13760 \begin_layout Plain Layout
13766 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13767 of its contents in its item in the table of contents.
13768 Otherwise, only the label, if it exists, appears.
13771 \begin_layout Description
13772 \begin_inset Flex Code
13775 \begin_layout Plain Layout
13782 \begin_inset Flex Code
13785 \begin_layout Plain Layout
13791 ] The \SpecialChar LaTeX
13792 command sequence declaring an item in a list.
13793 The command is to be defined without the preceding backslash (the default
13795 \begin_inset Quotes eld
13799 \begin_inset Quotes erd
13803 \begin_inset Flex Code
13806 \begin_layout Plain Layout
13814 in the \SpecialChar LaTeX
13818 \begin_layout Description
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13829 \begin_inset Flex Code
13832 \begin_layout Plain Layout
13838 ] This provides extra space between paragraphs that have the same style.
13839 If you put other styles into an environment, each is separated with the
13841 \begin_inset Flex Code
13844 \begin_layout Plain Layout
13851 But the whole items of the environment are additionally separated with
13853 \begin_inset Flex Code
13856 \begin_layout Plain Layout
13863 Note that this is a
13868 \begin_layout Description
13869 \begin_inset Flex Code
13872 \begin_layout Plain Layout
13878 [FIXME] (Used only with XML-type formats.)
13881 \begin_layout Description
13882 \begin_inset Flex Code
13885 \begin_layout Plain Layout
13892 \begin_inset Flex Code
13895 \begin_layout Plain Layout
13904 \begin_inset space \thinspace{}
13908 \begin_inset Flex Code
13911 \begin_layout Plain Layout
13917 ] Usually \SpecialChar LyX
13918 does not allow you to leave a paragraph empty, since it would
13919 lead to empty \SpecialChar LaTeX
13921 There are some cases where this could be desirable however: in a letter
13922 template, the required fields can be provided as empty fields, so that
13923 people do not forget them; in some special classes, a style can be used
13924 as some kind of break, which does not contain actual text.
13927 \begin_layout Description
13928 \begin_inset Flex Code
13931 \begin_layout Plain Layout
13938 \begin_inset Flex Code
13941 \begin_layout Plain Layout
13947 ] The vertical space between the label and the text body.
13948 Only used for labels that are above the text body (
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13959 \begin_inset Newline newline
13963 \begin_inset Flex Code
13966 \begin_layout Plain Layout
13967 Centered_Top_Environment
13975 \begin_layout Description
13976 \begin_inset Flex Code
13979 \begin_layout Plain Layout
13986 \begin_inset Flex Code
13989 \begin_layout Plain Layout
13995 ] The name of the counter for automatic numbering.
13996 In order to have the counter appear with your label, you will need to reference
13998 \begin_inset Flex Code
14001 \begin_layout Plain Layout
14010 This will work with
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14041 \begin_inset Flex Code
14044 \begin_layout Plain Layout
14051 \begin_inset Newline newline
14059 \begin_inset Flex Code
14062 \begin_layout Plain Layout
14069 \begin_inset Flex Code
14072 \begin_layout Plain Layout
14078 , though this case is a bit complicated.
14079 Suppose you declare
14080 \begin_inset Quotes eld
14084 \begin_inset Flex Code
14087 \begin_layout Plain Layout
14088 LabelCounter myenum
14094 \begin_inset Quotes erd
14098 Then the actual counters used are
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14109 \begin_inset Flex Code
14112 \begin_layout Plain Layout
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14129 \begin_inset Flex Code
14132 \begin_layout Plain Layout
14138 , much as in \SpecialChar LaTeX
14140 These counters must all be declared separately.
14141 \begin_inset Newline newline
14145 \begin_inset CommandInset ref
14147 reference "subsec:Counters"
14151 for details on counters.
14154 \begin_layout Description
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14164 The font used for the label.
14166 \begin_inset CommandInset ref
14168 reference "subsec:Font-description"
14175 \begin_layout Description
14176 \begin_inset Flex Code
14179 \begin_layout Plain Layout
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14195 ] Text that indicates how far a label should be indented.
14198 \begin_layout Description
14199 \begin_inset Flex Code
14202 \begin_layout Plain Layout
14209 \begin_inset Flex Code
14212 \begin_layout Plain Layout
14218 ] Text that indicates the amount of horizontal space between the label and
14220 Only used for labels that are not above the text body.
14223 \begin_layout Description
14224 \begin_inset Flex Code
14227 \begin_layout Plain Layout
14234 \begin_inset Flex Code
14237 \begin_layout Plain Layout
14243 ] The string used for the label.
14245 \begin_inset Flex Code
14248 \begin_layout Plain Layout
14254 is set, this string can be contain the special formatting commands described
14256 \begin_inset CommandInset ref
14258 reference "subsec:Counters"
14265 \begin_layout Description
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14270 LabelStringAppendix
14276 \begin_inset Flex Code
14279 \begin_layout Plain Layout
14285 ] This is used inside the appendix instead of
14286 \begin_inset Newline newline
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14311 \begin_inset Newline newline
14315 \begin_inset Flex Code
14318 \begin_layout Plain Layout
14319 LabelStringAppendix
14327 \begin_layout Description
14328 \begin_inset Flex Code
14331 \begin_layout Plain Layout
14337 [FIXME] (Used only with XML-type formats.)
14340 \begin_layout Description
14341 \begin_inset Flex Code
14344 \begin_layout Plain Layout
14351 \begin_inset Flex Code
14354 \begin_layout Plain Layout
14359 , Manual, Static, Above,
14360 \begin_inset Newline newline
14363 Centered, Sensitive, Enumerate,
14364 \begin_inset Newline newline
14367 Itemize, Bibliography
14376 \begin_layout Description
14377 \begin_inset Flex Code
14380 \begin_layout Plain Layout
14386 means the label is the very first word (up to the first real blank).
14387 Use protected spaces if you want more than one word as the label.
14391 \begin_layout Description
14392 \begin_inset Flex Code
14395 \begin_layout Plain Layout
14401 means the label is simply what is declared as
14402 \begin_inset Flex Code
14405 \begin_layout Plain Layout
14412 This will be displayed
14413 \begin_inset Quotes eld
14417 \begin_inset Quotes erd
14420 , at the beginning of the paragraph.
14422 \begin_inset Flex Code
14425 \begin_layout Plain Layout
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14441 , then it will be displayed only in the first paragraph of any sequence
14442 of paragraphs with the same
14443 \begin_inset Flex Code
14446 \begin_layout Plain Layout
14455 \begin_layout Description
14456 \begin_inset Flex Code
14459 \begin_layout Plain Layout
14466 \begin_inset space ~
14470 \begin_inset space ~
14474 \begin_inset Flex Code
14477 \begin_layout Plain Layout
14483 are special cases of
14484 \begin_inset Flex Code
14487 \begin_layout Plain Layout
14494 The label will be printed above the paragraph either at the beginning of
14495 the line or centered.
14498 \begin_layout Description
14499 \begin_inset Flex Code
14502 \begin_layout Plain Layout
14508 is a special case for the caption-labels
14509 \begin_inset Quotes eld
14513 \begin_inset Quotes erd
14517 \begin_inset Quotes eld
14521 \begin_inset Quotes erd
14525 \begin_inset Newline newline
14529 \begin_inset Flex Code
14532 \begin_layout Plain Layout
14538 means the (hardcoded) label string depends on the kind of float: It is
14539 hardcoded to be `FloatType N', where N is the value of the counter associated
14541 For the case that a caption is inserted outside of a float the
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14552 \begin_inset Quotes eld
14556 \begin_inset Quotes erd
14562 \begin_layout Description
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14572 produces the usual sort of enumeration labels.
14573 The number type needs to be set in the
14578 \begin_inset CommandInset ref
14580 reference "subsec:Counters"
14587 \begin_layout Description
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14597 produces various bullets at the different levels.
14598 The bullet types displayed can be set via
14599 \begin_inset Flex Noun
14602 \begin_layout Plain Layout
14603 Document\SpecialChar menuseparator
14604 Settings\SpecialChar menuseparator
14613 \begin_layout Description
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14623 should be used only with
14624 \begin_inset Flex Code
14627 \begin_layout Plain Layout
14628 LatexType BibEnvironment
14637 \begin_layout Description
14638 \begin_inset Flex Code
14641 \begin_layout Plain Layout
14647 Note that this will completely override any prior
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14657 declaration for this style.
14659 \begin_inset Quotes eld
14663 \begin_inset Flex Code
14666 \begin_layout Plain Layout
14673 \begin_inset Quotes erd
14678 \begin_inset CommandInset ref
14680 reference "subsec:I18n"
14684 for details on its use.
14687 \begin_layout Description
14688 \begin_inset Flex Code
14691 \begin_layout Plain Layout
14698 \begin_inset Flex Code
14701 \begin_layout Plain Layout
14707 ] The name of the corresponding \SpecialChar LaTeX
14709 Either the environment or command name.
14712 \begin_layout Description
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14732 ] An optional parameter for the corresponding
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14743 This parameter cannot be changed from within \SpecialChar LyX
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14754 for customizable parameters).
14755 This will be output as is after all \SpecialChar LaTeX
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14769 \begin_layout Description
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14788 , Command, Environment, Item_Environment,
14789 \begin_inset Newline newline
14792 List_Environment, Bib_Environment
14797 ] How the style should be translated into \SpecialChar LaTeX
14802 \begin_layout Plain Layout
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14812 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14813 Visit the SGML class files for specific examples.
14822 \begin_layout Description
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14832 means nothing special.
14835 \begin_layout Description
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14856 {\SpecialChar ldots
14865 \begin_layout Description
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14886 }\SpecialChar ldots
14902 \begin_layout Description
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14934 is generated for each paragraph of this environment.
14938 \begin_layout Description
14939 \begin_inset Flex Code
14942 \begin_layout Plain Layout
14949 \begin_inset Flex Code
14952 \begin_layout Plain Layout
14959 \begin_inset Newline newline
14963 \begin_inset Flex Code
14966 \begin_layout Plain Layout
14972 is passed as an argument to the environment.
14973 \begin_inset Newline newline
14977 \begin_inset Flex Code
14980 \begin_layout Plain Layout
14986 can be defined in the
14987 \begin_inset Flex Noun
14990 \begin_layout Plain Layout
14991 Edit\SpecialChar menuseparator
14993 \begin_inset space ~
15004 \begin_layout Description
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15015 \begin_inset Flex Code
15018 \begin_layout Plain Layout
15024 but adds the necessary mandatory argument (the longest label) to the begin
15025 statement of the bibliography environment:
15026 \begin_inset Newline newline
15030 \begin_inset Flex Code
15033 \begin_layout Plain Layout
15036 begin{thebibliography}{99}
15042 It is therefore only useful for bibliography environments.
15043 The default longest label
15044 \begin_inset Quotes eld
15048 \begin_inset Quotes erd
15051 can be changed by the user in the paragraph settings of a bibliography
15055 \begin_layout Standard
15056 Putting the last few things together, the \SpecialChar LaTeX
15057 output will be either:
15060 \begin_layout LyX-Code
15063 LatexName[LatexParam]{\SpecialChar ldots
15067 \begin_layout Standard
15071 \begin_layout LyX-Code
15074 begin{LatexName}[LatexParam] \SpecialChar ldots
15080 \begin_layout Standard
15081 depending upon the \SpecialChar LaTeX
15086 \begin_layout Description
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15097 \begin_inset Flex Code
15100 \begin_layout Plain Layout
15106 ] A string that is put at the beginning of the style content.
15107 A line break in the output can be indicated by
15108 \begin_inset Flex Code
15111 \begin_layout Plain Layout
15120 \begin_layout Description
15121 \begin_inset Flex Code
15124 \begin_layout Plain Layout
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15140 ] If you put styles into environments, the different
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15150 are not simply added, but added with a factor
15151 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15155 Note that this parameter is also used when
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15186 Then it is added to the manual or dynamic margin.
15187 \begin_inset Newline newline
15191 \begin_inset Quotes eld
15195 \begin_inset Flex Code
15198 \begin_layout Plain Layout
15205 \begin_inset Quotes erd
15208 means that the paragraph is indented with the width of
15209 \begin_inset Quotes eld
15213 \begin_inset Flex Code
15216 \begin_layout Plain Layout
15223 \begin_inset Quotes erd
15226 in the normal font.
15227 You can get a negative width by prefixing the string with
15228 \begin_inset Quotes eld
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15242 \begin_inset Quotes erd
15246 This way was chosen so that the look is the same with each used screen
15250 \begin_layout Description
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15269 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15275 \begin_inset Newline newline
15278 The kind of margin that the style has on the left side.
15282 \begin_layout Description
15283 \begin_inset Flex Code
15286 \begin_layout Plain Layout
15292 just means a fixed margin.
15295 \begin_layout Description
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15305 means that the left margin depends on the string entered in the
15306 \begin_inset Flex Noun
15309 \begin_layout Plain Layout
15310 Edit\SpecialChar menuseparator
15312 \begin_inset space ~
15321 This is used to typeset nice lists without tabulators.
15324 \begin_layout Description
15325 \begin_inset Flex Code
15328 \begin_layout Plain Layout
15334 means that the margin depends on the size of the label.
15335 This is used for automatic enumerated headlines.
15336 It is obvious that the headline
15337 \begin_inset Quotes eld
15340 5.4.3.2.1 Very long headline
15341 \begin_inset Quotes erd
15344 must have a wider left margin (as wide as
15345 \begin_inset Quotes eld
15349 \begin_inset Quotes erd
15352 plus the space) than
15353 \begin_inset Quotes eld
15356 3.2 Very long headline
15357 \begin_inset Quotes erd
15361 \begin_inset Quotes eld
15365 \begin_inset Quotes erd
15368 are not able to do this.
15371 \begin_layout Description
15372 \begin_inset Flex Code
15375 \begin_layout Plain Layout
15381 is similar, but only the very first row of the paragraph is dynamic, while
15382 the others are static; this is used, for example, for descriptions.
15385 \begin_layout Description
15386 \begin_inset Flex Code
15389 \begin_layout Plain Layout
15395 means the margin is chosen in a way that the longest row of this paragraph
15396 fits to the right margin.
15397 This is used to typeset an address on the right edge of the page.
15401 \begin_layout Description
15402 \begin_inset Flex Code
15405 \begin_layout Plain Layout
15412 \begin_inset Flex Code
15415 \begin_layout Plain Layout
15424 \begin_inset space \thinspace{}
15428 \begin_inset Flex Code
15431 \begin_layout Plain Layout
15437 ] Whether fragile commands in this style should be
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15454 whether this command should itself be protected.)
15455 \change_inserted -712698321 1523696949
15459 \begin_layout Description
15461 \change_inserted -712698321 1552395557
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15467 \change_inserted -712698321 1523696950
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15479 \change_inserted -712698321 1523696950
15488 \begin_inset space \thinspace{}
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15497 \change_inserted -712698321 1523696950
15503 ] This causes macros that contain this layout to be protected with
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15509 \change_inserted -712698321 1523696950
15522 ) if necessary and thus allows (some) verbatim stuff in macros.
15525 \begin_layout Description
15527 \change_inserted -712698321 1552395844
15528 \begin_inset Flex Code
15531 \begin_layout Plain Layout
15533 \change_inserted -712698321 1552395561
15540 \begin_inset Flex Code
15543 \begin_layout Plain Layout
15545 \change_inserted -712698321 1552395557
15554 \begin_inset space \thinspace{}
15558 \begin_inset Flex Code
15561 \begin_layout Plain Layout
15563 \change_inserted -712698321 1552395557
15569 ] Whether specific commands in this style (such as
15570 \begin_inset Flex Code
15573 \begin_layout Plain Layout
15575 \change_inserted -712698321 1552395655
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15591 \change_inserted -712698321 1552395661
15601 ) should be protected in an
15602 \begin_inset Flex Code
15605 \begin_layout Plain Layout
15607 \change_inserted -712698321 1552395631
15618 This is particularly needed for styles that draw on
15626 commands which parse their content in complex ways.
15631 \begin_layout Description
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15642 \begin_inset Flex Code
15645 \begin_layout Plain Layout
15652 \begin_inset space \thinspace{}
15656 \begin_inset Flex Code
15659 \begin_layout Plain Layout
15667 ] Whether newlines are translated into \SpecialChar LaTeX
15669 \begin_inset Flex Code
15672 \begin_layout Plain Layout
15683 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15685 inside \SpecialChar LyX
15689 \begin_layout Description
15690 \begin_inset Flex Code
15693 \begin_layout Plain Layout
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15712 \begin_inset space \thinspace{}
15716 \begin_inset Flex Code
15719 \begin_layout Plain Layout
15725 ] If set to true, and if
15726 \begin_inset Flex Code
15729 \begin_layout Plain Layout
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15745 ) paragraphs are being indented, then the indentation of such a paragraph
15746 following one of this type will be suppressed.
15747 (So this will not affect the display of non-default paragraphs.)
15750 \begin_layout Description
15751 \begin_inset Flex Code
15754 \begin_layout Plain Layout
15761 \begin_inset Flex Code
15764 \begin_layout Plain Layout
15770 ] Name of a style that has replaced this style.
15771 This is used to rename a style, while keeping backward compatibility.
15774 \begin_layout Description
15775 \begin_inset Flex Code
15778 \begin_layout Plain Layout
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15795 \begin_inset space \thinspace{}
15799 \begin_inset Flex Code
15802 \begin_layout Plain Layout
15808 ] Determines whether consecutive paragraphs of the same type are treated
15809 as belonging together.
15810 This has the effect that the
15811 \begin_inset Flex Code
15814 \begin_layout Plain Layout
15820 is only printed once before such a group.
15821 By default, this is true for
15822 \begin_inset Flex Code
15825 \begin_layout Plain Layout
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15851 and false for all other types.
15854 \begin_layout Description
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15865 \begin_inset Flex Code
15868 \begin_layout Plain Layout
15877 \begin_inset space \thinspace{}
15881 \begin_inset Flex Code
15884 \begin_layout Plain Layout
15890 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15892 but only by a line break; together with
15893 \begin_inset Flex Code
15896 \begin_layout Plain Layout
15902 , this allows to emulate a plain text editor (like the ERT inset).
15905 \begin_layout Description
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15925 ] The indent of the very first line of a paragraph.
15927 \begin_inset Newline newline
15931 \begin_inset Flex Code
15934 \begin_layout Plain Layout
15940 will be fixed for a certain style.
15941 The exception is the default style, since the indentation for these paragraphs
15942 can be prohibited with
15943 \begin_inset Flex Code
15946 \begin_layout Plain Layout
15954 \begin_inset Flex Code
15957 \begin_layout Plain Layout
15963 style paragraphs inside environments use the
15964 \begin_inset Flex Code
15967 \begin_layout Plain Layout
15973 of the environment, not their native one.
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15984 paragraphs inside an enumeration are not indented.
15987 \begin_layout Description
15988 \begin_inset Flex Code
15991 \begin_layout Plain Layout
15998 \begin_inset Flex Code
16001 \begin_layout Plain Layout
16007 ] The vertical space between two paragraphs of this style.
16010 \begin_layout Description
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16031 allows the user to choose either
16032 \begin_inset Quotes eld
16036 \begin_inset Quotes erd
16040 \begin_inset Quotes eld
16044 \begin_inset Quotes erd
16047 to separate paragraphs.
16049 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16057 \begin_inset Flex Code
16060 \begin_layout Plain Layout
16068 \begin_inset Quotes eld
16072 \begin_inset Quotes erd
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16085 is ignored and all paragraphs are separated by the
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16096 The vertical space is calculated with
16097 \begin_inset Flex Code
16100 \begin_layout Plain Layout
16102 \begin_inset space ~
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16120 is the height of a row with the normal font.
16121 This way, the look stays the same with different screen fonts.
16124 \begin_layout Description
16125 \begin_inset Flex Code
16128 \begin_layout Plain Layout
16135 \begin_inset Flex Code
16138 \begin_layout Plain Layout
16147 \begin_inset space \thinspace{}
16151 \begin_inset Flex Code
16154 \begin_layout Plain Layout
16160 ] Whether the contents of this paragraph should be output in raw form, meaning
16161 without special translations that \SpecialChar LaTeX
16165 \begin_layout Description
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16176 \begin_inset Flex Code
16179 \begin_layout Plain Layout
16189 Defines individual characters that should be output in raw form, meaning
16190 without special translations that \SpecialChar LaTeX
16194 \begin_layout Description
16195 \begin_inset Flex Code
16198 \begin_layout Plain Layout
16204 Information to be included in the \SpecialChar LaTeX
16205 preamble when this style is used.
16206 Used to define macros, load packages, etc., required by this particular
16209 \begin_inset Quotes eld
16213 \begin_inset Flex Code
16216 \begin_layout Plain Layout
16223 \begin_inset Quotes erd
16229 \begin_layout Description
16230 \begin_inset Flex Code
16233 \begin_layout Plain Layout
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16249 ] The prefix to use when creating labels referring to paragraphs of this
16251 This allows the use of formatted references.
16254 \begin_layout Description
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16265 \begin_inset Flex Code
16268 \begin_layout Plain Layout
16274 ] Whether the style requires the feature
16275 \begin_inset Flex Code
16278 \begin_layout Plain Layout
16285 \begin_inset CommandInset ref
16287 reference "chap:List-of-functions"
16291 for the list of features).
16292 If you require a package with specific options, you can additionally use
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16303 as a general text class parameter (see
16304 \begin_inset CommandInset ref
16306 reference "subsec:General-text-class"
16313 \begin_layout Description
16314 \begin_inset Flex Code
16317 \begin_layout Plain Layout
16324 \begin_inset Flex Code
16327 \begin_layout Plain Layout
16336 \begin_inset Flex Code
16339 \begin_layout Plain Layout
16345 ] Resets the \SpecialChar LaTeX
16346 arguments of this style (as defined via the
16347 \begin_inset Flex Code
16350 \begin_layout Plain Layout
16357 This is useful if you have copied a style via
16358 \begin_inset Flex Code
16361 \begin_layout Plain Layout
16367 , but you do not want to inherit its (required and optional) arguments.
16370 \begin_layout Description
16371 \begin_inset Flex Code
16374 \begin_layout Plain Layout
16381 \begin_inset Flex Code
16384 \begin_layout Plain Layout
16393 \begin_inset Flex Code
16396 \begin_layout Plain Layout
16402 ] Resumes a counter that is usually reset at each new sequence of layouts.
16403 This is currently only useful when
16404 \begin_inset Flex Code
16407 \begin_layout Plain Layout
16414 \begin_inset Flex Code
16417 \begin_layout Plain Layout
16426 \begin_layout Description
16427 \begin_inset Flex Code
16430 \begin_layout Plain Layout
16437 \begin_inset Flex Code
16440 \begin_layout Plain Layout
16446 ] A string that is put at the end of the layout content.
16447 A line break in the output can be indicated by
16448 \begin_inset Flex Code
16451 \begin_layout Plain Layout
16460 \begin_layout Description
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16471 \begin_inset Flex Code
16474 \begin_layout Plain Layout
16481 \begin_inset Flex Code
16484 \begin_layout Plain Layout
16493 \begin_layout Description
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16504 \begin_inset Flex Code
16507 \begin_layout Plain Layout
16516 \begin_inset Flex Code
16519 \begin_layout Plain Layout
16526 \begin_inset Flex Code
16529 \begin_layout Plain Layout
16536 \begin_inset Flex Code
16539 \begin_layout Plain Layout
16541 \begin_inset space ~
16549 ] This defines what the default spacing should be in the style.
16551 \begin_inset Flex Code
16554 \begin_layout Plain Layout
16561 \begin_inset Flex Code
16564 \begin_layout Plain Layout
16571 \begin_inset Flex Code
16574 \begin_layout Plain Layout
16580 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16581 If you specify the argument
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16591 , then you must also provide a value argument which will be the actual multiplie
16593 Note that, contrary to other parameters,
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16603 implies the generation of specific \SpecialChar LaTeX
16604 code, using the \SpecialChar LaTeX
16608 \begin_inset Flex Code
16611 \begin_layout Plain Layout
16620 \begin_layout Description
16621 \begin_inset Flex Code
16624 \begin_layout Plain Layout
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16641 \begin_inset space \thinspace{}
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16656 ] Allow spell-checking paragraphs of this style.
16660 \begin_layout Description
16661 \begin_inset Flex Code
16664 \begin_layout Plain Layout
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16683 \begin_inset Flex Code
16686 \begin_layout Plain Layout
16692 ] Steps the master counter of a given counter at the beginning of a new
16693 sequence of layouts.
16694 This is currently only useful when
16695 \begin_inset Flex Code
16698 \begin_layout Plain Layout
16705 \begin_inset Flex Code
16708 \begin_layout Plain Layout
16717 \begin_layout Description
16718 \begin_inset Flex Code
16721 \begin_layout Plain Layout
16727 The font used for the text body .
16729 \begin_inset CommandInset ref
16731 reference "subsec:Font-description"
16738 \begin_layout Description
16739 \begin_inset Flex Code
16742 \begin_layout Plain Layout
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16764 The level of the style in the table of contents.
16765 This is used for automatic numbering of section headings.
16768 \begin_layout Description
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16814 ] This tag determines whether the first line indentation of this paragraph
16815 can be toggled via the Paragraph settings dialog.
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16832 is set, indentation can be toggled if the document settings use
16833 \begin_inset Quotes eld
16837 \begin_inset Quotes erd
16840 paragraph style, with
16841 \begin_inset Flex Code
16844 \begin_layout Plain Layout
16850 , indentation can always be toggled, notwithstanding the document settings,
16852 \begin_inset Flex Code
16855 \begin_layout Plain Layout
16861 , indentation can never be toggled.
16864 \begin_layout Description
16865 \begin_inset Flex Code
16868 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16884 ] The vertical space with which the very first of a chain of paragraphs
16885 with this style is separated from the previous paragraph.
16886 If the previous paragraph has another style, the separations are not simply
16887 added, but the maximum is taken.
16890 \begin_layout Subsection
16891 \begin_inset CommandInset label
16897 Internationalization of Paragraph Styles
16900 \begin_layout Standard
16902 has long supported internationalization of layout information, but, until
16903 version 2.0, this applied only to the user interface and not to, say, PDF
16905 Thus, French authors were forced to resort to ugly hacks if they wanted
16910 1' instead of `Theorem 1'.
16911 Thanks to Georg Baum, that is no longer the case.
16914 \begin_layout Standard
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16925 defines text that is to appear in the typeset document, it may use
16926 \begin_inset Flex Code
16929 \begin_layout Plain Layout
16936 \begin_inset Flex Code
16939 \begin_layout Plain Layout
16945 to support non-English and even multi-language documents correctly.
16946 The following excerpt (from the
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16956 file) shows how this works:
16959 \begin_layout LyX-Code
16964 \begin_layout LyX-Code
16967 theoremstyle{remark}
16970 \begin_layout LyX-Code
16973 newtheorem{claim}[thm]{
16980 \begin_layout LyX-Code
16984 \begin_layout LyX-Code
16988 \begin_layout LyX-Code
16993 claimname}{_(Claim)}
16996 \begin_layout LyX-Code
17000 \begin_layout LyX-Code
17004 \begin_layout LyX-Code
17013 claimname}{_(Claim)}}
17016 \begin_layout LyX-Code
17021 \begin_layout Standard
17022 In principle, any legal \SpecialChar LaTeX
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17043 tags, but in practice they will typically look as they do here.
17044 The key to correct translation of the typeset text is the definition of
17045 the \SpecialChar LaTeX
17047 \begin_inset Flex Code
17050 \begin_layout Plain Layout
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17074 \begin_layout Standard
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17085 tag provides for internationalization based upon the overall language of
17087 The contents of the tag will be included in the preamble, just as with
17089 \begin_inset Flex Code
17092 \begin_layout Plain Layout
17099 What makes it special is the use of the
17100 \begin_inset Quotes eld
17104 \begin_inset Quotes erd
17108 \begin_inset Flex Code
17111 \begin_layout Plain Layout
17117 , which will be replaced, when \SpecialChar LyX
17118 produces \SpecialChar LaTeX
17119 output, with the translation of
17120 its argument into the document language.
17123 \begin_layout Standard
17125 \begin_inset Flex Code
17128 \begin_layout Plain Layout
17134 tag is more complex, since it is meant to provide support for multi-language
17135 documents and so offers an interface to the
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17146 Its contents will be added to the preamble once for each language that
17147 appears in the document.
17148 In this case, the argument to
17149 \begin_inset Flex Code
17152 \begin_layout Plain Layout
17158 will be replaced with its translation into the language in question; the
17160 \begin_inset Flex Code
17163 \begin_layout Plain Layout
17169 is replaced by the language name (as used by the babel package).
17172 \begin_layout Standard
17173 A German document that also included a French section would thus have the
17174 following in the preamble:
17177 \begin_layout LyX-Code
17186 claimname}{Affirmation}}
17187 \begin_inset Newline newline
17198 claimname}{Behauptung}}
17199 \begin_inset Newline newline
17206 claimname}{Behauptung}
17209 \begin_layout Standard
17212 \begin_inset Flex Code
17215 \begin_layout Plain Layout
17221 will then conspire to produce the correct text in the output.
17224 \begin_layout Standard
17225 One important point to note here is that the translations are provided by
17227 itself, through the file
17228 \begin_inset Flex Code
17231 \begin_layout Plain Layout
17238 This means, in effect, that
17239 \begin_inset Flex Code
17242 \begin_layout Plain Layout
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17258 are really only of use in layout files that are provided with \SpecialChar LyX
17260 entered in user-created layout files will not be seen by \SpecialChar LyX
17261 's internationalizatio
17262 n routines unless the
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17272 file is modified accordingly.
17273 That said, however, any layout created with the intention that it will
17274 be included with \SpecialChar LyX
17275 should use these tags where appropriate.
17276 Please note that the paragraph style translations provided by \SpecialChar LyX
17278 change with a minor update (e.
17279 \begin_inset space \thinspace{}
17283 \begin_inset space \space{}
17286 from version 2.1.x to 2.1.y).
17287 It is however quite likely that a major update (e.
17288 \begin_inset space \thinspace{}
17292 \begin_inset space \space{}
17295 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17298 \begin_layout Subsection
17300 \begin_inset CommandInset label
17302 name "subsec:Floats"
17309 \begin_layout Standard
17310 It is necessary to define the floats (
17311 \begin_inset Flex Noun
17314 \begin_layout Plain Layout
17321 \begin_inset Flex Noun
17324 \begin_layout Plain Layout
17330 , \SpecialChar ldots
17331 ) in the text class itself.
17332 Standard floats are included in the file
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17342 , so you may have to do no more than add
17345 \begin_layout LyX-Code
17346 Input stdfloats.inc
17349 \begin_layout Standard
17350 to your layout file.
17351 If you want to implement a text class that proposes some other float types
17352 (like the AGU class bundled with \SpecialChar LyX
17353 ), the information below will hopefully
17357 \begin_layout Description
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17377 =!htbpH] Allowed placement options for this float type.
17378 The value is a string of placement characters.
17379 Possible characters include:
17384 \begin_inset Quotes eld
17388 \begin_inset Quotes erd
17396 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17408 \begin_inset Quotes eld
17412 \begin_inset Quotes erd
17420 \begin_inset Quotes eld
17424 \begin_inset Quotes erd
17432 \begin_inset Quotes eld
17436 \begin_inset Quotes erd
17444 \begin_inset Quotes eld
17448 \begin_inset Quotes erd
17452 The order of the characters in the string does not matter.
17453 If no placement options are allowed, use the string
17460 \begin_layout Description
17461 \begin_inset Flex Code
17464 \begin_layout Plain Layout
17471 \begin_inset Flex Code
17474 \begin_layout Plain Layout
17483 \begin_inset space \thinspace{}
17489 \begin_inset Flex Code
17492 \begin_layout Plain Layout
17502 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17509 \begin_inset Flex Code
17512 \begin_layout Plain Layout
17518 if the float does not support this feature.
17521 \begin_layout Description
17522 \begin_inset Flex Code
17525 \begin_layout Plain Layout
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17544 \begin_inset space \thinspace{}
17550 \begin_inset Flex Code
17553 \begin_layout Plain Layout
17563 ] Defines whether the float has a starred variant that spans columns in
17564 a two column paragraph.
17566 \begin_inset Flex Code
17569 \begin_layout Plain Layout
17575 if the float does not support this feature.
17578 \begin_layout Description
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17599 \begin_inset Quotes erd
17603 \begin_inset Quotes erd
17606 ] The file name extension of an auxiliary file for the list of figures (or
17609 writes the captions to this file.
17612 \begin_layout Description
17613 \begin_inset Flex Code
17616 \begin_layout Plain Layout
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17633 \begin_inset Quotes erd
17637 \begin_inset Quotes erd
17640 ] The string that will be used in the menus and also for the caption.
17641 This is translated to the current language if babel is used.
17644 \begin_layout Description
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 These tags control the XHTML output.
17656 \begin_inset CommandInset ref
17658 reference "sec:Tags-for-XHTML"
17665 \begin_layout Description
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17690 \begin_inset space \thinspace{}
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17703 ] Indicates whether the float is already defined in the document class or
17704 if instead the \SpecialChar LaTeX
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17715 needs to be loaded to define it on-the-fly.
17717 \begin_inset Flex Code
17720 \begin_layout Plain Layout
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17737 It should be set to
17738 \begin_inset Flex Code
17741 \begin_layout Plain Layout
17747 if the float is already defined by the \SpecialChar LaTeX
17751 \begin_layout Description
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17762 \begin_inset Flex Code
17765 \begin_layout Plain Layout
17772 \begin_inset Quotes erd
17776 \begin_inset Quotes erd
17779 ] The command used to generate a list of floats of this type; the leading
17788 \begin_inset Flex Code
17791 \begin_layout Plain Layout
17797 is false, since there is no standard way to generate this command.
17799 \begin_inset Flex Code
17802 \begin_layout Plain Layout
17808 is true, since in that case there is a standard way to define the command.
17811 \begin_layout Description
17812 \begin_inset Flex Code
17815 \begin_layout Plain Layout
17822 \begin_inset Flex Code
17825 \begin_layout Plain Layout
17832 \begin_inset Quotes erd
17836 \begin_inset Quotes erd
17839 ] A title for a list of floats of this kind (list of figures, tables, or
17841 It is used for the screen label within \SpecialChar LyX
17842 , it is used by \SpecialChar LaTeX
17844 it is used as the title in the XHTML output.
17845 It will be translated to the document language.
17848 \begin_layout Description
17849 \begin_inset Flex Code
17852 \begin_layout Plain Layout
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17869 \begin_inset Quotes erd
17873 \begin_inset Quotes erd
17876 ] This (optional) argument determines whether floats of this class will
17877 be numbered within some sectional unit of the document.
17879 \begin_inset Flex Code
17882 \begin_layout Plain Layout
17889 \begin_inset Quotes eld
17893 \begin_inset Flex Code
17896 \begin_layout Plain Layout
17903 \begin_inset Quotes erd
17906 , the floats will be numbered within chapters.
17910 \begin_layout Description
17911 \begin_inset Flex Code
17914 \begin_layout Plain Layout
17921 \begin_inset Flex Code
17924 \begin_layout Plain Layout
17931 \begin_inset Quotes erd
17935 \begin_inset Quotes erd
17938 ] The default placement for the given class of floats.
17939 The string should be as in standard \SpecialChar LaTeX
17941 \begin_inset Flex Code
17944 \begin_layout Plain Layout
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17961 \begin_inset Flex Code
17964 \begin_layout Plain Layout
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17980 for top, bottom, page, and here, respectively.
17984 \begin_layout Plain Layout
17985 Note that the order of these letters in the string is irrelevant, like in
17992 On top of that there is a new type,
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
18002 , which does not really correspond to a float, since it means: put it
18003 \begin_inset Quotes eld
18007 \begin_inset Quotes erd
18011 Note however that the
18012 \begin_inset Flex Code
18015 \begin_layout Plain Layout
18021 specifier is special and, because of implementation details, cannot be
18022 used in non-built in float types.
18023 If you do not understand what this means, just use
18024 \begin_inset Quotes eld
18028 \begin_inset Flex Code
18031 \begin_layout Plain Layout
18038 \begin_inset Quotes erd
18044 \begin_layout Description
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18055 \begin_inset Flex Code
18058 \begin_layout Plain Layout
18064 ] The prefix to use when creating labels referring to floats of this type.
18065 This allows the use of formatted references.
18066 Note that you can remove any
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18076 set by a copied style by using the special value
18077 \begin_inset Quotes eld
18081 \begin_inset Quotes erd
18084 , which must be all caps.
18087 \begin_layout Description
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18108 \begin_inset Quotes erd
18112 \begin_inset Quotes erd
18115 ] The style used when defining the float using
18116 \begin_inset Flex Code
18119 \begin_layout Plain Layout
18130 \begin_layout Description
18131 \begin_inset Flex Code
18134 \begin_layout Plain Layout
18141 \begin_inset Flex Code
18144 \begin_layout Plain Layout
18151 \begin_inset Quotes erd
18155 \begin_inset Quotes erd
18159 \begin_inset Quotes eld
18163 \begin_inset Quotes erd
18166 of the new class of floats, like program or algorithm.
18167 After the appropriate
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18192 \begin_inset Flex Code
18195 \begin_layout Plain Layout
18206 \begin_layout Description
18207 \begin_inset Flex Code
18210 \begin_layout Plain Layout
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18227 \begin_inset space \thinspace{}
18231 \begin_inset Flex Code
18234 \begin_layout Plain Layout
18242 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18253 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18257 \begin_layout Standard
18258 Note that defining a float with type
18259 \begin_inset Flex Code
18262 \begin_layout Plain Layout
18270 automatically defines the corresponding counter with name
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18285 \begin_layout Subsection
18286 Flex insets and InsetLayout
18287 \begin_inset CommandInset label
18289 name "subsec:Flex-insets-and"
18296 \begin_layout Standard
18297 Flex insets come in three different kinds:
18300 \begin_layout Itemize
18302 \begin_inset Flex Code
18305 \begin_layout Plain Layout
18311 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18325 \begin_inset Flex Code
18328 \begin_layout Plain Layout
18339 \begin_layout Itemize
18341 \begin_inset Flex Code
18344 \begin_layout Plain Layout
18350 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18352 footnote, and the like.
18353 An obvious example is an endnote inset, which is defined in the
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18366 \begin_layout Itemize
18368 \begin_inset Flex Code
18371 \begin_layout Plain Layout
18377 ): For use with DocBook classes.
18380 \begin_layout Standard
18381 Flex insets are defined using the
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18391 tag, which shall be explained in a moment.
18394 \begin_layout Standard
18396 \begin_inset Flex Code
18399 \begin_layout Plain Layout
18405 tag also serves another function: It can be used to customize the general
18406 layout of many different types of insets.
18408 \begin_inset Flex Code
18411 \begin_layout Plain Layout
18417 can be used to customize the layout parameters for footnotes, marginal
18418 notes, note insets, \SpecialChar TeX
18419 code (ERT) insets, branches, listings, indexes, boxes,
18420 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18423 \begin_layout Standard
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18434 definition must begin with a line of the form:
18437 \begin_layout LyX-Code
18441 \begin_layout Standard
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18452 indicates the inset whose layout is being defined, and here there are four
18456 \begin_layout Enumerate
18457 The layout for a pre-existing inset is being modified.
18458 In this case, can be
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18468 any one of the following:
18469 \begin_inset Flex Code
18472 \begin_layout Plain Layout
18479 \begin_inset Flex Code
18482 \begin_layout Plain Layout
18489 \begin_inset Flex Code
18492 \begin_layout Plain Layout
18499 \begin_inset Flex Code
18502 \begin_layout Plain Layout
18509 \begin_inset Flex Code
18512 \begin_layout Plain Layout
18519 \begin_inset Flex Code
18522 \begin_layout Plain Layout
18529 \begin_inset Flex Code
18532 \begin_layout Plain Layout
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18549 \begin_inset Flex Code
18552 \begin_layout Plain Layout
18559 \begin_inset Flex Code
18562 \begin_layout Plain Layout
18569 \begin_inset Flex Code
18572 \begin_layout Plain Layout
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18599 \begin_inset Flex Code
18602 \begin_layout Plain Layout
18609 \begin_inset Flex Code
18612 \begin_layout Plain Layout
18619 \begin_inset Flex Code
18622 \begin_layout Plain Layout
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18671 \begin_layout Enumerate
18672 The layout for a Flex inset is being defined.
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18683 must be of the form
18684 \begin_inset Quotes eld
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18698 \begin_inset Quotes erd
18702 \begin_inset Flex Code
18705 \begin_layout Plain Layout
18711 may be be any valid identifier not used by a pre-existing Flex inset.
18712 The identifier may include spaces, but in that case the whole thing must
18713 be wrapped in quotes.
18714 Note that the definition of a flex inset
18719 \begin_inset Flex Code
18722 \begin_layout Plain Layout
18728 entry, declaring which type of inset it defines.
18731 \begin_layout Enumerate
18732 The layout for user specific branch is being defined.
18734 \begin_inset Flex Code
18737 \begin_layout Plain Layout
18743 must be of the form
18744 \begin_inset Quotes eld
18748 \begin_inset Flex Code
18751 \begin_layout Plain Layout
18758 \begin_inset Quotes erd
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18771 may be be any valid identifier of branch defined in user's document.
18772 The identifier may include spaces, but in that case the whole thing must
18773 be wrapped in quotes.
18774 The main purpose of this feature is to allow \SpecialChar LaTeX
18775 wrapping around specific
18776 branches as user needs.
18779 \begin_layout Enumerate
18780 The layout of a user (or class) specific caption is being defined.
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18791 must be of the form
18792 \begin_inset Quotes eld
18796 \begin_inset Flex Code
18799 \begin_layout Plain Layout
18806 \begin_inset Quotes erd
18810 \begin_inset Flex Code
18813 \begin_layout Plain Layout
18819 specifies the name of the caption as it appears in the menu.
18820 Have a look at the standard caption (
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18830 ), the specific captions of the KOMA-Script classes (
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18841 \begin_inset Flex Code
18844 \begin_layout Plain Layout
18853 \begin_inset space ~
18857 \begin_inset Newline linebreak
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18872 ) for applications.
18875 \begin_layout Standard
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18886 definition can contain the following entries:
18889 \begin_layout Description
18890 \begin_inset Flex Code
18893 \begin_layout Plain Layout
18900 \begin_inset Flex Code
18903 \begin_layout Plain Layout
18909 =""] This inset will appear in the table of contents of the given type.
18910 An empty string disables.
18911 See also the OutlinerName and the IsTocCaption commands.
18912 This is only implemented for Flex insets.
18916 \begin_layout Description
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18927 \begin_inset Flex Code
18930 \begin_layout Plain Layout
18936 ] Defines argument number of a command\SpecialChar breakableslash
18937 environment associated with the current
18939 The definition must end with
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18951 \begin_inset CommandInset ref
18953 reference "subsec:Paragraph-Styles"
18960 \begin_layout Description
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18970 Preamble for changing language commands; see
18971 \begin_inset CommandInset ref
18973 reference "subsec:I18n"
18980 \begin_layout Description
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19000 ] The color for the inset's background.
19002 \begin_inset CommandInset ref
19004 reference "chap:Names-of-colors"
19008 for a list of the available color names.
19011 \begin_layout Description
19012 \begin_inset Flex Code
19015 \begin_layout Plain Layout
19022 \begin_inset Flex Code
19025 \begin_layout Plain Layout
19034 \begin_inset space \thinspace{}
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19047 ] Whether to use the content of the inset as the label, when the inset is
19052 \begin_layout Description
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19072 ] As with paragraph styles, see
19073 \begin_inset CommandInset ref
19075 reference "subsec:Paragraph-Styles"
19080 Note that you need to specify the complete type, e.
19081 \begin_inset space \thinspace{}
19085 \begin_inset space ~
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19093 CopyStyle Flex:<name>
19101 \begin_layout Description
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19112 \begin_inset Flex Code
19115 \begin_layout Plain Layout
19124 \begin_inset space \thinspace{}
19128 \begin_inset Flex Code
19131 \begin_layout Plain Layout
19137 ] Indicates whether the user may employ the Paragraph Settings dialog to
19138 customize the paragraph.
19141 \begin_layout Description
19142 \begin_inset Flex Code
19145 \begin_layout Plain Layout
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19172 \begin_inset Flex Code
19175 \begin_layout Plain Layout
19181 , describing the rendering style used for the inset's frame and buttons.
19182 Footnotes generally use
19183 \begin_inset Flex Code
19186 \begin_layout Plain Layout
19192 , ERT insets generally
19193 \begin_inset Flex Code
19196 \begin_layout Plain Layout
19202 , and character styles
19203 \begin_inset Flex Code
19206 \begin_layout Plain Layout
19215 \begin_layout Description
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19238 \begin_inset space \thinspace{}
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19256 \begin_inset Flex Code
19259 \begin_layout Plain Layout
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19276 Indicates whether the environment will stand on its own in the output or
19277 will appear inline with the surrounding text.
19278 If set to false, it is supposed that the \SpecialChar LaTeX
19279 environment ignores white space
19280 (including one newline character) after the
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19297 \begin_inset Flex Code
19300 \begin_layout Plain Layout
19314 \change_inserted 731793113 1538674858
19318 \begin_layout Description
19320 \change_inserted 731793113 1538674891
19321 \begin_inset Flex Code
19324 \begin_layout Plain Layout
19326 \change_inserted 731793113 1538674863
19338 ,1] Allow the contents of the inset to be edited externally (using whatever
19339 editor is defined for the document's output format).
19344 \begin_layout Description
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19354 Required at the end of the
19355 \begin_inset Flex Code
19358 \begin_layout Plain Layout
19367 \begin_layout Description
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19377 The font used for both the text body
19383 \begin_inset CommandInset ref
19385 reference "subsec:Font-description"
19390 Note that defining this font automatically defines the
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19400 to the same value, so define this first and define
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19410 later if you want them to be different.
19413 \begin_layout Description
19414 \begin_inset Flex Code
19417 \begin_layout Plain Layout
19418 FixedWidthPreambleEncoding
19424 \begin_inset Flex Code
19427 \begin_layout Plain Layout
19436 \begin_inset space \thinspace{}
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19449 ] Force a fixed width encoding for the translated contents of
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19469 code generated by this layout.
19470 This is needed for special \SpecialChar LaTeX
19475 that do not work with variable width encodings such as
19480 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19481 backends such as Xe\SpecialChar TeX
19483 Lua\SpecialChar TeX
19487 \begin_layout Description
19488 \begin_inset Flex Code
19491 \begin_layout Plain Layout
19492 ForceLocalFontSwitch
19498 \begin_inset Flex Code
19501 \begin_layout Plain Layout
19510 \begin_inset space \thinspace{}
19514 \begin_inset Flex Code
19517 \begin_layout Plain Layout
19523 ] When using babel, always use a local font switch (
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19535 ), never a global one (such as
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19550 \begin_layout Description
19551 \begin_inset Flex Code
19554 \begin_layout Plain Layout
19561 \begin_inset Flex Code
19564 \begin_layout Plain Layout
19573 \begin_inset space \thinspace{}
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19587 \begin_inset Quotes eld
19591 \begin_inset Quotes erd
19594 language, leading to Left-to-Right (Latin) output, e.
19595 \begin_inset space \thinspace{}
19599 \begin_inset space \space{}
19602 in \SpecialChar TeX
19607 \begin_layout Description
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19630 \begin_inset space \thinspace{}
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19643 ] Force a a line break in the \SpecialChar LaTeX
19644 output before the inset starts and after
19646 This assures the inset itself is output on its own lines, for parsing purposes.
19649 \begin_layout Description
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19672 \begin_inset space \thinspace{}
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19685 ] Indicates whether the
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19695 should be used or, instead, the user can change the paragraph style used
19700 \begin_layout Description
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19723 \begin_inset space \thinspace{}
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19736 ] As with paragraph styles, see
19737 \begin_inset CommandInset ref
19739 reference "subsec:Paragraph-Styles"
19746 \begin_layout Description
19747 \begin_inset Flex Code
19750 \begin_layout Plain Layout
19756 These tags control the XHTML output.
19758 \begin_inset CommandInset ref
19760 reference "sec:Tags-for-XHTML"
19767 \begin_layout Description
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19790 \begin_inset space \thinspace{}
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19803 ] Whether to include the contents of this inset in the strings generated
19804 for the `Outline' pane for all table of contents, regardless of the AddToToc
19806 One would not, for example, want the content of a footnote in a section
19807 header to be included in the TOC displayed in the outline, but one would
19808 normally want the content of a character style displayed.
19809 Default is false: not to include.
19812 \begin_layout Description
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19823 \begin_inset Flex Code
19826 \begin_layout Plain Layout
19835 \begin_inset space \thinspace{}
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19848 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19849 of its contents in its item in the table of contents.
19850 Otherwise, only the label appears.
19853 \begin_layout Description
19854 \begin_inset Flex Code
19857 \begin_layout Plain Layout
19866 \begin_inset Flex Code
19869 \begin_layout Plain Layout
19878 \begin_inset space \thinspace{}
19882 \begin_inset Flex Code
19885 \begin_layout Plain Layout
19891 ] As with paragraph styles, see
19892 \begin_inset CommandInset ref
19894 reference "subsec:Paragraph-Styles"
19901 \begin_layout Description
19902 \begin_inset Flex Code
19905 \begin_layout Plain Layout
19911 The font used for the label.
19913 \begin_inset CommandInset ref
19915 reference "subsec:Font-description"
19920 Note that this definition can never appear before
19921 \begin_inset Flex Code
19924 \begin_layout Plain Layout
19930 , lest it be ineffective.
19933 \begin_layout Description
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19954 \begin_inset Quotes erd
19958 \begin_inset Quotes erd
19961 ] What will be displayed on the button or elsewhere as the inset label.
19963 \begin_inset Flex Code
19966 \begin_layout Plain Layout
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19983 ) modify this label on the fly.
19986 \begin_layout Description
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19996 Language dependent preamble; see
19997 \begin_inset CommandInset ref
19999 reference "subsec:I18n"
20006 \begin_layout Description
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20026 ] The name of the corresponding \SpecialChar LaTeX
20028 Either the environment or command name.
20031 \begin_layout Description
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20051 ] The optional parameter for the corresponding
20052 \begin_inset Flex Code
20055 \begin_layout Plain Layout
20061 stuff, including possible bracket pairs like
20062 \begin_inset Flex Code
20065 \begin_layout Plain Layout
20072 This parameter cannot be changed from within \SpecialChar LyX
20074 \begin_inset Flex Code
20077 \begin_layout Plain Layout
20083 for customizable parameters).
20084 It will be output as is after all \SpecialChar LaTeX
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20098 \begin_layout Description
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20109 \begin_inset Flex Code
20112 \begin_layout Plain Layout
20113 Command, Environment, None
20118 ] How the style should be translated into \SpecialChar LaTeX
20123 \begin_layout Plain Layout
20124 \begin_inset Flex Code
20127 \begin_layout Plain Layout
20133 is perhaps a bit misleading, since these rules apply to SGML classes too.
20134 Visit the SGML class files for specific examples.
20143 \begin_layout Description
20144 \begin_inset Flex Code
20147 \begin_layout Plain Layout
20153 means nothing special
20156 \begin_layout Description
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20167 \begin_inset Flex Code
20170 \begin_layout Plain Layout
20177 {\SpecialChar ldots
20186 \begin_layout Description
20187 \begin_inset Flex Code
20190 \begin_layout Plain Layout
20197 \begin_inset Flex Code
20200 \begin_layout Plain Layout
20207 }\SpecialChar ldots
20222 \begin_layout Standard
20223 Putting the last few things together, the \SpecialChar LaTeX
20224 output will be either:
20227 \begin_layout LyX-Code
20230 LatexName[LatexParam]{\SpecialChar ldots
20234 \begin_layout Standard
20238 \begin_layout LyX-Code
20241 begin{LatexName}[LatexParam] \SpecialChar ldots
20247 \begin_layout Standard
20248 depending upon the \SpecialChar LaTeX
20253 \begin_layout Description
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20273 ] A string that is put at the beginning of the layout content.
20274 A line break in the output can be indicated by
20275 \begin_inset Flex Code
20278 \begin_layout Plain Layout
20287 \begin_layout Description
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20328 \begin_inset Flex Code
20331 \begin_layout Plain Layout
20337 (indicating a dummy definition ending definitions of charstyles, etc).
20338 This entry is required in and is only meaningful for Flex insets.
20339 Among other things, it determines on which menu this inset will appear.
20341 \begin_inset Flex Code
20344 \begin_layout Plain Layout
20351 \begin_inset Flex Code
20354 \begin_layout Plain Layout
20360 will automatically set
20361 \begin_inset Flex Code
20364 \begin_layout Plain Layout
20371 \begin_inset Flex Code
20374 \begin_layout Plain Layout
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20391 can be set to true, or
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20411 insets by setting it
20416 \begin_inset Flex Code
20419 \begin_layout Plain Layout
20426 \change_inserted -712698321 1555575738
20430 \begin_layout Description
20432 \change_inserted -712698321 1555575844
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20438 \change_inserted -712698321 1555575740
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20450 \change_inserted -712698321 1555575740
20456 A dedicated string for the menu.
20457 You can define an accelerator by appending the respective character to
20458 the string, divided by
20459 \begin_inset Quotes eld
20463 \begin_inset Quotes erd
20467 \begin_inset space \thinspace{}
20471 \begin_inset space \space{}
20475 \begin_inset Quotes eld
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20484 \change_inserted -712698321 1555575781
20491 \begin_inset Quotes erd
20495 This specification is optional.
20496 If it is not given the inset name as specified in the type declaration
20497 will be used instead for the menu.
20502 \begin_layout Description
20503 \begin_inset Flex Code
20506 \begin_layout Plain Layout
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20525 \begin_inset space \thinspace{}
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20538 ] Whether multiple paragraphs are permitted in this inset.
20540 \begin_inset Flex Code
20543 \begin_layout Plain Layout
20549 to the same value and
20550 \begin_inset Flex Code
20553 \begin_layout Plain Layout
20559 to the opposite value.
20560 These can be reset to other values, if they are used
20565 \begin_inset Flex Code
20568 \begin_layout Plain Layout
20578 \begin_layout Description
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20601 \begin_inset space \thinspace{}
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20614 ] Whether fragile commands in this inset should be
20615 \begin_inset Flex Code
20618 \begin_layout Plain Layout
20631 whether the command should itself be protected.) Default is false.
20632 \change_inserted -712698321 1523633958
20636 \begin_layout Description
20638 \change_inserted -712698321 1552395786
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20644 \change_inserted -712698321 1523633961
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20656 \change_inserted -712698321 1523633958
20665 \begin_inset space \thinspace{}
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20674 \change_inserted -712698321 1523633958
20680 ] This causes macros that contain this inset to be protected with
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20686 \change_inserted -712698321 1523634038
20701 ) if necessary and thus allows (some) verbatim stuff in macros.
20705 \begin_layout Description
20707 \change_inserted -712698321 1555579651
20708 \begin_inset Flex Code
20711 \begin_layout Plain Layout
20713 \change_inserted -712698321 1552395787
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20725 \change_inserted -712698321 1552395787
20734 \begin_inset space \thinspace{}
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20743 \change_inserted -712698321 1552395787
20749 ] Whether specific commands in this inset (such as
20750 \begin_inset Flex Code
20753 \begin_layout Plain Layout
20755 \change_inserted -712698321 1552395787
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20769 \change_inserted -712698321 1552395787
20777 ) should be protected in an
20778 \begin_inset Flex Code
20781 \begin_layout Plain Layout
20783 \change_inserted -712698321 1552395787
20792 This is particularly needed for insets that draw on
20800 commands which parse their content in complex ways.
20804 \begin_layout Description
20806 \change_inserted -712698321 1555579742
20807 \begin_inset Flex Code
20810 \begin_layout Plain Layout
20812 \change_inserted -712698321 1555579658
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20824 \change_inserted -712698321 1555579651
20830 Option to define a different command (from the default
20831 \begin_inset Flex Code
20834 \begin_layout Plain Layout
20836 \change_inserted -712698321 1555579742
20848 ) to be used for line breaks.
20849 The initial backslash must not be specified.
20854 \begin_layout Description
20855 \begin_inset Flex Code
20858 \begin_layout Plain Layout
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20874 ] Deletes an existing
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20887 \begin_layout Description
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20908 \begin_inset Flex Code
20911 \begin_layout Plain Layout
20917 that has replaced this
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20928 This is used to rename an
20929 \begin_inset Flex Code
20932 \begin_layout Plain Layout
20938 , while keeping backward compatibility.
20941 \begin_layout Description
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20964 \begin_inset space \thinspace{}
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20977 ] As with paragraph styles, see
20978 \begin_inset CommandInset ref
20980 reference "subsec:Paragraph-Styles"
20988 \begin_layout Description
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20999 \begin_inset Flex Code
21002 \begin_layout Plain Layout
21011 \begin_inset space \thinspace{}
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21024 ] As with paragraph styles, see
21025 \begin_inset CommandInset ref
21027 reference "subsec:Paragraph-Styles"
21035 \begin_layout Description
21036 \begin_inset Flex Code
21039 \begin_layout Plain Layout
21045 As with paragraph styles, see
21046 \begin_inset CommandInset ref
21048 reference "subsec:Paragraph-Styles"
21055 \begin_layout Description
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21075 ] The prefix to use when creating labels referring to insets of this type.
21076 This allows the use of formatted references.
21079 \begin_layout Description
21080 \begin_inset Flex Code
21083 \begin_layout Plain Layout
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21099 ] As with paragraph styles, see
21100 \begin_inset CommandInset ref
21102 reference "subsec:Paragraph-Styles"
21109 \begin_layout Description
21110 \begin_inset Flex Code
21113 \begin_layout Plain Layout
21120 \begin_inset Flex Code
21123 \begin_layout Plain Layout
21132 \begin_inset space \thinspace{}
21136 \begin_inset Flex Code
21139 \begin_layout Plain Layout
21145 ] Resets the \SpecialChar LaTeX
21146 arguments of this layout (as defined via the
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21157 This is useful if you have copied a style via
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21167 , but you do not want to inherit its (required and optional) arguments.
21170 \begin_layout Description
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21191 \begin_inset space \thinspace{}
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21206 ] Whether this inset should use the font of its surrounding environment
21208 Default is false: use the font of the surrounding environment.
21211 \begin_layout Description
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21222 \begin_inset Flex Code
21225 \begin_layout Plain Layout
21231 ] A string that is put at the end of the layout content.
21232 A line break in the output can be indicated by
21233 \begin_inset Flex Code
21236 \begin_layout Plain Layout
21245 \begin_layout Description
21246 \begin_inset Flex Code
21249 \begin_layout Plain Layout
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21266 \begin_inset space \thinspace{}
21270 \begin_inset Flex Code
21273 \begin_layout Plain Layout
21281 ] Allow spell-checking the contents of this inset.
21285 \begin_layout Subsection
21287 \begin_inset CommandInset label
21289 name "subsec:Counters"
21296 \begin_layout Standard
21297 It is necessary to define the counters (
21298 \begin_inset Flex Noun
21301 \begin_layout Plain Layout
21308 \begin_inset Flex Noun
21311 \begin_layout Plain Layout
21317 , \SpecialChar ldots
21318 ) in the text class itself.
21319 The standard counters are defined in the file
21320 \begin_inset Flex Code
21323 \begin_layout Plain Layout
21329 , so you may have to do no more than add
21332 \begin_layout LyX-Code
21333 Input stdcounters.inc
21336 \begin_layout Standard
21337 to your layout file to get them to work.
21338 But if you want to define custom counters, then you can do so.
21339 The counter declaration must begin with:
21342 \begin_layout LyX-Code
21343 Counter CounterName
21346 \begin_layout Standard
21348 \begin_inset Flex Code
21351 \begin_layout Plain Layout
21357 ' is replaced by the name of the counter.
21358 And it must end with
21359 \begin_inset Quotes eld
21363 \begin_inset Flex Code
21366 \begin_layout Plain Layout
21373 \begin_inset Quotes erd
21377 The following parameters can also be used:
21380 \begin_layout Description
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21391 \begin_inset Flex Code
21394 \begin_layout Plain Layout
21400 ] Sets the initial value for the counter, to which it will be reset whenever
21402 Normally, one will want the default, 1.
21405 \begin_layout Description
21406 \begin_inset Flex Code
21409 \begin_layout Plain Layout
21416 \begin_inset Flex Code
21419 \begin_layout Plain Layout
21426 \begin_inset Quotes erd
21430 \begin_inset Quotes erd
21433 ] When defined, this string defines how the counter is displayed.
21434 Setting this value sets
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21439 LabelStringAppendix
21445 The following special constructs can be used in the string:
21449 \begin_layout Itemize
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21461 will be replaced by the expansion of the
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21476 LabelStringAppendix
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21495 \begin_layout Itemize
21496 counter values can be expressed using \SpecialChar LaTeX
21498 \begin_inset Newline newline
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21537 \begin_layout Plain Layout
21547 Actually, the situation is a bit more complicated: any
21566 other than those described below will produce arabic numerals.
21567 It would not be surprising to see this change in the future.
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21582 : 1, 2, 3,\SpecialChar ldots
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21593 for lower-case letters: a, b, c, \SpecialChar ldots
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21604 for upper-case letters: A, B, C, \SpecialChar ldots
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21615 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21626 for upper-case roman numerals: I, II, III\SpecialChar ldots
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21637 for hebrew numerals.
21641 \begin_layout Standard
21642 If LabelString is not defined, a default value is constructed as follows:
21643 if the counter has a master counter
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21664 \begin_inset Newline newline
21668 \begin_inset Flex Code
21671 \begin_layout Plain Layout
21681 is used; otherwise the string
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21696 \begin_layout Description
21697 \begin_inset Flex Code
21700 \begin_layout Plain Layout
21701 LabelStringAppendix
21707 \begin_inset Flex Code
21710 \begin_layout Plain Layout
21717 \begin_inset Quotes erd
21721 \begin_inset Quotes erd
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21734 , but for use in the Appendix.
21737 \begin_layout Description
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21758 \begin_inset Quotes erd
21762 \begin_inset Quotes erd
21765 ] A format for use with formatted references to this counter.
21766 For example, one might want to have references to section numbers appear
21768 \begin_inset Quotes eld
21772 \begin_inset Quotes erd
21776 The string should contain
21777 \begin_inset Quotes eld
21781 \begin_inset Quotes erd
21785 This will be replaced by the counter number itself.
21786 So, for sections, it would be: Section ##.
21789 \begin_layout Description
21790 \begin_inset Flex Code
21793 \begin_layout Plain Layout
21800 \begin_inset Flex Code
21803 \begin_layout Plain Layout
21810 \begin_inset Quotes erd
21814 \begin_inset Quotes erd
21817 ] If this is set to the name of another counter, the present counter will
21818 be reset every time the other one is increased.
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21842 \begin_layout Subsection
21844 \begin_inset CommandInset label
21846 name "subsec:Font-description"
21853 \begin_layout Standard
21854 A font description looks like this:
21857 \begin_layout LyX-Code
21874 \begin_layout LyX-Code
21878 \begin_layout LyX-Code
21882 \begin_layout Standard
21883 The following commands are available:
21886 \begin_layout Description
21887 \begin_inset Flex Code
21890 \begin_layout Plain Layout
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21909 \begin_inset Flex Code
21912 \begin_layout Plain Layout
21919 \begin_inset Flex Code
21922 \begin_layout Plain Layout
21929 \begin_inset Flex Code
21932 \begin_layout Plain Layout
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21959 \begin_inset Flex Code
21962 \begin_layout Plain Layout
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21979 \begin_inset Flex Code
21982 \begin_layout Plain Layout
21989 \begin_inset Flex Code
21992 \begin_layout Plain Layout
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22019 \begin_inset Flex Code
22022 \begin_layout Plain Layout
22029 \begin_inset Flex Code
22032 \begin_layout Plain Layout
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22059 \begin_inset Flex Code
22062 \begin_layout Plain Layout
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22101 \begin_layout Description
22102 \begin_inset Flex Code
22105 \begin_layout Plain Layout
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22124 \begin_inset Flex Code
22127 \begin_layout Plain Layout
22134 \begin_inset Flex Code
22137 \begin_layout Plain Layout
22146 \begin_layout Description
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22166 ] Valid arguments are:
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22187 \begin_inset Flex Code
22190 \begin_layout Plain Layout
22197 \begin_inset Flex Code
22200 \begin_layout Plain Layout
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22217 \begin_inset Flex Code
22220 \begin_layout Plain Layout
22227 \begin_inset Flex Code
22230 \begin_layout Plain Layout
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22247 \begin_inset Flex Code
22250 \begin_layout Plain Layout
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22287 Each of these turns on or off the corresponding attribute.
22289 \begin_inset Flex Code
22292 \begin_layout Plain Layout
22298 turns on emphasis, and
22299 \begin_inset Flex Code
22302 \begin_layout Plain Layout
22310 \begin_inset Newline newline
22313 If the latter seems puzzling, remember that the font settings for the present
22314 context are generally inherited from the surrounding context.
22316 \begin_inset Flex Code
22319 \begin_layout Plain Layout
22325 would turn off the emphasis that was anyway in effect, say, in a theorem
22329 \begin_layout Description
22330 \begin_inset Flex Code
22333 \begin_layout Plain Layout
22340 \begin_inset Flex Code
22343 \begin_layout Plain Layout
22352 \begin_inset Flex Code
22355 \begin_layout Plain Layout
22364 \begin_layout Description
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22387 \begin_inset Flex Code
22390 \begin_layout Plain Layout
22397 \begin_inset Flex Code
22400 \begin_layout Plain Layout
22407 \begin_inset Flex Code
22410 \begin_layout Plain Layout
22419 \begin_layout Description
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22440 \begin_inset Flex Code
22443 \begin_layout Plain Layout
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22502 \begin_inset Flex Code
22505 \begin_layout Plain Layout
22514 \begin_layout Subsection
22515 \begin_inset CommandInset label
22517 name "subsec:Citation-engine-description"
22521 Cite engine description
22524 \begin_layout Standard
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22535 blocks, as used mainly in cite engine files (see
22536 \begin_inset CommandInset ref
22538 reference "subsec:Cite-Engine-Files"
22545 ), define the citation commands provided by a specific
22546 \begin_inset Quotes eld
22550 \begin_inset Quotes erd
22554 A cite engine, in \SpecialChar LyX
22555 terms, is way specific way to format citations, using
22556 numbers, author names and/or years.
22557 Currently, \SpecialChar LyX
22558 supports three such engine types, namely:
22561 \begin_layout Enumerate
22562 \begin_inset Flex Code
22565 \begin_layout Plain Layout
22571 : the default Bib\SpecialChar TeX
22572 way to format citations, a simple numeric style (e.
22573 \begin_inset space \thinspace{}
22577 \begin_inset Quotes eld
22581 \begin_inset Quotes erd
22587 \begin_layout Enumerate
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22597 : Harvard-styled citations using author names and publication year (e.
22598 \begin_inset space \thinspace{}
22602 \begin_inset Quotes eld
22605 Smith and Miller (2017b)
22606 \begin_inset Quotes erd
22612 \begin_layout Enumerate
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22622 : extended numerical citations that also allow for author or title next
22624 \begin_inset space \thinspace{}
22628 \begin_inset Quotes eld
22631 Smith and Miller [1]
22632 \begin_inset Quotes erd
22638 \begin_layout Standard
22639 \begin_inset Flex Code
22642 \begin_layout Plain Layout
22648 blocks look like this:
22651 \begin_layout LyX-Code
22655 \begin_layout LyX-Code
22659 \begin_layout LyX-Code
22663 \begin_layout LyX-Code
22664 citeyearpar[][]=parencite*
22667 \begin_layout LyX-Code
22671 \begin_layout LyX-Code
22675 \begin_layout Standard
22677 \begin_inset Flex Code
22680 \begin_layout Plain Layout
22686 denotes the engine.
22687 The individual lines respectively define a cite command or cite command
22688 paradigm supported by this engine.
22689 The line can be as simple as a cite command that is used both to name the
22690 respective \SpecialChar LyX
22691 command and the \SpecialChar LaTeX
22692 output or more complex in order to differentiate
22694 The full syntax is:
22697 \begin_layout LyX-Code
22698 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22701 \begin_layout Itemize
22702 \begin_inset Flex Code
22705 \begin_layout Plain Layout
22711 : The name as used in the
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22725 \begin_layout Standard
22726 For portability reasons, we try to use the same name for same-formatted
22727 commands in different cite packages (thus many names stem from natbib,
22728 and thus we need to differentiate a
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22738 sometimes, if the \SpecialChar LaTeX
22739 command names differ).
22743 \begin_layout Itemize
22744 \begin_inset Flex Code
22747 \begin_layout Plain Layout
22753 : a (comma-separated) list of commands that fall back to the given
22754 \begin_inset Flex Code
22757 \begin_layout Plain Layout
22763 in the current engine.
22764 This eases the switch of citation packages and engines.
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22776 \begin_inset Flex Code
22779 \begin_layout Plain Layout
22785 in layout definitions.
22788 \begin_layout Itemize
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22798 : The actual \SpecialChar LaTeX
22799 command that is output.
22803 \begin_layout Standard
22804 \begin_inset Flex Code
22807 \begin_layout Plain Layout
22814 \begin_inset Flex Code
22817 \begin_layout Plain Layout
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22844 will be output to \SpecialChar LaTeX
22848 \begin_layout Standard
22852 \begin_layout Itemize
22853 Capitalization indicates that the command also has a capitalized form (
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22867 \begin_inset Flex Code
22870 \begin_layout Plain Layout
22879 These usually enforce up-casing of name prefixes (
22884 \begin_inset Formula $\Rightarrow$
22894 \begin_layout Itemize
22896 \begin_inset Flex Code
22899 \begin_layout Plain Layout
22905 indicate the number of optional arguments (there can be 0–2).
22908 \begin_layout Itemize
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22919 indicates there is a starred version of the command (
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22933 \begin_inset Flex Code
22936 \begin_layout Plain Layout
22949 \begin_layout Standard
22950 By default, the starred version means: Output all authors even if it should
22952 \begin_inset Quotes eld
22956 \begin_inset Quotes erd
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22972 \begin_layout Standard
22973 If the star has a different meaning for a given command, it can be specified
22975 \begin_inset Flex Code
22978 \begin_layout Plain Layout
22979 <!_stardesc!_stardesctooltip>
22985 Maximal two translatable macro keywords, marked by the prefix
22986 \begin_inset Flex Code
22989 \begin_layout Plain Layout
22996 The first points to the string that replaces the
22997 \begin_inset Quotes eld
23001 \begin_inset Quotes erd
23004 checkbox label in the citation dialog, the second one to an optional tool
23005 tip for this checkbox.
23009 \begin_layout Standard
23010 Note that these two macros have to be defined in a
23011 \begin_inset Flex Code
23014 \begin_layout Plain Layout
23020 (see next section), dropping the
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23030 from the prefix, like this:
23033 \begin_layout LyX-Code
23034 _stardesc Sta&rred command label
23037 \begin_layout LyX-Code
23038 _stardesctooltip Tooltip for the starred command checkbox.
23042 \begin_layout Itemize
23044 \begin_inset Flex Code
23047 \begin_layout Plain Layout
23053 indicates that this command features
23054 \begin_inset Quotes eld
23057 qualified citation lists
23058 \begin_inset Quotes erd
23066 -specific feature for multi-reference citations where an individual pre-
23067 and postnote can be given to each reference in the list.
23068 Please refer to the
23072 manual for details.
23073 \change_inserted -712698321 1526898670
23077 \begin_layout Standard
23079 \change_inserted -712698321 1526899524
23080 If you want to add a cite command to a cite engine (e.
23081 \begin_inset space \thinspace{}
23084 g., add a specific command provided by a class), you can use
23085 \begin_inset Flex Code
23088 \begin_layout Plain Layout
23090 \change_inserted -712698321 1526898768
23091 AddToCiteEngine <engine type> \SpecialChar ldots
23100 Note that only cite commands that do not exist yet are added.
23105 \begin_layout Subsection
23106 \begin_inset CommandInset label
23108 name "subsec:Citation-format-description"
23112 Cite format description
23115 \begin_layout Standard
23117 \begin_inset Flex Code
23120 \begin_layout Plain Layout
23126 blocks are used to describe how bibliographic information should be displayed,
23127 both within \SpecialChar LyX
23128 itself (in the citation dialog and in tooltips, for example)
23129 and in XHTML output.
23130 Such a block might look like this:
23133 \begin_layout LyX-Code
23137 \begin_layout LyX-Code
23141 \begin_layout LyX-Code
23145 \begin_layout LyX-Code
23149 \begin_layout Standard
23153 \begin_layout LyX-Code
23157 \begin_layout LyX-Code
23161 \begin_layout LyX-Code
23165 \begin_layout LyX-Code
23169 \begin_layout Standard
23170 In the first case, the individual lines define how the bibliographic information
23171 associated with an article or book, respectively, is to be displayed, and
23172 such a definition can be given for any
23173 \begin_inset Quotes els
23177 \begin_inset Quotes ers
23180 that might be present in a Bib\SpecialChar TeX
23183 defines a default format in the source code that will be used if no specific
23184 definition has been given.
23186 predefines several formats in the file
23187 \begin_inset Flex Code
23190 \begin_layout Plain Layout
23196 , which is included in most of \SpecialChar LyX
23197 's document classes.
23200 \begin_layout Standard
23201 In the second case, the lines define how a specific citation command (in
23203 \begin_inset Flex Code
23206 \begin_layout Plain Layout
23215 \begin_inset Flex Code
23218 \begin_layout Plain Layout
23226 ) is to be displayed on the citation inset label, in the citation dialog,
23227 menu or XHTML output.
23229 defines such formats for the citation style variants it supports via
23231 Document\SpecialChar menuseparator
23232 Setting\SpecialChar menuseparator
23233 Bibliography\SpecialChar ldots
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23246 files that are shipped with \SpecialChar LyX
23248 \begin_inset CommandInset ref
23250 reference "subsec:Cite-Engine-Files"
23260 \begin_layout Standard
23261 The definitions use a simple language that allows Bib\SpecialChar TeX
23262 keys to be replaced
23264 Keys should be enclosed in
23265 \begin_inset Flex Code
23268 \begin_layout Plain Layout
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23285 So a simple definition might look like this:
23288 \begin_layout LyX-Code
23290 \begin_inset Quotes eld
23294 \begin_inset Quotes erd
23300 \begin_layout Standard
23301 This would print the author, followed by a comma, followed by the title,
23302 in quotes, followed by a period.
23305 \begin_layout Standard
23306 Of course, sometimes you may want to print a key only if it exists.
23307 This can be done by using a conditional construction, such as:
23308 \begin_inset Flex Code
23311 \begin_layout Plain Layout
23313 \begin_inset space ~
23323 \begin_inset Flex Code
23326 \begin_layout Plain Layout
23332 key exists, then print
23333 \begin_inset Quotes eld
23337 \begin_inset space ~
23341 \begin_inset Quotes erd
23344 followed by the volume key.
23345 It is also possible to have an else clause in the conditional, such as:
23346 \begin_inset Newline newline
23350 \begin_inset Flex Code
23353 \begin_layout Plain Layout
23354 {%author%[[%author%]][[%editor%, ed.]]}
23360 \begin_inset Newline newline
23364 \begin_inset Flex Code
23367 \begin_layout Plain Layout
23373 key is printed if it exists; otherwise, the editor key is printed, followed
23375 \begin_inset Quotes eld
23379 \begin_inset space ~
23383 \begin_inset Quotes erd
23386 Note that the key is again enclosed in
23387 \begin_inset Flex Code
23390 \begin_layout Plain Layout
23396 signs; the entire conditional is enclosed in braces; and the if and else
23397 clauses are enclosed in double brackets,
23398 \begin_inset Quotes eld
23402 \begin_inset Flex Code
23405 \begin_layout Plain Layout
23412 \begin_inset Quotes eld
23416 \begin_inset Quotes eld
23420 \begin_inset Flex Code
23423 \begin_layout Plain Layout
23430 \begin_inset Quotes erd
23434 There must be no space between any of these.
23437 \begin_layout Standard
23438 Next to the entry keys, there are some special keys that can be used for
23439 these conditionals:
23442 \begin_layout Itemize
23443 \begin_inset Flex Code
23446 \begin_layout Plain Layout
23447 {%dialog%[[true]][[false]]}
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23460 part for dialogs and menus, the
23461 \begin_inset Quotes eld
23465 \begin_inset Quotes erd
23468 part for other contexts (workarea, export)
23471 \begin_layout Itemize
23472 \begin_inset Flex Code
23475 \begin_layout Plain Layout
23476 {%export%[[true]][[false]]}
23482 \begin_inset Quotes eld
23486 \begin_inset Quotes erd
23489 part for export and menus, the
23490 \begin_inset Quotes eld
23494 \begin_inset Quotes erd
23497 part for other contexts (workarea, dialog)
23500 \begin_layout Itemize
23501 \begin_inset Flex Code
23504 \begin_layout Plain Layout
23511 \begin_inset Quotes eld
23515 \begin_inset Quotes erd
23518 part if another item follows (e.
23519 \begin_inset space \thinspace{}
23522 g., in a citation with multiple keys)
23525 \begin_layout Itemize
23526 \begin_inset Flex Code
23529 \begin_layout Plain Layout
23530 {%second%[[true]][[false]]}
23536 \begin_inset Quotes eld
23540 \begin_inset Quotes erd
23543 if this is the second of multiple items, else the
23544 \begin_inset Quotes eld
23548 \begin_inset Quotes erd
23554 \begin_layout Itemize
23555 \begin_inset Flex Code
23558 \begin_layout Plain Layout
23559 {%ifstar%[[true]][[false]]}
23565 \begin_inset Quotes eld
23569 \begin_inset Quotes erd
23572 part for starred citation commands (such as
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23584 ), the false part for unstarred
23587 \begin_layout Itemize
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23592 {%ifentrytype:<type>%[[true]][[false]]}
23598 \begin_inset Quotes eld
23602 \begin_inset Quotes erd
23605 if the current entry type matches
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23615 , else the false part (e.g., in a citation definition:
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23620 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23628 \begin_layout Itemize
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23633 {%ifmultiple:<authortype>%[[true]][[false]]}
23639 \begin_inset Quotes eld
23643 \begin_inset Quotes erd
23646 if the current author type (author, editor etc.) has multiple authors, else
23647 the false part (e.g., in a bibliography definition:
23648 \begin_inset Flex Code
23651 \begin_layout Plain Layout
23652 {%ifmultiple:editor%[[eds.]][[ed.]]}
23660 \begin_layout Itemize
23661 \begin_inset Flex Code
23664 \begin_layout Plain Layout
23665 {%ifqualified%[[true]][[false]]}
23671 \begin_inset Quotes eld
23675 \begin_inset Quotes erd
23678 part if the current citation is a qualified citation list (a specific
23682 format for multi-reference citations), the false part if this is not the
23686 \begin_layout Standard
23688 \begin_inset Flex Code
23691 \begin_layout Plain Layout
23697 prints the author key as it is recorded in the bibliography file.
23698 This might not be what you want, since it will result in a string such
23700 \begin_inset Quotes eld
23703 Miller, Peter and Smith, Mary and White, Jane
23704 \begin_inset Quotes erd
23708 \begin_inset Quotes eld
23712 \begin_inset Quotes erd
23715 is used by Bib\SpecialChar TeX
23716 to delimit authors).
23718 therefore provides some methods to get properly formatted name lists (which
23719 will also get translated).
23720 The following keys are provided:
23723 \begin_layout Enumerate
23724 For name lists with pre- and surname, suitable for the main authors/editors
23725 of a bibliography item.
23727 \begin_inset Flex Code
23730 \begin_layout Plain Layout
23736 part denotes the kind of list that is requested (e.g.
23738 \begin_inset Flex Code
23741 \begin_layout Plain Layout
23751 \begin_layout Itemize
23752 \begin_inset Flex Code
23755 \begin_layout Plain Layout
23756 %abbrvnames:<nametype>%
23761 : Provides a name list which is abbreviated (with
23762 \begin_inset Quotes eld
23766 \begin_inset Quotes erd
23770 \begin_inset Flex Code
23773 \begin_layout Plain Layout
23782 \begin_layout Itemize
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23787 %fullnames:<nametype>%
23792 : Provides a full name list (never abbreviated with
23793 \begin_inset Quotes eld
23797 \begin_inset Quotes erd
23803 \begin_layout Itemize
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23808 %forceabbrvnames:<nametype>%
23813 : Provides a name list which is always abbreviated (with
23814 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23835 \begin_layout Enumerate
23836 Alternative name lists with pre- and surname, if the order of pre- and surname
23837 inside the bibliography item differs (as in:
23838 \begin_inset Quotes eld
23841 Miller, John: Some text, in: Mary Smith, ed.: A volume
23842 \begin_inset Quotes erd
23849 \begin_layout Itemize
23850 \begin_inset Flex Code
23853 \begin_layout Plain Layout
23854 %abbrvbynames:<nametype>%
23859 : Provides a name list which is abbreviated (with
23860 \begin_inset Quotes eld
23864 \begin_inset Quotes erd
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23880 \begin_layout Itemize
23881 \begin_inset Flex Code
23884 \begin_layout Plain Layout
23885 %fullbynames:<nametype>%
23890 : Provides a full name list (never abbreviated with
23891 \begin_inset Quotes eld
23895 \begin_inset Quotes erd
23901 \begin_layout Itemize
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23906 %forceabbrvbynames:<nametype>%
23911 : Provides a name list which is always abbreviated (with
23912 \begin_inset Quotes eld
23916 \begin_inset Quotes erd
23920 \begin_inset Flex Code
23923 \begin_layout Plain Layout
23933 \begin_layout Enumerate
23934 And finally name lists which consist of family names only, as used in author-yea
23936 These do not take a
23937 \begin_inset Flex Code
23940 \begin_layout Plain Layout
23946 part, but always return either an author list or, if this does not exist,
23947 an editor list (as common in author-year labels):
23951 \begin_layout Itemize
23952 \begin_inset Flex Code
23955 \begin_layout Plain Layout
23961 : Provides a name list which is abbreviated (with
23962 \begin_inset Quotes eld
23966 \begin_inset Quotes erd
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23982 \begin_layout Itemize
23983 \begin_inset Flex Code
23986 \begin_layout Plain Layout
23992 : Provides a full name list (never abbreviated with
23993 \begin_inset Quotes eld
23997 \begin_inset Quotes erd
24003 \begin_layout Itemize
24004 \begin_inset Flex Code
24007 \begin_layout Plain Layout
24008 %forceabbrvciteauthor%
24013 : Provides a name list which is always abbreviated (with
24014 \begin_inset Quotes eld
24018 \begin_inset Quotes erd
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24035 \begin_layout Standard
24036 The order of pre- and surname in the former two lists can be adjusted by
24040 \begin_layout Itemize
24041 \begin_inset Flex Code
24044 \begin_layout Plain Layout
24045 !firstnameform %surname%, %prename%
24050 (first author in lists of type 1)
24053 \begin_layout Itemize
24054 \begin_inset Flex Code
24057 \begin_layout Plain Layout
24058 !othernameform %surname%, %prename%
24063 (other authors in lists of type 1)
24066 \begin_layout Itemize
24067 \begin_inset Flex Code
24070 \begin_layout Plain Layout
24071 !firstbynameform %prename% %surname%
24076 (first author in lists of type 2)
24079 \begin_layout Itemize
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24084 !otherbynameform %prename% %surname%
24089 (other authors in lists of type 2)
24092 \begin_layout Standard
24093 This allows you to configure namings like
24094 \begin_inset Quotes eld
24097 Miller, Peter and Mary Smith: \SpecialChar ldots
24098 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24100 \begin_inset Quotes erd
24106 \begin_layout Standard
24107 There is one other piece of syntax available in definitions, which looks
24109 \begin_inset Flex Code
24112 \begin_layout Plain Layout
24119 This defines a piece of formatting information that is to be used when
24121 \begin_inset Quotes eld
24125 \begin_inset Quotes erd
24129 Obviously, we do not want to output HTML tags when writing plain text,
24130 so they should be wrapped in
24131 \begin_inset Quotes eld
24135 \begin_inset Quotes erd
24139 \begin_inset Quotes eld
24143 \begin_inset Quotes erd
24149 \begin_layout Standard
24150 Two special sorts of definitions are also possible in a
24151 \begin_inset Flex Code
24154 \begin_layout Plain Layout
24161 An example of the first would be:
24164 \begin_layout LyX-Code
24166 \begin_inset Quotes eld
24170 \begin_inset Quotes erd
24176 \begin_layout Standard
24177 This is an abbreviation, or macro, and it can be used by treating it as
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24200 exactly as it would treat its definition.
24201 So, let us issue the obvious
24209 \begin_layout LyX-Code
24213 \begin_layout Standard
24214 or anything like it.
24216 shouldn't go into an infinite loop, but it may go into a long one before
24220 \begin_layout Standard
24221 The second sort of special definition might look like this:
24224 \begin_layout LyX-Code
24228 \begin_layout Standard
24229 This defines a translatable piece of text, which allows relevant parts of
24230 the bibliography or citation to be translated.
24231 It can be included in a definition by treating it as a key:
24232 \begin_inset Flex Code
24235 \begin_layout Plain Layout
24242 Note that there are two different translation paths: All definitions starting
24244 \begin_inset Flex Code
24247 \begin_layout Plain Layout
24253 , such as in the example above, will be translated to the currently active
24254 buffer language (so the translation will match the generated document).
24255 All definitions starting with underscore only will be translated to the
24257 This is the proper translation for strings that only occur in the dialogs
24258 or on buttons, such as this one:
24261 \begin_layout LyX-Code
24262 _addtobib Add to bibliography only.
24265 \begin_layout Standard
24266 Several of these translatable strings are predefined in
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24277 \begin_inset Flex Code
24280 \begin_layout Plain Layout
24287 Note that these are not macros, in the sense just defined.
24288 They will not be expanded.
24291 \begin_layout Standard
24292 So here then is an example that uses several of these features:
24293 \begin_inset VSpace defskip
24299 \begin_layout Standard
24303 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24306 \begin_layout Standard
24307 \begin_inset VSpace defskip
24310 This defines a macro that prints the author, followed by a comma, if the
24312 \begin_inset Flex Code
24315 \begin_layout Plain Layout
24321 key is defined, or else prints the name of the editor, followed by the
24323 \begin_inset Flex Code
24326 \begin_layout Plain Layout
24332 or its translation (it is by default
24333 \begin_inset Quotes eld
24337 \begin_inset Quotes erd
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24351 Note that this is in fact defined in
24352 \begin_inset Flex Code
24355 \begin_layout Plain Layout
24361 , so you can use it in your own definitions, or re-definitions, if you load
24365 \begin_layout Section
24366 \begin_inset CommandInset label
24368 name "sec:Tags-for-XHTML"
24372 Tags for XHTML output
24375 \begin_layout Standard
24376 As with \SpecialChar LaTeX
24377 or DocBook, the format of \SpecialChar LyX
24378 's XHTML output is also controlled by
24379 layout information.
24380 In general, \SpecialChar LyX
24381 provides sensible defaults and, as mentioned earlier, it will
24382 even construct default CSS style rules from the other layout tags.
24383 For example, \SpecialChar LyX
24384 will attempt to use the information provided in the
24385 \begin_inset Flex Code
24388 \begin_layout Plain Layout
24394 declaration for the Chapter style to write CSS that will appropriately
24395 format chapter headings.
24398 \begin_layout Standard
24399 In many cases, then, you may not have to do anything at all to get acceptable
24400 XHTML output for your own environments, custom insets, and so forth.
24401 But in some cases you will, and so \SpecialChar LyX
24402 provides a number of layout tags that
24403 can be used to customize the XHTML and CSS that are generated.
24406 \begin_layout Standard
24407 Note that there are two tags,
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24418 \begin_inset Flex Code
24421 \begin_layout Plain Layout
24427 that may appear outside style and inset declarations.
24429 \begin_inset CommandInset ref
24431 reference "subsec:General-text-class"
24435 for details on these.
24438 \begin_layout Subsection
24439 \begin_inset CommandInset label
24441 name "subsec:Paragraph-Style-XHTML"
24448 \begin_layout Standard
24449 The sort of XHTML \SpecialChar LyX
24450 outputs for a paragraph depends upon whether we are dealing
24451 with a normal paragraph, a command, or an environment, where this is itself
24452 determined by the contents of the corresponding
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24467 \begin_layout Standard
24468 For a command or normal paragraph, the output XHTML has the following form:
24471 \begin_layout LyX-Code
24475 \begin_inset Quotes erd
24479 \begin_inset Quotes erd
24485 \begin_layout LyX-Code
24489 \begin_inset Quotes erd
24493 \begin_inset Quotes erd
24499 \begin_layout LyX-Code
24502 Contents of the paragraph.
24505 \begin_layout LyX-Code
24511 \begin_layout Standard
24512 The label tags are of course omitted if the paragraph does not have a label.
24515 \begin_layout Standard
24516 For an environment that is not some sort of list, the XHTML takes this form:
24519 \begin_layout LyX-Code
24523 \begin_inset Quotes erd
24527 \begin_inset Quotes erd
24533 \begin_layout LyX-Code
24537 \begin_inset Quotes erd
24541 \begin_inset Quotes erd
24545 \begin_inset Quotes erd
24549 \begin_inset Quotes erd
24552 >Environment Label</labeltag>First paragraph.</itemtag>
24555 \begin_layout LyX-Code
24558 <itemtag>Second paragraph.</itemtag>
24561 \begin_layout LyX-Code
24567 \begin_layout Standard
24568 Note that the label is output only for the first paragraph, as it should
24569 be for a theorem, for example.
24573 \begin_layout Standard
24574 For a list, we have one of these forms:
24577 \begin_layout LyX-Code
24581 \begin_inset Quotes erd
24585 \begin_inset Quotes erd
24591 \begin_layout LyX-Code
24595 \begin_inset Quotes erd
24599 \begin_inset Quotes erd
24603 \begin_inset Quotes erd
24607 \begin_inset Quotes erd
24610 >List Label</labeltag>First item.</itemtag>
24613 \begin_layout LyX-Code
24617 \begin_inset Quotes erd
24621 \begin_inset Quotes erd
24625 \begin_inset Quotes erd
24629 \begin_inset Quotes erd
24632 >List Label</labeltag>Second item.</itemtag>
24635 \begin_layout LyX-Code
24641 \begin_layout LyX-Code
24645 \begin_layout LyX-Code
24649 \begin_inset Quotes erd
24653 \begin_inset Quotes erd
24659 \begin_layout LyX-Code
24663 \begin_inset Quotes erd
24667 \begin_inset Quotes erd
24670 >List Label</labeltag><itemtag attr=
24671 \begin_inset Quotes erd
24675 \begin_inset Quotes erd
24678 >First item.</itemtag>
24681 \begin_layout LyX-Code
24685 \begin_inset Quotes erd
24689 \begin_inset Quotes erd
24692 >List Label</labeltag><itemtag attr=
24693 \begin_inset Quotes erd
24697 \begin_inset Quotes erd
24700 >Second item.</itemtag>
24703 \begin_layout LyX-Code
24709 \begin_layout Standard
24710 Note the different orders of
24711 \begin_inset Flex Code
24714 \begin_layout Plain Layout
24721 \begin_inset Flex Code
24724 \begin_layout Plain Layout
24731 Which order we get depends upon the setting of
24732 \begin_inset Flex Code
24735 \begin_layout Plain Layout
24742 \begin_inset Flex Code
24745 \begin_layout Plain Layout
24751 is false (the default), you get the first of these, with the label within
24752 the item; if true, you get the second, with the label outside the item.
24755 \begin_layout Standard
24756 The specific tags and attributes output for each paragraph type can be controlle
24757 d by means of the layout tags we are about to describe.
24758 As mentioned earlier, however, \SpecialChar LyX
24759 uses sensible defaults for many of these,
24760 so you often may not need to do very much to get good XHTML output.
24761 Think of the available tags as there so you can tweak things to your liking.
24764 \begin_layout Description
24765 \begin_inset Flex Code
24768 \begin_layout Plain Layout
24775 \begin_inset Flex Code
24778 \begin_layout Plain Layout
24784 ] Specifies attribute information to be output with the main tag.
24786 \begin_inset Quotes eld
24790 \begin_inset Flex Code
24793 \begin_layout Plain Layout
24800 \begin_inset Quotes erd
24804 By default, \SpecialChar LyX
24806 \begin_inset Quotes eld
24810 \begin_inset Flex Code
24813 \begin_layout Plain Layout
24820 \begin_inset Quotes erd
24824 \begin_inset Flex Code
24827 \begin_layout Plain Layout
24833 is the \SpecialChar LyX
24834 name of the layout, made lowercase, for example: chapter.
24839 contain any style information.
24841 \begin_inset Flex Code
24844 \begin_layout Plain Layout
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
24903 \begin_inset Flex Code
24906 \begin_layout Plain Layout
24915 \begin_layout Description
24916 \begin_inset Flex Code
24919 \begin_layout Plain Layout
24926 \begin_inset Flex Code
24929 \begin_layout Plain Layout
24935 ] The tag to be used for individual paragraphs of environments, replacing
24937 \begin_inset Flex Code
24940 \begin_layout Plain Layout
24946 in the examples above.
24948 \begin_inset Flex Code
24951 \begin_layout Plain Layout
24960 \begin_layout Description
24961 \begin_inset Flex Code
24964 \begin_layout Plain Layout
24971 \begin_inset Flex Code
24974 \begin_layout Plain Layout
24980 ] Attributes for the item tag.
24982 \begin_inset Newline newline
24986 \begin_inset Quotes eld
24990 \begin_inset Flex Code
24993 \begin_layout Plain Layout
24994 class=`layoutname_item'
25000 \begin_inset Quotes erd
25008 contain any style information.
25010 \begin_inset Flex Code
25013 \begin_layout Plain Layout
25022 \begin_layout Description
25023 \begin_inset Flex Code
25026 \begin_layout Plain Layout
25033 \begin_inset Flex Code
25036 \begin_layout Plain Layout
25042 ] The tag to be used for paragraph and item labels, replacing
25043 \begin_inset Flex Code
25046 \begin_layout Plain Layout
25052 in the examples above.
25054 \begin_inset Flex Code
25057 \begin_layout Plain Layout
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25074 \begin_inset Flex Code
25077 \begin_layout Plain Layout
25084 \begin_inset Flex Code
25087 \begin_layout Plain Layout
25088 Centered_Top_Environment
25093 , in which case it defaults to
25094 \begin_inset Flex Code
25097 \begin_layout Plain Layout
25106 \begin_layout Description
25107 \begin_inset Flex Code
25110 \begin_layout Plain Layout
25117 \begin_inset Flex Code
25120 \begin_layout Plain Layout
25126 ] Attributes for the label tag.
25128 \begin_inset Newline newline
25132 \begin_inset Quotes eld
25136 \begin_inset Flex Code
25139 \begin_layout Plain Layout
25140 class=`layoutname_label'
25146 \begin_inset Quotes erd
25154 contain any style information.
25156 \begin_inset Flex Code
25159 \begin_layout Plain Layout
25168 \begin_layout Description
25169 \begin_inset Flex Code
25172 \begin_layout Plain Layout
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25192 ] Meaningful only for list-like environments, this tag controls whether
25193 the label tag is output before or inside the item tag.
25194 This is used, for example, in the description environment, where we want
25196 \begin_inset Flex Code
25199 \begin_layout Plain Layout
25200 <dt>\SpecialChar ldots
25201 </dt><dd>\SpecialChar ldots
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25218 : The label tag is output inside the item tag.
25221 \begin_layout Description
25222 \begin_inset Flex Code
25225 \begin_layout Plain Layout
25231 Information to be output in the
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25241 section when this style is used.
25242 This might, for example, be used to include a
25243 \begin_inset Flex Code
25246 \begin_layout Plain Layout
25253 \begin_inset Flex Code
25256 \begin_layout Plain Layout
25265 \begin_layout Description
25266 \begin_inset Flex Code
25269 \begin_layout Plain Layout
25275 CSS style information to be included when this style is used.
25276 Note that this will automatically be wrapped in a layout-generated
25277 \begin_inset Flex Code
25280 \begin_layout Plain Layout
25286 block, so only the CSS itself need be included.
25288 \begin_inset Flex Code
25291 \begin_layout Plain Layout
25300 \begin_layout Description
25301 \begin_inset Flex Code
25304 \begin_layout Plain Layout
25311 \begin_inset Flex Code
25314 \begin_layout Plain Layout
25320 ] The tag to be used for the main label, replacing
25321 \begin_inset Flex Code
25324 \begin_layout Plain Layout
25330 in the examples above.
25332 \begin_inset Flex Code
25335 \begin_layout Plain Layout
25344 \begin_layout Description
25345 \begin_inset Flex Code
25348 \begin_layout Plain Layout
25355 \begin_inset Flex Code
25358 \begin_layout Plain Layout
25368 ] Marks this style as the one to be used to generate the
25369 \begin_inset Flex Code
25372 \begin_layout Plain Layout
25378 tag for the XHTML file.
25379 By default, it is false.
25381 \begin_inset Flex Code
25384 \begin_layout Plain Layout
25390 file sets it to true for the
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25404 \begin_layout Subsection
25408 \begin_layout Standard
25409 The XHTML output of insets can also be controlled by information in layout
25414 \begin_layout Plain Layout
25415 At present, this is true only for
25416 \begin_inset Quotes eld
25420 \begin_inset Quotes erd
25423 insets (insets you can type into) and is not true for
25424 \begin_inset Quotes eld
25428 \begin_inset Quotes erd
25431 insets (insets that are associated with dialog boxes).
25436 Here, too, \SpecialChar LyX
25437 tries to provide sensible defaults, and it constructs default
25439 But everything can be customized.
25442 \begin_layout Standard
25443 The XHTML \SpecialChar LyX
25444 outputs for an inset has the following form:
25447 \begin_layout LyX-Code
25449 \begin_inset Quotes erd
25453 \begin_inset Quotes erd
25459 \begin_layout LyX-Code
25460 <labeltag>Label</labeltag>
25463 \begin_layout LyX-Code
25465 \begin_inset Quotes erd
25469 \begin_inset Quotes erd
25472 >Contents of the inset.</innertag>
25475 \begin_layout LyX-Code
25479 \begin_layout Standard
25480 If the inset permits multiple paragraphs—that is, if
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25490 is true—then the contents of the inset will itself be output as paragraphs
25491 formatted according to the styles used for those paragraphs (standard,
25492 quote, and the like).
25493 The label tag is of course omitted if the paragraph does not have a label
25494 and, at present, is always
25495 \begin_inset Flex Code
25498 \begin_layout Plain Layout
25505 The inner tag is optional and, by default, does not appear.
25508 \begin_layout Standard
25509 The specific tags and attributes output for each inset can be controlled
25510 by means of the following layout tags.
25513 \begin_layout Description
25514 \begin_inset Flex Code
25517 \begin_layout Plain Layout
25524 \begin_inset Flex Code
25527 \begin_layout Plain Layout
25533 ] Specifies attribute information to be output with the main tag.
25535 \begin_inset Quotes eld
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25543 class=`myinset' onclick=`\SpecialChar ldots
25550 \begin_inset Quotes erd
25554 By default, \SpecialChar LyX
25556 \begin_inset Quotes eld
25560 \begin_inset Flex Code
25563 \begin_layout Plain Layout
25570 \begin_inset Quotes erd
25574 \begin_inset Flex Code
25577 \begin_layout Plain Layout
25583 is the \SpecialChar LyX
25584 name of the inset, made lowercase and with non-alphanumeric characters
25585 converted to underscores, for example: footnote.
25588 \begin_layout Description
25589 \begin_inset Flex Code
25592 \begin_layout Plain Layout
25599 \begin_inset Flex Code
25602 \begin_layout Plain Layout
25612 ] Whether to output the default CSS information \SpecialChar LyX
25613 generates for this layout,
25614 even if additional information is explicitly provided via
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25626 \begin_inset Flex Code
25629 \begin_layout Plain Layout
25635 allows you to alter or augment the generated CSS, rather than to override
25640 \begin_layout Description
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25651 \begin_inset Flex Code
25654 \begin_layout Plain Layout
25660 ] Attributes for the inner tag.
25662 \begin_inset Newline newline
25666 \begin_inset Quotes eld
25670 \begin_inset Flex Code
25673 \begin_layout Plain Layout
25674 class=`insetname_inner'
25680 \begin_inset Quotes erd
25686 \begin_layout Description
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25697 \begin_inset Flex Code
25700 \begin_layout Plain Layout
25706 ] The inner tag, replacing
25707 \begin_inset Flex Code
25710 \begin_layout Plain Layout
25716 in the examples above.
25717 By default, there is none.
25720 \begin_layout Description
25721 \begin_inset Flex Code
25724 \begin_layout Plain Layout
25731 \begin_inset Flex Code
25734 \begin_layout Plain Layout
25742 ] Whether this inset represents a standalone block of text (such as a footnote)
25743 or instead represents material that is included in the surrounding text
25744 (such as a branch).
25748 \begin_layout Description
25749 \begin_inset Flex Code
25752 \begin_layout Plain Layout
25759 \begin_inset Flex Code
25762 \begin_layout Plain Layout
25768 ] A label for this inset, possibly including a reference to a counter.
25769 For example, for footnote, it might be:
25770 \begin_inset Flex Code
25773 \begin_layout Plain Layout
25782 This is optional, and there is no default.
25785 \begin_layout Description
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25795 Information to be output in the
25796 \begin_inset Flex Code
25799 \begin_layout Plain Layout
25805 section when this style is used.
25806 This might, for example, be used to include a
25807 \begin_inset Flex Code
25810 \begin_layout Plain Layout
25817 \begin_inset Flex Code
25820 \begin_layout Plain Layout
25829 \begin_layout Description
25830 \begin_inset Flex Code
25833 \begin_layout Plain Layout
25839 CSS style information to be included when this style is used.
25840 Note that this will automatically be wrapped in a layout-generated
25841 \begin_inset Flex Code
25844 \begin_layout Plain Layout
25850 block, so only the CSS itself need be included.
25853 \begin_layout Description
25854 \begin_inset Flex Code
25857 \begin_layout Plain Layout
25864 \begin_inset Flex Code
25867 \begin_layout Plain Layout
25873 ] The tag to be used for the main label, replacing
25874 \begin_inset Flex Code
25877 \begin_layout Plain Layout
25883 in the examples above.
25884 The default depends upon the setting of
25885 \begin_inset Flex Code
25888 \begin_layout Plain Layout
25895 \begin_inset Flex Code
25898 \begin_layout Plain Layout
25904 is true, the default is
25905 \begin_inset Flex Code
25908 \begin_layout Plain Layout
25914 ; if it is false, the default is
25915 \begin_inset Flex Code
25918 \begin_layout Plain Layout
25927 \begin_layout Subsection
25931 \begin_layout Standard
25932 The XHTML output for floats too can be controlled by layout information.
25933 The output has the following form:
25936 \begin_layout LyX-Code
25938 \begin_inset Quotes erd
25942 \begin_inset Quotes erd
25948 \begin_layout LyX-Code
25949 Contents of the float.
25952 \begin_layout LyX-Code
25956 \begin_layout Standard
25957 The caption, if there is one, is a separate inset and will be output as
25959 Its appearance can be controlled via the InsetLayout for caption insets.
25963 \begin_layout Description
25964 \begin_inset Flex Code
25967 \begin_layout Plain Layout
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25983 ] Specifies attribute information to be output with the main tag.
25985 \begin_inset Quotes eld
25989 \begin_inset Flex Code
25992 \begin_layout Plain Layout
25993 class=`myfloat' onclick=`\SpecialChar ldots
26000 \begin_inset Quotes erd
26004 By default, \SpecialChar LyX
26006 \begin_inset Quotes eld
26010 \begin_inset Flex Code
26013 \begin_layout Plain Layout
26014 class=`float float-floattype'
26020 \begin_inset Quotes erd
26024 \begin_inset Flex Code
26027 \begin_layout Plain Layout
26033 is \SpecialChar LyX
26034 's name for this type of float, as determined by the float declaration
26036 \begin_inset CommandInset ref
26038 reference "subsec:Floats"
26042 ), though made lowercase and with non-alphanumeric characters converted
26043 to underscores, for example: float-table.
26046 \begin_layout Description
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26056 CSS style information to be included when this float is used.
26057 Note that this will automatically be wrapped in a layout-generated
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26067 block, so only the CSS itself need be included.
26070 \begin_layout Description
26071 \begin_inset Flex Code
26074 \begin_layout Plain Layout
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26090 ] The tag to be used for this float, replacing
26091 \begin_inset Quotes eld
26095 \begin_inset Flex Code
26098 \begin_layout Plain Layout
26105 \begin_inset Quotes erd
26108 in the example above.
26110 \begin_inset Flex Code
26113 \begin_layout Plain Layout
26119 and will rarely need changing.
26122 \begin_layout Subsection
26123 Bibliography formatting
26126 \begin_layout Standard
26127 The bibliography can be formatted using
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26139 \begin_inset CommandInset ref
26141 reference "subsec:Citation-format-description"
26148 \begin_layout Subsection
26153 \begin_layout Standard
26154 We have several times mentioned that \SpecialChar LyX
26155 will generate default CSS style rules
26156 for both insets and paragraph styles, based upon the other layout information
26158 In this section, we shall say a word about which layout information \SpecialChar LyX
26163 \begin_layout Standard
26164 At present, \SpecialChar LyX
26165 auto-generates CSS only for font information, making use of
26167 \begin_inset Flex Code
26170 \begin_layout Plain Layout
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26187 \begin_inset Flex Code
26190 \begin_layout Plain Layout
26197 \begin_inset Flex Code
26200 \begin_layout Plain Layout
26207 \begin_inset Flex Code
26210 \begin_layout Plain Layout
26217 \begin_inset CommandInset ref
26219 reference "subsec:Font-description"
26224 The translation is mostly straightforward and obvious.
26226 \begin_inset Quotes eld
26230 \begin_inset Flex Code
26233 \begin_layout Plain Layout
26240 \begin_inset Quotes erd
26244 \begin_inset Quotes eld
26248 \begin_inset Flex Code
26251 \begin_layout Plain Layout
26252 font-family: sans-serif;
26258 \begin_inset Quotes erd
26262 The correspondence of \SpecialChar LyX
26263 sizes and CSS sizes is a little less obvious but
26264 nonetheless intuitive.
26266 \begin_inset Flex Code
26269 \begin_layout Plain Layout
26276 \begin_inset Flex URL
26279 \begin_layout Plain Layout
26289 \begin_layout Chapter
26290 Including External Material
26291 \begin_inset CommandInset label
26293 name "chap:Including-External-Material"
26300 \begin_layout Standard
26301 \begin_inset Box Shadowbox
26311 height_special "totalheight"
26316 backgroundcolor "none"
26319 \begin_layout Plain Layout
26320 WARNING: This portion of the documentation has not been updated for some
26322 We certainly hope that it is still accurate, but there are no guarantees.
26330 \begin_layout Standard
26331 The use of material from sources external to \SpecialChar LyX
26332 is covered in detail in the
26338 This part of the manual covers what needs to happen behind the scenes for
26339 new sorts of material to be included.
26342 \begin_layout Section
26346 \begin_layout Standard
26347 The external material feature is based on the concept of a
26352 A template is a specification of how \SpecialChar LyX
26353 should interface with a certain kind
26355 As bundled, \SpecialChar LyX
26356 comes with predefined templates for Xfig figures, various
26357 raster format images, chess diagrams, and LilyPond music notation.
26358 You can check the actual list by using the menu
26359 \begin_inset Flex Noun
26362 \begin_layout Plain Layout
26363 Insert\SpecialChar menuseparator
26364 File\SpecialChar menuseparator
26371 Furthermore, it is possible to roll your own template to support a specific
26373 Later we'll describe in more detail what is involved, and hopefully you
26374 will submit all the templates you create so we can include them in a later
26379 \begin_layout Standard
26380 Another basic idea of the external material feature is to distinguish between
26381 the original file that serves as a base for final material and the produced
26382 file that is included in your exported or printed document.
26383 For example, consider the case of a figure produced with
26384 \begin_inset Flex Code
26387 \begin_layout Plain Layout
26394 The Xfig application itself works on an original file with the
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26405 Within Xfig, you create and change your figure, and when you are done,
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26417 When you want to include the figure in your document, you invoke
26418 \begin_inset Flex Code
26421 \begin_layout Plain Layout
26427 in order to create a PostScript file that can readily be included in your
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26440 file is the original file, and the PostScript file is the produced file.
26443 \begin_layout Standard
26444 This distinction is important in order to allow updating of the material
26445 while you are in the process of writing the document.
26446 Furthermore, it provides us with the flexibility that is needed to support
26447 multiple export formats.
26448 For instance, in the case of a plain text file, it is not exactly an award-winn
26449 ing idea to include the figure as raw PostScript.
26450 Instead, you would either prefer to just include a reference to the figure
26451 or try to invoke some graphics to ASCII converter to make the final result
26452 look similar to the real graphics.
26453 The external material management allows you to do this, because it is parametri
26454 zed on the different export formats that \SpecialChar LyX
26458 \begin_layout Standard
26459 Besides supporting the production of different products according to the
26460 exported format, it supports tight integration with editing and viewing
26462 In the case of an Xfig figure, you are able to invoke Xfig on the original
26463 file with a single click from within the external material dialog in \SpecialChar LyX
26465 and also preview the produced PostScript file with Ghostview with another
26467 No more fiddling around with the command line and/or file browsers to locate
26468 and manipulate the original or produced files.
26469 In this way, you are finally able to take full advantage of the many different
26470 applications that are relevant to use when you write your documents, and
26471 ultimately be more productive.
26474 \begin_layout Section
26475 The external template configuration files
26478 \begin_layout Standard
26479 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26481 However, be aware that doing this in an careless manner most probably
26485 introduce an easily exploitable security hole.
26486 So before you do this, please read the discussion about security in
26487 \begin_inset CommandInset ref
26489 reference "sec:Security-discussion"
26496 \begin_layout Standard
26497 Having said that, we encourage you to submit any interesting templates that
26502 \begin_layout Standard
26503 The external templates are defined in the
26504 \begin_inset Flex Code
26507 \begin_layout Plain Layout
26513 files that are stored in the
26514 \begin_inset Flex Code
26517 \begin_layout Plain Layout
26518 LyXDir/lib/xtemplates/
26524 Each template is defined in a file of its own.
26525 You can place your own templates in
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26530 UserDir/xtemplates/
26535 or copy existing templates to that directory in order to modify them.
26538 \begin_layout Standard
26539 A typical template looks like this:
26542 \begin_layout LyX-Code
26546 \begin_layout LyX-Code
26547 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26550 \begin_layout LyX-Code
26554 \begin_layout LyX-Code
26558 \begin_layout LyX-Code
26562 \begin_layout LyX-Code
26566 \begin_layout LyX-Code
26570 \begin_layout LyX-Code
26571 AutomaticProduction true
26574 \begin_layout LyX-Code
26578 \begin_layout LyX-Code
26582 \begin_layout LyX-Code
26586 \begin_layout LyX-Code
26587 TransformCommand Rotate RotationLatexCommand
26590 \begin_layout LyX-Code
26591 TransformCommand Resize ResizeLatexCommand
26594 \begin_layout LyX-Code
26595 Product "$$RotateFront$$ResizeFront
26598 \begin_layout LyX-Code
26603 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26606 \begin_layout LyX-Code
26607 $$ResizeBack$$RotateBack"
26610 \begin_layout LyX-Code
26614 \begin_layout LyX-Code
26615 UpdateResult "$$AbsPath$$Basename.pstex_t"
26618 \begin_layout LyX-Code
26619 Requirement "graphicx"
26622 \begin_layout LyX-Code
26623 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26626 \begin_layout LyX-Code
26627 ReferencedFile latex "$$AbsPath$$Basename.eps"
26630 \begin_layout LyX-Code
26631 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26634 \begin_layout LyX-Code
26638 \begin_layout LyX-Code
26642 \begin_layout LyX-Code
26643 TransformCommand Rotate RotationLatexCommand
26646 \begin_layout LyX-Code
26647 TransformCommand Resize ResizeLatexCommand
26650 \begin_layout LyX-Code
26651 Product "$$RotateFront$$ResizeFront
26654 \begin_layout LyX-Code
26659 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26662 \begin_layout LyX-Code
26663 $$ResizeBack$$RotateBack"
26666 \begin_layout LyX-Code
26667 UpdateFormat pdftex
26670 \begin_layout LyX-Code
26671 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26674 \begin_layout LyX-Code
26675 Requirement "graphicx"
26678 \begin_layout LyX-Code
26679 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26682 \begin_layout LyX-Code
26683 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26686 \begin_layout LyX-Code
26690 \begin_layout LyX-Code
26694 \begin_layout LyX-Code
26695 Product "[XFig: $$FName]"
26698 \begin_layout LyX-Code
26702 \begin_layout LyX-Code
26706 \begin_layout LyX-Code
26707 Product "<graphic fileref=
26709 "$$AbsOrRelPathMaster$$Basename.eps
26714 \begin_layout LyX-Code
26718 \begin_layout LyX-Code
26722 \begin_layout LyX-Code
26723 UpdateResult "$$AbsPath$$Basename.eps"
26726 \begin_layout LyX-Code
26727 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26730 \begin_layout LyX-Code
26731 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26734 \begin_layout LyX-Code
26738 \begin_layout LyX-Code
26742 \begin_layout Standard
26743 As you can see, the template is enclosed in
26744 \begin_inset Flex Code
26747 \begin_layout Plain Layout
26755 \begin_inset Flex Code
26758 \begin_layout Plain Layout
26765 It contains a header specifying some general settings and, for each supported
26766 primary document file format, a section
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26778 \begin_inset Flex Code
26781 \begin_layout Plain Layout
26790 \begin_layout Subsection
26791 The template header
26794 \begin_layout Description
26795 \begin_inset Flex Code
26798 \begin_layout Plain Layout
26799 AutomaticProduction
26800 \begin_inset space ~
26808 Whether the file represented by the template must be generated by \SpecialChar LyX
26810 This command must occur exactly once.
26813 \begin_layout Description
26814 \begin_inset Flex Code
26817 \begin_layout Plain Layout
26819 \begin_inset space ~
26827 A glob pattern that is used in the file dialog to filter out the desired
26829 If there is more than one possible file extension (e.
26830 \begin_inset space \thinspace{}
26834 \begin_inset space \space{}
26838 \begin_inset Flex Code
26841 \begin_layout Plain Layout
26848 \begin_inset Flex Code
26851 \begin_layout Plain Layout
26857 ), use something like
26858 \begin_inset Flex Code
26861 \begin_layout Plain Layout
26868 This command must occur exactly once.
26871 \begin_layout Description
26872 \begin_inset Flex Code
26875 \begin_layout Plain Layout
26877 \begin_inset space ~
26885 The text that is displayed on the button.
26886 This command must occur exactly once.
26889 \begin_layout Description
26890 \begin_inset Flex Code
26893 \begin_layout Plain Layout
26895 \begin_inset space ~
26899 \begin_inset space ~
26907 The help text that is used in the External dialog.
26908 Provide enough information to explain to the user just what the template
26909 can provide him with.
26910 This command must occur exactly once.
26913 \begin_layout Description
26914 \begin_inset Flex Code
26917 \begin_layout Plain Layout
26919 \begin_inset space ~
26927 The file format of the original file.
26928 This must be the name of a format that is known to \SpecialChar LyX
26930 \begin_inset CommandInset ref
26932 reference "sec:Formats"
26938 \begin_inset Quotes eld
26942 \begin_inset Flex Code
26945 \begin_layout Plain Layout
26952 \begin_inset Quotes erd
26955 if the template can handle original files of more than one format.
26957 will attempt to interrogate the file itself in order to deduce its format
26959 This command must occur exactly once.
26962 \begin_layout Description
26963 \begin_inset Flex Code
26966 \begin_layout Plain Layout
26968 \begin_inset space ~
26976 A unique name for the template.
26977 It must not contain substitution macros (see below).
26980 \begin_layout Description
26981 \begin_inset Flex Code
26984 \begin_layout Plain Layout
26986 \begin_inset space ~
26989 Rotate|Resize|Clip|Extra
26994 This command specifies which transformations are supported by this template.
26995 It may occur zero or more times.
26996 This command enables the corresponding tabs in the external dialog.
26998 \begin_inset Flex Code
27001 \begin_layout Plain Layout
27007 command must have either a corresponding
27008 \begin_inset Flex Code
27011 \begin_layout Plain Layout
27018 \begin_inset Flex Code
27021 \begin_layout Plain Layout
27028 \begin_inset Flex Code
27031 \begin_layout Plain Layout
27038 Otherwise the transformation will not be supported by that format.
27041 \begin_layout Subsection
27045 \begin_layout Description
27046 \begin_inset Flex Code
27049 \begin_layout Plain Layout
27051 \begin_inset space ~
27054 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27059 The primary document file format that this format definition is for.
27060 Not every template has a sensible representation in all document file formats.
27061 Please define nevertheless a
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27071 section for all templates.
27072 Use a dummy text when no representation is available.
27073 Then you can at least see a reference to the external material in the exported
27077 \begin_layout Description
27078 \begin_inset Flex Code
27081 \begin_layout Plain Layout
27083 \begin_inset space ~
27087 \begin_inset space ~
27095 This command defines an additional macro
27096 \begin_inset Flex Code
27099 \begin_layout Plain Layout
27105 for substitution in
27106 \begin_inset Flex Code
27109 \begin_layout Plain Layout
27117 \begin_inset Flex Code
27120 \begin_layout Plain Layout
27126 itself may contain substitution macros.
27127 The advantage over using
27128 \begin_inset Flex Code
27131 \begin_layout Plain Layout
27138 \begin_inset Flex Code
27141 \begin_layout Plain Layout
27147 is that the substituted value of
27148 \begin_inset Flex Code
27151 \begin_layout Plain Layout
27157 is sanitized so that it is a valid optional argument in the document format.
27158 This command may occur zero or more times.
27161 \begin_layout Description
27162 \begin_inset Flex Code
27165 \begin_layout Plain Layout
27167 \begin_inset space ~
27175 The text that is inserted in the exported document.
27176 This is actually the most important command and can be quite complex.
27177 This command must occur exactly once.
27180 \begin_layout Description
27181 \begin_inset Flex Code
27184 \begin_layout Plain Layout
27186 \begin_inset space ~
27194 This command specifies a preamble snippet that will be included in the
27197 It has to be defined using
27198 \begin_inset Flex Code
27201 \begin_layout Plain Layout
27209 \begin_inset Flex Code
27212 \begin_layout Plain Layout
27219 This command may occur zero or more times.
27222 \begin_layout Description
27223 \begin_inset Flex Code
27226 \begin_layout Plain Layout
27228 \begin_inset space ~
27232 \begin_inset space ~
27240 This command denotes files that are created by the conversion process and
27241 are needed for a particular export format.
27242 If the filename is relative, it is interpreted relative to the master document.
27243 This command may be given zero or more times.
27246 \begin_layout Description
27247 \begin_inset Flex Code
27250 \begin_layout Plain Layout
27252 \begin_inset space ~
27260 The name of a required \SpecialChar LaTeX
27262 The package is included via
27263 \begin_inset Flex Code
27266 \begin_layout Plain Layout
27274 in the \SpecialChar LaTeX
27276 This command may occur zero or more times.
27279 \begin_layout Description
27280 \begin_inset Flex Code
27283 \begin_layout Plain Layout
27285 \begin_inset space ~
27289 \begin_inset space ~
27292 RotationLatexCommand
27297 This command specifies that the built in \SpecialChar LaTeX
27298 command should be used for rotation.
27299 This command may occur once or not at all.
27302 \begin_layout Description
27303 \begin_inset Flex Code
27306 \begin_layout Plain Layout
27308 \begin_inset space ~
27312 \begin_inset space ~
27320 This command specifies that the built in \SpecialChar LaTeX
27321 command should be used for resizing.
27322 This command may occur once or not at all.
27325 \begin_layout Description
27326 \begin_inset Flex Code
27329 \begin_layout Plain Layout
27331 \begin_inset space ~
27335 \begin_inset space ~
27338 RotationLatexOption
27343 This command specifies that rotation is done via an optional argument.
27344 This command may occur once or not at all.
27347 \begin_layout Description
27348 \begin_inset Flex Code
27351 \begin_layout Plain Layout
27353 \begin_inset space ~
27357 \begin_inset space ~
27365 This command specifies that resizing is done via an optional argument.
27366 This command may occur once or not at all.
27369 \begin_layout Description
27370 \begin_inset Flex Code
27373 \begin_layout Plain Layout
27375 \begin_inset space ~
27379 \begin_inset space ~
27387 This command specifies that clipping is done via an optional argument.
27388 This command may occur once or not at all.
27391 \begin_layout Description
27392 \begin_inset Flex Code
27395 \begin_layout Plain Layout
27397 \begin_inset space ~
27401 \begin_inset space ~
27409 This command specifies that an extra optional argument is used.
27410 This command may occur once or not at all.
27413 \begin_layout Description
27414 \begin_inset Flex Code
27417 \begin_layout Plain Layout
27419 \begin_inset space ~
27427 The file format of the converted file.
27428 This must be the name of a format that is known to \SpecialChar LyX
27430 \begin_inset Flex Noun
27433 \begin_layout Plain Layout
27434 Tools\SpecialChar menuseparator
27435 Preferences\SpecialChar menuseparator
27436 File Handling\SpecialChar menuseparator
27443 This command must occur exactly once.
27444 If the resulting file format is PDF, you need to specify the format
27445 \begin_inset Flex Code
27448 \begin_layout Plain Layout
27455 This is the PDF format used for including graphics.
27456 The other defined PDF formats are for document export.
27459 \begin_layout Description
27460 \begin_inset Flex Code
27463 \begin_layout Plain Layout
27465 \begin_inset space ~
27473 The file name of the converted file.
27474 The file name must be absolute.
27475 This command must occur exactly once.
27478 \begin_layout Subsection
27479 Preamble definitions
27482 \begin_layout Standard
27483 The external template configuration file may contain additional preamble
27484 definitions enclosed by
27485 \begin_inset Flex Code
27488 \begin_layout Plain Layout
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27506 They can be used by the templates in the
27507 \begin_inset Flex Code
27510 \begin_layout Plain Layout
27519 \begin_layout Section
27520 The substitution mechanism
27523 \begin_layout Standard
27524 When the external material facility invokes an external program, it is done
27525 on the basis of a command defined in the template configuration file.
27526 These commands can contain various macros that are expanded before execution.
27527 Execution always take place in the directory of the containing document.
27530 \begin_layout Standard
27531 Also, whenever external material is to be displayed, the name will be produced
27532 by the substitution mechanism, and most other commands in the template
27533 definition support substitution as well.
27536 \begin_layout Standard
27537 The available macros are the following:
27540 \begin_layout Description
27541 \begin_inset Flex Code
27544 \begin_layout Plain Layout
27545 $$AbsOrRelPathMaster
27550 The file path, absolute or relative to the master \SpecialChar LyX
27554 \begin_layout Description
27555 \begin_inset Flex Code
27558 \begin_layout Plain Layout
27559 $$AbsOrRelPathParent
27564 The file path, absolute or relative to the \SpecialChar LyX
27568 \begin_layout Description
27569 \begin_inset Flex Code
27572 \begin_layout Plain Layout
27578 The absolute file path.
27581 \begin_layout Description
27582 \begin_inset Flex Code
27585 \begin_layout Plain Layout
27591 The filename without path and without the extension.
27594 \begin_layout Description
27595 \begin_inset Flex Code
27598 \begin_layout Plain Layout
27600 \begin_inset Quotes eld
27604 \begin_inset Quotes erd
27612 This macro will expand to the contents of the file with the name
27613 \begin_inset Flex Code
27616 \begin_layout Plain Layout
27625 \begin_layout Description
27626 \begin_inset Flex Code
27629 \begin_layout Plain Layout
27635 The file extension (including the dot).
27638 \begin_layout Description
27639 \begin_inset Flex Code
27642 \begin_layout Plain Layout
27648 This will be the string
27649 \begin_inset Quotes eld
27653 \begin_inset Quotes erd
27656 if the file is in JPEG format, otherwise it will be the string
27657 \begin_inset Quotes eld
27661 \begin_inset Quotes erd
27665 This is useful to avoid uneeded conversions for output formats that support
27666 both PNG and JPEG fomats.
27667 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27672 \begin_layout Description
27673 \begin_inset Flex Code
27676 \begin_layout Plain Layout
27682 The filename of the file specified in the external material dialog.
27683 This is either an absolute name, or it is relative to the \SpecialChar LyX
27687 \begin_layout Description
27688 \begin_inset Flex Code
27691 \begin_layout Plain Layout
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27707 (absolute name or relative to the \SpecialChar LyX
27711 \begin_layout Description
27712 \begin_inset Flex Code
27715 \begin_layout Plain Layout
27721 The file path, relative to the master \SpecialChar LyX
27725 \begin_layout Description
27726 \begin_inset Flex Code
27729 \begin_layout Plain Layout
27735 The file path, relative to the \SpecialChar LyX
27739 \begin_layout Description
27740 \begin_inset Flex Code
27743 \begin_layout Plain Layout
27749 This macro will expand to the absolute path of the system directory.
27750 This is typically used to point to the various helper scripts that are
27751 bundled with \SpecialChar LyX
27755 \begin_layout Description
27756 \begin_inset Flex Code
27759 \begin_layout Plain Layout
27765 A name and full path to a temporary file which will be automatically deleted
27766 whenever the containing document is closed, or the external material insertion
27770 \begin_layout Standard
27771 All path macros contain a trailing directory separator, so you can construct
27773 \begin_inset space \thinspace{}
27777 \begin_inset space \space{}
27780 the absolute filename with
27781 \begin_inset Flex Code
27784 \begin_layout Plain Layout
27785 $$AbsPath$$Basename$$Extension
27793 \begin_layout Standard
27794 The macros above are substituted in all commands unless otherwise noted.
27796 \begin_inset Flex Code
27799 \begin_layout Plain Layout
27805 supports additionally the following substitutions if they are enabled by
27807 \begin_inset Flex Code
27810 \begin_layout Plain Layout
27817 \begin_inset Flex Code
27820 \begin_layout Plain Layout
27829 \begin_layout Description
27830 \begin_inset Flex Code
27833 \begin_layout Plain Layout
27839 The front part of the resize command.
27842 \begin_layout Description
27843 \begin_inset Flex Code
27846 \begin_layout Plain Layout
27852 The back part of the resize command.
27855 \begin_layout Description
27856 \begin_inset Flex Code
27859 \begin_layout Plain Layout
27865 The front part of the rotation command.
27868 \begin_layout Description
27869 \begin_inset Flex Code
27872 \begin_layout Plain Layout
27878 The back part of the rotation command.
27881 \begin_layout Standard
27882 The value string of the
27883 \begin_inset Flex Code
27886 \begin_layout Plain Layout
27892 command supports additionally the following substitutions if they are enabled
27894 \begin_inset Flex Code
27897 \begin_layout Plain Layout
27904 \begin_inset Flex Code
27907 \begin_layout Plain Layout
27916 \begin_layout Description
27917 \begin_inset Flex Code
27920 \begin_layout Plain Layout
27929 \begin_layout Description
27930 \begin_inset Flex Code
27933 \begin_layout Plain Layout
27942 \begin_layout Description
27943 \begin_inset Flex Code
27946 \begin_layout Plain Layout
27955 \begin_layout Description
27956 \begin_inset Flex Code
27959 \begin_layout Plain Layout
27965 The rotation option.
27968 \begin_layout Standard
27969 You may ask why there are so many path macros.
27970 There are mainly two reasons:
27973 \begin_layout Enumerate
27974 Relative and absolute file names should remain relative or absolute, respectivel
27976 Users may have reasons to prefer either form.
27977 Relative names are useful for portable documents that should work on different
27978 machines, for example.
27979 Absolute names may be required by some programs.
27982 \begin_layout Enumerate
27984 treats relative file names differently than \SpecialChar LyX
27985 and other programs in nested
27987 For \SpecialChar LyX
27988 , a relative file name is always relative to the document that contains
27990 For \SpecialChar LaTeX
27991 , it is always relative to the master document.
27992 These two definitions are identical if you have only one document, but
27993 differ if you have a master document that includes part documents.
27994 That means that relative filenames must be transformed when presented to
27997 Fortunately \SpecialChar LyX
27998 does this automatically for you if you choose the right macros.
28001 \begin_layout Standard
28002 So which path macro should be used in new template definitions? The rule
28006 \begin_layout Itemize
28008 \begin_inset Flex Code
28011 \begin_layout Plain Layout
28017 if an absolute path is required.
28020 \begin_layout Itemize
28022 \begin_inset Flex Code
28025 \begin_layout Plain Layout
28026 $$AbsOrRelPathMaster
28031 if the substituted string is some kind of \SpecialChar LaTeX
28035 \begin_layout Itemize
28037 \begin_inset Flex Code
28040 \begin_layout Plain Layout
28041 $$AbsOrRelPathParent
28046 in order to preserve the user's choice.
28049 \begin_layout Standard
28050 There are special cases where this rule does not work and e.
28051 \begin_inset space \thinspace{}
28055 \begin_inset space \space{}
28058 relative names are needed, but normally it will work just fine.
28059 One example for such a case is the command
28060 \begin_inset Flex Code
28063 \begin_layout Plain Layout
28064 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28069 in the XFig template above: We can't use the absolute name because the
28071 \begin_inset Flex Code
28074 \begin_layout Plain Layout
28080 files needs the relative name in order to rewrite the file content.
28083 \begin_layout Section
28084 Security discussion
28085 \begin_inset CommandInset label
28087 name "sec:Security-discussion"
28094 \begin_layout Standard
28095 The external material feature interfaces with a lot of external programs
28096 and does so automatically, so we have to consider the security implications
28098 In particular, since you have the option of including your own filenames
28099 and/or parameter strings and those are expanded into a command, it seems
28100 that it would be possible to create a malicious document which executes
28101 arbitrary commands when a user views or prints the document.
28102 This is something we definitely want to avoid.
28105 \begin_layout Standard
28106 However, since the external program commands are specified in the template
28107 configuration file only, there are no security issues if \SpecialChar LyX
28108 is properly configure
28109 d with safe templates only.
28110 This is so because the external programs are invoked with the
28111 \begin_inset Flex Code
28114 \begin_layout Plain Layout
28120 -system call rather than the
28121 \begin_inset Flex Code
28124 \begin_layout Plain Layout
28130 system-call, so it's not possible to execute arbitrary commands from the
28131 filename or parameter section via the shell.
28134 \begin_layout Standard
28135 This also implies that you are restricted in what command strings you can
28136 use in the external material templates.
28137 In particular, pipes and redirection are not readily available.
28138 This has to be so if \SpecialChar LyX
28139 should remain safe.
28140 If you want to use some of the shell features, you should write a safe
28141 script to do this in a controlled manner, and then invoke the script from
28142 the command string.
28146 \begin_layout Standard
28147 It is possible to design a template that interacts directly with the shell,
28148 but since this would allow a malicious user to execute arbitrary commands
28149 by writing clever filenames and/or parameters, we generally recommend that
28150 you only use safe scripts that work with the
28151 \begin_inset Flex Code
28154 \begin_layout Plain Layout
28160 system call in a controlled manner.
28161 Of course, for use in a controlled environment, it can be tempting to just
28162 fall back to use ordinary shell scripts.
28163 If you do so, be aware that you
28167 provide an easily exploitable security hole in your system.
28168 Of course it stands to reason that such unsafe templates will never be
28169 included in the standard \SpecialChar LyX
28170 distribution, although we do encourage people
28171 to submit new templates in the open source tradition.
28172 But \SpecialChar LyX
28173 as shipped from the official distribution channels will never have
28177 \begin_layout Standard
28178 Including external material provides a lot of power, and you have to be
28179 careful not to introduce security hazards with this power.
28180 A subtle error in a single line in an innocent looking script can open
28181 the door to huge security problems.
28182 So if you do not fully understand the issues, we recommend that you consult
28183 a knowledgeable security professional or the \SpecialChar LyX
28184 development team if you have
28185 any questions about whether a given template is safe or not.
28186 And do this before you use it in an uncontrolled environment.
28189 \begin_layout Chapter
28191 List of supported \SpecialChar LyX
28192 functions to be used in layouts
28193 \begin_inset CommandInset label
28195 name "chap:List-of-functions"
28202 \begin_layout Standard
28204 \begin_inset Tabular
28205 <lyxtabular version="3" rows="11" columns="8">
28206 <features tabularvalignment="middle">
28207 <column alignment="left" valignment="top">
28208 <column alignment="left" valignment="top">
28209 <column alignment="left" valignment="top">
28210 <column alignment="left" valignment="top">
28211 <column alignment="left" valignment="top">
28212 <column alignment="left" valignment="top">
28213 <column alignment="left" valignment="top">
28214 <column alignment="left" valignment="top">
28216 <cell alignment="left" valignment="top" usebox="none">
28219 \begin_layout Plain Layout
28225 <cell alignment="left" valignment="top" usebox="none">
28228 \begin_layout Plain Layout
28234 <cell alignment="left" valignment="top" usebox="none">
28237 \begin_layout Plain Layout
28243 <cell alignment="left" valignment="top" usebox="none">
28246 \begin_layout Plain Layout
28252 <cell alignment="center" valignment="top" usebox="none">
28255 \begin_layout Plain Layout
28261 <cell alignment="center" valignment="top" usebox="none">
28264 \begin_layout Plain Layout
28270 <cell alignment="center" valignment="top" usebox="none">
28273 \begin_layout Plain Layout
28279 <cell alignment="center" valignment="top" usebox="none">
28282 \begin_layout Plain Layout
28290 <cell alignment="left" valignment="top" usebox="none">
28293 \begin_layout Plain Layout
28299 <cell alignment="left" valignment="top" usebox="none">
28302 \begin_layout Plain Layout
28308 <cell alignment="left" valignment="top" usebox="none">
28311 \begin_layout Plain Layout
28317 <cell alignment="left" valignment="top" usebox="none">
28320 \begin_layout Plain Layout
28326 <cell alignment="center" valignment="top" usebox="none">
28329 \begin_layout Plain Layout
28335 <cell alignment="center" valignment="top" usebox="none">
28338 \begin_layout Plain Layout
28344 <cell alignment="center" valignment="top" usebox="none">
28347 \begin_layout Plain Layout
28353 <cell alignment="center" valignment="top" usebox="none">
28356 \begin_layout Plain Layout
28364 <cell alignment="left" valignment="top" usebox="none">
28367 \begin_layout Plain Layout
28373 <cell alignment="left" valignment="top" usebox="none">
28376 \begin_layout Plain Layout
28382 <cell alignment="left" valignment="top" usebox="none">
28385 \begin_layout Plain Layout
28391 <cell alignment="left" valignment="top" usebox="none">
28394 \begin_layout Plain Layout
28400 <cell alignment="center" valignment="top" usebox="none">
28403 \begin_layout Plain Layout
28409 <cell alignment="center" valignment="top" usebox="none">
28412 \begin_layout Plain Layout
28418 <cell alignment="center" valignment="top" usebox="none">
28421 \begin_layout Plain Layout
28427 <cell alignment="center" valignment="top" usebox="none">
28430 \begin_layout Plain Layout
28438 <cell alignment="left" valignment="top" usebox="none">
28441 \begin_layout Plain Layout
28447 <cell alignment="left" valignment="top" usebox="none">
28450 \begin_layout Plain Layout
28456 <cell alignment="left" valignment="top" usebox="none">
28459 \begin_layout Plain Layout
28465 <cell alignment="left" valignment="top" usebox="none">
28468 \begin_layout Plain Layout
28474 <cell alignment="center" valignment="top" usebox="none">
28477 \begin_layout Plain Layout
28483 <cell alignment="center" valignment="top" usebox="none">
28486 \begin_layout Plain Layout
28492 <cell alignment="center" valignment="top" usebox="none">
28495 \begin_layout Plain Layout
28501 <cell alignment="center" valignment="top" usebox="none">
28504 \begin_layout Plain Layout
28512 <cell alignment="left" valignment="top" usebox="none">
28515 \begin_layout Plain Layout
28521 <cell alignment="left" valignment="top" usebox="none">
28524 \begin_layout Plain Layout
28530 <cell alignment="left" valignment="top" usebox="none">
28533 \begin_layout Plain Layout
28539 <cell alignment="left" valignment="top" usebox="none">
28542 \begin_layout Plain Layout
28548 <cell alignment="center" valignment="top" usebox="none">
28551 \begin_layout Plain Layout
28557 <cell alignment="center" valignment="top" usebox="none">
28560 \begin_layout Plain Layout
28566 <cell alignment="center" valignment="top" usebox="none">
28569 \begin_layout Plain Layout
28575 <cell alignment="center" valignment="top" usebox="none">
28578 \begin_layout Plain Layout
28586 <cell alignment="left" valignment="top" usebox="none">
28589 \begin_layout Plain Layout
28595 <cell alignment="left" valignment="top" usebox="none">
28598 \begin_layout Plain Layout
28604 <cell alignment="left" valignment="top" usebox="none">
28607 \begin_layout Plain Layout
28613 <cell alignment="left" valignment="top" usebox="none">
28616 \begin_layout Plain Layout
28622 <cell alignment="center" valignment="top" usebox="none">
28625 \begin_layout Plain Layout
28631 <cell alignment="center" valignment="top" usebox="none">
28634 \begin_layout Plain Layout
28640 <cell alignment="center" valignment="top" usebox="none">
28643 \begin_layout Plain Layout
28649 <cell alignment="center" valignment="top" usebox="none">
28652 \begin_layout Plain Layout
28660 <cell alignment="left" valignment="top" usebox="none">
28663 \begin_layout Plain Layout
28669 <cell alignment="left" valignment="top" usebox="none">
28672 \begin_layout Plain Layout
28678 <cell alignment="left" valignment="top" usebox="none">
28681 \begin_layout Plain Layout
28687 <cell alignment="left" valignment="top" usebox="none">
28690 \begin_layout Plain Layout
28696 <cell alignment="center" valignment="top" usebox="none">
28699 \begin_layout Plain Layout
28705 <cell alignment="center" valignment="top" usebox="none">
28708 \begin_layout Plain Layout
28714 <cell alignment="center" valignment="top" usebox="none">
28717 \begin_layout Plain Layout
28723 <cell alignment="center" valignment="top" usebox="none">
28726 \begin_layout Plain Layout
28734 <cell alignment="left" valignment="top" usebox="none">
28737 \begin_layout Plain Layout
28743 <cell alignment="left" valignment="top" usebox="none">
28746 \begin_layout Plain Layout
28752 <cell alignment="left" valignment="top" usebox="none">
28755 \begin_layout Plain Layout
28761 <cell alignment="left" valignment="top" usebox="none">
28764 \begin_layout Plain Layout
28770 <cell alignment="center" valignment="top" usebox="none">
28773 \begin_layout Plain Layout
28779 <cell alignment="center" valignment="top" usebox="none">
28782 \begin_layout Plain Layout
28788 <cell alignment="center" valignment="top" usebox="none">
28791 \begin_layout Plain Layout
28797 <cell alignment="center" valignment="top" usebox="none">
28800 \begin_layout Plain Layout
28808 <cell alignment="left" valignment="top" usebox="none">
28811 \begin_layout Plain Layout
28817 <cell alignment="left" valignment="top" usebox="none">
28820 \begin_layout Plain Layout
28826 <cell alignment="left" valignment="top" usebox="none">
28829 \begin_layout Plain Layout
28835 <cell alignment="left" valignment="top" usebox="none">
28838 \begin_layout Plain Layout
28844 <cell alignment="center" valignment="top" usebox="none">
28847 \begin_layout Plain Layout
28853 <cell alignment="center" valignment="top" usebox="none">
28856 \begin_layout Plain Layout
28862 <cell alignment="center" valignment="top" usebox="none">
28865 \begin_layout Plain Layout
28871 <cell alignment="center" valignment="top" usebox="none">
28874 \begin_layout Plain Layout
28882 <cell alignment="left" valignment="top" usebox="none">
28885 \begin_layout Plain Layout
28891 <cell alignment="left" valignment="top" usebox="none">
28894 \begin_layout Plain Layout
28900 <cell alignment="left" valignment="top" usebox="none">
28903 \begin_layout Plain Layout
28909 <cell alignment="left" valignment="top" usebox="none">
28912 \begin_layout Plain Layout
28918 <cell alignment="center" valignment="top" usebox="none">
28921 \begin_layout Plain Layout
28927 <cell alignment="center" valignment="top" usebox="none">
28930 \begin_layout Plain Layout
28936 <cell alignment="center" valignment="top" usebox="none">
28939 \begin_layout Plain Layout
28945 <cell alignment="center" valignment="top" usebox="none">
28948 \begin_layout Plain Layout
28956 <cell alignment="center" valignment="top" usebox="none">
28959 \begin_layout Plain Layout
28965 <cell alignment="center" valignment="top" usebox="none">
28968 \begin_layout Plain Layout
28974 <cell alignment="center" valignment="top" usebox="none">
28977 \begin_layout Plain Layout
28983 <cell alignment="center" valignment="top" usebox="none">
28986 \begin_layout Plain Layout
28992 <cell alignment="center" valignment="top" usebox="none">
28995 \begin_layout Plain Layout
29001 <cell alignment="center" valignment="top" usebox="none">
29004 \begin_layout Plain Layout
29010 <cell alignment="center" valignment="top" usebox="none">
29013 \begin_layout Plain Layout
29019 <cell alignment="center" valignment="top" usebox="none">
29022 \begin_layout Plain Layout
29036 \begin_layout Chapter
29037 Names of available colors to be used in layouts
29038 \begin_inset CommandInset label
29040 name "chap:Names-of-colors"
29047 \begin_layout Standard
29048 The colors listed below are the standard colors and those that you can adjust
29049 in the \SpecialChar LyX
29053 \begin_layout Section
29057 \begin_layout Standard
29058 The following are no real colors, but rather act on color definitions:
29061 \begin_layout Description
29062 ignore The color is ignored
29065 \begin_layout Description
29066 inherit The color is inherited
29069 \begin_layout Description
29082 No particular color – clear or default
29085 \begin_layout Section
29089 \begin_layout Standard
29090 These are fixed colors that cannot me customized:
29093 \begin_layout Description
29097 \begin_layout Description
29101 \begin_layout Description
29105 \begin_layout Description
29109 \begin_layout Description
29113 \begin_layout Description
29117 \begin_layout Description
29121 \begin_layout Description
29125 \begin_layout Description
29129 \begin_layout Description
29133 \begin_layout Description
29137 \begin_layout Description
29141 \begin_layout Description
29145 \begin_layout Description
29149 \begin_layout Description
29153 \begin_layout Description
29157 \begin_layout Description
29161 \begin_layout Description
29165 \begin_layout Description
29169 \begin_layout Section
29173 \begin_layout Standard
29174 These are the colors allocated to specific elements in
29177 arg "dialog-show prefs"
29183 \begin_layout Description
29184 added_space Added space color
29187 \begin_layout Description
29188 addedtext Added text color
29191 \begin_layout Description
29192 appendix Appendix marker color
29195 \begin_layout Description
29196 background Background color
29199 \begin_layout Description
29200 bottomarea Bottom area color
29203 \begin_layout Description
29204 branchlabel Label color for branches
29207 \begin_layout Description
29208 buttonbg Color used for button background
29211 \begin_layout Description
29212 buttonframe Color for inset button frames
29215 \begin_layout Description
29216 buttonhoverbg Color used for button background under focus
29219 \begin_layout Description
29220 changebar Changebar color
29223 \begin_layout Description
29224 changedtextauthor1 Changed text color author 1
29227 \begin_layout Description
29228 changedtextauthor2 Changed text color author 2
29231 \begin_layout Description
29232 changedtextauthor3 Changed text color author 3
29235 \begin_layout Description
29236 changedtextauthor4 Changed text color author 4
29239 \begin_layout Description
29240 changedtextauthor5 Changed text color author 5
29243 \begin_layout Description
29244 collapsible Collapsible insets text color
29247 \begin_layout Description
29248 collapsibleframe Collapsible insets framecolor
29251 \begin_layout Description
29252 command Text color for command insets
29255 \begin_layout Description
29256 commandbg Background color for command insets
29259 \begin_layout Description
29260 commandframe Frame color for command insets
29263 \begin_layout Description
29264 comment Label color for comments
29267 \begin_layout Description
29268 commentbg Background color of comments
29271 \begin_layout Description
29272 cursor Cursor color
29275 \begin_layout Description
29276 deletedtext Deleted text color
29279 \begin_layout Description
29280 deletedtextmodifier Deleted text modifying color
29283 \begin_layout Description
29284 depthbar Color for the depth bars in the margin
29287 \begin_layout Description
29288 eolmarker End of line marker color
29291 \begin_layout Description
29292 error Color of the \SpecialChar LaTeX
29296 \begin_layout Description
29297 footlabel Label color for footnotes
29300 \begin_layout Description
29301 foreground Foreground color
29304 \begin_layout Description
29305 graphicsbg Graphics inset background color
29308 \begin_layout Description
29309 greyedoutbg Background color of greyedout inset
29312 \begin_layout Description
29313 greyedoutlabel Label color for greyedout insets
29316 \begin_layout Description
29317 greyedouttext Color for greyedout inset text
29320 \begin_layout Description
29321 indexlabel Label color for index insets
29324 \begin_layout Description
29325 inlinecompletion Inline completion color
29328 \begin_layout Description
29329 insetbg Inset marker background color
29332 \begin_layout Description
29333 insetframe Inset marker frame color
29336 \begin_layout Description
29337 language Color for marking foreign language words
29340 \begin_layout Description
29341 latex Text color in \SpecialChar LaTeX
29345 \begin_layout Description
29346 listingsbg Background color of listings inset
29349 \begin_layout Description
29350 marginlabel Label color for margin notes
29353 \begin_layout Description
29354 math Math inset text color
29357 \begin_layout Description
29358 mathbg Math inset background color
29361 \begin_layout Description
29362 mathcorners Math inset frame color not under focus
29365 \begin_layout Description
29366 mathframe Math inset frame color under focus
29369 \begin_layout Description
29370 mathline Math line color
29373 \begin_layout Description
29374 mathmacrobg Macro math inset background color
29377 \begin_layout Description
29378 mathmacroblend Macro math blended color
29381 \begin_layout Description
29382 mathmacroframe Macro math frame color
29385 \begin_layout Description
29386 mathmacrohoverbg Macro math inset background color hovered
29389 \begin_layout Description
29390 mathmacrolabel Macro math label color
29393 \begin_layout Description
29394 mathmacronewarg Macro template color for new parameters
29397 \begin_layout Description
29398 mathmacrooldarg Macro template color for old parameters
29401 \begin_layout Description
29402 newpage New page color
29405 \begin_layout Description
29406 nonunique_inlinecompletion Inline completion color for the non-unique part
29409 \begin_layout Description
29410 note Label color for notes
29413 \begin_layout Description
29414 notebg Background color of notes
29417 \begin_layout Description
29418 pagebreak Page break/line break color
29421 \begin_layout Description
29422 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29425 \begin_layout Description
29426 phantomtext Text color for phantom insets
29429 \begin_layout Description
29430 preview The color used for previews
29433 \begin_layout Description
29434 previewframe Preview frame color
29437 \begin_layout Description
29438 regexpframe Color for regexp frame
29441 \begin_layout Description
29442 scroll Color that indicates when a row can be scrolled
29445 \begin_layout Description
29446 selection Background color of selected text
29449 \begin_layout Description
29450 selectiontext Foreground color of selected text
29453 \begin_layout Description
29454 shadedbg Background color of shaded box
29457 \begin_layout Description
29458 special Special chars text color
29461 \begin_layout Description
29462 tabularline Table line color
29465 \begin_layout Description
29466 tabularonoffline Table line color
29469 \begin_layout Description
29470 urllabel Label color for URL insets
29473 \begin_layout Description
29474 urltext Color for URL inset text