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
106 \notefontcolor #0000ff
118 \paragraph_separation indent
119 \paragraph_indentation default
121 \math_indentation default
122 \math_numbering_side default
123 \quotes_style english
127 \paperpagestyle headings
129 \tracking_changes true
130 \output_changes false
134 \author -712698321 "Jürgen Spitzmüller"
135 \author -495245474 "Jean-Marc Lasgouttes"
136 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
142 Customizing \SpecialChar LyX
143 : Features for the Advanced User
147 by the \SpecialChar LyX
152 \begin_layout Plain Layout
154 If you have comments or error corrections, please send them to the \SpecialChar LyX
157 \begin_inset CommandInset href
159 target "lyx-docs@lists.lyx.org"
167 \begin_inset Quotes eld
171 \begin_inset Quotes erd
174 in the subject header, and please cc the current maintainer of this file,
175 Richard Heck <rgheck@comcast.net>.
181 \begin_inset Newline newline
185 \begin_inset Newline newline
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Standard
201 \begin_inset Note Note
204 \begin_layout Plain Layout
205 Please use change tracking when modifying this document.
206 This makes it easier for our translators to recognize things that have
207 been changed, and it helps the maintainer keep up-to-date with what's been
216 \begin_layout Chapter
220 \begin_layout Standard
221 This manual covers the customization features present in \SpecialChar LyX
223 In it, we discuss issues like keyboard shortcuts, screen previewing options,
224 printer options, sending commands to \SpecialChar LyX
225 via the \SpecialChar LyX
226 Server, internationalization,
227 installing new \SpecialChar LaTeX
228 classes and \SpecialChar LyX
230 We can't possibly hope to touch on everything you can change—our developers
231 add new features faster than we can document them—but we will explain the
232 most common customizations and hopefully point you in the right direction
233 for some of the more obscure ones.
236 \begin_layout Standard
237 \begin_inset Branch OutDated
241 \begin_layout Standard
242 Information from previous versions of this document that now seems to be
243 outdated is contained in the OutDated branch of this document.
244 By default, this information will not appear in the \SpecialChar LaTeX
253 \begin_layout Chapter
258 \begin_layout Standard
259 This chapter aims to help you to find your way through the \SpecialChar LyX
262 Before continuing to read this chapter, you should find out where your
264 library and user directories are by using
265 \begin_inset Flex Noun
268 \begin_layout Plain Layout
269 Help\SpecialChar menuseparator
280 The library directory is the place where \SpecialChar LyX
281 places its system-wide configuration
282 files; the user directory is where you can place your modified versions.
283 We will call the former
284 \begin_inset Flex Code
287 \begin_layout Plain Layout
294 \begin_inset Flex Noun
297 \begin_layout Plain Layout
303 in the remainder of this document.
307 \begin_layout Section
309 \begin_inset Flex Code
312 \begin_layout Plain Layout
321 \begin_layout Standard
322 \begin_inset Flex Code
325 \begin_layout Plain Layout
331 and its sub-directories contain a number of files and that can be used
332 to customize \SpecialChar LyX
334 You can change many of these files from within \SpecialChar LyX
336 \begin_inset Flex Noun
339 \begin_layout Plain Layout
340 Tools\SpecialChar menuseparator
347 Most customization that you will want to do in \SpecialChar LyX
348 is possible through this
350 However, many other inner aspects of \SpecialChar LyX
351 can be customized by modifying the
353 \begin_inset Flex Code
356 \begin_layout Plain Layout
363 These files fall in different categories, described in the following subsection
367 \begin_layout Subsection
368 Automatically generated files
371 \begin_layout Standard
372 The files, which are to be found in
373 \begin_inset Flex Noun
376 \begin_layout Plain Layout
382 , are generated when you configure \SpecialChar LyX
384 They contain various default values that are guessed by inspection.
385 In general, it is not a good idea to modify them, since they might be overwritt
389 \begin_layout Labeling
390 \labelwidthstring 00.00.0000
391 \begin_inset Flex Code
394 \begin_layout Plain Layout
400 contains defaults for various commands.
403 \begin_layout Labeling
404 \labelwidthstring 00.00.0000
405 \begin_inset Flex Code
408 \begin_layout Plain Layout
414 contains the list of packages that have been recognized by \SpecialChar LyX
416 It is currently unused by the \SpecialChar LyX
417 program itself, but the information extracted,
418 and more, is made available with
419 \begin_inset Flex Noun
422 \begin_layout Plain Layout
423 Help\SpecialChar menuseparator
437 \begin_layout Labeling
438 \labelwidthstring 00.00.0000
439 \begin_inset Flex Code
442 \begin_layout Plain Layout
448 the list of text classes that have been found in your
449 \begin_inset Flex Code
452 \begin_layout Plain Layout
458 directories, along with the associated \SpecialChar LaTeX
459 document class and their description.
462 \begin_layout Labeling
463 \labelwidthstring 00.00.0000
464 \begin_inset Flex Code
467 \begin_layout Plain Layout
473 the list of layout modules found in your
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
486 \begin_layout Labeling
487 \labelwidthstring 00.00.0000
488 \begin_inset Flex Code
491 \begin_layout Plain Layout
497 lists of various sorts of \SpecialChar LaTeX
498 -related files found on your system
501 \begin_layout Labeling
502 \labelwidthstring 00.00.0000
503 \begin_inset Flex Code
506 \begin_layout Plain Layout
507 doc/\SpecialChar LaTeX
513 is automatically generated during configuration from the file
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
525 It contains information on your \SpecialChar LaTeX
529 \begin_layout Subsection
533 \begin_layout Standard
534 These directories are duplicated between
535 \begin_inset Flex Code
538 \begin_layout Plain Layout
545 \begin_inset Flex Code
548 \begin_layout Plain Layout
555 If a particular files exists in both places, the one in
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
568 \begin_layout Labeling
569 \labelwidthstring 00.00.0000
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
579 this directory contains files with the extension
580 \begin_inset Flex Code
583 \begin_layout Plain Layout
589 that define the keybindings used in \SpecialChar LyX
591 If there exists an internationalized version of the bind file named
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
601 , that will be used first.
604 \begin_layout Labeling
605 \labelwidthstring 00.00.0000
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
615 contains files with the extension
616 \begin_inset Flex Code
619 \begin_layout Plain Layout
625 which define the diverse citation possibilities (natbib, biblatex etc.).
627 \begin_inset CommandInset ref
629 reference "subsec:Cite-Engine-Files"
639 \begin_layout Labeling
640 \labelwidthstring 00.00.0000
641 \begin_inset Flex Code
644 \begin_layout Plain Layout
650 contains graphics files that can be included in documents.
654 \begin_layout Labeling
655 \labelwidthstring 00.00.0000
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 contains \SpecialChar LyX
666 documentation files (including the one you are currently reading).
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
678 deserves special attention, as noted above.
679 The internationalized help docs are in subdirectories
680 \begin_inset Flex Code
683 \begin_layout Plain Layout
690 \begin_inset Quotes eld
694 \begin_inset Quotes erd
697 is the ISO language code.
699 \begin_inset CommandInset ref
701 reference "cha:Internationalizing-LyX"
708 \begin_layout Labeling
709 \labelwidthstring 00.00.0000
710 \begin_inset Flex Code
713 \begin_layout Plain Layout
719 contains example files that explain how to use some features.
720 In the file browser, press the
721 \begin_inset Flex Noun
724 \begin_layout Plain Layout
733 \begin_layout Labeling
734 \labelwidthstring 00.00.0000
735 \begin_inset Flex Code
738 \begin_layout Plain Layout
744 contains image files that are used by the
745 \begin_inset Flex Noun
748 \begin_layout Plain Layout
755 In addition, it also contains the individual icons used in the toolbar
756 and the banners that can be shown when \SpecialChar LyX
760 \begin_layout Labeling
761 \labelwidthstring 00.00.0000
762 \begin_inset Flex Code
765 \begin_layout Plain Layout
771 contains keyboard keymapping files.
773 \begin_inset CommandInset ref
775 reference "sec:International-Keymap-Stuff"
782 \begin_layout Labeling
783 \labelwidthstring 00.00.0000
784 \begin_inset Flex Code
787 \begin_layout Plain Layout
793 contains the text class and module files described in
794 \begin_inset CommandInset ref
796 reference "cha:Installing-New-Document"
803 \begin_layout Labeling
804 \labelwidthstring 00.00.0000
805 \begin_inset Flex Code
808 \begin_layout Plain Layout
815 \begin_inset Flex Code
818 \begin_layout Plain Layout
824 Python scripts used to convert between \SpecialChar LyX
826 These can be run from the command line if, say, you want to batch-convert
830 \begin_layout Labeling
831 \labelwidthstring 00.00.0000
832 \begin_inset Flex Code
835 \begin_layout Plain Layout
841 contains some files that demonstrate the capabilities of the
842 \begin_inset Flex Noun
845 \begin_layout Plain Layout
856 Also contains some scripts used by \SpecialChar LyX
860 \begin_layout Labeling
861 \labelwidthstring 00.00.0000
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
871 contains the standard \SpecialChar LyX
872 template files described in
873 \begin_inset CommandInset ref
875 reference "subsec:Creating-Templates"
882 \begin_layout Labeling
883 \labelwidthstring 00.00.0000
884 \begin_inset Flex Code
887 \begin_layout Plain Layout
893 contains files with the extension
894 \begin_inset Flex Code
897 \begin_layout Plain Layout
903 that define the user interface to \SpecialChar LyX
905 That is, the files define which items appear in which menus and the items
906 appearing on the toolbar.
909 \begin_layout Labeling
910 \labelwidthstring 00.00.0000
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
920 contains files with the extension
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 which define the templates for the insertion of external material to a
933 \begin_inset CommandInset ref
935 reference "chap:Including-External-Material"
942 \begin_layout Subsection
943 Files you don't want to modify
946 \begin_layout Standard
947 These files are used internally by \SpecialChar LyX
948 and you generally do not need to modify
949 them unless you are a developer.
952 \begin_layout Labeling
953 \labelwidthstring 00.00.0000
954 \begin_inset Flex Code
957 \begin_layout Plain Layout
963 this file contains the list of \SpecialChar LyX
965 The contents are displayed with the menu entry
966 \begin_inset Flex Noun
969 \begin_layout Plain Layout
970 Help\SpecialChar menuseparator
983 \begin_layout Labeling
984 \labelwidthstring 00.00.0000
985 \begin_inset Flex Code
988 \begin_layout Plain Layout
994 this is a \SpecialChar LaTeX
995 script used during the configuration process.
999 \begin_layout Labeling
1000 \labelwidthstring 00.00.0000
1001 \begin_inset Flex Code
1004 \begin_layout Plain Layout
1010 this is a Python script that is used to re-configure \SpecialChar LyX
1012 It creates configuration files in the directory it was run from.
1015 \begin_layout Subsection
1016 Other files needing a line or two
1019 \begin_layout Labeling
1020 \labelwidthstring 00.00.0000
1021 \begin_inset Flex Code
1024 \begin_layout Plain Layout
1030 this contains tables describing how different character encodings can be
1034 \begin_layout Labeling
1035 \labelwidthstring 00.00.0000
1036 \begin_inset Flex Code
1039 \begin_layout Plain Layout
1045 this file contains a list of all the languages currently supported by \SpecialChar LyX
1049 \begin_layout Labeling
1050 \labelwidthstring 00.00.0000
1051 \begin_inset Flex Code
1054 \begin_layout Plain Layout
1060 contains information about the supported fonts.
1063 \begin_layout Labeling
1064 \labelwidthstring 00.00.0000
1065 \begin_inset Flex Code
1068 \begin_layout Plain Layout
1074 this file contains translations for internationalized paragraph styles
1076 \begin_inset CommandInset ref
1078 reference "subsec:I18n"
1085 \begin_layout Labeling
1086 \labelwidthstring 00.00.0000
1087 \begin_inset Flex Code
1090 \begin_layout Plain Layout
1096 this file contains information about Unicode-encoded glyphs and the way
1097 they are supported by \SpecialChar LyX
1098 via \SpecialChar LaTeX
1102 \begin_layout Section
1103 Your local configuration directory
1106 \begin_layout Standard
1107 Even if you are using \SpecialChar LyX
1108 as an unprivileged user, you might want to change
1110 configuration for your own use.
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1121 directory contains all your personal configuration files.
1122 This is the directory described as
1123 \begin_inset Quotes eld
1127 \begin_inset Quotes erd
1131 \begin_inset Flex Noun
1134 \begin_layout Plain Layout
1135 Help\SpecialChar menuseparator
1137 \begin_inset space ~
1146 This directory is used as a mirror of
1147 \begin_inset Flex Code
1150 \begin_layout Plain Layout
1156 , which means that every file in
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1166 is a replacement for the corresponding file in
1167 \begin_inset Flex Code
1170 \begin_layout Plain Layout
1177 Any configuration file described in the above sections can be placed either
1178 in the system-wide directory, in which case it will affect all users, or
1179 in your local directory for your own use.
1182 \begin_layout Standard
1183 To make things clearer, let's provide a few examples:
1186 \begin_layout Itemize
1187 The preferences set in the
1188 \begin_inset Flex Noun
1191 \begin_layout Plain Layout
1192 Tools\SpecialChar menuseparator
1198 dialog are saved to a file
1199 \begin_inset Flex Code
1202 \begin_layout Plain Layout
1209 \begin_inset Flex Code
1212 \begin_layout Plain Layout
1221 \begin_layout Itemize
1222 When you reconfigure using
1223 \begin_inset Flex Noun
1226 \begin_layout Plain Layout
1227 Tools\SpecialChar menuseparator
1235 \begin_inset Flex Code
1238 \begin_layout Plain Layout
1244 script, and the resulting files are written in your local configuration
1246 This means that any additional text class file that you might have added
1248 \begin_inset Flex Code
1251 \begin_layout Plain Layout
1257 will be added to the list of classes in the
1258 \begin_inset Flex Noun
1261 \begin_layout Plain Layout
1262 Document\SpecialChar menuseparator
1271 \begin_layout Itemize
1272 If you get some updated documentation from \SpecialChar LyX
1273 ftp site and cannot install
1274 it because you do not have sysadmin rights on your system, you can just
1276 \begin_inset Flex Code
1279 \begin_layout Plain Layout
1285 and the items in the
1286 \begin_inset Flex Noun
1289 \begin_layout Plain Layout
1295 menu will open them!
1298 \begin_layout Section
1299 Running \SpecialChar LyX
1300 with multiple configurations
1303 \begin_layout Standard
1304 The configuration freedom of the local configuration directory may not suffice
1305 if you want to have more than one configuration at your disposal.
1306 For example, you may want to be use different key bindings or printer settings
1308 You can achieve this by having several such directories.
1309 You then specify which directory to use at run-time.
1312 \begin_layout Standard
1313 Invoking \SpecialChar LyX
1314 with the command line switch
1315 \begin_inset Flex Code
1318 \begin_layout Plain Layout
1328 instructs the program to read the configuration from that directory, and
1329 not from the default directory.
1330 (You can determine the default directory by running \SpecialChar LyX
1332 \begin_inset Flex Code
1335 \begin_layout Plain Layout
1341 switch.) If the specified directory does not exist, \SpecialChar LyX
1343 for you, just like it does for the default directory on the first time
1344 you run the program.
1345 You can modify the configuration options in this additional user directory
1346 exactly as you would for the default directory.
1347 These directories are completely independent (but read on).
1348 Note that setting the environment variable
1349 \begin_inset Flex Code
1352 \begin_layout Plain Layout
1358 to some value has exactly the same effect.
1361 \begin_layout Standard
1362 Having several configurations also requires more maintenance: if you want
1363 to add a new layout to
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1373 which you want available from all your configurations, you must add it
1374 to each directory separately.
1375 You can avoid this with the following trick: after \SpecialChar LyX
1376 creates the additional
1377 directory, most of the subdirectories (see above) are empty.
1378 If you want the new configuration to mirror an existing one, replace the
1379 empty subdirectory with a symbolic link to the matching subdirectory in
1380 the existing configuration.
1382 \begin_inset Flex Code
1385 \begin_layout Plain Layout
1391 subdirectory, however, since it contains a file written by the configuration
1392 script (also accessible through
1393 \begin_inset Flex Noun
1396 \begin_layout Plain Layout
1397 Tools\SpecialChar menuseparator
1403 ) which is configuration-specific.
1406 \begin_layout Chapter
1407 The Preferences dialog
1410 \begin_layout Standard
1411 All options of the preferences dialog are described in the Appendix
1413 The Preferences Dialog
1420 For some options you might find here more details.
1423 \begin_layout Section
1425 \begin_inset CommandInset label
1434 \begin_layout Standard
1435 The first step is to define your file formats if they are not already defined.
1437 \begin_inset Flex Noun
1440 \begin_layout Plain Layout
1441 Tools\SpecialChar menuseparator
1449 \begin_inset Flex Noun
1452 \begin_layout Plain Layout
1453 File Handling\SpecialChar menuseparator
1460 \begin_inset Flex Noun
1463 \begin_layout Plain Layout
1469 button to define your new format.
1471 \begin_inset Flex Noun
1474 \begin_layout Plain Layout
1480 field contains the name used to identify the format in the GUI.
1482 \begin_inset Flex Noun
1485 \begin_layout Plain Layout
1491 is used to identify the format internally.
1492 You will also need to enter a file extension.
1493 These are all required.
1495 \begin_inset Flex Noun
1498 \begin_layout Plain Layout
1504 field is used to provide a keyboard shortcut on the menus.
1505 (For example, pressing
1506 \begin_inset Flex Noun
1509 \begin_layout Plain Layout
1516 \begin_inset Flex Noun
1519 \begin_layout Plain Layout
1520 Document\SpecialChar menuseparator
1521 View (Other Formats)\SpecialChar menuseparator
1530 \begin_layout Standard
1532 \begin_inset Flex Noun
1535 \begin_layout Plain Layout
1542 \begin_inset Flex Noun
1545 \begin_layout Plain Layout
1552 For example, you might want to use
1553 \begin_inset Flex Noun
1556 \begin_layout Plain Layout
1562 to view PostScript files.
1563 You can enter the command needed to start the program in the corresponding
1565 In defining this command, you can use the four variables listed in the
1567 The viewer is launched when you view an image in \SpecialChar LyX
1569 \begin_inset Flex Noun
1572 \begin_layout Plain Layout
1573 Document\SpecialChar menuseparator
1580 The editor is for example launched when you right-click on an image and
1582 \begin_inset Flex Noun
1585 \begin_layout Plain Layout
1591 in the appearing context menu.
1594 \begin_layout Standard
1596 \begin_inset Flex Noun
1599 \begin_layout Plain Layout
1605 type of a format is optional, but if it is specified, it must be unique
1607 It is used to detect files of this format from the file contents.
1608 For some important file formats there is no MIME type officially registered
1610 \begin_inset CommandInset href
1613 target "http://www.iana.org/assignments/media-types/"
1619 Therefore \SpecialChar LyX
1620 uses the extended list of MIME types as specified by
1621 \begin_inset CommandInset href
1623 name "freedesktop.org"
1624 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1632 \begin_layout Standard
1634 \begin_inset Flex Noun
1637 \begin_layout Plain Layout
1643 option tells \SpecialChar LyX
1644 that a format is suitable for document export.
1645 If this is set and if a suitable conversion route exists (see
1646 \begin_inset CommandInset ref
1648 reference "sec:Converters"
1652 ), the format will appear in the
1653 \begin_inset Flex Noun
1656 \begin_layout Plain Layout
1657 File\SpecialChar menuseparator
1664 The format will also appear in the
1665 \begin_inset Flex Noun
1668 \begin_layout Plain Layout
1669 Document\SpecialChar menuseparator
1675 menu if a viewer is specified for the format.
1676 Pure image formats, such as
1677 \begin_inset Flex Code
1680 \begin_layout Plain Layout
1686 , should not use this option.
1687 Formats that can both represent vector graphics and documents like
1688 \begin_inset Flex Code
1691 \begin_layout Plain Layout
1700 \begin_layout Standard
1702 \begin_inset Flex Noun
1705 \begin_layout Plain Layout
1706 Vector graphics format
1711 tells \SpecialChar LyX
1712 that a format can contain vector graphics.
1713 This information is used to determine the target format of included graphics
1715 \begin_inset Flex Noun
1718 \begin_layout Plain Layout
1725 Included graphics may need to be converted to either
1726 \begin_inset Flex Noun
1729 \begin_layout Plain Layout
1736 \begin_inset Flex Noun
1739 \begin_layout Plain Layout
1746 \begin_inset Flex Noun
1749 \begin_layout Plain Layout
1756 \begin_inset Flex Noun
1759 \begin_layout Plain Layout
1765 cannot handle other image formats.
1766 If an included graphic is not already in
1767 \begin_inset Flex Noun
1770 \begin_layout Plain Layout
1777 \begin_inset Flex Noun
1780 \begin_layout Plain Layout
1787 \begin_inset Flex Noun
1790 \begin_layout Plain Layout
1796 format, it is converted to
1797 \begin_inset Flex Noun
1800 \begin_layout Plain Layout
1806 if the vector format option is set, and otherwise to
1807 \begin_inset Flex Noun
1810 \begin_layout Plain Layout
1819 \begin_layout Section
1823 \begin_layout Standard
1824 Since all conversions from one format to another take place in \SpecialChar LyX
1826 directory, it is sometimes necessary to modify a file before copying it
1827 to the temporary directory in order that the conversion may be performed.
1831 \begin_layout Plain Layout
1832 For example, the file may refer to other files—images, for example—using
1833 relative file names, and these may become invalid when the file is copied
1834 to the temporary directory.
1839 This is done by a Copier: It copies a file to (or from) the temporary directory
1840 and may modify it in the process.
1843 \begin_layout Standard
1844 The definitions of the copiers may use eight variables:
1847 \begin_layout Labeling
1848 \labelwidthstring 00.00.0000
1849 \begin_inset Flex Code
1852 \begin_layout Plain Layout
1858 The \SpecialChar LyX
1859 system directory (e.
1860 \begin_inset space \thinspace{}
1864 \begin_inset space \space{}
1868 \begin_inset Flex Noun
1871 \begin_layout Plain Layout
1880 \begin_layout Labeling
1881 \labelwidthstring 00.00.0000
1882 \begin_inset Flex Code
1885 \begin_layout Plain Layout
1894 \begin_layout Labeling
1895 \labelwidthstring 00.00.0000
1896 \begin_inset Flex Code
1899 \begin_layout Plain Layout
1908 \begin_layout Labeling
1909 \labelwidthstring 00.00.0000
1910 \begin_inset Flex Code
1913 \begin_layout Plain Layout
1919 The base name (without filename extension) in the \SpecialChar LyX
1923 \begin_layout Labeling
1924 \labelwidthstring 00.00.0000
1925 \begin_inset Flex Code
1928 \begin_layout Plain Layout
1934 The full directory path of the \SpecialChar LyX
1938 \begin_layout Labeling
1939 \labelwidthstring 00.00.0000
1940 \begin_inset Flex Code
1943 \begin_layout Plain Layout
1949 The full pathname to the original \SpecialChar LyX
1950 file being processed
1953 \begin_layout Labeling
1954 \labelwidthstring 00.00.0000
1955 \begin_inset Flex Code
1958 \begin_layout Plain Layout
1964 The filename (without any directory path) of the \SpecialChar LyX
1968 \begin_layout Labeling
1969 \labelwidthstring 00.00.0000
1970 \begin_inset Flex Code
1973 \begin_layout Plain Layout
1979 The `\SpecialChar LaTeX
1983 \begin_layout Standard
1984 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1992 It is relevant only when exporting files suitable for such inclusion.
1995 \begin_layout Standard
1996 Copiers can be used to do almost anything with output files.
1997 For example, suppose you want generated pdf files to be copied to a special
1999 \begin_inset Flex Code
2002 \begin_layout Plain Layout
2009 Then you could write a shell script such as this one:
2012 \begin_layout Standard
2013 \begin_inset listings
2017 \begin_layout Plain Layout
2022 \begin_layout Plain Layout
2027 \begin_layout Plain Layout
2029 TOFILE=`basename $2`
2032 \begin_layout Plain Layout
2034 cp $FROMFILE /home/you/pdf/$TOFILE
2039 Save it in your local \SpecialChar LyX
2041 \begin_inset Flex Code
2044 \begin_layout Plain Layout
2045 /home/you/.lyx/scripts/pdfcopier.sh
2050 —and make it executable, if you need to do so on your platform.
2052 \begin_inset Flex Noun
2055 \begin_layout Plain Layout
2056 Tools\SpecialChar menuseparator
2062 dialog, select under
2063 \begin_inset Flex Noun
2066 \begin_layout Plain Layout
2067 File Handling\SpecialChar menuseparator
2074 \begin_inset Flex Noun
2077 \begin_layout Plain Layout
2083 format—or one of the other pdf formats—and enter
2084 \begin_inset Flex Code
2087 \begin_layout Plain Layout
2088 pdfcopier.sh $$i $$o
2094 \begin_inset Flex Noun
2097 \begin_layout Plain Layout
2107 \begin_layout Standard
2108 Copiers are used by \SpecialChar LyX
2109 in various of its own conversions.
2110 For example, if appropriate programs are found, \SpecialChar LyX
2111 will automatically install
2113 \begin_inset Flex Noun
2116 \begin_layout Plain Layout
2123 \begin_inset Flex Noun
2126 \begin_layout Plain Layout
2128 \begin_inset space ~
2137 When these formats are exported, the copier sees that not just the main
2138 HTML file but various associated files (style files, images, etc.) are also
2140 All these files are written to a subdirectory of the directory in which
2141 the original \SpecialChar LyX
2146 \begin_layout Plain Layout
2147 This copier can be customized.
2149 \begin_inset Quotes eld
2153 \begin_inset Quotes erd
2156 argument takes a comma-separated list of extensions to be copied; if it
2157 is omitted, all files will be copied.
2159 \begin_inset Quotes eld
2163 \begin_inset Quotes erd
2166 argument determines the extension added to the generated directory.
2168 \begin_inset Quotes eld
2172 \begin_inset Flex Noun
2175 \begin_layout Plain Layout
2182 \begin_inset Quotes erd
2185 , so HTML generated from
2186 \begin_inset Flex Noun
2189 \begin_layout Plain Layout
2190 /path/to/filename.lyx
2196 \begin_inset Flex Noun
2199 \begin_layout Plain Layout
2200 /path/to/filename.html.LyXconv
2214 \begin_layout Section
2216 \begin_inset CommandInset label
2218 name "sec:Converters"
2225 \begin_layout Standard
2226 You can define your own Converters to convert files between different formats.
2228 \begin_inset Flex Noun
2231 \begin_layout Plain Layout
2232 Tools\SpecialChar menuseparator
2233 Preferences\SpecialChar menuseparator
2234 File Handling\SpecialChar menuseparator
2243 \begin_layout Standard
2244 To define a new converter, select the
2245 \begin_inset Flex Noun
2248 \begin_layout Plain Layout
2250 \begin_inset space ~
2259 \begin_inset Flex Noun
2262 \begin_layout Plain Layout
2264 \begin_inset space ~
2272 from the drop-down lists, enter the command needed for the conversion,
2274 \begin_inset Flex Noun
2277 \begin_layout Plain Layout
2284 Several variables can be used in the definition of converters:
2287 \begin_layout Labeling
2288 \labelwidthstring 00.00.0000
2289 \begin_inset Flex Code
2292 \begin_layout Plain Layout
2298 The \SpecialChar LyX
2302 \begin_layout Labeling
2303 \labelwidthstring 00.00.0000
2304 \begin_inset Flex Code
2307 \begin_layout Plain Layout
2316 \begin_layout Labeling
2317 \labelwidthstring 00.00.0000
2318 \begin_inset Flex Code
2321 \begin_layout Plain Layout
2330 \begin_layout Labeling
2331 \labelwidthstring 00.00.0000
2332 \begin_inset Flex Code
2335 \begin_layout Plain Layout
2341 The base filename of the input file (i.
2342 \begin_inset space \thinspace{}
2345 g., without the extension)
2348 \begin_layout Labeling
2349 \labelwidthstring 00.00.0000
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2359 The path to the input file
2362 \begin_layout Labeling
2363 \labelwidthstring 00.00.0000
2364 \begin_inset Flex Code
2367 \begin_layout Plain Layout
2373 The path to the original input file (this is different from $$p when a
2374 chain of converters is called)
2377 \begin_layout Labeling
2378 \labelwidthstring 00.00.0000
2379 \begin_inset Flex Code
2382 \begin_layout Plain Layout
2388 The iconv name for the encoding of the document.
2391 \begin_layout Standard
2393 \begin_inset Flex Noun
2396 \begin_layout Plain Layout
2398 \begin_inset space ~
2406 field you can enter the following flags, separated by commas:
2409 \begin_layout Labeling
2410 \labelwidthstring 00.00.0000
2411 \begin_inset Flex Code
2414 \begin_layout Plain Layout
2416 \change_inserted -712698321 1524656940
2424 This converter runs some form of \SpecialChar LaTeX
2426 This will make \SpecialChar LyX
2427 's \SpecialChar LaTeX
2428 error logs available.
2430 \change_inserted -712698321 1524657018
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2437 \change_inserted -712698321 1524657012
2445 value specifies the form of \SpecialChar LaTeX
2447 \begin_inset Flex Code
2450 \begin_layout Plain Layout
2452 \change_inserted -712698321 1524657005
2453 latex, pdflatex, platex, xetex, luatex
2461 If no value is specified,
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2467 \change_inserted -712698321 1524657018
2480 \begin_layout Labeling
2481 \labelwidthstring 00.00.0000
2482 \begin_inset Flex Code
2485 \begin_layout Plain Layout
2487 \change_inserted -712698321 1524656935
2495 Needs the \SpecialChar LaTeX
2497 \begin_inset Flex Noun
2500 \begin_layout Plain Layout
2506 file for the conversion.
2508 \change_inserted -712698321 1524657047
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2515 \change_inserted -712698321 1524657030
2521 value specifies the form of \SpecialChar LaTeX
2522 that is run in order to generate the
2523 \begin_inset Flex Noun
2526 \begin_layout Plain Layout
2528 \change_inserted -712698321 1524657047
2535 \begin_inset Flex Code
2538 \begin_layout Plain Layout
2540 \change_inserted -712698321 1524657030
2541 latex, pdflatex, platex, xetex, luatex
2547 If no value is specified,
2548 \begin_inset Flex Code
2551 \begin_layout Plain Layout
2553 \change_inserted -712698321 1524657030
2564 \begin_layout Labeling
2565 \labelwidthstring 00.00.0000
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2576 \begin_inset Quotes eld
2580 \begin_inset Quotes erd
2583 file from the backend, which in practice means a \SpecialChar LaTeX
2584 file like the one we
2585 would export, without
2586 \begin_inset Flex Code
2589 \begin_layout Plain Layout
2598 \begin_layout Labeling
2599 \labelwidthstring 00.00.0000
2600 \begin_inset Flex Code
2603 \begin_layout Plain Layout
2612 \begin_layout Standard
2613 The following three flags are not really flags at all because they take
2615 \begin_inset Flex Noun
2618 \begin_layout Plain Layout
2620 \begin_inset space ~
2624 \begin_inset space ~
2635 \begin_layout Labeling
2636 \labelwidthstring 00.00.0000
2638 \change_inserted -712698321 1523206314
2639 \begin_inset Flex Code
2642 \begin_layout Plain Layout
2644 \change_inserted -712698321 1523206193
2650 The name of the driver that needs to be loaded with the
2654 package for this converter.
2655 The loading of the correct driver is necessary to get some PDF-specific
2664 \begin_layout Labeling
2665 \labelwidthstring 00.00.0000
2666 \begin_inset Flex Code
2669 \begin_layout Plain Layout
2675 If set, the converter's standard error will be redirected to a file
2676 \begin_inset Flex Code
2679 \begin_layout Plain Layout
2685 , and the script given as argument will be run as:
2686 \begin_inset Flex Code
2689 \begin_layout Plain Layout
2690 script < infile.out > infile.log
2696 The argument may contain
2697 \begin_inset Flex Code
2700 \begin_layout Plain Layout
2709 \begin_layout Labeling
2710 \labelwidthstring 00.00.0000
2711 \begin_inset Flex Code
2714 \begin_layout Plain Layout
2720 The name of the directory in which the converter will dump the generated
2723 will not create this directory, and it does not copy anything into it,
2724 though it will copy this directory to the destination.
2725 The argument may contain
2726 \begin_inset Flex Code
2729 \begin_layout Plain Layout
2735 , which will be replaced by the base name of the input and output files,
2736 respectively, when the directory is copied.
2737 \begin_inset Newline newline
2740 Note that resultdir and usetempdir make no sense together.
2741 The latter will be ignored if the former is given.
2744 \begin_layout Labeling
2745 \labelwidthstring 00.00.0000
2746 \begin_inset Flex Code
2749 \begin_layout Plain Layout
2755 Determines the output file name and may, contain
2756 \begin_inset Flex Code
2759 \begin_layout Plain Layout
2766 Sensible only with resultdir and optional even then; if not given, it defaults
2770 \begin_layout Standard
2772 \change_inserted -712698321 1523206384
2773 A suitable hyperref-driver is set for some converters that are installed
2774 with \SpecialChar LyX
2777 \change_deleted -712698321 1523206388
2779 \change_inserted -712698321 1523206389
2783 \change_inserted -712698321 1523206400
2787 \change_inserted -712698321 1523206407
2791 \change_inserted -712698321 1523206437
2795 \change_deleted -712698321 1523206442
2796 that are installed with \SpecialChar LyX
2803 \begin_layout Standard
2804 You do not have to define converters for all formats between which you want
2806 For example, you will note that there is no `\SpecialChar LyX
2807 to PostScript' converter,
2808 but \SpecialChar LyX
2809 will export PostScript.
2810 It does so by first creating a \SpecialChar LaTeX
2811 file (no converter needs to be defined
2812 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2814 and finally converting the resulting DVI file to PostScript.
2816 finds such `chains' of converters automatically, and it will always choose
2817 the shortest possible chain.
2818 You can, though, still define multiple conversion methods between file
2820 For example, the standard \SpecialChar LyX
2821 configuration provides five ways to convert
2826 \begin_layout Enumerate
2828 \begin_inset Flex Noun
2831 \begin_layout Plain Layout
2840 \begin_layout Enumerate
2841 via (DVI and) PostScript, using
2842 \begin_inset Flex Noun
2845 \begin_layout Plain Layout
2854 \begin_layout Enumerate
2856 \begin_inset Flex Noun
2859 \begin_layout Plain Layout
2868 \begin_layout Enumerate
2870 \begin_inset Flex Noun
2873 \begin_layout Plain Layout
2883 \begin_layout Enumerate
2885 \begin_inset Flex Noun
2888 \begin_layout Plain Layout
2898 \begin_layout Standard
2899 To define such alternate chains, you must define multiple target `file formats',
2901 \begin_inset CommandInset ref
2903 reference "sec:Formats"
2908 For example, in the standard configuration, the formats named
2909 \begin_inset Flex Noun
2912 \begin_layout Plain Layout
2919 \begin_inset Flex Noun
2922 \begin_layout Plain Layout
2929 \begin_inset Flex Noun
2932 \begin_layout Plain Layout
2939 \begin_inset Flex Noun
2942 \begin_layout Plain Layout
2949 \begin_inset Flex Noun
2952 \begin_layout Plain Layout
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2969 \begin_inset Flex Noun
2972 \begin_layout Plain Layout
2979 \begin_inset Flex Noun
2982 \begin_layout Plain Layout
2990 \begin_inset Flex Noun
2993 \begin_layout Plain Layout
3000 \begin_inset Flex Noun
3003 \begin_layout Plain Layout
3010 ) are defined, all of which share the extension
3011 \begin_inset Flex Noun
3014 \begin_layout Plain Layout
3020 , and which correspond to the conversion methods just mentioned.
3023 \begin_layout Chapter
3024 Internationalizing \SpecialChar LyX
3026 \begin_inset CommandInset label
3028 name "cha:Internationalizing-LyX"
3035 \begin_layout Standard
3037 supports using a translated interface.
3038 Last time we checked, \SpecialChar LyX
3039 provided text in thirty languages.
3040 The language of choice is called your
3045 (For further reading on locale settings, see also the documentation for
3046 locale that comes with your operating system.
3047 For Linux, the manual page for
3048 \begin_inset Flex Code
3051 \begin_layout Plain Layout
3057 could be a good place to start).
3060 \begin_layout Standard
3061 Notice that these translations will work, but do contain a few flaws.
3062 In particular, all dialogs have been designed with the English text in
3063 mind, which means that some of the translated text will be too large to
3064 fit within the space allocated.
3065 This is only a display problem and will not cause any harm.
3066 Also, you will find that some of the translations do not define shortcut
3067 keys for everything.
3068 Sometimes, there are simply not enough free letters to do it.
3069 Other times, the translator just hasn't got around to doing it yet.
3070 Our localization team, which you may wish to join,
3074 \begin_layout Plain Layout
3075 If you are a fluent speaker of a language other than English, joining these
3076 teams is a great way to give back to the \SpecialChar LyX
3082 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3086 \begin_layout Section
3087 Translating \SpecialChar LyX
3091 \begin_layout Subsection
3092 Translating the graphical user interface (text messages).
3095 \begin_layout Standard
3098 \begin_inset Flex Code
3101 \begin_layout Plain Layout
3107 library to handle the internationalization of the interface.
3108 To have \SpecialChar LyX
3109 speak your favorite language in all menus and dialogs, you need
3111 \begin_inset Flex Code
3114 \begin_layout Plain Layout
3120 -file for that language.
3121 When this is available, you'll have to generate a
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3131 -file from it and install the
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3142 The process of doing all of this is explained in the documentation for
3144 \begin_inset Flex Code
3147 \begin_layout Plain Layout
3154 It is possible to do this just for yourself, but if you're going to do
3155 it, you might as well share the results of your labors with the rest of
3156 the \SpecialChar LyX
3158 Send a message to the \SpecialChar LyX
3159 developers' list for more information about how
3163 \begin_layout Standard
3164 In short, this is what you should do (xx denotes the language code):
3167 \begin_layout Itemize
3168 Check out the \SpecialChar LyX
3171 \begin_inset CommandInset href
3173 name "information on the web"
3174 target "https://www.lyx.org/HowToUseGIT"
3182 \begin_layout Itemize
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3193 to the folder of the
3194 \begin_inset Flex Code
3197 \begin_layout Plain Layout
3205 \begin_inset Flex Code
3208 \begin_layout Plain Layout
3216 \begin_inset Flex Code
3219 \begin_layout Plain Layout
3225 doesn't exist anywhere, it can be remade with the console command
3226 \begin_inset Flex Code
3229 \begin_layout Plain Layout
3235 in that directory, or you can use an existing po-file for some other language
3239 \begin_layout Itemize
3241 \begin_inset Flex Code
3244 \begin_layout Plain Layout
3254 \begin_layout Plain Layout
3255 This is just a text file, so it can be edited in any text editor.
3256 But there are also specialized programs that support such editing, such
3261 (for all platforms) or
3270 contains a `mode' for editing
3271 \begin_inset Flex Code
3274 \begin_layout Plain Layout
3281 \begin_inset Flex URL
3284 \begin_layout Plain Layout
3286 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3296 For some menu- and widget-labels, there are also shortcut keys that should
3298 Those keys are marked after a `|', and should be translated according to
3299 the words and phrases of the language.
3300 You should also fill also out the information at the beginning of the new
3302 \begin_inset Flex Code
3305 \begin_layout Plain Layout
3311 -file with your email-address, etc., so people know where to reach you with
3312 suggestions and entertaining flames.
3315 \begin_layout Standard
3316 If you are just doing this on your own, then:
3319 \begin_layout Itemize
3321 \begin_inset Flex Code
3324 \begin_layout Plain Layout
3331 This can be done with
3332 \begin_inset Flex Code
3335 \begin_layout Plain Layout
3336 msgfmt -o xx.mo < xx.po
3344 \begin_layout Itemize
3346 \begin_inset Flex Code
3349 \begin_layout Plain Layout
3355 -file to your locale-tree, at the correct directory for application messages
3360 xx, and under the name
3361 \begin_inset Flex Code
3364 \begin_layout Plain Layout
3371 \begin_inset space \thinspace{}
3375 \begin_inset space \space{}
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3383 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3393 \begin_layout Standard
3394 As said, however, it would be best if the new
3395 \begin_inset Flex Code
3398 \begin_layout Plain Layout
3404 file could be added to the \SpecialChar LyX
3405 distribution, so others can use it.
3406 Adding it involves making additional changes to \SpecialChar LyX
3408 So send an email to the developers' mailing list if you're interested in
3412 \begin_layout Subsubsection
3416 \begin_layout Standard
3417 Sometimes it turns out that one English message needs to be translated into
3418 different messages in the target language.
3419 One example is the message
3420 \begin_inset Flex Code
3423 \begin_layout Plain Layout
3429 which has the German translation
3437 , depending upon exactly what the English
3438 \begin_inset Quotes eld
3442 \begin_inset Quotes erd
3447 \begin_inset Flex Code
3450 \begin_layout Plain Layout
3456 does not handle such ambiguous translations.
3457 Therefore you have to add some context information to the message: Instead
3459 \begin_inset Flex Code
3462 \begin_layout Plain Layout
3469 \begin_inset Flex Code
3472 \begin_layout Plain Layout
3473 To[[as in 'From format x to format y']]
3479 \begin_inset Flex Code
3482 \begin_layout Plain Layout
3483 To[[as in 'From page x to page y']].
3488 Now the two occurrences of
3489 \begin_inset Flex Code
3492 \begin_layout Plain Layout
3499 \begin_inset Flex Code
3502 \begin_layout Plain Layout
3508 and can be translated correctly to
3519 \begin_layout Standard
3520 Of course the context information needs to be stripped off the original
3521 message when no translation is used.
3522 Therefore you have to put it in double square brackets at the end of the
3523 message (see the example above).
3524 The translation mechanism of \SpecialChar LyX
3525 ensures that everything in double square
3526 brackets at the end of messages is removed before displaying the message.
3529 \begin_layout Subsection
3530 Translating the documentation.
3533 \begin_layout Standard
3534 The online documentation (in the
3535 \begin_inset Flex Noun
3538 \begin_layout Plain Layout
3544 -menu) can (and should!) be translated.
3545 If there are translated versions of the documentation available
3549 \begin_layout Plain Layout
3550 As of March 2008, at least some of the documents have been translated into
3551 fourteen languages, with the Tutorial available in a few more.
3556 and the locale is set accordingly, these will be used automagically by
3560 looks for translated versions as
3561 \begin_inset Flex Code
3564 \begin_layout Plain Layout
3565 LyXDir/doc/xx/DocName.lyx
3571 \begin_inset Flex Code
3574 \begin_layout Plain Layout
3580 is the code for the language currently in use.
3581 If there are no translated documents, the default English versions will
3583 Note that the translated versions must have the same filenames (
3584 \begin_inset Flex Code
3587 \begin_layout Plain Layout
3593 above) as the original.
3594 If you feel up to translating the documentation (an excellent way to proof-read
3595 the original documentation by the way!), there are a few things you should
3599 \begin_layout Itemize
3600 Check out the documentation translation web page at
3601 \begin_inset CommandInset href
3603 name "https://www.lyx.org/Translation"
3604 target "https://www.lyx.org/Translation"
3610 That way, you can find out which (if any) documents have already been translate
3611 d into your language.
3612 You can also find out who (if anyone) is organizing the effort to translate
3613 the documentation into your language.
3614 If no one is organizing the effort, please let us know that you're interested.
3617 \begin_layout Standard
3618 Once you get to actually translating, here's a few hints for you that may
3622 \begin_layout Itemize
3623 Join the documentation team! There is information on how to do that in
3624 \begin_inset Flex Code
3627 \begin_layout Plain Layout
3634 \begin_inset Flex Noun
3637 \begin_layout Plain Layout
3638 Help\SpecialChar menuseparator
3644 ), which by the way is the first document you should translate.
3647 \begin_layout Itemize
3648 Learn the typographic conventions for the language you are translating to.
3649 Typography is an ancient art and over the centuries, a great variety of
3650 conventions have developed throughout different parts of the world.
3651 Also study the professional terminology amongst typographers in your country.
3652 Inventing your own terminology will only confuse the users.
3655 (Warning! Typography is addictive!)
3658 \begin_layout Itemize
3659 Make a copy of the document.
3660 This will be your working copy.
3661 You can use this as your personal translated help-file by placing it in
3663 \begin_inset Flex Code
3666 \begin_layout Plain Layout
3673 \begin_inset Note Greyedout
3676 \begin_layout Plain Layout
3681 For a complex document with external material (images, etc.), if you make
3683 \begin_inset space \thinspace{}
3687 \begin_inset space \space{}
3690 in a temp dir, beware that the links to external material may be broken
3691 when the document is moved to a different place.
3692 The best way is to retrieve the \SpecialChar LyX
3694 \begin_inset Flex URL
3697 \begin_layout Plain Layout
3699 https://www.lyx.org/HowToUseGIT
3704 ) and to edit the doc file in place.
3712 \begin_layout Itemize
3713 Sometimes the original document (from the \SpecialChar LyX
3714 team) will be updated.
3715 Use the source viewer at
3716 \begin_inset CommandInset href
3718 name "https://www.lyx.org/trac/timeline"
3719 target "https://www.lyx.org/trac/timeline"
3724 to see what has been changed.
3725 That way you can easily see which parts of the translated document need
3729 \begin_layout Standard
3730 If you ever find an error in the original document, fix it and notify the
3731 rest of the documentation team of the changes! (You didn't forget to join
3732 the documentation team, did you?)
3735 \begin_layout Standard
3736 \begin_inset Branch OutDated
3740 \begin_layout Section
3741 International Keyboard Support
3744 \begin_layout Standard
3747 [Editor's Note: The following section is by
3755 It needs to be fixed to conform to the new Documentation Style sheet and
3756 to make use of the new v1.0 features.
3757 The whole thing also needs to be merged with the section following it.-jw
3758 It may also be badly out of date.-rh (2008)]
3761 \begin_layout Subsection
3762 Defining Own Keymaps: Keymap File Format
3765 \begin_layout Standard
3766 Let's look at a keyboard definition file a little closer.
3767 It is a plain text file defining
3770 \begin_layout Itemize
3771 key-to-key or key-to-string translations
3774 \begin_layout Itemize
3778 \begin_layout Itemize
3779 dead keys exceptions
3782 \begin_layout Standard
3783 To define key-to-key or key-to-string translation, use this command:
3786 \begin_layout Quotation
3787 \begin_inset Flex Code
3790 \begin_layout Plain Layout
3799 \begin_inset Flex Code
3802 \begin_layout Plain Layout
3811 \begin_layout Standard
3813 \begin_inset Flex Code
3816 \begin_layout Plain Layout
3822 is the key to be translated and
3823 \begin_inset Flex Code
3826 \begin_layout Plain Layout
3832 is the string to be inserted into the document.
3833 To define dead keys, use:
3836 \begin_layout Quotation
3837 \begin_inset Flex Code
3840 \begin_layout Plain Layout
3849 \begin_inset Flex Code
3852 \begin_layout Plain Layout
3861 \begin_layout Standard
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 is a keyboard key and
3873 \begin_inset Flex Code
3876 \begin_layout Plain Layout
3883 The following dead keys are supported (shortcut name is in parentheses):
3886 \begin_layout Quotation
3890 \begin_inset space \hfill{}
3896 \begin_layout Quotation
3898 \begin_inset space \hfill{}
3904 \begin_layout Quotation
3906 \begin_inset space \hfill{}
3912 \begin_layout Quotation
3914 \begin_inset space \hfill{}
3920 \begin_layout Quotation
3922 \begin_inset space \hfill{}
3928 \begin_layout Quotation
3930 \begin_inset space \hfill{}
3937 \begin_layout Plain Layout
3949 \begin_layout Quotation
3951 \begin_inset space \hfill{}
3957 \begin_layout Quotation
3959 \begin_inset space \hfill{}
3966 \begin_layout Plain Layout
3978 \begin_layout Quotation
3980 \begin_inset space \hfill{}
3986 \begin_layout Quotation
3988 \begin_inset space \hfill{}
3994 \begin_layout Quotation
3996 \begin_inset space \hfill{}
4003 \begin_layout Plain Layout
4015 \begin_layout Quotation
4017 \begin_inset space \hfill{}
4024 \begin_layout Plain Layout
4036 \begin_layout Quotation
4038 \begin_inset space \hfill{}
4044 \begin_layout Quotation
4045 hungarian umlaut (hug)
4046 \begin_inset space \hfill{}
4052 \begin_layout Quotation
4054 \begin_inset space \hfill{}
4060 \begin_layout Quotation
4062 \begin_inset space \hfill{}
4069 \begin_layout Plain Layout
4081 \begin_layout Standard
4082 Since in many international keyboards there are exceptions to what some
4083 dead keys should do, you can define them using
4086 \begin_layout Quotation
4087 \begin_inset Flex Code
4090 \begin_layout Plain Layout
4098 deadkey key outstring
4101 \begin_layout Standard
4102 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4106 \begin_layout Quotation
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4123 \begin_layout Standard
4124 to make it work correctly.
4125 Also, you have to define as exceptions dead keys over i and j, to remove
4126 the dot from them before inserting an accent mark.
4127 I will change this when the time comes, but so far I haven't had time.
4130 \begin_layout Standard
4131 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4134 \begin_inset Flex Code
4137 \begin_layout Plain Layout
4143 have different meaning.
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4154 marks comments, quotes start and end \SpecialChar LaTeX
4156 To enter quote, you'll need to use
4157 \begin_inset Flex Code
4160 \begin_layout Plain Layout
4169 \begin_inset Flex Code
4172 \begin_layout Plain Layout
4179 \begin_inset Flex Code
4182 \begin_layout Plain Layout
4193 \begin_layout Standard
4194 If you make a keyboard description file that works for your language, please
4195 mail it to me, so I can include it in the next keymap distribution.
4198 \begin_layout Standard
4199 More keywords will be supported in keymap configuration file in future,
4203 \begin_layout Itemize
4204 \begin_inset Flex Code
4207 \begin_layout Plain Layout
4218 \begin_inset space \hfill{}
4222 \begin_inset Flex Code
4225 \begin_layout Plain Layout
4234 \begin_layout Itemize
4235 \begin_inset Flex Code
4238 \begin_layout Plain Layout
4249 \begin_inset space \hfill{}
4253 \begin_inset Flex Code
4256 \begin_layout Plain Layout
4262 an external keymap translation program
4265 \begin_layout Standard
4266 Also, it should look into
4267 \begin_inset Flex Code
4270 \begin_layout Plain Layout
4276 file for defaults, too (for example, a
4277 \begin_inset Flex Code
4280 \begin_layout Plain Layout
4288 option to include default keyboard).
4296 \begin_layout Section
4297 International Keymap Stuff
4298 \begin_inset CommandInset label
4300 name "sec:International-Keymap-Stuff"
4307 \begin_layout Standard
4308 \begin_inset Note Note
4311 \begin_layout Plain Layout
4312 In doing the revisions on this document in March 2008, I did not look over
4313 this stuff, as I do not understand it.
4314 It would be good if someone else could do so.
4323 \begin_layout Standard
4324 The next two sections describe the
4325 \begin_inset Flex Code
4328 \begin_layout Plain Layout
4337 \begin_inset Flex Code
4340 \begin_layout Plain Layout
4348 file syntax in detail.
4349 These sections should help you design your own key map if the ones provided
4350 do not meet your needs.
4353 \begin_layout Subsection
4357 \begin_layout Standard
4361 \begin_inset Flex Code
4364 \begin_layout Plain Layout
4370 file maps keystrokes to characters or strings.
4371 As the name suggests, it sets a keyboard mapping.
4373 \begin_inset Flex Code
4376 \begin_layout Plain Layout
4387 \begin_inset Flex Code
4390 \begin_layout Plain Layout
4405 \begin_inset Flex Code
4408 \begin_layout Plain Layout
4421 \begin_inset Flex Code
4424 \begin_layout Plain Layout
4433 \begin_inset Flex Code
4436 \begin_layout Plain Layout
4444 are described in this section.
4447 \begin_layout Labeling
4448 \labelwidthstring 00.00.0000
4449 \begin_inset Flex Code
4452 \begin_layout Plain Layout
4460 Map a character to a string
4463 \begin_layout LyX-Code
4478 \begin_layout Standard
4511 the double-quote (")
4528 must be escaped with a preceding backslash (
4539 \begin_layout Standard
4541 \begin_inset Flex Noun
4544 \begin_layout Plain Layout
4552 statement to cause the symbol
4553 \begin_inset Flex Noun
4556 \begin_layout Plain Layout
4564 to be output for the keystroke
4565 \begin_inset Flex Noun
4568 \begin_layout Plain Layout
4579 \begin_layout LyX-Code
4585 \begin_layout Labeling
4586 \labelwidthstring 00.00.0000
4587 \begin_inset Flex Code
4590 \begin_layout Plain Layout
4598 Specify an accent character
4601 \begin_layout LyX-Code
4610 \begin_layout Standard
4611 This will make the cha
4649 This is the dead key
4653 \begin_layout Plain Layout
4660 refers to a key that does not produce a character by itself, but when followed
4661 with another key, produces the desired accent character.
4662 For example, a German characte
4664 r with an umlaut like
4674 can be produced in this manner.
4683 \begin_layout Standard
4696 and then another key not in
4713 followed by the other, not allowed key, as output.
4717 \begin_inset Flex Noun
4720 \begin_layout Plain Layout
4728 cancels a dead key, so if
4739 \begin_inset Flex Noun
4742 \begin_layout Plain Layout
4751 , the cursor will not go one position backwards but will instead cancel
4767 might have had on the next keystroke.
4771 \begin_layout Standard
4772 The following example specifies that the character ' is to be an acute accent,
4773 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4776 \begin_layout LyX-Code
4779 kmod ' acute aeiouAEIOU
4782 \begin_layout Labeling
4783 \labelwidthstring 00.00.0000
4784 \begin_inset Flex Code
4787 \begin_layout Plain Layout
4793 Specify an exception to the accent character
4796 \begin_layout LyX-Code
4805 \begin_layout Standard
4806 This defines an exce
4847 have been assigned a keystroke with a previous
4850 \begin_inset Flex Code
4853 \begin_layout Plain Layout
4877 must not belong in the
4924 If such a declaration does not exist in
4932 \begin_inset Flex Code
4935 \begin_layout Plain Layout
4969 \begin_inset Flex Code
4972 \begin_layout Plain Layout
4986 \begin_layout Standard
4987 The following command produces causes äi to be produced when you enter acute-i
4991 \begin_layout LyX-Code
5005 \begin_layout Labeling
5006 \labelwidthstring 00.00.0000
5007 \begin_inset Flex Code
5010 \begin_layout Plain Layout
5016 Combine two accent characters
5019 \begin_layout LyX-Code
5025 accent1 accent2 allowed
5028 \begin_layout Standard
5029 This one is getting pretty esoteric.
5030 It allows you to combine the effect
5086 \begin_inset Flex Code
5089 \begin_layout Plain Layout
5117 \begin_layout Standard
5118 Consider this example from the
5119 \begin_inset Flex Code
5122 \begin_layout Plain Layout
5133 \begin_layout LyX-Code
5136 kmod ; acute aeioyvhAEIOYVH
5140 kcomb acute umlaut iyIY
5143 \begin_layout Standard
5144 This allows you to press
5145 \begin_inset Flex Noun
5148 \begin_layout Plain Layout
5156 and get the effect of
5157 \begin_inset Flex Code
5160 \begin_layout Plain Layout
5179 in this case cancels the last dead key, so if you press
5180 \begin_inset Flex Noun
5183 \begin_layout Plain Layout
5192 \begin_inset Flex Code
5195 \begin_layout Plain Layout
5208 \begin_layout Subsection
5212 \begin_layout Standard
5214 \begin_inset Flex Code
5217 \begin_layout Plain Layout
5225 mapping is performed, a
5226 \begin_inset Flex Code
5229 \begin_layout Plain Layout
5239 file maps the strings that the symbols generate to characters in the current
5241 The \SpecialChar LyX
5242 distribution currently includes at least the
5243 \begin_inset Flex Code
5246 \begin_layout Plain Layout
5255 \begin_inset Flex Code
5258 \begin_layout Plain Layout
5269 \begin_layout Standard
5271 \begin_inset Flex Code
5274 \begin_layout Plain Layout
5282 file is a sequence of declarations of the form
5285 \begin_layout LyX-Code
5298 \begin_layout Standard
5299 For example, in order to map
5300 \begin_inset Flex Noun
5303 \begin_layout Plain Layout
5313 to the corresponding character in the iso-8859-1 set (233), the following
5317 \begin_layout LyX-Code
5325 \begin_layout Standard
5327 \begin_inset Flex Code
5330 \begin_layout Plain Layout
5339 \begin_inset Flex Code
5342 \begin_layout Plain Layout
5360 the same character can apply to more than one string.
5362 \begin_inset Flex Code
5365 \begin_layout Plain Layout
5376 \begin_layout LyX-Code
5388 \begin_inset Newline newline
5404 \begin_layout Standard
5406 cannot find a mapping for the string produced by the keystroke or a
5407 deadkey sequence, it will check if it looks like an accented char and try
5408 to draw an accent over the character on screen.
5411 \begin_layout Subsection
5415 \begin_layout Standard
5416 There is a second way to add support for international characters through
5417 so-called dead-keys.
5418 A dead-key works in combination with a letter to produce an accented character.
5419 Here, we'll explain how to create a really simple dead-key to illustrate
5423 \begin_layout Standard
5424 Suppose you happen to need the circumflex character,
5425 \begin_inset Quotes eld
5429 \begin_inset Quotes erd
5434 \begin_inset Flex Noun
5437 \begin_layout Plain Layout
5444 \begin_inset space ~
5448 \begin_inset Flex Noun
5451 \begin_layout Plain Layout
5457 ] to the \SpecialChar LyX
5459 \begin_inset Flex Code
5462 \begin_layout Plain Layout
5469 \begin_inset Flex Code
5472 \begin_layout Plain Layout
5479 Now, whenever you type the
5480 \begin_inset Flex Noun
5483 \begin_layout Plain Layout
5489 -key followed by a letter, that letter will have a circumflex accent on
5491 For example, the sequence
5492 \begin_inset Quotes eld
5496 \begin_inset Flex Noun
5499 \begin_layout Plain Layout
5506 \begin_inset Quotes erd
5509 produces the letter:
5510 \begin_inset Quotes eld
5514 \begin_inset Quotes erd
5518 If you tried to type
5519 \begin_inset Quotes eld
5523 \begin_inset Flex Noun
5526 \begin_layout Plain Layout
5533 \begin_inset Quotes erd
5536 , however, \SpecialChar LyX
5537 will complain with a beep, since a
5538 \begin_inset Quotes eld
5542 \begin_inset Flex Noun
5545 \begin_layout Plain Layout
5552 \begin_inset Quotes erd
5555 never takes a circumflex accent.
5557 \begin_inset Flex Noun
5560 \begin_layout Plain Layout
5566 after a dead-key produces the bare-accent.
5567 Please note this last point! If you bind a key to a dead-key, you'll need
5568 to rebind the character on that key to yet another key.
5570 \begin_inset Flex Noun
5573 \begin_layout Plain Layout
5579 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5582 \begin_layout Standard
5583 One common way to bind dead-keys is to use
5584 \begin_inset Flex Noun
5587 \begin_layout Plain Layout
5594 \begin_inset Flex Noun
5597 \begin_layout Plain Layout
5604 \begin_inset Flex Noun
5607 \begin_layout Plain Layout
5613 in combination with an accent, like
5614 \begin_inset Quotes eld
5618 \begin_inset Flex Noun
5621 \begin_layout Plain Layout
5628 \begin_inset Quotes erd
5632 \begin_inset Quotes eld
5636 \begin_inset Flex Noun
5639 \begin_layout Plain Layout
5646 \begin_inset Quotes erd
5650 \begin_inset Quotes eld
5654 \begin_inset Flex Noun
5657 \begin_layout Plain Layout
5664 \begin_inset Quotes erd
5668 Another way involves using
5669 \begin_inset Flex Code
5672 \begin_layout Plain Layout
5679 \begin_inset Flex Code
5682 \begin_layout Plain Layout
5688 to set up the special
5689 \begin_inset Flex Code
5692 \begin_layout Plain Layout
5700 \begin_inset Flex Code
5703 \begin_layout Plain Layout
5709 acts in some ways just like
5710 \begin_inset Flex Noun
5713 \begin_layout Plain Layout
5719 and permits you to bind keys to accented characters.
5720 You can also turn keys into dead-keys by binding them to something like
5722 \begin_inset Flex Code
5725 \begin_layout Plain Layout
5731 and then binding this symbolic key to the corresponding \SpecialChar LyX
5736 \begin_layout Plain Layout
5741 : This is exactly what I do in my
5742 \begin_inset Flex Code
5745 \begin_layout Plain Layout
5752 \begin_inset Flex Code
5755 \begin_layout Plain Layout
5763 \begin_inset Flex Noun
5766 \begin_layout Plain Layout
5768 \begin_inset space ~
5777 \begin_inset Flex Code
5780 \begin_layout Plain Layout
5786 and a bunch of these
5787 \begin_inset Quotes eld
5791 \begin_inset Flex Code
5794 \begin_layout Plain Layout
5801 \begin_inset Quotes erd
5804 symbolic keys bound such things as
5805 \begin_inset Flex Noun
5808 \begin_layout Plain Layout
5810 \begin_inset space ~
5819 \begin_inset Flex Noun
5822 \begin_layout Plain Layout
5824 \begin_inset space ~
5833 This is how I produce my accented characters.
5838 You can make just about anything into the
5839 \begin_inset Flex Code
5842 \begin_layout Plain Layout
5849 \begin_inset Flex Noun
5852 \begin_layout Plain Layout
5858 keys, a spare function key, etc.
5859 As for the \SpecialChar LyX
5860 commands that produce accents, check the entry for
5861 \begin_inset Flex Code
5864 \begin_layout Plain Layout
5875 You'll find the complete list there.
5878 \begin_layout Subsection
5879 Saving your Language Configuration
5882 \begin_layout Standard
5883 You can edit your preferences so that your desired language environment
5884 is automatically configured when \SpecialChar LyX
5886 \begin_inset Flex Noun
5889 \begin_layout Plain Layout
5890 Edit\SpecialChar menuseparator
5899 \begin_layout Chapter
5900 Installing New Document Classes, Layouts, and Templates
5901 \begin_inset CommandInset label
5903 name "cha:Installing-New-Document"
5908 \begin_inset Argument 1
5911 \begin_layout Plain Layout
5912 Installing New Document Classes
5920 \begin_layout Standard
5921 In this chapter, we describe the procedures for creating and installing
5922 new \SpecialChar LyX
5923 layout and template files, as well as offer a refresher on correctly
5924 installing new \SpecialChar LaTeX
5929 \begin_layout Standard
5930 First, let us a say a few words about how one ought to think about the relation
5931 between \SpecialChar LyX
5932 and \SpecialChar LaTeX
5934 The thing to understand is that, in a certain sense, \SpecialChar LyX
5935 doesn't know anything
5936 about \SpecialChar LaTeX
5938 Indeed, from \SpecialChar LyX
5939 's point of view, \SpecialChar LaTeX
5940 is just one of several
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5948 in which it is capable of producing output.
5949 Other such formats are DocBook, plaintext, and XHTML.
5951 is, of course, a particularly important format, but very little of the
5952 information \SpecialChar LyX
5953 has about \SpecialChar LaTeX
5954 is actually contained in the program itself.
5958 \begin_layout Plain Layout
5959 Some commands are sufficiently complex that they are
5960 \begin_inset Quotes eld
5964 \begin_inset Quotes erd
5967 into \SpecialChar LyX
5969 But the developers generally regard this as a Bad Thing.
5974 Rather, that information, even for the standard classes like
5975 \begin_inset Flex Code
5978 \begin_layout Plain Layout
5984 , is contained in `layout files'.
5985 Similarly, \SpecialChar LyX
5986 itself does not know much about DocBook or XHTML.
5987 What it knows is contained in layout files.
5990 \begin_layout Standard
5991 You can think of the layout file for a given document class as a translation
5992 manual between \SpecialChar LyX
5993 constructs—paragraphs with their corresponding styles,
5994 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5997 Almost everything \SpecialChar LyX
5999 \begin_inset Flex Code
6002 \begin_layout Plain Layout
6008 , for example, is contained in the file
6009 \begin_inset Flex Code
6012 \begin_layout Plain Layout
6018 and in various other files it includes.
6019 For this reason, anyone intending to write layout files should plan to
6020 study the existing files.
6021 A good place to start is with
6022 \begin_inset Flex Code
6025 \begin_layout Plain Layout
6031 , which is included in
6032 \begin_inset Flex Code
6035 \begin_layout Plain Layout
6042 \begin_inset Flex Code
6045 \begin_layout Plain Layout
6051 , and many of the other layout files for document classes.
6052 This file is where sections and the like are defined:
6053 \begin_inset Flex Code
6056 \begin_layout Plain Layout
6062 tells \SpecialChar LyX
6063 how paragraphs that are marked with the Section, Subsection, etc,
6064 styles can be translated into corresponding \SpecialChar LaTeX
6065 , DocBook, and XHTML commands
6068 \begin_inset Flex Code
6071 \begin_layout Plain Layout
6077 file basically just includes several of these
6078 \begin_inset Flex Code
6081 \begin_layout Plain Layout
6090 \begin_layout Standard
6091 Defining the \SpecialChar LyX
6093 correspondence is not the only thing layout files do, though.
6094 Their other job is to define how the \SpecialChar LyX
6095 constructs themselves will appear
6097 The fact that layout files have these two jobs is often a source of confusion,
6098 because they are completely separate.
6099 Telling \SpecialChar LyX
6100 how to translate a certain paragraph style into \SpecialChar LaTeX
6103 how to display it; conversely, telling \SpecialChar LyX
6104 how to display a certain paragraph
6105 style does not tell \SpecialChar LyX
6106 how to translate it into \SpecialChar LaTeX
6107 (let alone tell \SpecialChar LaTeX
6110 So, in general, when you define a new \SpecialChar LyX
6111 construct, you must always do two
6112 quite separate things: (i)
6113 \begin_inset space ~
6116 tell \SpecialChar LyX
6117 how to translate it into \SpecialChar LaTeX
6119 \begin_inset space ~
6122 tell \SpecialChar LyX
6126 \begin_layout Standard
6127 Much the same is true, of course, as regards \SpecialChar LyX
6128 's other backend formats, though
6129 XHTML is in some ways different, because in that case \SpecialChar LyX
6134 able, to some extent, to use information about how it should display a
6135 paragraph on the screen to output information (in the form of CSS) about
6136 how the paragraph should be displayed in a browser.
6137 Even in this case, however, the distinction between what \SpecialChar LyX
6139 and how things are rendered externally remains in force, and the two can
6140 be controlled separately.
6142 \begin_inset CommandInset ref
6144 reference "sec:Tags-for-XHTML"
6151 \begin_layout Section
6152 Installing new \SpecialChar LaTeX
6156 \begin_layout Standard
6157 Some installations may not include a \SpecialChar LaTeX
6158 package or class file that you would
6159 like to use within \SpecialChar LyX
6161 For example, you might need Foil\SpecialChar TeX
6162 , a package for preparing slides for overhead
6164 Modern \SpecialChar LaTeX
6165 distributions like \SpecialChar TeX
6166 Live (2008 or newer) or MiK\SpecialChar TeX
6167 provide a user interface
6168 for installing such packages.
6169 For example, with MiK\SpecialChar TeX
6170 , you start the program
6171 \begin_inset Quotes eld
6175 \begin_inset space ~
6179 \begin_inset Quotes erd
6182 to get a list of available packages.
6183 To install one of them, right click on it or use the corresponding toolbar
6187 \begin_layout Standard
6188 If your \SpecialChar LaTeX
6189 distribution does not provide such a `package manager', or if the
6190 package is not available from your distribution, then follow these steps
6191 to install it manually:
6194 \begin_layout Enumerate
6195 Get the package from
6196 \begin_inset CommandInset href
6199 target "http://www.ctan.org/"
6207 \begin_layout Enumerate
6208 If the package contains a file with the ending
6209 \begin_inset Quotes eld
6213 \begin_inset Flex Code
6216 \begin_layout Plain Layout
6223 \begin_inset Quotes erd
6226 (is the case for Foil\SpecialChar TeX
6227 ) then open a console, change to the folder of this
6228 file and execute the command
6229 \begin_inset Flex Code
6232 \begin_layout Plain Layout
6239 You have now unpacked the package and have all files to install it.
6240 Most \SpecialChar LaTeX
6241 -packages are not packed and you can skip this step.
6244 \begin_layout Enumerate
6245 Now you need to decide if the package should be available for all users
6250 \begin_layout Enumerate
6251 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6252 for all users on your system, then install it in your `local' \SpecialChar TeX
6254 install it in your own `user' \SpecialChar TeX
6256 Where these trees should be created, if they do not already exist, depends
6258 To find this out, look in the file
6259 \begin_inset Flex Code
6262 \begin_layout Plain Layout
6272 \begin_layout Plain Layout
6273 This is usually in the directory
6274 \begin_inset Flex Code
6277 \begin_layout Plain Layout
6283 , though you can execute the command
6284 \begin_inset Flex Code
6287 \begin_layout Plain Layout
6298 The location of the `local' \SpecialChar TeX
6299 tree is defined by the
6300 \begin_inset Flex Code
6303 \begin_layout Plain Layout
6309 variable; this is usually somewhere like
6310 \begin_inset Flex Code
6313 \begin_layout Plain Layout
6314 /usr/local/share/texmf
6319 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6322 The location of the `user' \SpecialChar TeX
6324 \begin_inset Flex Code
6327 \begin_layout Plain Layout
6334 \begin_inset Flex Code
6337 \begin_layout Plain Layout
6344 \begin_inset Flex Code
6347 \begin_layout Plain Layout
6356 (If these variables are not predefined, you have to define them.) You'll
6357 probably need root permissions to create or modify the `local' tree, but
6358 not for your `user' tree.
6359 \begin_inset Newline newline
6362 In general, it is recommended to install in the user tree because your user
6363 will not be modified or even overwritten when you upgrade your system.
6364 It will typically also be backed up together with everything else when
6365 you backup your home directory (which, of course, you do on a regular basis).
6368 \begin_layout Enumerate
6369 On Windows, if you want the new package to be available for all users on
6370 your system, change to the folder where \SpecialChar LaTeX
6371 is installed and then change to
6373 \begin_inset Flex Code
6376 \begin_layout Plain Layout
6387 (For MiK\SpecialChar TeX
6388 , this would be by default the folder
6389 \begin_inset Flex Code
6392 \begin_layout Plain Layout
6410 \begin_layout Plain Layout
6411 Note that this will be the correct path only on English installations.
6412 On a German one, it would be
6413 \begin_inset Flex Code
6416 \begin_layout Plain Layout
6430 , and similarly for other languages.
6435 Create there a new folder
6436 \begin_inset Flex Code
6439 \begin_layout Plain Layout
6445 and copy all files of the package into it.
6447 \begin_inset Newline newline
6450 If the package should only available for you or you don't have admin permissions
6451 , do the same, but in the local \SpecialChar LaTeX
6454 \begin_inset space \thinspace{}
6457 g., for MiK\SpecialChar TeX
6459 \begin_inset space ~
6462 2.8 under Windows XP, this would be the folder:
6463 \begin_inset Newline newline
6469 \begin_inset Flex Code
6472 \begin_layout Plain Layout
6475 Documents and Settings
6487 \begin_inset Newline newline
6493 \begin_inset Phantom HPhantom
6496 \begin_layout Plain Layout
6507 \begin_inset Flex Code
6510 \begin_layout Plain Layout
6523 \begin_inset Newline newline
6526 On Vista, it would be:
6527 \begin_inset Newline newline
6531 \begin_inset Flex Code
6534 \begin_layout Plain Layout
6560 \begin_layout Enumerate
6561 Now one only need to tell \SpecialChar LaTeX
6562 that there are new files.
6563 This depends on the used \SpecialChar LaTeX
6568 \begin_layout Enumerate
6569 For \SpecialChar TeX
6570 Live execute the command
6571 \begin_inset Flex Code
6574 \begin_layout Plain Layout
6581 If you installed the package for all users, then you will probably need
6582 to have root permissions for that.
6585 \begin_layout Enumerate
6586 For MiK\SpecialChar TeX
6587 , if you have installed the package for all users, start the program
6589 \begin_inset Quotes eld
6593 \begin_inset space ~
6597 \begin_inset Quotes erd
6600 and press the button marked
6601 \begin_inset Quotes eld
6605 \begin_inset Quotes erd
6609 Otherwise start the program
6610 \begin_inset Quotes eld
6614 \begin_inset Quotes erd
6621 \begin_layout Enumerate
6622 Finally, you need to tell \SpecialChar LyX
6623 that there are new packages available.
6624 So, in \SpecialChar LyX
6626 \begin_inset Flex Noun
6629 \begin_layout Plain Layout
6632 \SpecialChar menuseparator
6638 and then restart \SpecialChar LyX
6642 \begin_layout Standard
6643 Now the package is installed.
6644 In our example, the document class
6645 \begin_inset Flex Code
6648 \begin_layout Plain Layout
6654 will now be available under
6655 \begin_inset Flex Noun
6658 \begin_layout Plain Layout
6659 Document\SpecialChar menuseparator
6660 Settings\SpecialChar menuseparator
6667 \begin_inset Quotes eld
6671 \begin_inset Quotes erd
6678 \begin_layout Standard
6679 If you would like to use a \SpecialChar LaTeX
6680 document class that is not even listed in the
6682 \begin_inset Flex Noun
6685 \begin_layout Plain Layout
6686 Document\SpecialChar menuseparator
6687 Settings\SpecialChar menuseparator
6693 , then you need to create a `layout' file for it.
6694 That is the topic of the next section.
6697 \begin_layout Section
6698 Types of layout files
6701 \begin_layout Standard
6702 This section describes the various sorts of \SpecialChar LyX
6703 files that contain layout informati
6705 These files describe various paragraph and character styles, determining
6706 how \SpecialChar LyX
6707 should display them and how they should be translated into \SpecialChar LaTeX
6709 XHTML, or whatever output format is being used.
6713 \begin_layout Standard
6714 We shall try to provide a thorough description of the process of writing
6716 However, there are so many different types of documents supported even
6717 by just \SpecialChar LaTeX
6718 that we can't hope to cover every different possibility or problem
6719 you might encounter.
6720 The \SpecialChar LyX
6721 users' list is frequented by people with lots of experience with layout
6722 design who are willing to share what they've learned, so please feel free
6723 to ask questions there.
6726 \begin_layout Standard
6727 As you prepare to write a new layout, it is extremely helpful to look at
6728 the layouts distributed with \SpecialChar LyX
6730 If you write a \SpecialChar LyX
6731 layout for a \SpecialChar LaTeX
6732 document class that might also be used by
6733 others, or write a module that might be useful to others, then you should
6734 consider posting your layout to the
6735 \begin_inset CommandInset href
6737 name "layout section on the LyX wiki"
6738 target "https://wiki.lyx.org/Layouts/Layouts"
6743 or even to the \SpecialChar LyX
6744 developers' list, so that it might be included in \SpecialChar LyX
6749 \begin_layout Plain Layout
6750 Note that \SpecialChar LyX
6751 is licensed under the General Public License, so any material
6752 that is contributed to \SpecialChar LyX
6753 must be similarly licensed.
6761 \begin_layout Subsection
6763 \begin_inset CommandInset label
6765 name "subsec:Layout-modules"
6772 \begin_layout Standard
6773 We have spoken to this point about `layout files'.
6774 But there are different sorts of files that contain layout information.
6775 Layout files, strictly so called, have the
6776 \begin_inset Flex Code
6779 \begin_layout Plain Layout
6785 extension and provide \SpecialChar LyX
6786 with information about document classes.
6787 Since \SpecialChar LyX
6788 1.6 layout information can also be contained in layout
6793 \begin_inset Flex Code
6796 \begin_layout Plain Layout
6803 Modules are to \SpecialChar LaTeX
6804 packages much as layouts are to \SpecialChar LaTeX
6805 classes, and some modules—such
6807 \begin_inset Flex Code
6810 \begin_layout Plain Layout
6816 module—specifically provide support for one package.
6817 In a sense, layout modules are similar to included
6821 \begin_layout Plain Layout
6822 These can have any extension, but by convention have the
6823 \begin_inset Flex Code
6826 \begin_layout Plain Layout
6838 \begin_inset Flex Code
6841 \begin_layout Plain Layout
6847 —in that modules are not specific to a given document class but may be used
6848 with many different classes.
6849 The difference is that using an included file with
6850 \begin_inset Flex Code
6853 \begin_layout Plain Layout
6859 requires editing that file.
6860 Modules, by contrast, are selected in the
6861 \begin_inset Flex Noun
6864 \begin_layout Plain Layout
6865 Document\SpecialChar menuseparator
6874 \begin_layout Standard
6875 Building modules is the easiest way to get started with layout editing,
6876 since it can be as simple as adding a single new paragraph style or flex
6878 But modules may, in principle, contain anything a layout file can contain.
6881 \begin_layout Standard
6882 After creating a new module and copying it to the
6883 \begin_inset Flex Code
6886 \begin_layout Plain Layout
6892 folder, you will need to reconfigure and then restart \SpecialChar LyX
6895 However, changes you make to the module will be seen immediately, if you
6897 \begin_inset Flex Noun
6900 \begin_layout Plain Layout
6901 Document\SpecialChar menuseparator
6907 , highlight something, and then hit
6908 \begin_inset Quotes eld
6912 \begin_inset Quotes erd
6918 It is strongly recommended that you save your work before doing this
6923 it is strongly recommended that you not attempt to edit modules while simultaneo
6924 usly working on actual documents
6927 Though of course the developers strive to keep \SpecialChar LyX
6928 stable in such situations,
6929 syntax errors and the like in your module file could cause strange behavior.
6932 \begin_layout Subsubsection
6936 \begin_layout Standard
6937 Modules are to \SpecialChar LyX
6938 as packages are to \SpecialChar LaTeX
6940 Sometimes, however, you find yourself wanting a specific inset or character
6941 style just for one document and writing a module that will also be available
6942 to other documents makes little sense.
6943 What you need is \SpecialChar LyX
6945 \begin_inset Quotes eld
6949 \begin_inset Quotes erd
6955 \begin_layout Standard
6956 You will find it under
6958 Document\SpecialChar menuseparator
6959 Settings\SpecialChar menuseparator
6963 The large text box allows you to enter anything that you might enter in
6964 a layout file or module.
6965 You can think of a document's local layout, in fact, as a module that belongs
6967 So, in particular, you must enter a
6968 \begin_inset Flex Code
6971 \begin_layout Plain Layout
6978 Any format is acceptable, but one would normally use the format current
6980 (In \SpecialChar LyX
6987 , the current layout format is
6996 \begin_layout Standard
6997 When you have entered something in the
6998 \begin_inset Flex Code
7001 \begin_layout Plain Layout
7007 pane, \SpecialChar LyX
7009 \begin_inset Quotes eld
7013 \begin_inset Quotes erd
7016 button at the bottom.
7017 Clicking this button will cause \SpecialChar LyX
7018 to determine whether what you have entered
7019 is valid layout information for the chosen format.
7021 will report the result but, unfortunately, will not tell you what errors
7022 there might have been.
7023 These will be written to the terminal, however, if \SpecialChar LyX
7024 is started from a terminal.
7025 You will not be permitted to save your local layout until you have entered
7029 \begin_layout Standard
7030 The warnings at the end of the previous section apply here, too.
7031 Do not play with local layout while you are actually working, especially
7032 if you have not saved your document.
7033 That said, using local layout with a test document can be a very convenient
7034 way to try out layout ideas, or even to start developing a module.
7037 \begin_layout Subsection
7039 \begin_inset Flex Noun
7042 \begin_layout Plain Layout
7051 \begin_layout Standard
7052 There are two situations you are likely to encounter when wanting to support
7053 a new \SpecialChar LaTeX
7054 document class, involving style (
7055 \begin_inset Flex Code
7058 \begin_layout Plain Layout
7064 ) files and \SpecialChar LaTeX2e
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7076 Supporting a style file is usually fairly easy.
7077 Supporting a new class file is a bit harder.
7078 We'll discuss the former in this section and the latter in the next.
7079 Similar remarks apply, of course, if you want to support a new DocBook
7083 \begin_layout Standard
7084 The easier case is the one in which your new document class is provided
7085 as a style file that is to be used in conjunction with an already supported
7087 For the sake of the example, we'll assume that the style file is called
7089 \begin_inset Flex Noun
7092 \begin_layout Plain Layout
7098 and that it is meant to be used with
7099 \begin_inset Flex Noun
7102 \begin_layout Plain Layout
7108 , which is a standard class.
7112 \begin_layout Standard
7113 Start by copying the existing class's layout file into your local directory:
7117 \begin_layout Plain Layout
7118 Of course, which directory is your local directory will vary by platform,
7119 and \SpecialChar LyX
7120 allows you to specify your local directory on startup, too, using
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7139 \begin_layout LyX-Code
7140 cp report.layout ~/.lyx/layouts/myclass.layout
7143 \begin_layout Standard
7145 \begin_inset Flex Code
7148 \begin_layout Plain Layout
7154 and change the line:
7157 \begin_layout LyX-Code
7160 DeclareLaTeXClass{Report (Standard Class)}
7163 \begin_layout Standard
7167 \begin_layout LyX-Code
7170 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7173 \begin_layout Standard
7177 \begin_layout LyX-Code
7179 \begin_inset Newline newline
7185 \begin_inset Newline newline
7191 \begin_layout Standard
7192 near the top of the file.
7195 \begin_layout Standard
7196 Start \SpecialChar LyX
7198 \begin_inset Flex Noun
7201 \begin_layout Plain Layout
7202 Tools\SpecialChar menuseparator
7209 Then restart \SpecialChar LyX
7210 and try creating a new document.
7212 \begin_inset Flex Noun
7215 \begin_layout Plain Layout
7221 " as a document class option in the
7222 \begin_inset Flex Noun
7225 \begin_layout Plain Layout
7226 Document\SpecialChar menuseparator
7233 It is likely that some of the sectioning commands and such in your new
7234 class will work differently from how they worked in the base class—
7235 \begin_inset Flex Code
7238 \begin_layout Plain Layout
7244 in this example—so you can fiddle around with the settings for the different
7245 sections if you wish.
7246 The layout information for sections is contained in
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7256 , but you do not need to copy and change this file.
7257 Instead, you can simply add your changes to your layout file, after the
7259 \begin_inset Flex Code
7262 \begin_layout Plain Layout
7268 , which itself includes
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7279 For example, you might add these lines:
7282 \begin_layout LyX-Code
7286 \begin_layout LyX-Code
7290 \begin_layout LyX-Code
7294 \begin_layout LyX-Code
7298 \begin_layout LyX-Code
7302 \begin_layout Standard
7303 to change the font for chapter headings to sans-serif.
7304 This will override (or, in this case, add to) the existing declaration
7305 for the Chapter style.
7309 \begin_layout Standard
7310 Your new package may also provide commands or environments not present in
7312 In this case, you will want to add these to the layout file.
7314 \begin_inset CommandInset ref
7316 reference "sec:TextClass"
7320 for information on how to do so.
7323 \begin_layout Standard
7325 \begin_inset Flex Noun
7328 \begin_layout Plain Layout
7334 can be used with several different document classes, and even if it cannot,
7335 you might find it easiest just to write a module that you can load with
7337 The simplest possible such module would be:
7340 \begin_layout LyX-Code
7343 DeclareLyXModule{My Class}
7346 \begin_layout LyX-Code
7350 \begin_layout LyX-Code
7351 #Support for myclass.sty.
7354 \begin_layout LyX-Code
7356 \begin_inset Newline newline
7362 \begin_layout LyX-Code
7370 \begin_inset Newline newline
7376 \begin_layout LyX-Code
7378 \begin_inset Newline newline
7384 \begin_inset Newline newline
7390 \begin_layout Standard
7391 A more complex module might modify the behavior of some existing constructs
7392 or define some new ones.
7394 \begin_inset CommandInset ref
7396 reference "sec:TextClass"
7403 \begin_layout Subsection
7405 \begin_inset Flex Noun
7408 \begin_layout Plain Layout
7417 \begin_layout Standard
7418 There are two possibilities here.
7419 One is that the class file is itself based upon an existing document class.
7420 For example, many thesis classes are based upon
7421 \begin_inset Flex Noun
7424 \begin_layout Plain Layout
7431 To see whether yours is, look for a line like
7434 \begin_layout LyX-Code
7440 \begin_layout Standard
7442 If so, then you may proceed largely as in the previous section, though
7444 \begin_inset Flex Code
7447 \begin_layout Plain Layout
7448 Declare\SpecialChar LaTeX
7454 line will be different.
7455 If your new class is
7456 \begin_inset Flex Code
7459 \begin_layout Plain Layout
7465 and it is based upon
7466 \begin_inset Flex Code
7469 \begin_layout Plain Layout
7475 , then the line should read:
7479 \begin_layout Plain Layout
7480 And it will be easiest if you save the file to
7481 \begin_inset Flex Code
7484 \begin_layout Plain Layout
7491 assumes that the document class has the same name as the layout file.
7500 \begin_layout LyX-Code
7503 DeclareLaTeXClass[thesis,book]{thesis}
7506 \begin_layout Standard
7507 If, on the other hand, the new class is not based upon an existing class,
7508 you will probably have to
7509 \begin_inset Quotes eld
7513 \begin_inset Quotes erd
7517 We strongly suggest copying an existing layout file which uses a similar
7519 class and then modifying it, if you can do so.
7520 At least use an existing file as a starting point so you can find out what
7521 items you need to worry about.
7522 Again, the specifics are covered below.
7525 \begin_layout Subsection
7527 \begin_inset CommandInset label
7529 name "subsec:Creating-Templates"
7536 \begin_layout Standard
7537 Once you have written a layout file for a new document class, you might
7538 want to consider writing a
7543 A template acts as a kind of tutorial for your layout, showing how it might
7544 be used, though containing dummy content.
7545 You can of course look at the various templates included with \SpecialChar LyX
7549 \begin_layout Standard
7550 Templates are created just like usual documents: using \SpecialChar LyX
7552 The only difference is that usual documents contain all possible settings,
7553 including the font scheme and the paper size.
7554 Usually a user doesn't want a template to overwrite his preferred settings
7555 for such parameters.
7556 For that reason, the designer of a template should remove the corresponding
7558 \begin_inset Flex Code
7561 \begin_layout Plain Layout
7570 \begin_inset Flex Code
7573 \begin_layout Plain Layout
7581 from the template \SpecialChar LyX
7583 This can be done with any simple text-editor, for example
7584 \begin_inset Flex Code
7587 \begin_layout Plain Layout
7594 \begin_inset Flex Code
7597 \begin_layout Plain Layout
7606 \begin_layout Standard
7607 Put the edited template files you create in
7608 \begin_inset Flex Code
7611 \begin_layout Plain Layout
7617 , copy the ones you use from the global template directory in
7618 \begin_inset Flex Code
7621 \begin_layout Plain Layout
7627 to the same place, and redefine the template path in the
7628 \begin_inset Flex Noun
7631 \begin_layout Plain Layout
7632 Tools\SpecialChar menuseparator
7633 Preferences\SpecialChar menuseparator
7642 \begin_layout Standard
7643 Note, by the way, that there is a template which has a particular meaning:
7644 \begin_inset Newline linebreak
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7658 This template is loaded every time you create a new document with
7659 \begin_inset Flex Noun
7662 \begin_layout Plain Layout
7663 File\SpecialChar menuseparator
7669 in order to provide useful defaults.
7670 To create this template from inside \SpecialChar LyX
7671 , all you have to do is to open a document
7672 with the correct settings, and use the
7673 \begin_inset Flex Noun
7676 \begin_layout Plain Layout
7677 Save as Document Defaults
7685 \begin_layout Subsection
7686 Upgrading old layout files
7689 \begin_layout Standard
7690 The format of layout files changes with each \SpecialChar LyX
7691 release, so old layout files
7692 need to be converted to the new format.
7694 reads a layout file in an older format, it automatically calls the
7696 \begin_inset Flex Code
7699 \begin_layout Plain Layout
7705 to convert it to a temporary file in current format.
7706 The original file is left untouched.
7707 If you use the layout file often, then, you may want to convert it permanently,
7708 so that \SpecialChar LyX
7709 does not have to do so itself every time.
7710 To do this, you can call the converter manually:
7713 \begin_layout Enumerate
7715 \begin_inset Flex Code
7718 \begin_layout Plain Layout
7725 \begin_inset Flex Code
7728 \begin_layout Plain Layout
7737 \begin_layout Enumerate
7739 \begin_inset Newline newline
7743 \begin_inset Flex Code
7746 \begin_layout Plain Layout
7747 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7753 \begin_inset Newline newline
7757 \begin_inset Flex Code
7760 \begin_layout Plain Layout
7766 is the name of your \SpecialChar LyX
7770 \begin_layout Standard
7771 Note that manual conversion does not affect included files, so these will
7772 have to be converted separately.
7775 \begin_layout Subsection
7776 \begin_inset CommandInset label
7778 name "subsec:Cite-Engine-Files"
7785 \begin_layout Standard
7786 A specific form of layout files are the so-called
7787 \begin_inset Flex Code
7790 \begin_layout Plain Layout
7796 files that are located in the
7797 \begin_inset Flex Code
7800 \begin_layout Plain Layout
7807 Their purpose is to define the specifics of \SpecialChar LaTeX
7808 packages aimed at bibliography
7821 , but also the way how normal Bib\SpecialChar TeX
7822 citations (without additional packages)
7823 are handled in \SpecialChar LyX
7824 is defined in such a file.
7828 \begin_layout Standard
7829 More specifically, it is defined which packages \SpecialChar LyX
7830 needs to load, which citation
7831 commands are available, how these are to be displayed in \SpecialChar LyX
7833 the dialogs, the context menus) as well as in the XHTML and plain text
7835 Furthermore, the files specify available style variants (author-year, numerical
7836 , etc.) and their specifics.
7837 The cite engine files are also used to generate the options that are available
7840 Document\SpecialChar menuseparator
7841 Settings\SpecialChar menuseparator
7842 Bibliography\SpecialChar menuseparator
7848 \begin_layout Standard
7849 Even though a cite engine file is essentially a normal layout file that
7850 could theoretically include any layout information, it usually primarily
7851 includes some specific parameters such as
7852 \begin_inset Flex Code
7855 \begin_layout Plain Layout
7862 \begin_inset Flex Code
7865 \begin_layout Plain Layout
7872 \begin_inset Flex Code
7875 \begin_layout Plain Layout
7882 \begin_inset Flex Code
7885 \begin_layout Plain Layout
7892 The syntax of the latter two is described in
7893 \begin_inset CommandInset ref
7895 reference "subsec:Citation-engine-description"
7903 \begin_inset CommandInset ref
7905 reference "subsec:Citation-format-description"
7909 , as well as in the files themselves.
7912 \begin_layout Section
7913 \begin_inset CommandInset label
7915 name "sec:TextClass"
7919 The layout file format
7922 \begin_layout Standard
7923 The following sections describe how layout files are structured and written.
7924 Our advice is to go slowly, save and test often.
7925 It is really not that hard, except that the multitude of options can become
7926 overwhelming, especially if you try to check out too many at once.
7927 It becomes easier if you use existing layouts of \SpecialChar LyX
7928 as examples/reference
7929 or if you modify an existing layout to your needs.
7932 \begin_layout Standard
7933 Note that all the tags used in layout files are case-insensitive.
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7955 \begin_inset Flex Code
7958 \begin_layout Plain Layout
7964 are really the same tag.
7965 The possible arguments are printed in brackets after the tag's name.
7966 The default argument is typeset
7967 \begin_inset Flex Code
7970 \begin_layout Plain Layout
7979 If the argument has a data type like
7980 \begin_inset Quotes eld
7984 \begin_inset Quotes erd
7988 \begin_inset Quotes eld
7992 \begin_inset Quotes erd
7995 , the default is shown like this:
7996 \begin_inset Flex Code
7999 \begin_layout Plain Layout
8010 \begin_layout Subsection
8011 The document class declaration and classification
8014 \begin_layout Standard
8015 Lines in a layout file which begin with
8016 \begin_inset Flex Code
8019 \begin_layout Plain Layout
8026 There is one exception to this rule.
8028 \begin_inset Flex Code
8031 \begin_layout Plain Layout
8037 files should begin with lines like:
8040 \begin_layout LyX-Code
8043 #% Do not delete the line below; configure depends on this
8046 \begin_layout LyX-Code
8051 DeclareLaTeXClass{Article (Standard Class)}
8054 \begin_layout LyX-Code
8059 DeclareCategory{Articles}
8062 \begin_layout Standard
8063 The second and third lines are used when you (re)configure \SpecialChar LyX
8065 The layout file is read by the \SpecialChar LaTeX
8067 \begin_inset Flex Code
8070 \begin_layout Plain Layout
8076 , in a special mode where
8077 \begin_inset Flex Code
8080 \begin_layout Plain Layout
8087 The first line is just a \SpecialChar LaTeX
8088 comment, the second one contains the mandatory
8089 declaration of the text class and the third line contains the optional
8090 classification of the class.
8091 If these lines appear in a file named
8092 \begin_inset Flex Code
8095 \begin_layout Plain Layout
8101 , then they define a text class of name
8102 \begin_inset Flex Code
8105 \begin_layout Plain Layout
8111 (the name of the layout file) which uses the \SpecialChar LaTeX
8113 \begin_inset Flex Code
8116 \begin_layout Plain Layout
8122 (the default is to use the same name as the layout).
8124 \begin_inset Quotes eld
8127 Article (Standard Class)
8128 \begin_inset Quotes erd
8131 that appears above is used as a description of the text class in the
8132 \begin_inset Flex Noun
8135 \begin_layout Plain Layout
8136 Document\SpecialChar menuseparator
8144 \begin_inset Quotes eld
8148 \begin_inset Quotes erd
8151 in the example) is also used in the
8152 \begin_inset Flex Noun
8155 \begin_layout Plain Layout
8156 Document\SpecialChar menuseparator
8162 dialog: the text classes are grouped by these categories (which are usually
8163 genres, so typical categories are
8164 \begin_inset Quotes eld
8168 \begin_inset Quotes erd
8172 \begin_inset Quotes eld
8176 \begin_inset Quotes erd
8180 \begin_inset Quotes eld
8184 \begin_inset Quotes erd
8188 \begin_inset Quotes eld
8192 \begin_inset Quotes erd
8196 \begin_inset Quotes eld
8200 \begin_inset Quotes erd
8204 \begin_inset Quotes eld
8208 \begin_inset Quotes erd
8212 If no category has been declared, the class will be put in the
8213 \begin_inset Quotes eld
8217 \begin_inset Quotes erd
8223 \begin_layout Standard
8224 Let's assume that you wrote your own text class that uses the
8225 \begin_inset Flex Code
8228 \begin_layout Plain Layout
8234 document class, but where you changed the appearance of the section headings.
8235 If you put it in a file
8236 \begin_inset Flex Code
8239 \begin_layout Plain Layout
8245 , the header of this file should be:
8248 \begin_layout LyX-Code
8251 #% Do not delete the line below; configure depends on this
8254 \begin_layout LyX-Code
8259 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8262 \begin_layout LyX-Code
8267 DeclareCategory{Articles}
8270 \begin_layout Standard
8271 This declares a text class
8272 \begin_inset Flex Code
8275 \begin_layout Plain Layout
8281 , associated with the \SpecialChar LaTeX
8283 \begin_inset Flex Code
8286 \begin_layout Plain Layout
8293 \begin_inset Quotes eld
8296 Article (with My Own Headings)
8297 \begin_inset Quotes erd
8301 If your text class depends on several packages, you can declare it as:
8304 \begin_layout LyX-Code
8307 #% Do not delete the line below; configure depends on this
8310 \begin_layout LyX-Code
8315 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8318 \begin_layout LyX-Code
8323 DeclareCategory{Articles}
8326 \begin_layout Standard
8327 This indicates that your text class uses the
8328 \begin_inset Flex Code
8331 \begin_layout Plain Layout
8338 Finally, it is also possible to declare classes for DocBook code.
8339 Typical declarations will look like:
8342 \begin_layout LyX-Code
8345 #% Do not delete the line below; configure depends on this
8348 \begin_layout LyX-Code
8353 DeclareDocBookClass[article]{SGML (DocBook Article)}
8356 \begin_layout LyX-Code
8361 DeclareCategory{Articles (DocBook)}
8364 \begin_layout Standard
8365 Note that these declarations can also be given an optional parameter declaring
8366 the name of the document class (but not a list).
8369 \begin_layout Standard
8370 So, to be as explicit as possible, the form of the layout declaration is:
8373 \begin_layout LyX-Code
8378 DeclareLaTeXClass[class,package.sty]{layout description}
8381 \begin_layout LyX-Code
8386 DeclareCategory{category}
8389 \begin_layout Standard
8390 The class need only be specified if the name of the \SpecialChar LaTeX
8392 name of the layout file are different or if there are packages to load.
8393 If the name of the class file is not specified, then \SpecialChar LyX
8395 that it is the same as the name of the layout file.
8398 \begin_layout Standard
8399 When the text class has been modified to your taste, all you have to do
8400 is to copy it either to
8401 \begin_inset Flex Code
8404 \begin_layout Plain Layout
8411 \begin_inset Flex Code
8414 \begin_layout Plain Layout
8421 \begin_inset Flex Noun
8424 \begin_layout Plain Layout
8425 Tools\SpecialChar menuseparator
8431 , exit \SpecialChar LyX
8433 Then your new text class should be available along with the others.
8436 \begin_layout Standard
8437 Once the layout file is installed, you can edit it and see your changes
8438 without having to reconfigure or to restart \SpecialChar LyX
8443 \begin_layout Plain Layout
8444 In versions of \SpecialChar LyX
8445 prior to 1.6, this was not true.
8446 As a result, editing layout files was very time consuming, since you had
8447 constantly to restart \SpecialChar LyX
8453 You can force a reload of the current layout by using the \SpecialChar LyX
8455 \begin_inset Flex Noun
8458 \begin_layout Plain Layout
8465 There is no default binding for this function—though, of course, you can
8466 bind it to a key yourself.
8467 But you will normally use this function simply by entering it in the mini-buffe
8472 \begin_layout Standard
8478 \begin_inset Flex Noun
8481 \begin_layout Plain Layout
8487 is very much an `advanced feature'.
8492 recommended that you save your work before using this function.
8497 recommended that you not attempt to edit layout information while simultaneousl
8498 y working on a document that you care about.
8499 Use a test document.
8500 Syntax errors and the like in your layout file could cause peculiar behavior.
8501 In particular, such errors could cause \SpecialChar LyX
8502 to regard the current layout as
8503 invalid and to attempt to switch to some other layout.
8507 \begin_layout Plain Layout
8508 Really bad syntax errors may even caused \SpecialChar LyX
8510 This is because certain sorts of errors may make \SpecialChar LyX
8521 The \SpecialChar LyX
8522 team strives to keep \SpecialChar LyX
8523 stable in such situations, but safe is better
8528 \begin_layout Plain Layout
8529 While we're giving advice: make regular backups.
8530 And be nice to your mother.
8538 \begin_layout Subsection
8539 The Module declaration
8542 \begin_layout Standard
8543 A module must begin with a line like the following:
8546 \begin_layout LyX-Code
8549 DeclareLyXModule[endnotes.sty]{Endnotes}
8550 \change_inserted -712698321 1554395911
8554 \begin_layout LyX-Code
8556 \change_inserted -712698321 1554395924
8561 DeclareCategory{Foot- and Endnotes}
8562 \change_deleted -712698321 1554395911
8570 \begin_layout Standard
8571 The mandatory argument
8572 \change_inserted -712698321 1554395956
8581 , in curly brackets, is the name of the module, as it should appear in
8582 \begin_inset Flex Noun
8585 \begin_layout Plain Layout
8586 Document\SpecialChar menuseparator
8587 Settings\SpecialChar menuseparator
8594 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8596 on which the module depends.
8597 It is also possible to use the form
8598 \begin_inset Flex Noun
8601 \begin_layout Plain Layout
8607 as an optional argument, which declares that the module can only be used
8608 when there exists a conversion chain between the formats `
8609 \begin_inset Flex Code
8612 \begin_layout Plain Layout
8619 \begin_inset Flex Code
8622 \begin_layout Plain Layout
8630 \change_inserted -712698321 1554396133
8637 declaration is not strictly mandatory, but you should add it, since it
8638 is helpful to find the module.
8639 Please have a look at the existing module categories and if appropriate,
8645 \begin_layout Standard
8647 \change_inserted -712698321 1554395988
8650 declaration should then be followed by lines like the following:
8654 \begin_layout Plain Layout
8655 Preferably in English if the module should be published with \SpecialChar LyX
8657 This description will appear in the list of messages to be translated and
8658 will be thus translated with the next interface update.
8666 \begin_layout LyX-Code
8670 \begin_layout LyX-Code
8671 #Adds an endnote command, in addition to footnotes.
8675 \begin_layout LyX-Code
8676 #You will need to add
8678 theendnotes in TeX code where you
8681 \begin_layout LyX-Code
8682 #want the endnotes to appear.
8686 \begin_layout LyX-Code
8690 \begin_layout LyX-Code
8691 #Requires: somemodule | othermodule
8694 \begin_layout LyX-Code
8695 #Excludes: badmodule
8698 \begin_layout Standard
8699 The description is used in
8700 \begin_inset Flex Noun
8703 \begin_layout Plain Layout
8704 Document\SpecialChar menuseparator
8705 Settings\SpecialChar menuseparator
8711 to provide the user with information about what the module does.
8713 \begin_inset Flex Code
8716 \begin_layout Plain Layout
8722 line is used to identify other modules with which this one must be used;
8724 \begin_inset Flex Code
8727 \begin_layout Plain Layout
8733 line is used to identify modules with which this one may not be used.
8734 Both are optional, and, as shown, multiple modules should be separated
8735 with the pipe symbol: |.
8736 Note that the required modules are treated disjunctively:
8740 of the required modules must be used.
8745 excluded module may be used.
8746 Note that modules are identified here by their filenames without the
8747 \begin_inset Flex Code
8750 \begin_layout Plain Layout
8758 \begin_inset Flex Code
8761 \begin_layout Plain Layout
8768 \begin_inset Flex Code
8771 \begin_layout Plain Layout
8780 \begin_layout Subsection
8781 The CiteEngine file declaration
8784 \begin_layout Standard
8785 A cite engine file must begin with a line like the following:
8788 \begin_layout LyX-Code
8791 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8794 \begin_layout Standard
8795 The mandatory argument, in curly brackets, is the name of the cite style,
8796 as it should appear in
8797 \begin_inset Flex Noun
8800 \begin_layout Plain Layout
8801 Document\SpecialChar menuseparator
8802 Settings\SpecialChar menuseparator
8809 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8811 on which the cite engine depends.
8814 \begin_layout Standard
8815 The cite engine declaration should then be followed by lines like the following:
8819 \begin_layout Plain Layout
8820 Preferably in English if the module should be published with \SpecialChar LyX
8822 This description will appear in the list of messages to be translated and
8823 will be thus translated with the next interface update.
8831 \begin_layout LyX-Code
8835 \begin_layout LyX-Code
8836 # Biblatex supports many author-year and numerical styles.
8839 \begin_layout LyX-Code
8840 # It is mainly aimed at the Humanities.
8844 \begin_layout LyX-Code
8845 # customizable, fully localized and provides many features
8848 \begin_layout LyX-Code
8849 # that are not possible with BibTeX.
8850 The use of 'biber' as
8853 \begin_layout LyX-Code
8854 # bibliography processor is advised.
8857 \begin_layout LyX-Code
8861 \begin_layout Standard
8862 The description is used in
8863 \begin_inset Flex Noun
8866 \begin_layout Plain Layout
8867 Document\SpecialChar menuseparator
8868 Settings\SpecialChar menuseparator
8874 to provide the user with information about the cite engine.
8877 \begin_layout Subsection
8881 \begin_layout Standard
8882 The first non-comment line of any layout file, included file, or module
8887 contain the file format number:
8890 \begin_layout Description
8891 \begin_inset Flex Code
8894 \begin_layout Plain Layout
8901 \begin_inset Flex Code
8904 \begin_layout Plain Layout
8910 ] The format number of the layout file.
8913 \begin_layout Standard
8914 This tag was introduced with \SpecialChar LyX
8916 \begin_inset space ~
8920 Layout files from older \SpecialChar LyX
8921 versions do not have an explicit file format and
8922 are considered to have
8923 \begin_inset Flex Code
8926 \begin_layout Plain Layout
8928 \begin_inset space ~
8937 The format for the present version of \SpecialChar LyX
8939 But each version of \SpecialChar LyX
8940 is capable of reading earlier versions' layout files,
8941 just as they are capable of reading files produced by earlier versions
8944 There is, however, no provision for converting to earlier formats.
8947 \begin_layout Subsection
8948 \begin_inset CommandInset label
8950 name "subsec:General-text-class"
8954 General text class parameters
8957 \begin_layout Standard
8958 These are general parameters that govern the behavior of an entire document
8964 mean that they must appear in
8965 \begin_inset Flex Code
8968 \begin_layout Plain Layout
8974 files rather than in modules.
8975 A module can contain any layout tag.)
8978 \begin_layout Description
8980 \change_inserted -712698321 1526899478
8981 \begin_inset Flex Code
8984 \begin_layout Plain Layout
8986 \change_inserted -712698321 1526898610
8987 AddToCiteEngine <engine>
8992 Extends the possibilities for displaying citation references.
8994 \begin_inset CommandInset ref
8996 reference "subsec:Citation-engine-description"
9005 \begin_inset Flex Code
9008 \begin_layout Plain Layout
9010 \change_inserted -712698321 1526898823
9021 \begin_layout Description
9022 \begin_inset Flex Code
9025 \begin_layout Plain Layout
9031 Adds information that will be output in the
9032 \begin_inset Flex Code
9035 \begin_layout Plain Layout
9041 block when the document is output to XHTML.
9042 Typically, this would be used to output CSS style information, but it can
9043 be used for anything that can appear in
9044 \begin_inset Flex Code
9047 \begin_layout Plain Layout
9055 \begin_inset Quotes eld
9059 \begin_inset Flex Code
9062 \begin_layout Plain Layout
9069 \begin_inset Quotes erd
9075 \begin_layout Description
9076 \begin_inset Flex Code
9079 \begin_layout Plain Layout
9085 Adds information to the document preamble.
9087 \begin_inset Newline newline
9091 \begin_inset Quotes eld
9095 \begin_inset Flex Code
9098 \begin_layout Plain Layout
9105 \begin_inset Quotes erd
9111 \begin_layout Description
9112 \begin_inset Flex Code
9115 \begin_layout Plain Layout
9121 Defines the possibilities for displaying citation references.
9123 \begin_inset CommandInset ref
9125 reference "subsec:Citation-engine-description"
9134 \begin_inset Quotes eld
9138 \begin_inset Flex Code
9141 \begin_layout Plain Layout
9148 \begin_inset Quotes erd
9152 Primarily used in cite engine files (see
9153 \begin_inset CommandInset ref
9155 reference "subsec:Cite-Engine-Files"
9164 \change_inserted -712698321 1526898530
9165 Note that if you specify this in a layout file or module, any cite engine
9166 definition will be overridden.
9168 \begin_inset Flex Code
9171 \begin_layout Plain Layout
9173 \change_inserted -712698321 1526898530
9186 \begin_layout Description
9187 \begin_inset Flex Code
9190 \begin_layout Plain Layout
9196 Defines formats for use in the display of bibliographic information.
9198 \begin_inset CommandInset ref
9200 reference "subsec:Citation-format-description"
9206 \begin_inset Quotes eld
9210 \begin_inset Flex Code
9213 \begin_layout Plain Layout
9220 \begin_inset Quotes erd
9224 Primarily used in cite engine files (see
9225 \begin_inset CommandInset ref
9227 reference "subsec:Cite-Engine-Files"
9236 \change_inserted -712698321 1526898585
9237 A cite format defined in a layout or module will override the cite engine
9243 \begin_layout Description
9244 \begin_inset Flex Code
9247 \begin_layout Plain Layout
9254 \begin_inset Flex Code
9257 \begin_layout Plain Layout
9266 \begin_inset Flex Code
9269 \begin_layout Plain Layout
9275 ] Determines whether
9279 or Bib\SpecialChar TeX
9280 is used to generate a Bibliography.
9281 Primarily used in cite engine files (see
9282 \begin_inset CommandInset ref
9284 reference "subsec:Cite-Engine-Files"
9294 \begin_layout Description
9295 \begin_inset Flex Code
9298 \begin_layout Plain Layout
9304 Describes various global options supported by the document class.
9306 \begin_inset CommandInset ref
9308 reference "subsec:ClassOptions"
9314 \begin_inset Quotes eld
9318 \begin_inset Flex Code
9321 \begin_layout Plain Layout
9328 \begin_inset Quotes erd
9334 \begin_layout Description
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9345 \begin_inset Flex Code
9348 \begin_layout Plain Layout
9357 \begin_inset space \thinspace{}
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9370 ] Whether the class should
9374 to having one or two columns.
9375 Can be changed in the
9376 \begin_inset Flex Noun
9379 \begin_layout Plain Layout
9380 Document\SpecialChar menuseparator
9389 \begin_layout Description
9390 \begin_inset Flex Code
9393 \begin_layout Plain Layout
9400 \begin_inset Flex Code
9403 \begin_layout Plain Layout
9409 ] This sequence defines the properties for a counter.
9410 If the counter does not yet exist, it is created; if it does exist, it
9413 \begin_inset Quotes eld
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9427 \begin_inset Quotes erd
9431 \begin_inset Newline newline
9435 \begin_inset CommandInset ref
9437 reference "subsec:Counters"
9441 for details on counters.
9444 \begin_layout Description
9445 \begin_inset Flex Code
9448 \begin_layout Plain Layout
9454 Sets the default font used to display the document.
9456 \begin_inset CommandInset ref
9458 reference "subsec:Font-description"
9462 for how to declare fonts.
9464 \begin_inset Quotes eld
9468 \begin_inset Flex Code
9471 \begin_layout Plain Layout
9478 \begin_inset Quotes erd
9484 \begin_layout Description
9485 \begin_inset Flex Code
9488 \begin_layout Plain Layout
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9504 ] Specifies a module to be included by default with this document class.
9505 The module is specified as filename without the
9506 \begin_inset Flex Code
9509 \begin_layout Plain Layout
9516 The user can still remove the module, but it will be active at the outset.
9517 (This applies only when new files are created, or when this class is chosen
9518 for an existing document.)
9521 \begin_layout Description
9522 \begin_inset Flex Code
9525 \begin_layout Plain Layout
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9541 ] This is the style that will be assigned to new paragraphs, usually
9542 \begin_inset Flex Noun
9545 \begin_layout Plain Layout
9552 This will default to the first defined style if not given, but you are
9553 encouraged to use this directive.
9556 \begin_layout Description
9557 \begin_inset Flex Code
9560 \begin_layout Plain Layout
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9576 ] This tag indicates that the module (which is specified by filename without
9578 \begin_inset Flex Code
9581 \begin_layout Plain Layout
9587 extension) cannot be used with this document class.
9588 This might be used in a journal-specific layout file to prevent, say, the
9590 \begin_inset Flex Code
9593 \begin_layout Plain Layout
9599 module that numbers theorems by section.
9604 be used in a module.
9605 Modules have their own way of excluding other modules (see
9606 \begin_inset CommandInset ref
9608 reference "subsec:Layout-modules"
9615 \begin_layout Description
9616 \begin_inset Flex Code
9619 \begin_layout Plain Layout
9625 Defines a new float.
9627 \begin_inset CommandInset ref
9629 reference "subsec:Floats"
9635 \begin_inset Quotes eld
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9649 \begin_inset Quotes erd
9655 \begin_layout Description
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9665 Sets the information that will be output in the
9666 \begin_inset Flex Code
9669 \begin_layout Plain Layout
9675 block when this document class is output to XHTML.
9676 Note that this will completely override any prior
9677 \begin_inset Flex Code
9680 \begin_layout Plain Layout
9687 \begin_inset Flex Code
9690 \begin_layout Plain Layout
9698 \begin_inset Newline newline
9702 \begin_inset Flex Code
9705 \begin_layout Plain Layout
9711 if you just want to add material to the preamble.) Must end with
9712 \begin_inset Quotes eld
9716 \begin_inset Flex Code
9719 \begin_layout Plain Layout
9726 \begin_inset Quotes erd
9732 \begin_layout Description
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9752 ] The style to use for the table of contents, bibliography, and so forth,
9753 when the document is output to HTML.
9754 For articles, this should normally be
9755 \begin_inset Flex Code
9758 \begin_layout Plain Layout
9765 \begin_inset Flex Code
9768 \begin_layout Plain Layout
9775 If it is not given, then \SpecialChar LyX
9776 will attempt to figure out which layout to use.
9779 \begin_layout Description
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9790 \begin_inset Flex Code
9793 \begin_layout Plain Layout
9799 ] Modifies the properties of the given counter.
9800 If the counter does not exist, the statement is ignored.
9802 \begin_inset Quotes eld
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9816 \begin_inset Quotes erd
9820 \begin_inset Newline newline
9824 \begin_inset CommandInset ref
9826 reference "subsec:Counters"
9830 for details on counters.
9833 \begin_layout Description
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9844 \begin_inset Flex Code
9847 \begin_layout Plain Layout
9853 ] This allows you to include another layout definition file within yours
9854 to avoid duplicating commands.
9855 Common examples are the standard layout files, for example,
9856 \begin_inset Flex Code
9859 \begin_layout Plain Layout
9865 , which contains most of the basic layouts.
9868 \begin_layout Description
9869 \begin_inset Flex Code
9872 \begin_layout Plain Layout
9879 \begin_inset Flex Code
9882 \begin_layout Plain Layout
9888 ] This section (re-)defines the layout of an inset.
9889 It can be applied to an existing inset or to a new, user-defined inset,
9890 e.g., a new character style.
9892 \begin_inset Quotes eld
9896 \begin_inset Flex Code
9899 \begin_layout Plain Layout
9906 \begin_inset Quotes erd
9910 \begin_inset Newline newline
9914 \begin_inset CommandInset ref
9916 reference "subsec:Flex-insets-and"
9920 for more information.
9924 \begin_layout Description
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9935 \begin_inset Flex Code
9938 \begin_layout Plain Layout
9944 ] A string that indicates the width of the left margin on the screen, for
9946 \begin_inset Quotes eld
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9960 \begin_inset Quotes erd
9964 (Note that this is not a `length', like
9965 \begin_inset Quotes eld
9969 \begin_inset Quotes erd
9975 \begin_layout Description
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9986 \begin_inset Flex Code
9989 \begin_layout Plain Layout
9995 ] An integer that determines the maximal number of names displayed in an
9996 author-year citation before the citation switches to
9997 \begin_inset Quotes eld
10001 \begin_inset Quotes erd
10005 Primarily used in cite engine files (see
10006 \begin_inset CommandInset ref
10008 reference "subsec:Cite-Engine-Files"
10018 \begin_layout Description
10019 \begin_inset Flex Code
10022 \begin_layout Plain Layout
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10038 ] Modifies the properties of the given paragraph style.
10039 If the style does not exist, this section is ignored.
10041 \begin_inset Quotes eld
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10055 \begin_inset Quotes erd
10061 \begin_layout Description
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10081 ] Deletes an existing counter, usually one defined in an included file.
10084 \begin_layout Description
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 \begin_inset Flex Code
10098 \begin_layout Plain Layout
10104 ] Deletes an existing float.
10105 This is particularly useful when you want to suppress a float that has
10106 been defined in an input file.
10109 \begin_layout Description
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10129 ] Deletes an existing style.
10132 \begin_layout Description
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10162 ] Define a new table of contents with type
10163 \begin_inset Flex Code
10166 \begin_layout Plain Layout
10173 \begin_inset Flex Code
10176 \begin_layout Plain Layout
10183 See also the AddToToc commands.
10186 \begin_layout Description
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10197 \begin_inset Flex Code
10200 \begin_layout Plain Layout
10206 ] The file format (as defined in the \SpecialChar LyX
10207 preferences) produced by this document
10209 It is mainly useful when
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10229 and one wants to define a new type of literate document.
10230 The format is reset to
10231 \begin_inset Quotes eld
10235 \begin_inset Flex Code
10238 \begin_layout Plain Layout
10245 \begin_inset Quotes erd
10249 \begin_inset Quotes eld
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10263 \begin_inset Quotes erd
10266 when the corresponding
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10276 parameter is encountered.
10279 \begin_layout Description
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10314 \begin_inset Flex Code
10317 \begin_layout Plain Layout
10323 ] Specifies what sort of output documents using this class will produce.
10326 \begin_layout Description
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10337 \begin_inset Flex Code
10340 \begin_layout Plain Layout
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10356 ] Specifies options, given in the second string, for the package named by
10359 \begin_inset Quotes eld
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10367 PackageOptions natbib square
10373 \begin_inset Quotes erd
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10386 to be loaded with the
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10397 (For \SpecialChar TeX
10398 perts, this causes \SpecialChar LyX
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10406 PassOptionsToPackage{natbib}{square}
10412 \begin_inset Flex Code
10415 \begin_layout Plain Layout
10424 \begin_layout Description
10425 \begin_inset Flex Code
10428 \begin_layout Plain Layout
10435 \begin_inset Flex Code
10438 \begin_layout Plain Layout
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10466 ] The default pagestyle.
10467 Can be changed in the
10468 \begin_inset Flex Noun
10471 \begin_layout Plain Layout
10472 Document\SpecialChar menuseparator
10481 \begin_layout Description
10482 \begin_inset Flex Code
10485 \begin_layout Plain Layout
10491 Sets the preamble for the \SpecialChar LaTeX
10493 Note that this will completely override any prior
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10504 \begin_inset Flex Code
10507 \begin_layout Plain Layout
10515 \begin_inset Flex Code
10518 \begin_layout Plain Layout
10524 if you just want to add material to the preamble.) Must end with
10525 \begin_inset Quotes eld
10529 \begin_inset Flex Code
10532 \begin_layout Plain Layout
10539 \begin_inset Quotes erd
10545 \begin_layout Description
10546 \begin_inset Flex Code
10549 \begin_layout Plain Layout
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10578 \begin_inset space \thinspace{}
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10591 ] Whether the class already provides the feature
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 A feature is in general the name of a package (e.
10603 \begin_inset space \thinspace{}
10607 \begin_inset space \space{}
10611 \begin_inset Flex Code
10614 \begin_layout Plain Layout
10621 \begin_inset Flex Code
10624 \begin_layout Plain Layout
10631 \begin_inset space \thinspace{}
10635 \begin_inset space \space{}
10639 \begin_inset Flex Code
10642 \begin_layout Plain Layout
10649 \begin_inset Flex Code
10652 \begin_layout Plain Layout
10660 \begin_inset CommandInset ref
10662 reference "chap:List-of-functions"
10666 for the list of features.
10669 \begin_layout Description
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 \begin_inset Flex Code
10683 \begin_layout Plain Layout
10689 ] Indicates that this layout provides the functionality of the module mentioned,
10690 which should be specified by the filename without the
10691 \begin_inset Flex Code
10694 \begin_layout Plain Layout
10701 This will typically be used if the layout includes the module directly,
10702 rather than using the
10703 \begin_inset Flex Code
10706 \begin_layout Plain Layout
10712 tag to indicate that it ought to be used.
10713 It could also be used in a module that provided an alternate implementation
10714 of the same functionality.
10717 \begin_layout Description
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10737 ] Creates a new paragraph style if it does not already exist.
10738 If the style does exist, this section is ignored.
10740 \begin_inset Quotes eld
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10754 \begin_inset Quotes erd
10760 \begin_layout Description
10761 \begin_inset Flex Code
10764 \begin_layout Plain Layout
10771 \begin_inset Flex Code
10774 \begin_layout Plain Layout
10780 ] Whether the class requires the feature
10781 \begin_inset Flex Code
10784 \begin_layout Plain Layout
10791 Multiple features must be separated by commas.
10792 Note that you can only request supported features.
10794 \begin_inset CommandInset ref
10796 reference "chap:List-of-functions"
10800 for the list of features.).
10801 If you require a package with specific options, you can additionally use
10803 \begin_inset Flex Code
10806 \begin_layout Plain Layout
10815 \begin_layout Description
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10826 \begin_inset Flex Code
10829 \begin_layout Plain Layout
10835 ] A string that indicates the width of the right margin on the screen, for
10837 \begin_inset Quotes eld
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10851 \begin_inset Quotes erd
10857 \begin_layout Description
10858 \begin_inset Flex Code
10861 \begin_layout Plain Layout
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10877 ] Sets which divisions get numbered.
10879 \begin_inset Newline newline
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10892 counter in \SpecialChar LaTeX
10896 \begin_layout Description
10897 \begin_inset Flex Code
10900 \begin_layout Plain Layout
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10919 \begin_inset space \thinspace{}
10923 \begin_inset Flex Code
10926 \begin_layout Plain Layout
10932 ] Whether the class-default should be printing on one or both sides of the
10934 Can be changed in the
10935 \begin_inset Flex Noun
10938 \begin_layout Plain Layout
10939 Document\SpecialChar menuseparator
10948 \begin_layout Description
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10968 ] This sequence defines a paragraph style.
10969 If the style does not yet exist, it is created; if it does exist, its parameter
10972 \begin_inset Quotes eld
10976 \begin_inset Flex Code
10979 \begin_layout Plain Layout
10986 \begin_inset Quotes erd
10990 \begin_inset Newline newline
10994 \begin_inset CommandInset ref
10996 reference "subsec:Paragraph-Styles"
11000 for details on paragraph styles.
11001 \change_inserted -712698321 1553617804
11005 \begin_layout Description
11007 \change_inserted -712698321 1553617862
11008 \begin_inset Flex Code
11011 \begin_layout Plain Layout
11013 \change_inserted -712698321 1553617809
11020 \begin_inset Flex Code
11023 \begin_layout Plain Layout
11025 \change_inserted -712698321 1553617805
11031 ] defines the default table style that is used when inserting a table.
11032 The following styles are available:
11036 \begin_layout Itemize
11038 \change_inserted -712698321 1554308039
11039 \begin_inset Flex Code
11042 \begin_layout Plain Layout
11044 \change_inserted -712698321 1554307928
11045 Formal_with_Footline
11053 \begin_inset Quotes eld
11057 \begin_inset Quotes erd
11060 ) style with horizontal lines only, using a bold top and bottom line, the
11061 first and last row are additionally separated from the table body with
11062 a thin middle line.
11065 \begin_layout Itemize
11067 \change_inserted -712698321 1554308087
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11073 \change_inserted -712698321 1554308042
11074 Formal_without_Footline
11079 : same as the above, but the last row is not separated with a middle line
11083 \begin_layout Itemize
11085 \change_inserted -712698321 1553618031
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11091 \change_inserted -712698321 1553618006
11097 : Simple table lines.
11100 \begin_layout Itemize
11102 \change_inserted -712698321 1553618309
11103 \begin_inset Flex Code
11106 \begin_layout Plain Layout
11108 \change_inserted -712698321 1553618031
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11120 \change_inserted -712698321 1553618043
11126 , but with the header column offset with a second horizontal line.
11127 This is also the default style of \SpecialChar LyX
11131 \begin_layout Itemize
11133 \change_inserted -712698321 1553618280
11134 \begin_inset Flex Code
11137 \begin_layout Plain Layout
11139 \change_inserted -712698321 1553618261
11145 : Table without lines.
11151 \begin_layout Description
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11171 ] The name of the command or environment to be used with
11172 \begin_inset Flex Code
11175 \begin_layout Plain Layout
11184 \begin_layout Description
11185 \begin_inset Flex Code
11188 \begin_layout Plain Layout
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11216 ] Indicates what kind of markup is used to define the title of a document.
11218 \begin_inset Flex Code
11221 \begin_layout Plain Layout
11227 means that the macro with name
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11237 will be inserted after the last layout which has
11238 \begin_inset Quotes eld
11242 \begin_inset Flex Code
11245 \begin_layout Plain Layout
11247 \begin_inset space ~
11256 \begin_inset Quotes erd
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11270 corresponds to the case where all layouts which have
11271 \begin_inset Quotes eld
11275 \begin_inset Flex Code
11278 \begin_layout Plain Layout
11280 \begin_inset space ~
11289 \begin_inset Quotes erd
11292 should be enclosed into the
11293 \begin_inset Flex Code
11296 \begin_layout Plain Layout
11305 \begin_layout Description
11306 \begin_inset Flex Code
11309 \begin_layout Plain Layout
11316 \begin_inset Flex Code
11319 \begin_layout Plain Layout
11325 ] Sets which divisions are included in the table of contents.
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11336 counter in \SpecialChar LaTeX
11340 \begin_layout Subsection
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11351 \begin_inset CommandInset label
11353 name "subsec:ClassOptions"
11360 \begin_layout Standard
11362 \begin_inset Flex Code
11365 \begin_layout Plain Layout
11371 section can contain the following entries:
11374 \begin_layout Description
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11385 \begin_inset Flex Code
11388 \begin_layout Plain Layout
11394 ] The list of available font sizes for the document's main font, separated
11396 \begin_inset Quotes eld
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11410 \begin_inset Quotes erd
11416 \begin_layout Description
11417 \begin_inset Flex Code
11420 \begin_layout Plain Layout
11426 Used to set the DTD line with XML-based output classes.
11428 \begin_inset space \thinspace{}
11432 \begin_inset Quotes eld
11435 -//OASIS//DTD DocBook V4.2//EN
11436 \begin_inset Quotes erd
11442 \begin_layout Description
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11453 \begin_inset Flex Code
11456 \begin_layout Plain Layout
11457 string="empty|plain|headings|fancy"
11462 ] The list of available page sty\SpecialChar softhyphen
11464 \begin_inset Quotes eld
11468 \begin_inset Flex Code
11471 \begin_layout Plain Layout
11478 \begin_inset Quotes erd
11484 \begin_layout Description
11485 \begin_inset Flex Code
11488 \begin_layout Plain Layout
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11504 ] Some document class options, separated by a comma, that will be added
11505 to the optional part of the
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11520 \begin_layout Standard
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11531 section must end with
11532 \begin_inset Quotes eld
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11546 \begin_inset Quotes erd
11552 \begin_layout Subsection
11554 \begin_inset CommandInset label
11556 name "subsec:Paragraph-Styles"
11563 \begin_layout Standard
11564 A paragraph style description looks like this:
11568 \begin_layout Plain Layout
11569 Note that this will either define a new style or modify an existing one.
11577 \begin_layout LyX-Code
11584 \begin_layout LyX-Code
11588 \begin_layout LyX-Code
11592 \begin_layout Standard
11593 where the following commands are allowed:
11596 \begin_layout Description
11597 \begin_inset Flex Code
11600 \begin_layout Plain Layout
11607 \begin_inset Flex Code
11610 \begin_layout Plain Layout
11616 =""] This paragraph will appear in the table of contents of the given type.
11617 An empty string disables.
11618 See also the OutlinerName and the IsTocCaption commands.
11622 \begin_layout Description
11623 \begin_inset Flex Code
11626 \begin_layout Plain Layout
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11641 , left, right, center
11646 ] Paragraph alignment.
11649 \begin_layout Description
11650 \begin_inset Flex Code
11653 \begin_layout Plain Layout
11660 \begin_inset Flex Code
11663 \begin_layout Plain Layout
11668 , left, right, center
11673 ] A comma separated list of permitted alignments.
11674 (Some \SpecialChar LaTeX
11675 styles prohibit certain alignments, since those wouldn't make sense.
11676 For example a right-aligned or centered enumeration isn't possible.)
11679 \begin_layout Description
11680 \begin_inset Flex Code
11683 \begin_layout Plain Layout
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11699 ] Defines argument number <int> of a command\SpecialChar breakableslash
11700 environment associated with
11702 This is useful for things like section headings, and only makes sense with
11705 Every (optional or required) argument of a command or environment – except
11706 for the required argument that is associated with the content of the paragraph
11707 itself – has a separate definition, where the number specifies the order
11709 The definition must end with
11710 \begin_inset Flex Code
11713 \begin_layout Plain Layout
11720 So a command with two optional arguments has:
11724 \begin_layout Quote
11730 \begin_layout Quote
11736 \begin_layout Quote
11742 \begin_layout Quote
11748 \begin_layout Quote
11754 \begin_layout Quote
11760 \begin_layout Standard
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11771 definition, the following specifications are possible:
11774 \begin_layout Itemize
11775 \begin_inset Flex Code
11778 \begin_layout Plain Layout
11785 \begin_inset Flex Code
11788 \begin_layout Plain Layout
11794 The string that will appear both in the menu (to insert this argument)
11795 and on the argument inset button (unless you also specify a separate
11796 \begin_inset Flex Code
11799 \begin_layout Plain Layout
11806 For the menu, you can define an accelerator by appending the respective
11807 character to the string, divided by
11808 \begin_inset Quotes eld
11812 \begin_inset Quotes erd
11816 \begin_inset space \thinspace{}
11820 \begin_inset space \space{}
11824 \begin_inset Quotes eld
11828 \begin_inset Flex Code
11831 \begin_layout Plain Layout
11838 \begin_inset Quotes erd
11844 \begin_layout Itemize
11845 \begin_inset Flex Code
11848 \begin_layout Plain Layout
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11864 A separate string for the menu.
11865 You can define an accelerator by appending the respective character to
11866 the string, divided by
11867 \begin_inset Quotes eld
11871 \begin_inset Quotes erd
11875 \begin_inset space \thinspace{}
11879 \begin_inset space \space{}
11883 \begin_inset Quotes eld
11887 \begin_inset Flex Code
11890 \begin_layout Plain Layout
11897 \begin_inset Quotes erd
11901 This specification is optional.
11902 If it is not given the
11903 \begin_inset Flex Code
11906 \begin_layout Plain Layout
11912 will be used instead for the menu.
11915 \begin_layout Itemize
11916 \begin_inset Flex Code
11919 \begin_layout Plain Layout
11926 \begin_inset Flex Code
11929 \begin_layout Plain Layout
11935 A longer explanatory text that appears in the tooltip when hovering over
11936 the argument inset.
11939 \begin_layout Itemize
11940 \begin_inset Flex Code
11943 \begin_layout Plain Layout
11950 \begin_inset Flex Code
11953 \begin_layout Plain Layout
11962 \begin_inset space \thinspace{}
11966 \begin_inset Flex Code
11969 \begin_layout Plain Layout
11975 ] Declare if this is a mandatory (1) or an optional (0) argument.
11976 Mandatory arguments will be output empty if not given, while optional arguments
11977 will not be output at all.
11978 By default, mandatory arguments are delimited by
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11988 , while optional arguments are delimited by
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11999 \change_inserted -712698321 1555579782
12003 \begin_layout Itemize
12005 \change_inserted -712698321 1555579780
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12011 \change_inserted -712698321 1555579780
12018 \begin_inset Flex Code
12021 \begin_layout Plain Layout
12023 \change_inserted -712698321 1555579780
12029 Option to define a different command (from the default
12030 \begin_inset Flex Code
12033 \begin_layout Plain Layout
12035 \change_inserted -712698321 1555579780
12045 ) to be used for line breaks.
12046 The initial backslash must not be specified.
12051 \begin_layout Itemize
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12071 defines another argument (by its number) which this argument requires to
12072 be output if it is itself output.
12074 \begin_inset space \thinspace{}
12077 g., in \SpecialChar LaTeX
12078 commands, optional arguments often require previous optional arguments
12079 to be output (at least empty), as in
12080 \begin_inset Flex Code
12083 \begin_layout Plain Layout
12086 command[][argument]{text}
12092 This can be achieved by the statement
12093 \begin_inset Flex Code
12096 \begin_layout Plain Layout
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12115 \begin_layout Itemize
12116 \begin_inset Flex Code
12119 \begin_layout Plain Layout
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12135 defines a custom left delimiter (instead of
12136 \begin_inset Flex Code
12139 \begin_layout Plain Layout
12146 \begin_inset Flex Code
12149 \begin_layout Plain Layout
12156 A line break in the output can be indicated by
12157 \begin_inset Flex Code
12160 \begin_layout Plain Layout
12169 \begin_layout Itemize
12170 \begin_inset Flex Code
12173 \begin_layout Plain Layout
12180 \begin_inset Flex Code
12183 \begin_layout Plain Layout
12189 defines a custom right delimiter (instead of
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Flex Code
12203 \begin_layout Plain Layout
12210 A line break in the output can be indicated by
12211 \begin_inset Flex Code
12214 \begin_layout Plain Layout
12223 \begin_layout Itemize
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12234 \begin_inset Flex Code
12237 \begin_layout Plain Layout
12243 defines an argument that is inserted if and only if no user-specified arguments
12245 \begin_inset space \thinspace{}
12249 \begin_inset space \space{}
12252 if no argument inset has been inserted (note that also an empty argument
12253 inset omits the DefaultArg).
12254 Multiple arguments need to be separated by comma.
12257 \begin_layout Itemize
12258 \begin_inset Flex Code
12261 \begin_layout Plain Layout
12268 \begin_inset Flex Code
12271 \begin_layout Plain Layout
12277 defines an argument that is inserted in any case (alone or in addition
12278 to user-specified arguments).
12279 Multiple arguments need to be separated by comma.
12282 \begin_layout Itemize
12283 \begin_inset Flex Code
12286 \begin_layout Plain Layout
12292 The font used for the argument content, see
12293 \begin_inset CommandInset ref
12295 reference "subsec:Font-description"
12300 \change_inserted -712698321 1559484228
12304 \begin_layout Itemize
12306 \change_inserted -712698321 1559484228
12307 \begin_inset Flex Code
12310 \begin_layout Plain Layout
12312 \change_inserted -712698321 1559484228
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12324 \change_inserted -712698321 1559484228
12333 \begin_inset space \thinspace{}
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12342 \change_inserted -712698321 1559484228
12348 ] As with paragraph styles, see
12349 \begin_inset CommandInset ref
12351 reference "subsec:Paragraph-Styles"
12360 \begin_layout Itemize
12361 \begin_inset Flex Code
12364 \begin_layout Plain Layout
12370 The font used for the label; see
12371 \begin_inset CommandInset ref
12373 reference "subsec:Font-description"
12380 \begin_layout Itemize
12381 \begin_inset Flex Code
12384 \begin_layout Plain Layout
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12399 , Minimalistic, Conglomerate
12404 ] describes the rendering style used for the inset's frame and buttons.
12407 \begin_layout Itemize
12408 \begin_inset Flex Code
12411 \begin_layout Plain Layout
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12428 \begin_inset Flex Code
12431 \begin_layout Plain Layout
12437 , this argument is automatically inserted when the respective style is selected.
12439 \change_deleted -712698321 1559484200
12440 Currently, only one argument per style\SpecialChar breakableslash
12441 layout can be automatically inserted.
12446 \begin_layout Itemize
12448 \change_inserted -712698321 1559491402
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12454 \change_inserted -712698321 1559490711
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12466 \change_inserted -712698321 1559490703
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12478 \change_inserted -712698321 1559490703
12484 , this argument will be inserted on a new line with
12485 \begin_inset Flex Code
12488 \begin_layout Plain Layout
12490 \change_inserted -712698321 1559491402
12496 (only available within Flex insets).
12499 \begin_layout Itemize
12500 \begin_inset Flex Code
12503 \begin_layout Plain Layout
12510 \begin_inset Flex Code
12513 \begin_layout Plain Layout
12520 \begin_inset Flex Code
12523 \begin_layout Plain Layout
12529 , this argument will be inserted with a copy of the co-text (either selected
12530 text or the whole paragraph) as content.
12533 \begin_layout Itemize
12534 \begin_inset Flex Code
12537 \begin_layout Plain Layout
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12557 ] Whether the contents of this argument should be output in raw form, meaning
12558 without special translations that \SpecialChar LaTeX
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12570 status is inherited by the inset or paragraph layout the argument belongs
12571 to, true and false change the status for the given argument only.
12574 \begin_layout Itemize
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12585 \begin_inset Flex Code
12588 \begin_layout Plain Layout
12589 string of characters
12598 Defines individual characters
12599 \begin_inset Newline linebreak
12602 that should be output in raw form, meaning without special translations
12603 that \SpecialChar LaTeX
12605 Note that, contrary to PassThru, this needs to be explicitly defined for
12607 That is, arguments do not inherit PassThruChars from their parent inset
12611 \begin_layout Itemize
12612 \begin_inset Flex Code
12615 \begin_layout Plain Layout
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12634 \begin_inset space \thinspace{}
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12647 ] If this is set to 1, the argument will output its content in the corresponding
12648 item in the table of contents.
12652 \begin_layout Standard
12653 By default, the text entered in the \SpecialChar LyX
12654 workarea in the respective layout is
12655 the last (mandatory) argument of a command if the
12656 \begin_inset Flex Code
12659 \begin_layout Plain Layout
12666 \begin_inset Flex Code
12669 \begin_layout Plain Layout
12676 However, arguments with the prefix
12677 \begin_inset Flex Code
12680 \begin_layout Plain Layout
12686 are output after this workarea argument.
12687 Note that post-argument numbering restarts at 1, so the first argument
12688 following the workarea argument is
12689 \begin_inset Flex Code
12692 \begin_layout Plain Layout
12699 Post-arguments are ignored in any other
12700 \begin_inset Flex Code
12703 \begin_layout Plain Layout
12710 \begin_inset Flex Code
12713 \begin_layout Plain Layout
12722 \begin_layout Standard
12724 \begin_inset Flex Code
12727 \begin_layout Plain Layout
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12757 followed by the number (e.
12758 \begin_inset space \thinspace{}
12762 \begin_inset space \space{}
12766 \begin_inset Flex Code
12769 \begin_layout Plain Layout
12776 \change_inserted -712698321 1534487781
12780 \begin_layout Standard
12782 \change_inserted -712698321 1534488561
12783 Finally, there is a special argument type with the prefix
12784 \begin_inset Flex Code
12787 \begin_layout Plain Layout
12789 \change_inserted -712698321 1534487844
12798 It is not really an argument, but uses the argument interface (thus, the
12799 prefix is also followed by a number, e.
12800 \begin_inset space \thinspace{}
12805 \begin_inset Flex Code
12808 \begin_layout Plain Layout
12810 \change_inserted -712698321 1534488412
12811 Argument listpreamble:1
12817 As the name implies, it is targeted at lists such as
12834 Its content will be output at the list start, before the first
12835 \begin_inset Flex Code
12838 \begin_layout Plain Layout
12840 \change_inserted -712698321 1534488058
12850 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12852 This way, users can insert redefinitions (of lengths etc.) to individual
12854 By default, these arguments do not have a delimiter.
12860 \begin_layout Description
12861 \begin_inset Flex Code
12864 \begin_layout Plain Layout
12870 Includes a comma-separated list of layouts that should be nested in and
12871 after the current layout.
12872 Only makes sense for nestable layouts (such as environments).
12874 \begin_inset Quotes eld
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12888 \begin_inset Quotes erd
12893 \begin_inset Flex Code
12896 \begin_layout Plain Layout
12905 \begin_layout Description
12906 \begin_inset Flex Code
12909 \begin_layout Plain Layout
12915 Note that this will completely override any prior
12916 \begin_inset Flex Code
12919 \begin_layout Plain Layout
12925 declaration for this style.
12927 \begin_inset Quotes eld
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12941 \begin_inset Quotes erd
12946 \begin_inset CommandInset ref
12948 reference "subsec:I18n"
12952 for details on its use.
12955 \begin_layout Description
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12979 \begin_layout Plain Layout
12980 Note that a `float' here is a real number, such as: 1.5.
12985 The vertical space with which the last of a chain of paragraphs with this
12986 style is separated from the following paragraph.
12987 If the next paragraph has another style, the separations are not simply
12988 added, but the maximum is taken.
12991 \begin_layout Description
12992 \begin_inset Flex Code
12995 \begin_layout Plain Layout
13002 \begin_inset Flex Code
13005 \begin_layout Plain Layout
13011 ] The category for this style.
13012 This is used to group related styles in the style combobox on the toolbar.
13013 Any string can be used, but you may want to use existing categories with
13018 \begin_layout Description
13019 \begin_inset Flex Code
13022 \begin_layout Plain Layout
13028 Depth of XML command.
13029 Used only with XML-type formats.
13032 \begin_layout Description
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13043 \begin_inset Flex Code
13046 \begin_layout Plain Layout
13052 ] Copies all the features of an existing style into the current one.
13056 \begin_layout Description
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13076 ] The name of a style whose preamble should be output
13081 This allows to ensure some ordering of the preamble snippets when macros
13082 definitions depend on one another.
13086 \begin_layout Plain Layout
13087 Note that, besides that functionality, there is no way to ensure any ordering
13089 The ordering that you see in a given version of \SpecialChar LyX
13090 may change without warning
13099 \begin_layout Description
13100 \begin_inset Flex Code
13103 \begin_layout Plain Layout
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13118 , Box, Filled_Box, Static
13123 ] The type of label that stands at the end of the paragraph (or sequence
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13135 \begin_inset Newline newline
13139 \begin_inset Flex Code
13142 \begin_layout Plain Layout
13149 \begin_inset Flex Code
13152 \begin_layout Plain Layout
13159 \begin_inset Flex Code
13162 \begin_layout Plain Layout
13170 \begin_inset Flex Code
13173 \begin_layout Plain Layout
13180 \begin_inset Quotes eld
13184 \begin_inset Quotes erd
13188 \begin_inset Flex Code
13191 \begin_layout Plain Layout
13198 \begin_inset space \space{}
13202 \begin_inset Flex Code
13205 \begin_layout Plain Layout
13211 ) is a white (resp.
13212 \begin_inset space ~
13215 black) square suitable for end of proof markers,
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13225 is an explicit text string.
13228 \begin_layout Description
13229 \begin_inset Flex Code
13232 \begin_layout Plain Layout
13239 \begin_inset Flex Code
13242 \begin_layout Plain Layout
13248 ] The string used for a label with a
13249 \begin_inset Flex Code
13252 \begin_layout Plain Layout
13259 \begin_inset Newline newline
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13276 \begin_layout Description
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13286 The font used for both the text body
13292 \begin_inset CommandInset ref
13294 reference "subsec:Font-description"
13299 Note that defining this font automatically defines the
13300 \begin_inset Flex Code
13303 \begin_layout Plain Layout
13310 So you should define this one first if you also want to define
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13323 \begin_layout Description
13324 \begin_inset Flex Code
13327 \begin_layout Plain Layout
13334 \begin_inset Flex Code
13337 \begin_layout Plain Layout
13343 ] Used for backporting new styles to stable \SpecialChar LyX
13345 The first stable version that supports this tag is \SpecialChar LyX
13347 The argument is a number which may either be 0, -1 or any value greater
13350 \begin_inset Flex Code
13353 \begin_layout Plain Layout
13359 flag of a style is greater than zero, it will always be written to the
13361 If a .lyx file is read, the style definitions from the document header are
13362 added to the document class.
13363 Therefore even older \SpecialChar LyX
13364 versions can handle the style.
13366 \begin_inset Flex Code
13369 \begin_layout Plain Layout
13375 is a version number: if the style is read, and the version number is less
13376 than the version number of the already existing style in the document class,
13377 the new style is ignored.
13378 If the version number is greater, the new style replaces the existing style.
13379 A value of -1 means an infinite version number, i.
13380 \begin_inset space \thinspace{}
13384 \begin_inset space \space{}
13387 the style is always used.
13390 \begin_layout Description
13391 \begin_inset Flex Code
13394 \begin_layout Plain Layout
13401 \begin_inset Flex Code
13404 \begin_layout Plain Layout
13413 \begin_inset space \thinspace{}
13417 \begin_inset Flex Code
13420 \begin_layout Plain Layout
13426 ] Usually \SpecialChar LyX
13427 does not allow you to insert more than one space between words,
13428 since a space is considered as the separation between two words, not a
13429 character or symbol of its own.
13430 This is a very fine thing but sometimes annoying, for example, when typing
13431 program code or plain \SpecialChar LaTeX
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13445 \change_deleted -495245474 1550490105
13449 will create protected blanks for the additional blanks when in
13450 \change_inserted -495245474 1550490096
13452 \begin_inset Flex Code
13455 \begin_layout Plain Layout
13457 \change_inserted -495245474 1550490089
13464 \change_deleted -495245474 1550490116
13465 another mode than \SpecialChar LaTeX
13468 \change_inserted -495245474 1550247760
13470 \begin_inset Flex Code
13473 \begin_layout Plain Layout
13475 \change_inserted -495245474 1550247736
13482 \begin_inset Flex Code
13485 \begin_layout Plain Layout
13487 \change_inserted -495245474 1550247755
13498 \begin_layout Description
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13508 These tags are used with XHTML output.
13510 \begin_inset CommandInset ref
13512 reference "subsec:Paragraph-Style-XHTML"
13519 \begin_layout Description
13520 \begin_inset Flex Code
13523 \begin_layout Plain Layout
13529 [FIXME] (Used only with XML-type formats.)
13532 \begin_layout Description
13533 \begin_inset Flex Code
13536 \begin_layout Plain Layout
13543 \begin_inset Flex Code
13546 \begin_layout Plain Layout
13555 \begin_inset space \thinspace{}
13559 \begin_inset Flex Code
13562 \begin_layout Plain Layout
13569 \begin_inset Flex Code
13572 \begin_layout Plain Layout
13578 , marks the style as to be included in the document preamble and not in
13580 This is useful for document classes that want such information as the title
13581 and author to appear in the preamble.
13582 Note that this works only for styles for which the
13583 \begin_inset Flex Code
13586 \begin_layout Plain Layout
13593 \begin_inset Flex Code
13596 \begin_layout Plain Layout
13603 \begin_inset Flex Code
13606 \begin_layout Plain Layout
13615 \begin_layout Description
13616 \begin_inset Flex Code
13619 \begin_layout Plain Layout
13626 \begin_inset Flex Code
13629 \begin_layout Plain Layout
13638 \begin_inset space \thinspace{}
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13652 \begin_inset Flex Code
13655 \begin_layout Plain Layout
13661 , marks the style as being part of a title block (see also the
13662 \begin_inset Flex Code
13665 \begin_layout Plain Layout
13672 \begin_inset Flex Code
13675 \begin_layout Plain Layout
13684 \begin_layout Description
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13694 Includes a comma-separated list of layouts after which this one should
13696 Only makes sense with regard to nestable layouts (such as environments).
13698 \begin_inset Quotes eld
13702 \begin_inset Flex Code
13705 \begin_layout Plain Layout
13712 \begin_inset Quotes erd
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13729 \begin_layout Description
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13740 \begin_inset Flex Code
13743 \begin_layout Plain Layout
13752 \begin_inset space \thinspace{}
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13765 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13766 of its contents in its item in the table of contents.
13767 Otherwise, only the label, if it exists, appears.
13770 \begin_layout Description
13771 \begin_inset Flex Code
13774 \begin_layout Plain Layout
13781 \begin_inset Flex Code
13784 \begin_layout Plain Layout
13790 ] The \SpecialChar LaTeX
13791 command sequence declaring an item in a list.
13792 The command is to be defined without the preceding backslash (the default
13794 \begin_inset Quotes eld
13798 \begin_inset Quotes erd
13802 \begin_inset Flex Code
13805 \begin_layout Plain Layout
13813 in the \SpecialChar LaTeX
13817 \begin_layout Description
13818 \begin_inset Flex Code
13821 \begin_layout Plain Layout
13828 \begin_inset Flex Code
13831 \begin_layout Plain Layout
13837 ] This provides extra space between paragraphs that have the same style.
13838 If you put other styles into an environment, each is separated with the
13840 \begin_inset Flex Code
13843 \begin_layout Plain Layout
13850 But the whole items of the environment are additionally separated with
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 Note that this is a
13867 \begin_layout Description
13868 \begin_inset Flex Code
13871 \begin_layout Plain Layout
13877 [FIXME] (Used only with XML-type formats.)
13880 \begin_layout Description
13881 \begin_inset Flex Code
13884 \begin_layout Plain Layout
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13903 \begin_inset space \thinspace{}
13907 \begin_inset Flex Code
13910 \begin_layout Plain Layout
13916 ] Usually \SpecialChar LyX
13917 does not allow you to leave a paragraph empty, since it would
13918 lead to empty \SpecialChar LaTeX
13920 There are some cases where this could be desirable however: in a letter
13921 template, the required fields can be provided as empty fields, so that
13922 people do not forget them; in some special classes, a style can be used
13923 as some kind of break, which does not contain actual text.
13926 \begin_layout Description
13927 \begin_inset Flex Code
13930 \begin_layout Plain Layout
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13946 ] The vertical space between the label and the text body.
13947 Only used for labels that are above the text body (
13948 \begin_inset Flex Code
13951 \begin_layout Plain Layout
13958 \begin_inset Newline newline
13962 \begin_inset Flex Code
13965 \begin_layout Plain Layout
13966 Centered_Top_Environment
13974 \begin_layout Description
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13985 \begin_inset Flex Code
13988 \begin_layout Plain Layout
13994 ] The name of the counter for automatic numbering.
13995 In order to have the counter appear with your label, you will need to reference
13997 \begin_inset Flex Code
14000 \begin_layout Plain Layout
14009 This will work with
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14020 \begin_inset Flex Code
14023 \begin_layout Plain Layout
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14040 \begin_inset Flex Code
14043 \begin_layout Plain Layout
14050 \begin_inset Newline newline
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14077 , though this case is a bit complicated.
14078 Suppose you declare
14079 \begin_inset Quotes eld
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14087 LabelCounter myenum
14093 \begin_inset Quotes erd
14097 Then the actual counters used are
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14108 \begin_inset Flex Code
14111 \begin_layout Plain Layout
14118 \begin_inset Flex Code
14121 \begin_layout Plain Layout
14128 \begin_inset Flex Code
14131 \begin_layout Plain Layout
14137 , much as in \SpecialChar LaTeX
14139 These counters must all be declared separately.
14140 \begin_inset Newline newline
14144 \begin_inset CommandInset ref
14146 reference "subsec:Counters"
14150 for details on counters.
14153 \begin_layout Description
14154 \begin_inset Flex Code
14157 \begin_layout Plain Layout
14163 The font used for the label.
14165 \begin_inset CommandInset ref
14167 reference "subsec:Font-description"
14174 \begin_layout Description
14175 \begin_inset Flex Code
14178 \begin_layout Plain Layout
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14194 ] Text that indicates how far a label should be indented.
14197 \begin_layout Description
14198 \begin_inset Flex Code
14201 \begin_layout Plain Layout
14208 \begin_inset Flex Code
14211 \begin_layout Plain Layout
14217 ] Text that indicates the amount of horizontal space between the label and
14219 Only used for labels that are not above the text body.
14222 \begin_layout Description
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14242 ] The string used for the label.
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14253 is set, this string can be contain the special formatting commands described
14255 \begin_inset CommandInset ref
14257 reference "subsec:Counters"
14264 \begin_layout Description
14265 \begin_inset Flex Code
14268 \begin_layout Plain Layout
14269 LabelStringAppendix
14275 \begin_inset Flex Code
14278 \begin_layout Plain Layout
14284 ] This is used inside the appendix instead of
14285 \begin_inset Newline newline
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14300 \begin_inset Flex Code
14303 \begin_layout Plain Layout
14310 \begin_inset Newline newline
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14318 LabelStringAppendix
14326 \begin_layout Description
14327 \begin_inset Flex Code
14330 \begin_layout Plain Layout
14336 [FIXME] (Used only with XML-type formats.)
14339 \begin_layout Description
14340 \begin_inset Flex Code
14343 \begin_layout Plain Layout
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14358 , Manual, Static, Above,
14359 \begin_inset Newline newline
14362 Centered, Sensitive, Enumerate,
14363 \begin_inset Newline newline
14366 Itemize, Bibliography
14375 \begin_layout Description
14376 \begin_inset Flex Code
14379 \begin_layout Plain Layout
14385 means the label is the very first word (up to the first real blank).
14386 Use protected spaces if you want more than one word as the label.
14390 \begin_layout Description
14391 \begin_inset Flex Code
14394 \begin_layout Plain Layout
14400 means the label is simply what is declared as
14401 \begin_inset Flex Code
14404 \begin_layout Plain Layout
14411 This will be displayed
14412 \begin_inset Quotes eld
14416 \begin_inset Quotes erd
14419 , at the beginning of the paragraph.
14421 \begin_inset Flex Code
14424 \begin_layout Plain Layout
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14440 , then it will be displayed only in the first paragraph of any sequence
14441 of paragraphs with the same
14442 \begin_inset Flex Code
14445 \begin_layout Plain Layout
14454 \begin_layout Description
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14465 \begin_inset space ~
14469 \begin_inset space ~
14473 \begin_inset Flex Code
14476 \begin_layout Plain Layout
14482 are special cases of
14483 \begin_inset Flex Code
14486 \begin_layout Plain Layout
14493 The label will be printed above the paragraph either at the beginning of
14494 the line or centered.
14497 \begin_layout Description
14498 \begin_inset Flex Code
14501 \begin_layout Plain Layout
14507 is a special case for the caption-labels
14508 \begin_inset Quotes eld
14512 \begin_inset Quotes erd
14516 \begin_inset Quotes eld
14520 \begin_inset Quotes erd
14524 \begin_inset Newline newline
14528 \begin_inset Flex Code
14531 \begin_layout Plain Layout
14537 means the (hardcoded) label string depends on the kind of float: It is
14538 hardcoded to be `FloatType N', where N is the value of the counter associated
14540 For the case that a caption is inserted outside of a float the
14541 \begin_inset Flex Code
14544 \begin_layout Plain Layout
14551 \begin_inset Quotes eld
14555 \begin_inset Quotes erd
14561 \begin_layout Description
14562 \begin_inset Flex Code
14565 \begin_layout Plain Layout
14571 produces the usual sort of enumeration labels.
14572 The number type needs to be set in the
14577 \begin_inset CommandInset ref
14579 reference "subsec:Counters"
14586 \begin_layout Description
14587 \begin_inset Flex Code
14590 \begin_layout Plain Layout
14596 produces various bullets at the different levels.
14597 The bullet types displayed can be set via
14598 \begin_inset Flex Noun
14601 \begin_layout Plain Layout
14602 Document\SpecialChar menuseparator
14603 Settings\SpecialChar menuseparator
14612 \begin_layout Description
14613 \begin_inset Flex Code
14616 \begin_layout Plain Layout
14622 should be used only with
14623 \begin_inset Flex Code
14626 \begin_layout Plain Layout
14627 LatexType BibEnvironment
14636 \begin_layout Description
14637 \begin_inset Flex Code
14640 \begin_layout Plain Layout
14646 Note that this will completely override any prior
14647 \begin_inset Flex Code
14650 \begin_layout Plain Layout
14656 declaration for this style.
14658 \begin_inset Quotes eld
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14672 \begin_inset Quotes erd
14677 \begin_inset CommandInset ref
14679 reference "subsec:I18n"
14683 for details on its use.
14686 \begin_layout Description
14687 \begin_inset Flex Code
14690 \begin_layout Plain Layout
14697 \begin_inset Flex Code
14700 \begin_layout Plain Layout
14706 ] The name of the corresponding \SpecialChar LaTeX
14708 Either the environment or command name.
14711 \begin_layout Description
14712 \begin_inset Flex Code
14715 \begin_layout Plain Layout
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14731 ] An optional parameter for the corresponding
14732 \begin_inset Flex Code
14735 \begin_layout Plain Layout
14742 This parameter cannot be changed from within \SpecialChar LyX
14744 \begin_inset Flex Code
14747 \begin_layout Plain Layout
14753 for customizable parameters).
14754 This will be output as is after all \SpecialChar LaTeX
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14768 \begin_layout Description
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14779 \begin_inset Flex Code
14782 \begin_layout Plain Layout
14787 , Command, Environment, Item_Environment,
14788 \begin_inset Newline newline
14791 List_Environment, Bib_Environment
14796 ] How the style should be translated into \SpecialChar LaTeX
14801 \begin_layout Plain Layout
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14811 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14812 Visit the SGML class files for specific examples.
14821 \begin_layout Description
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14831 means nothing special.
14834 \begin_layout Description
14835 \begin_inset Flex Code
14838 \begin_layout Plain Layout
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14855 {\SpecialChar ldots
14864 \begin_layout Description
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14875 \begin_inset Flex Code
14878 \begin_layout Plain Layout
14885 }\SpecialChar ldots
14901 \begin_layout Description
14902 \begin_inset Flex Code
14905 \begin_layout Plain Layout
14912 \begin_inset Flex Code
14915 \begin_layout Plain Layout
14922 \begin_inset Flex Code
14925 \begin_layout Plain Layout
14933 is generated for each paragraph of this environment.
14937 \begin_layout Description
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14958 \begin_inset Newline newline
14962 \begin_inset Flex Code
14965 \begin_layout Plain Layout
14971 is passed as an argument to the environment.
14972 \begin_inset Newline newline
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14985 can be defined in the
14986 \begin_inset Flex Noun
14989 \begin_layout Plain Layout
14990 Edit\SpecialChar menuseparator
14992 \begin_inset space ~
15003 \begin_layout Description
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15014 \begin_inset Flex Code
15017 \begin_layout Plain Layout
15023 but adds the necessary mandatory argument (the longest label) to the begin
15024 statement of the bibliography environment:
15025 \begin_inset Newline newline
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15035 begin{thebibliography}{99}
15041 It is therefore only useful for bibliography environments.
15042 The default longest label
15043 \begin_inset Quotes eld
15047 \begin_inset Quotes erd
15050 can be changed by the user in the paragraph settings of a bibliography
15054 \begin_layout Standard
15055 Putting the last few things together, the \SpecialChar LaTeX
15056 output will be either:
15059 \begin_layout LyX-Code
15062 LatexName[LatexParam]{\SpecialChar ldots
15066 \begin_layout Standard
15070 \begin_layout LyX-Code
15073 begin{LatexName}[LatexParam] \SpecialChar ldots
15079 \begin_layout Standard
15080 depending upon the \SpecialChar LaTeX
15085 \begin_layout Description
15086 \begin_inset Flex Code
15089 \begin_layout Plain Layout
15096 \begin_inset Flex Code
15099 \begin_layout Plain Layout
15105 ] A string that is put at the beginning of the style content.
15106 A line break in the output can be indicated by
15107 \begin_inset Flex Code
15110 \begin_layout Plain Layout
15119 \begin_layout Description
15120 \begin_inset Flex Code
15123 \begin_layout Plain Layout
15130 \begin_inset Flex Code
15133 \begin_layout Plain Layout
15139 ] If you put styles into environments, the different
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15149 are not simply added, but added with a factor
15150 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15154 Note that this parameter is also used when
15155 \begin_inset Flex Code
15158 \begin_layout Plain Layout
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15175 \begin_inset Flex Code
15178 \begin_layout Plain Layout
15185 Then it is added to the manual or dynamic margin.
15186 \begin_inset Newline newline
15190 \begin_inset Quotes eld
15194 \begin_inset Flex Code
15197 \begin_layout Plain Layout
15204 \begin_inset Quotes erd
15207 means that the paragraph is indented with the width of
15208 \begin_inset Quotes eld
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15222 \begin_inset Quotes erd
15225 in the normal font.
15226 You can get a negative width by prefixing the string with
15227 \begin_inset Quotes eld
15231 \begin_inset Flex Code
15234 \begin_layout Plain Layout
15241 \begin_inset Quotes erd
15245 This way was chosen so that the look is the same with each used screen
15249 \begin_layout Description
15250 \begin_inset Flex Code
15253 \begin_layout Plain Layout
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15268 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15274 \begin_inset Newline newline
15277 The kind of margin that the style has on the left side.
15281 \begin_layout Description
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15291 just means a fixed margin.
15294 \begin_layout Description
15295 \begin_inset Flex Code
15298 \begin_layout Plain Layout
15304 means that the left margin depends on the string entered in the
15305 \begin_inset Flex Noun
15308 \begin_layout Plain Layout
15309 Edit\SpecialChar menuseparator
15311 \begin_inset space ~
15320 This is used to typeset nice lists without tabulators.
15323 \begin_layout Description
15324 \begin_inset Flex Code
15327 \begin_layout Plain Layout
15333 means that the margin depends on the size of the label.
15334 This is used for automatic enumerated headlines.
15335 It is obvious that the headline
15336 \begin_inset Quotes eld
15339 5.4.3.2.1 Very long headline
15340 \begin_inset Quotes erd
15343 must have a wider left margin (as wide as
15344 \begin_inset Quotes eld
15348 \begin_inset Quotes erd
15351 plus the space) than
15352 \begin_inset Quotes eld
15355 3.2 Very long headline
15356 \begin_inset Quotes erd
15360 \begin_inset Quotes eld
15364 \begin_inset Quotes erd
15367 are not able to do this.
15370 \begin_layout Description
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15380 is similar, but only the very first row of the paragraph is dynamic, while
15381 the others are static; this is used, for example, for descriptions.
15384 \begin_layout Description
15385 \begin_inset Flex Code
15388 \begin_layout Plain Layout
15394 means the margin is chosen in a way that the longest row of this paragraph
15395 fits to the right margin.
15396 This is used to typeset an address on the right edge of the page.
15400 \begin_layout Description
15401 \begin_inset Flex Code
15404 \begin_layout Plain Layout
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15423 \begin_inset space \thinspace{}
15427 \begin_inset Flex Code
15430 \begin_layout Plain Layout
15436 ] Whether fragile commands in this style should be
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15453 whether this command should itself be protected.)
15454 \change_inserted -712698321 1523696949
15458 \begin_layout Description
15460 \change_inserted -712698321 1552395557
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15466 \change_inserted -712698321 1523696950
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15478 \change_inserted -712698321 1523696950
15487 \begin_inset space \thinspace{}
15491 \begin_inset Flex Code
15494 \begin_layout Plain Layout
15496 \change_inserted -712698321 1523696950
15502 ] This causes macros that contain this layout to be protected with
15503 \begin_inset Flex Code
15506 \begin_layout Plain Layout
15508 \change_inserted -712698321 1523696950
15521 ) if necessary and thus allows (some) verbatim stuff in macros.
15524 \begin_layout Description
15526 \change_inserted -712698321 1552395844
15527 \begin_inset Flex Code
15530 \begin_layout Plain Layout
15532 \change_inserted -712698321 1552395561
15539 \begin_inset Flex Code
15542 \begin_layout Plain Layout
15544 \change_inserted -712698321 1552395557
15553 \begin_inset space \thinspace{}
15557 \begin_inset Flex Code
15560 \begin_layout Plain Layout
15562 \change_inserted -712698321 1552395557
15568 ] Whether specific commands in this style (such as
15569 \begin_inset Flex Code
15572 \begin_layout Plain Layout
15574 \change_inserted -712698321 1552395655
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15590 \change_inserted -712698321 1552395661
15600 ) should be protected in an
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15606 \change_inserted -712698321 1552395631
15617 This is particularly needed for styles that draw on
15625 commands which parse their content in complex ways.
15630 \begin_layout Description
15631 \begin_inset Flex Code
15634 \begin_layout Plain Layout
15641 \begin_inset Flex Code
15644 \begin_layout Plain Layout
15651 \begin_inset space \thinspace{}
15655 \begin_inset Flex Code
15658 \begin_layout Plain Layout
15666 ] Whether newlines are translated into \SpecialChar LaTeX
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15682 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15684 inside \SpecialChar LyX
15688 \begin_layout Description
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15711 \begin_inset space \thinspace{}
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15724 ] If set to true, and if
15725 \begin_inset Flex Code
15728 \begin_layout Plain Layout
15735 \begin_inset Flex Code
15738 \begin_layout Plain Layout
15744 ) paragraphs are being indented, then the indentation of such a paragraph
15745 following one of this type will be suppressed.
15746 (So this will not affect the display of non-default paragraphs.)
15749 \begin_layout Description
15750 \begin_inset Flex Code
15753 \begin_layout Plain Layout
15760 \begin_inset Flex Code
15763 \begin_layout Plain Layout
15769 ] Name of a style that has replaced this style.
15770 This is used to rename a style, while keeping backward compatibility.
15773 \begin_layout Description
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15794 \begin_inset space \thinspace{}
15798 \begin_inset Flex Code
15801 \begin_layout Plain Layout
15807 ] Determines whether consecutive paragraphs of the same type are treated
15808 as belonging together.
15809 This has the effect that the
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15819 is only printed once before such a group.
15820 By default, this is true for
15821 \begin_inset Flex Code
15824 \begin_layout Plain Layout
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15850 and false for all other types.
15853 \begin_layout Description
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15864 \begin_inset Flex Code
15867 \begin_layout Plain Layout
15876 \begin_inset space \thinspace{}
15880 \begin_inset Flex Code
15883 \begin_layout Plain Layout
15889 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15891 but only by a line break; together with
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15901 , this allows to emulate a plain text editor (like the ERT inset).
15904 \begin_layout Description
15905 \begin_inset Flex Code
15908 \begin_layout Plain Layout
15915 \begin_inset Flex Code
15918 \begin_layout Plain Layout
15924 ] The indent of the very first line of a paragraph.
15926 \begin_inset Newline newline
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15939 will be fixed for a certain style.
15940 The exception is the default style, since the indentation for these paragraphs
15941 can be prohibited with
15942 \begin_inset Flex Code
15945 \begin_layout Plain Layout
15953 \begin_inset Flex Code
15956 \begin_layout Plain Layout
15962 style paragraphs inside environments use the
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15972 of the environment, not their native one.
15974 \begin_inset Flex Code
15977 \begin_layout Plain Layout
15983 paragraphs inside an enumeration are not indented.
15986 \begin_layout Description
15987 \begin_inset Flex Code
15990 \begin_layout Plain Layout
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16006 ] The vertical space between two paragraphs of this style.
16009 \begin_layout Description
16010 \begin_inset Flex Code
16013 \begin_layout Plain Layout
16020 \begin_inset Flex Code
16023 \begin_layout Plain Layout
16030 allows the user to choose either
16031 \begin_inset Quotes eld
16035 \begin_inset Quotes erd
16039 \begin_inset Quotes eld
16043 \begin_inset Quotes erd
16046 to separate paragraphs.
16048 \begin_inset Quotes eld
16052 \begin_inset Quotes erd
16056 \begin_inset Flex Code
16059 \begin_layout Plain Layout
16067 \begin_inset Quotes eld
16071 \begin_inset Quotes erd
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16084 is ignored and all paragraphs are separated by the
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16095 The vertical space is calculated with
16096 \begin_inset Flex Code
16099 \begin_layout Plain Layout
16101 \begin_inset space ~
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16119 is the height of a row with the normal font.
16120 This way, the look stays the same with different screen fonts.
16123 \begin_layout Description
16124 \begin_inset Flex Code
16127 \begin_layout Plain Layout
16134 \begin_inset Flex Code
16137 \begin_layout Plain Layout
16146 \begin_inset space \thinspace{}
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16159 ] Whether the contents of this paragraph should be output in raw form, meaning
16160 without special translations that \SpecialChar LaTeX
16164 \begin_layout Description
16165 \begin_inset Flex Code
16168 \begin_layout Plain Layout
16175 \begin_inset Flex Code
16178 \begin_layout Plain Layout
16188 Defines individual characters that should be output in raw form, meaning
16189 without special translations that \SpecialChar LaTeX
16193 \begin_layout Description
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16203 Information to be included in the \SpecialChar LaTeX
16204 preamble when this style is used.
16205 Used to define macros, load packages, etc., required by this particular
16208 \begin_inset Quotes eld
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 \begin_inset Quotes erd
16228 \begin_layout Description
16229 \begin_inset Flex Code
16232 \begin_layout Plain Layout
16239 \begin_inset Flex Code
16242 \begin_layout Plain Layout
16248 ] The prefix to use when creating labels referring to paragraphs of this
16250 This allows the use of formatted references.
16253 \begin_layout Description
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16264 \begin_inset Flex Code
16267 \begin_layout Plain Layout
16273 ] Whether the style requires the feature
16274 \begin_inset Flex Code
16277 \begin_layout Plain Layout
16284 \begin_inset CommandInset ref
16286 reference "chap:List-of-functions"
16290 for the list of features).
16291 If you require a package with specific options, you can additionally use
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16302 as a general text class parameter (see
16303 \begin_inset CommandInset ref
16305 reference "subsec:General-text-class"
16312 \begin_layout Description
16313 \begin_inset Flex Code
16316 \begin_layout Plain Layout
16323 \begin_inset Flex Code
16326 \begin_layout Plain Layout
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16344 ] Resets the \SpecialChar LaTeX
16345 arguments of this style (as defined via the
16346 \begin_inset Flex Code
16349 \begin_layout Plain Layout
16356 This is useful if you have copied a style via
16357 \begin_inset Flex Code
16360 \begin_layout Plain Layout
16366 , but you do not want to inherit its (required and optional) arguments.
16369 \begin_layout Description
16370 \begin_inset Flex Code
16373 \begin_layout Plain Layout
16380 \begin_inset Flex Code
16383 \begin_layout Plain Layout
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16401 ] Resumes a counter that is usually reset at each new sequence of layouts.
16402 This is currently only useful when
16403 \begin_inset Flex Code
16406 \begin_layout Plain Layout
16413 \begin_inset Flex Code
16416 \begin_layout Plain Layout
16425 \begin_layout Description
16426 \begin_inset Flex Code
16429 \begin_layout Plain Layout
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16445 ] A string that is put at the end of the layout content.
16446 A line break in the output can be indicated by
16447 \begin_inset Flex Code
16450 \begin_layout Plain Layout
16459 \begin_layout Description
16460 \begin_inset Flex Code
16463 \begin_layout Plain Layout
16470 \begin_inset Flex Code
16473 \begin_layout Plain Layout
16480 \begin_inset Flex Code
16483 \begin_layout Plain Layout
16492 \begin_layout Description
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16503 \begin_inset Flex Code
16506 \begin_layout Plain Layout
16515 \begin_inset Flex Code
16518 \begin_layout Plain Layout
16525 \begin_inset Flex Code
16528 \begin_layout Plain Layout
16535 \begin_inset Flex Code
16538 \begin_layout Plain Layout
16540 \begin_inset space ~
16548 ] This defines what the default spacing should be in the style.
16550 \begin_inset Flex Code
16553 \begin_layout Plain Layout
16560 \begin_inset Flex Code
16563 \begin_layout Plain Layout
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16579 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16580 If you specify the argument
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16590 , then you must also provide a value argument which will be the actual multiplie
16592 Note that, contrary to other parameters,
16593 \begin_inset Flex Code
16596 \begin_layout Plain Layout
16602 implies the generation of specific \SpecialChar LaTeX
16603 code, using the \SpecialChar LaTeX
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16619 \begin_layout Description
16620 \begin_inset Flex Code
16623 \begin_layout Plain Layout
16630 \begin_inset Flex Code
16633 \begin_layout Plain Layout
16640 \begin_inset space \thinspace{}
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16655 ] Allow spell-checking paragraphs of this style.
16659 \begin_layout Description
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16670 \begin_inset Flex Code
16673 \begin_layout Plain Layout
16682 \begin_inset Flex Code
16685 \begin_layout Plain Layout
16691 ] Steps the master counter of a given counter at the beginning of a new
16692 sequence of layouts.
16693 This is currently only useful when
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16716 \begin_layout Description
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16726 The font used for the text body .
16728 \begin_inset CommandInset ref
16730 reference "subsec:Font-description"
16737 \begin_layout Description
16738 \begin_inset Flex Code
16741 \begin_layout Plain Layout
16750 \begin_inset Flex Code
16753 \begin_layout Plain Layout
16763 The level of the style in the table of contents.
16764 This is used for automatic numbering of section headings.
16767 \begin_layout Description
16768 \begin_inset Flex Code
16771 \begin_layout Plain Layout
16780 \begin_inset Flex Code
16783 \begin_layout Plain Layout
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16804 \begin_inset Flex Code
16807 \begin_layout Plain Layout
16813 ] This tag determines whether the first line indentation of this paragraph
16814 can be toggled via the Paragraph settings dialog.
16818 \begin_inset Flex Code
16821 \begin_layout Plain Layout
16831 is set, indentation can be toggled if the document settings use
16832 \begin_inset Quotes eld
16836 \begin_inset Quotes erd
16839 paragraph style, with
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16849 , indentation can always be toggled, notwithstanding the document settings,
16851 \begin_inset Flex Code
16854 \begin_layout Plain Layout
16860 , indentation can never be toggled.
16863 \begin_layout Description
16864 \begin_inset Flex Code
16867 \begin_layout Plain Layout
16874 \begin_inset Flex Code
16877 \begin_layout Plain Layout
16883 ] The vertical space with which the very first of a chain of paragraphs
16884 with this style is separated from the previous paragraph.
16885 If the previous paragraph has another style, the separations are not simply
16886 added, but the maximum is taken.
16889 \begin_layout Subsection
16890 \begin_inset CommandInset label
16896 Internationalization of Paragraph Styles
16899 \begin_layout Standard
16901 has long supported internationalization of layout information, but, until
16902 version 2.0, this applied only to the user interface and not to, say, PDF
16904 Thus, French authors were forced to resort to ugly hacks if they wanted
16909 1' instead of `Theorem 1'.
16910 Thanks to Georg Baum, that is no longer the case.
16913 \begin_layout Standard
16915 \begin_inset Flex Code
16918 \begin_layout Plain Layout
16924 defines text that is to appear in the typeset document, it may use
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16944 to support non-English and even multi-language documents correctly.
16945 The following excerpt (from the
16946 \begin_inset Flex Code
16949 \begin_layout Plain Layout
16955 file) shows how this works:
16958 \begin_layout LyX-Code
16963 \begin_layout LyX-Code
16966 theoremstyle{remark}
16969 \begin_layout LyX-Code
16972 newtheorem{claim}[thm]{
16979 \begin_layout LyX-Code
16983 \begin_layout LyX-Code
16987 \begin_layout LyX-Code
16992 claimname}{_(Claim)}
16995 \begin_layout LyX-Code
16999 \begin_layout LyX-Code
17003 \begin_layout LyX-Code
17012 claimname}{_(Claim)}}
17015 \begin_layout LyX-Code
17020 \begin_layout Standard
17021 In principle, any legal \SpecialChar LaTeX
17023 \begin_inset Flex Code
17026 \begin_layout Plain Layout
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17042 tags, but in practice they will typically look as they do here.
17043 The key to correct translation of the typeset text is the definition of
17044 the \SpecialChar LaTeX
17046 \begin_inset Flex Code
17049 \begin_layout Plain Layout
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17073 \begin_layout Standard
17075 \begin_inset Flex Code
17078 \begin_layout Plain Layout
17084 tag provides for internationalization based upon the overall language of
17086 The contents of the tag will be included in the preamble, just as with
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17098 What makes it special is the use of the
17099 \begin_inset Quotes eld
17103 \begin_inset Quotes erd
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17116 , which will be replaced, when \SpecialChar LyX
17117 produces \SpecialChar LaTeX
17118 output, with the translation of
17119 its argument into the document language.
17122 \begin_layout Standard
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17133 tag is more complex, since it is meant to provide support for multi-language
17134 documents and so offers an interface to the
17135 \begin_inset Flex Code
17138 \begin_layout Plain Layout
17145 Its contents will be added to the preamble once for each language that
17146 appears in the document.
17147 In this case, the argument to
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 will be replaced with its translation into the language in question; the
17159 \begin_inset Flex Code
17162 \begin_layout Plain Layout
17168 is replaced by the language name (as used by the babel package).
17171 \begin_layout Standard
17172 A German document that also included a French section would thus have the
17173 following in the preamble:
17176 \begin_layout LyX-Code
17185 claimname}{Affirmation}}
17186 \begin_inset Newline newline
17197 claimname}{Behauptung}}
17198 \begin_inset Newline newline
17205 claimname}{Behauptung}
17208 \begin_layout Standard
17211 \begin_inset Flex Code
17214 \begin_layout Plain Layout
17220 will then conspire to produce the correct text in the output.
17223 \begin_layout Standard
17224 One important point to note here is that the translations are provided by
17226 itself, through the file
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17237 This means, in effect, that
17238 \begin_inset Flex Code
17241 \begin_layout Plain Layout
17248 \begin_inset Flex Code
17251 \begin_layout Plain Layout
17257 are really only of use in layout files that are provided with \SpecialChar LyX
17259 entered in user-created layout files will not be seen by \SpecialChar LyX
17260 's internationalizatio
17261 n routines unless the
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17271 file is modified accordingly.
17272 That said, however, any layout created with the intention that it will
17273 be included with \SpecialChar LyX
17274 should use these tags where appropriate.
17275 Please note that the paragraph style translations provided by \SpecialChar LyX
17277 change with a minor update (e.
17278 \begin_inset space \thinspace{}
17282 \begin_inset space \space{}
17285 from version 2.1.x to 2.1.y).
17286 It is however quite likely that a major update (e.
17287 \begin_inset space \thinspace{}
17291 \begin_inset space \space{}
17294 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17297 \begin_layout Subsection
17299 \begin_inset CommandInset label
17301 name "subsec:Floats"
17308 \begin_layout Standard
17309 It is necessary to define the floats (
17310 \begin_inset Flex Noun
17313 \begin_layout Plain Layout
17320 \begin_inset Flex Noun
17323 \begin_layout Plain Layout
17329 , \SpecialChar ldots
17330 ) in the text class itself.
17331 Standard floats are included in the file
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17341 , so you may have to do no more than add
17344 \begin_layout LyX-Code
17345 Input stdfloats.inc
17348 \begin_layout Standard
17349 to your layout file.
17350 If you want to implement a text class that proposes some other float types
17351 (like the AGU class bundled with \SpecialChar LyX
17352 ), the information below will hopefully
17356 \begin_layout Description
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17367 \begin_inset Flex Code
17370 \begin_layout Plain Layout
17376 =!htbpH] Allowed placement options for this float type.
17377 The value is a string of placement characters.
17378 Possible characters include:
17383 \begin_inset Quotes eld
17387 \begin_inset Quotes erd
17395 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17407 \begin_inset Quotes eld
17411 \begin_inset Quotes erd
17419 \begin_inset Quotes eld
17423 \begin_inset Quotes erd
17431 \begin_inset Quotes eld
17435 \begin_inset Quotes erd
17443 \begin_inset Quotes eld
17447 \begin_inset Quotes erd
17451 The order of the characters in the string does not matter.
17452 If no placement options are allowed, use the string
17459 \begin_layout Description
17460 \begin_inset Flex Code
17463 \begin_layout Plain Layout
17470 \begin_inset Flex Code
17473 \begin_layout Plain Layout
17482 \begin_inset space \thinspace{}
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17501 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17508 \begin_inset Flex Code
17511 \begin_layout Plain Layout
17517 if the float does not support this feature.
17520 \begin_layout Description
17521 \begin_inset Flex Code
17524 \begin_layout Plain Layout
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17543 \begin_inset space \thinspace{}
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17562 ] Defines whether the float has a starred variant that spans columns in
17563 a two column paragraph.
17565 \begin_inset Flex Code
17568 \begin_layout Plain Layout
17574 if the float does not support this feature.
17577 \begin_layout Description
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17588 \begin_inset Flex Code
17591 \begin_layout Plain Layout
17598 \begin_inset Quotes erd
17602 \begin_inset Quotes erd
17605 ] The file name extension of an auxiliary file for the list of figures (or
17608 writes the captions to this file.
17611 \begin_layout Description
17612 \begin_inset Flex Code
17615 \begin_layout Plain Layout
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17632 \begin_inset Quotes erd
17636 \begin_inset Quotes erd
17639 ] The string that will be used in the menus and also for the caption.
17640 This is translated to the current language if babel is used.
17643 \begin_layout Description
17644 \begin_inset Flex Code
17647 \begin_layout Plain Layout
17653 These tags control the XHTML output.
17655 \begin_inset CommandInset ref
17657 reference "sec:Tags-for-XHTML"
17664 \begin_layout Description
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17677 \begin_inset Flex Code
17680 \begin_layout Plain Layout
17689 \begin_inset space \thinspace{}
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17702 ] Indicates whether the float is already defined in the document class or
17703 if instead the \SpecialChar LaTeX
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17714 needs to be loaded to define it on-the-fly.
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17736 It should be set to
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17746 if the float is already defined by the \SpecialChar LaTeX
17750 \begin_layout Description
17751 \begin_inset Flex Code
17754 \begin_layout Plain Layout
17761 \begin_inset Flex Code
17764 \begin_layout Plain Layout
17771 \begin_inset Quotes erd
17775 \begin_inset Quotes erd
17778 ] The command used to generate a list of floats of this type; the leading
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17796 is false, since there is no standard way to generate this command.
17798 \begin_inset Flex Code
17801 \begin_layout Plain Layout
17807 is true, since in that case there is a standard way to define the command.
17810 \begin_layout Description
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17831 \begin_inset Quotes erd
17835 \begin_inset Quotes erd
17838 ] A title for a list of floats of this kind (list of figures, tables, or
17840 It is used for the screen label within \SpecialChar LyX
17841 , it is used by \SpecialChar LaTeX
17843 it is used as the title in the XHTML output.
17844 It will be translated to the document language.
17847 \begin_layout Description
17848 \begin_inset Flex Code
17851 \begin_layout Plain Layout
17858 \begin_inset Flex Code
17861 \begin_layout Plain Layout
17868 \begin_inset Quotes erd
17872 \begin_inset Quotes erd
17875 ] This (optional) argument determines whether floats of this class will
17876 be numbered within some sectional unit of the document.
17878 \begin_inset Flex Code
17881 \begin_layout Plain Layout
17888 \begin_inset Quotes eld
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17902 \begin_inset Quotes erd
17905 , the floats will be numbered within chapters.
17909 \begin_layout Description
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17920 \begin_inset Flex Code
17923 \begin_layout Plain Layout
17930 \begin_inset Quotes erd
17934 \begin_inset Quotes erd
17937 ] The default placement for the given class of floats.
17938 The string should be as in standard \SpecialChar LaTeX
17940 \begin_inset Flex Code
17943 \begin_layout Plain Layout
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17960 \begin_inset Flex Code
17963 \begin_layout Plain Layout
17970 \begin_inset Flex Code
17973 \begin_layout Plain Layout
17979 for top, bottom, page, and here, respectively.
17983 \begin_layout Plain Layout
17984 Note that the order of these letters in the string is irrelevant, like in
17991 On top of that there is a new type,
17992 \begin_inset Flex Code
17995 \begin_layout Plain Layout
18001 , which does not really correspond to a float, since it means: put it
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18010 Note however that the
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18020 specifier is special and, because of implementation details, cannot be
18021 used in non-built in float types.
18022 If you do not understand what this means, just use
18023 \begin_inset Quotes eld
18027 \begin_inset Flex Code
18030 \begin_layout Plain Layout
18037 \begin_inset Quotes erd
18043 \begin_layout Description
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18063 ] The prefix to use when creating labels referring to floats of this type.
18064 This allows the use of formatted references.
18065 Note that you can remove any
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18075 set by a copied style by using the special value
18076 \begin_inset Quotes eld
18080 \begin_inset Quotes erd
18083 , which must be all caps.
18086 \begin_layout Description
18087 \begin_inset Flex Code
18090 \begin_layout Plain Layout
18097 \begin_inset Flex Code
18100 \begin_layout Plain Layout
18107 \begin_inset Quotes erd
18111 \begin_inset Quotes erd
18114 ] The style used when defining the float using
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18129 \begin_layout Description
18130 \begin_inset Flex Code
18133 \begin_layout Plain Layout
18140 \begin_inset Flex Code
18143 \begin_layout Plain Layout
18150 \begin_inset Quotes erd
18154 \begin_inset Quotes erd
18158 \begin_inset Quotes eld
18162 \begin_inset Quotes erd
18165 of the new class of floats, like program or algorithm.
18166 After the appropriate
18167 \begin_inset Flex Code
18170 \begin_layout Plain Layout
18179 \begin_inset Flex Code
18182 \begin_layout Plain Layout
18191 \begin_inset Flex Code
18194 \begin_layout Plain Layout
18205 \begin_layout Description
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18216 \begin_inset Flex Code
18219 \begin_layout Plain Layout
18226 \begin_inset space \thinspace{}
18230 \begin_inset Flex Code
18233 \begin_layout Plain Layout
18241 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18252 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18256 \begin_layout Standard
18257 Note that defining a float with type
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18269 automatically defines the corresponding counter with name
18270 \begin_inset Flex Code
18273 \begin_layout Plain Layout
18284 \begin_layout Subsection
18285 Flex insets and InsetLayout
18286 \begin_inset CommandInset label
18288 name "subsec:Flex-insets-and"
18295 \begin_layout Standard
18296 Flex insets come in three different kinds:
18299 \begin_layout Itemize
18301 \begin_inset Flex Code
18304 \begin_layout Plain Layout
18310 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18312 \begin_inset Flex Code
18315 \begin_layout Plain Layout
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18338 \begin_layout Itemize
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18349 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18351 footnote, and the like.
18352 An obvious example is an endnote inset, which is defined in the
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18365 \begin_layout Itemize
18367 \begin_inset Flex Code
18370 \begin_layout Plain Layout
18376 ): For use with DocBook classes.
18379 \begin_layout Standard
18380 Flex insets are defined using the
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18390 tag, which shall be explained in a moment.
18393 \begin_layout Standard
18395 \begin_inset Flex Code
18398 \begin_layout Plain Layout
18404 tag also serves another function: It can be used to customize the general
18405 layout of many different types of insets.
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18416 can be used to customize the layout parameters for footnotes, marginal
18417 notes, note insets, \SpecialChar TeX
18418 code (ERT) insets, branches, listings, indexes, boxes,
18419 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18422 \begin_layout Standard
18424 \begin_inset Flex Code
18427 \begin_layout Plain Layout
18433 definition must begin with a line of the form:
18436 \begin_layout LyX-Code
18440 \begin_layout Standard
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18451 indicates the inset whose layout is being defined, and here there are four
18455 \begin_layout Enumerate
18456 The layout for a pre-existing inset is being modified.
18457 In this case, can be
18458 \begin_inset Flex Code
18461 \begin_layout Plain Layout
18467 any one of the following:
18468 \begin_inset Flex Code
18471 \begin_layout Plain Layout
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18508 \begin_inset Flex Code
18511 \begin_layout Plain Layout
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18568 \begin_inset Flex Code
18571 \begin_layout Plain Layout
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18608 \begin_inset Flex Code
18611 \begin_layout Plain Layout
18618 \begin_inset Flex Code
18621 \begin_layout Plain Layout
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18648 \begin_inset Flex Code
18651 \begin_layout Plain Layout
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18670 \begin_layout Enumerate
18671 The layout for a Flex inset is being defined.
18673 \begin_inset Flex Code
18676 \begin_layout Plain Layout
18682 must be of the form
18683 \begin_inset Quotes eld
18687 \begin_inset Flex Code
18690 \begin_layout Plain Layout
18697 \begin_inset Quotes erd
18701 \begin_inset Flex Code
18704 \begin_layout Plain Layout
18710 may be be any valid identifier not used by a pre-existing Flex inset.
18711 The identifier may include spaces, but in that case the whole thing must
18712 be wrapped in quotes.
18713 Note that the definition of a flex inset
18718 \begin_inset Flex Code
18721 \begin_layout Plain Layout
18727 entry, declaring which type of inset it defines.
18730 \begin_layout Enumerate
18731 The layout for user specific branch is being defined.
18733 \begin_inset Flex Code
18736 \begin_layout Plain Layout
18742 must be of the form
18743 \begin_inset Quotes eld
18747 \begin_inset Flex Code
18750 \begin_layout Plain Layout
18757 \begin_inset Quotes erd
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18770 may be be any valid identifier of branch defined in user's document.
18771 The identifier may include spaces, but in that case the whole thing must
18772 be wrapped in quotes.
18773 The main purpose of this feature is to allow \SpecialChar LaTeX
18774 wrapping around specific
18775 branches as user needs.
18778 \begin_layout Enumerate
18779 The layout of a user (or class) specific caption is being defined.
18781 \begin_inset Flex Code
18784 \begin_layout Plain Layout
18790 must be of the form
18791 \begin_inset Quotes eld
18795 \begin_inset Flex Code
18798 \begin_layout Plain Layout
18805 \begin_inset Quotes erd
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18818 specifies the name of the caption as it appears in the menu.
18819 Have a look at the standard caption (
18820 \begin_inset Flex Code
18823 \begin_layout Plain Layout
18829 ), the specific captions of the KOMA-Script classes (
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18840 \begin_inset Flex Code
18843 \begin_layout Plain Layout
18852 \begin_inset space ~
18856 \begin_inset Newline linebreak
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18871 ) for applications.
18874 \begin_layout Standard
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18885 definition can contain the following entries:
18888 \begin_layout Description
18889 \begin_inset Flex Code
18892 \begin_layout Plain Layout
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18908 =""] This inset will appear in the table of contents of the given type.
18909 An empty string disables.
18910 See also the OutlinerName and the IsTocCaption commands.
18911 This is only implemented for Flex insets.
18915 \begin_layout Description
18916 \begin_inset Flex Code
18919 \begin_layout Plain Layout
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 ] Defines argument number of a command\SpecialChar breakableslash
18936 environment associated with the current
18938 The definition must end with
18939 \begin_inset Flex Code
18942 \begin_layout Plain Layout
18950 \begin_inset CommandInset ref
18952 reference "subsec:Paragraph-Styles"
18959 \begin_layout Description
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18969 Preamble for changing language commands; see
18970 \begin_inset CommandInset ref
18972 reference "subsec:I18n"
18979 \begin_layout Description
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18990 \begin_inset Flex Code
18993 \begin_layout Plain Layout
18999 ] The color for the inset's background.
19001 \begin_inset CommandInset ref
19003 reference "chap:Names-of-colors"
19007 for a list of the available color names.
19010 \begin_layout Description
19011 \begin_inset Flex Code
19014 \begin_layout Plain Layout
19021 \begin_inset Flex Code
19024 \begin_layout Plain Layout
19033 \begin_inset space \thinspace{}
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19046 ] Whether to use the content of the inset as the label, when the inset is
19051 \begin_layout Description
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19062 \begin_inset Flex Code
19065 \begin_layout Plain Layout
19071 ] As with paragraph styles, see
19072 \begin_inset CommandInset ref
19074 reference "subsec:Paragraph-Styles"
19079 Note that you need to specify the complete type, e.
19080 \begin_inset space \thinspace{}
19084 \begin_inset space ~
19088 \begin_inset Flex Code
19091 \begin_layout Plain Layout
19092 CopyStyle Flex:<name>
19100 \begin_layout Description
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19111 \begin_inset Flex Code
19114 \begin_layout Plain Layout
19123 \begin_inset space \thinspace{}
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19136 ] Indicates whether the user may employ the Paragraph Settings dialog to
19137 customize the paragraph.
19140 \begin_layout Description
19141 \begin_inset Flex Code
19144 \begin_layout Plain Layout
19151 \begin_inset Flex Code
19154 \begin_layout Plain Layout
19161 \begin_inset Flex Code
19164 \begin_layout Plain Layout
19171 \begin_inset Flex Code
19174 \begin_layout Plain Layout
19180 , describing the rendering style used for the inset's frame and buttons.
19181 Footnotes generally use
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19191 , ERT insets generally
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 , and character styles
19202 \begin_inset Flex Code
19205 \begin_layout Plain Layout
19214 \begin_layout Description
19215 \begin_inset Flex Code
19218 \begin_layout Plain Layout
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19237 \begin_inset space \thinspace{}
19243 \begin_inset Flex Code
19246 \begin_layout Plain Layout
19255 \begin_inset Flex Code
19258 \begin_layout Plain Layout
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19275 Indicates whether the environment will stand on its own in the output or
19276 will appear inline with the surrounding text.
19277 If set to false, it is supposed that the \SpecialChar LaTeX
19278 environment ignores white space
19279 (including one newline character) after the
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19313 \change_inserted 731793113 1538674858
19317 \begin_layout Description
19319 \change_inserted 731793113 1538674891
19320 \begin_inset Flex Code
19323 \begin_layout Plain Layout
19325 \change_inserted 731793113 1538674863
19337 ,1] Allow the contents of the inset to be edited externally (using whatever
19338 editor is defined for the document's output format).
19343 \begin_layout Description
19344 \begin_inset Flex Code
19347 \begin_layout Plain Layout
19353 Required at the end of the
19354 \begin_inset Flex Code
19357 \begin_layout Plain Layout
19366 \begin_layout Description
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19376 The font used for both the text body
19382 \begin_inset CommandInset ref
19384 reference "subsec:Font-description"
19389 Note that defining this font automatically defines the
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19399 to the same value, so define this first and define
19400 \begin_inset Flex Code
19403 \begin_layout Plain Layout
19409 later if you want them to be different.
19412 \begin_layout Description
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19417 FixedWidthPreambleEncoding
19423 \begin_inset Flex Code
19426 \begin_layout Plain Layout
19435 \begin_inset space \thinspace{}
19439 \begin_inset Flex Code
19442 \begin_layout Plain Layout
19448 ] Force a fixed width encoding for the translated contents of
19449 \begin_inset Flex Code
19452 \begin_layout Plain Layout
19459 \begin_inset Flex Code
19462 \begin_layout Plain Layout
19468 code generated by this layout.
19469 This is needed for special \SpecialChar LaTeX
19474 that do not work with variable width encodings such as
19479 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19480 backends such as Xe\SpecialChar TeX
19482 Lua\SpecialChar TeX
19486 \begin_layout Description
19487 \begin_inset Flex Code
19490 \begin_layout Plain Layout
19491 ForceLocalFontSwitch
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19509 \begin_inset space \thinspace{}
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19522 ] When using babel, always use a local font switch (
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19534 ), never a global one (such as
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19549 \begin_layout Description
19550 \begin_inset Flex Code
19553 \begin_layout Plain Layout
19560 \begin_inset Flex Code
19563 \begin_layout Plain Layout
19572 \begin_inset space \thinspace{}
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 \begin_inset Quotes eld
19590 \begin_inset Quotes erd
19593 language, leading to Left-to-Right (Latin) output, e.
19594 \begin_inset space \thinspace{}
19598 \begin_inset space \space{}
19601 in \SpecialChar TeX
19606 \begin_layout Description
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19617 \begin_inset Flex Code
19620 \begin_layout Plain Layout
19629 \begin_inset space \thinspace{}
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19642 ] Force a a line break in the \SpecialChar LaTeX
19643 output before the inset starts and after
19645 This assures the inset itself is output on its own lines, for parsing purposes.
19648 \begin_layout Description
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19671 \begin_inset space \thinspace{}
19675 \begin_inset Flex Code
19678 \begin_layout Plain Layout
19684 ] Indicates whether the
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19694 should be used or, instead, the user can change the paragraph style used
19699 \begin_layout Description
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19710 \begin_inset Flex Code
19713 \begin_layout Plain Layout
19722 \begin_inset space \thinspace{}
19726 \begin_inset Flex Code
19729 \begin_layout Plain Layout
19735 ] As with paragraph styles, see
19736 \begin_inset CommandInset ref
19738 reference "subsec:Paragraph-Styles"
19745 \begin_layout Description
19746 \begin_inset Flex Code
19749 \begin_layout Plain Layout
19755 These tags control the XHTML output.
19757 \begin_inset CommandInset ref
19759 reference "sec:Tags-for-XHTML"
19766 \begin_layout Description
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19789 \begin_inset space \thinspace{}
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19802 ] Whether to include the contents of this inset in the strings generated
19803 for the `Outline' pane for all table of contents, regardless of the AddToToc
19805 One would not, for example, want the content of a footnote in a section
19806 header to be included in the TOC displayed in the outline, but one would
19807 normally want the content of a character style displayed.
19808 Default is false: not to include.
19811 \begin_layout Description
19812 \begin_inset Flex Code
19815 \begin_layout Plain Layout
19822 \begin_inset Flex Code
19825 \begin_layout Plain Layout
19834 \begin_inset space \thinspace{}
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19847 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19848 of its contents in its item in the table of contents.
19849 Otherwise, only the label appears.
19852 \begin_layout Description
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19877 \begin_inset space \thinspace{}
19881 \begin_inset Flex Code
19884 \begin_layout Plain Layout
19890 ] As with paragraph styles, see
19891 \begin_inset CommandInset ref
19893 reference "subsec:Paragraph-Styles"
19900 \begin_layout Description
19901 \begin_inset Flex Code
19904 \begin_layout Plain Layout
19910 The font used for the label.
19912 \begin_inset CommandInset ref
19914 reference "subsec:Font-description"
19919 Note that this definition can never appear before
19920 \begin_inset Flex Code
19923 \begin_layout Plain Layout
19929 , lest it be ineffective.
19932 \begin_layout Description
19933 \begin_inset Flex Code
19936 \begin_layout Plain Layout
19943 \begin_inset Flex Code
19946 \begin_layout Plain Layout
19953 \begin_inset Quotes erd
19957 \begin_inset Quotes erd
19960 ] What will be displayed on the button or elsewhere as the inset label.
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19973 \begin_inset Flex Code
19976 \begin_layout Plain Layout
19982 ) modify this label on the fly.
19985 \begin_layout Description
19986 \begin_inset Flex Code
19989 \begin_layout Plain Layout
19995 Language dependent preamble; see
19996 \begin_inset CommandInset ref
19998 reference "subsec:I18n"
20005 \begin_layout Description
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20025 ] The name of the corresponding \SpecialChar LaTeX
20027 Either the environment or command name.
20030 \begin_layout Description
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20050 ] The optional parameter for the corresponding
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20060 stuff, including possible bracket pairs like
20061 \begin_inset Flex Code
20064 \begin_layout Plain Layout
20071 This parameter cannot be changed from within \SpecialChar LyX
20073 \begin_inset Flex Code
20076 \begin_layout Plain Layout
20082 for customizable parameters).
20083 It will be output as is after all \SpecialChar LaTeX
20085 \begin_inset Flex Code
20088 \begin_layout Plain Layout
20097 \begin_layout Description
20098 \begin_inset Flex Code
20101 \begin_layout Plain Layout
20108 \begin_inset Flex Code
20111 \begin_layout Plain Layout
20112 Command, Environment, None
20117 ] How the style should be translated into \SpecialChar LaTeX
20122 \begin_layout Plain Layout
20123 \begin_inset Flex Code
20126 \begin_layout Plain Layout
20132 is perhaps a bit misleading, since these rules apply to SGML classes too.
20133 Visit the SGML class files for specific examples.
20142 \begin_layout Description
20143 \begin_inset Flex Code
20146 \begin_layout Plain Layout
20152 means nothing special
20155 \begin_layout Description
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20166 \begin_inset Flex Code
20169 \begin_layout Plain Layout
20176 {\SpecialChar ldots
20185 \begin_layout Description
20186 \begin_inset Flex Code
20189 \begin_layout Plain Layout
20196 \begin_inset Flex Code
20199 \begin_layout Plain Layout
20206 }\SpecialChar ldots
20221 \begin_layout Standard
20222 Putting the last few things together, the \SpecialChar LaTeX
20223 output will be either:
20226 \begin_layout LyX-Code
20229 LatexName[LatexParam]{\SpecialChar ldots
20233 \begin_layout Standard
20237 \begin_layout LyX-Code
20240 begin{LatexName}[LatexParam] \SpecialChar ldots
20246 \begin_layout Standard
20247 depending upon the \SpecialChar LaTeX
20252 \begin_layout Description
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20272 ] A string that is put at the beginning of the layout content.
20273 A line break in the output can be indicated by
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20286 \begin_layout Description
20287 \begin_inset Flex Code
20290 \begin_layout Plain Layout
20297 \begin_inset Flex Code
20300 \begin_layout Plain Layout
20307 \begin_inset Flex Code
20310 \begin_layout Plain Layout
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20327 \begin_inset Flex Code
20330 \begin_layout Plain Layout
20336 (indicating a dummy definition ending definitions of charstyles, etc).
20337 This entry is required in and is only meaningful for Flex insets.
20338 Among other things, it determines on which menu this inset will appear.
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20350 \begin_inset Flex Code
20353 \begin_layout Plain Layout
20359 will automatically set
20360 \begin_inset Flex Code
20363 \begin_layout Plain Layout
20370 \begin_inset Flex Code
20373 \begin_layout Plain Layout
20381 \begin_inset Flex Code
20384 \begin_layout Plain Layout
20390 can be set to true, or
20391 \begin_inset Flex Code
20394 \begin_layout Plain Layout
20401 \begin_inset Flex Code
20404 \begin_layout Plain Layout
20410 insets by setting it
20415 \begin_inset Flex Code
20418 \begin_layout Plain Layout
20425 \change_inserted -712698321 1555575738
20429 \begin_layout Description
20431 \change_inserted -712698321 1555575844
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20437 \change_inserted -712698321 1555575740
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20449 \change_inserted -712698321 1555575740
20455 A dedicated string for the menu.
20456 You can define an accelerator by appending the respective character to
20457 the string, divided by
20458 \begin_inset Quotes eld
20462 \begin_inset Quotes erd
20466 \begin_inset space \thinspace{}
20470 \begin_inset space \space{}
20474 \begin_inset Quotes eld
20478 \begin_inset Flex Code
20481 \begin_layout Plain Layout
20483 \change_inserted -712698321 1555575781
20490 \begin_inset Quotes erd
20494 This specification is optional.
20495 If it is not given the inset name as specified in the type declaration
20496 will be used instead for the menu.
20501 \begin_layout Description
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20524 \begin_inset space \thinspace{}
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20537 ] Whether multiple paragraphs are permitted in this inset.
20539 \begin_inset Flex Code
20542 \begin_layout Plain Layout
20548 to the same value and
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20558 to the opposite value.
20559 These can be reset to other values, if they are used
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20577 \begin_layout Description
20578 \begin_inset Flex Code
20581 \begin_layout Plain Layout
20588 \begin_inset Flex Code
20591 \begin_layout Plain Layout
20600 \begin_inset space \thinspace{}
20604 \begin_inset Flex Code
20607 \begin_layout Plain Layout
20613 ] Whether fragile commands in this inset should be
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20630 whether the command should itself be protected.) Default is false.
20631 \change_inserted -712698321 1523633958
20635 \begin_layout Description
20637 \change_inserted -712698321 1552395786
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20643 \change_inserted -712698321 1523633961
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20655 \change_inserted -712698321 1523633958
20664 \begin_inset space \thinspace{}
20668 \begin_inset Flex Code
20671 \begin_layout Plain Layout
20673 \change_inserted -712698321 1523633958
20679 ] This causes macros that contain this inset to be protected with
20680 \begin_inset Flex Code
20683 \begin_layout Plain Layout
20685 \change_inserted -712698321 1523634038
20700 ) if necessary and thus allows (some) verbatim stuff in macros.
20704 \begin_layout Description
20706 \change_inserted -712698321 1555579651
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20712 \change_inserted -712698321 1552395787
20719 \begin_inset Flex Code
20722 \begin_layout Plain Layout
20724 \change_inserted -712698321 1552395787
20733 \begin_inset space \thinspace{}
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20742 \change_inserted -712698321 1552395787
20748 ] Whether specific commands in this inset (such as
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20754 \change_inserted -712698321 1552395787
20763 \begin_inset Flex Code
20766 \begin_layout Plain Layout
20768 \change_inserted -712698321 1552395787
20776 ) should be protected in an
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20782 \change_inserted -712698321 1552395787
20791 This is particularly needed for insets that draw on
20799 commands which parse their content in complex ways.
20803 \begin_layout Description
20805 \change_inserted -712698321 1555579742
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20811 \change_inserted -712698321 1555579658
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20823 \change_inserted -712698321 1555579651
20829 Option to define a different command (from the default
20830 \begin_inset Flex Code
20833 \begin_layout Plain Layout
20835 \change_inserted -712698321 1555579742
20847 ) to be used for line breaks.
20848 The initial backslash must not be specified.
20853 \begin_layout Description
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20873 ] Deletes an existing
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20886 \begin_layout Description
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20907 \begin_inset Flex Code
20910 \begin_layout Plain Layout
20916 that has replaced this
20917 \begin_inset Flex Code
20920 \begin_layout Plain Layout
20927 This is used to rename an
20928 \begin_inset Flex Code
20931 \begin_layout Plain Layout
20937 , while keeping backward compatibility.
20938 \change_inserted -712698321 1559491850
20942 \begin_layout Description
20944 \change_inserted -712698321 1559492002
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20950 \change_inserted -712698321 1559491854
20957 \begin_inset Flex Code
20960 \begin_layout Plain Layout
20962 \change_inserted -712698321 1559491850
20971 \begin_inset space \thinspace{}
20975 \begin_inset Flex Code
20978 \begin_layout Plain Layout
20980 \change_inserted -712698321 1559491850
20986 ] If this is set to
20987 \begin_inset Flex Code
20990 \begin_layout Plain Layout
20992 \change_inserted -712698321 1559491881
21000 , paragraph breaks will be ignored in the output.
21001 This might be useful for insets where the content should be alignable on
21002 different lines only in the \SpecialChar LyX
21003 workarea, without any effect in the output.
21008 \begin_layout Description
21009 \begin_inset Flex Code
21012 \begin_layout Plain Layout
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21031 \begin_inset space \thinspace{}
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21044 ] As with paragraph styles, see
21045 \begin_inset CommandInset ref
21047 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
21078 \begin_inset space \thinspace{}
21082 \begin_inset Flex Code
21085 \begin_layout Plain Layout
21091 ] As with paragraph styles, see
21092 \begin_inset CommandInset ref
21094 reference "subsec:Paragraph-Styles"
21102 \begin_layout Description
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21112 As with paragraph styles, see
21113 \begin_inset CommandInset ref
21115 reference "subsec:Paragraph-Styles"
21122 \begin_layout Description
21123 \begin_inset Flex Code
21126 \begin_layout Plain Layout
21133 \begin_inset Flex Code
21136 \begin_layout Plain Layout
21142 ] The prefix to use when creating labels referring to insets of this type.
21143 This allows the use of formatted references.
21146 \begin_layout Description
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21166 ] As with paragraph styles, see
21167 \begin_inset CommandInset ref
21169 reference "subsec:Paragraph-Styles"
21176 \begin_layout Description
21177 \begin_inset Flex Code
21180 \begin_layout Plain Layout
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21199 \begin_inset space \thinspace{}
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21212 ] Resets the \SpecialChar LaTeX
21213 arguments of this layout (as defined via the
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 This is useful if you have copied a style via
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21234 , but you do not want to inherit its (required and optional) arguments.
21237 \begin_layout Description
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21258 \begin_inset space \thinspace{}
21262 \begin_inset Flex Code
21265 \begin_layout Plain Layout
21273 ] Whether this inset should use the font of its surrounding environment
21275 Default is false: use the font of the surrounding environment.
21278 \begin_layout Description
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21289 \begin_inset Flex Code
21292 \begin_layout Plain Layout
21298 ] A string that is put at the end of the layout content.
21299 A line break in the output can be indicated by
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21312 \begin_layout Description
21313 \begin_inset Flex Code
21316 \begin_layout Plain Layout
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21333 \begin_inset space \thinspace{}
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21348 ] Allow spell-checking the contents of this inset.
21352 \begin_layout Subsection
21354 \begin_inset CommandInset label
21356 name "subsec:Counters"
21363 \begin_layout Standard
21364 It is necessary to define the counters (
21365 \begin_inset Flex Noun
21368 \begin_layout Plain Layout
21375 \begin_inset Flex Noun
21378 \begin_layout Plain Layout
21384 , \SpecialChar ldots
21385 ) in the text class itself.
21386 The standard counters are defined in the file
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21396 , so you may have to do no more than add
21399 \begin_layout LyX-Code
21400 Input stdcounters.inc
21403 \begin_layout Standard
21404 to your layout file to get them to work.
21405 But if you want to define custom counters, then you can do so.
21406 The counter declaration must begin with:
21409 \begin_layout LyX-Code
21410 Counter CounterName
21413 \begin_layout Standard
21415 \begin_inset Flex Code
21418 \begin_layout Plain Layout
21424 ' is replaced by the name of the counter.
21425 And it must end with
21426 \begin_inset Quotes eld
21430 \begin_inset Flex Code
21433 \begin_layout Plain Layout
21440 \begin_inset Quotes erd
21444 The following parameters can also be used:
21447 \begin_layout Description
21448 \begin_inset Flex Code
21451 \begin_layout Plain Layout
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21467 ] Sets the initial value for the counter, to which it will be reset whenever
21469 Normally, one will want the default, 1.
21472 \begin_layout Description
21473 \begin_inset Flex Code
21476 \begin_layout Plain Layout
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21493 \begin_inset Quotes erd
21497 \begin_inset Quotes erd
21500 ] When defined, this string defines how the counter is displayed.
21501 Setting this value sets
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21506 LabelStringAppendix
21512 The following special constructs can be used in the string:
21516 \begin_layout Itemize
21517 \begin_inset Flex Code
21520 \begin_layout Plain Layout
21528 will be replaced by the expansion of the
21529 \begin_inset Flex Code
21532 \begin_layout Plain Layout
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21543 LabelStringAppendix
21549 \begin_inset Flex Code
21552 \begin_layout Plain Layout
21562 \begin_layout Itemize
21563 counter values can be expressed using \SpecialChar LaTeX
21565 \begin_inset Newline newline
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21589 \begin_inset Flex Code
21592 \begin_layout Plain Layout
21604 \begin_layout Plain Layout
21614 Actually, the situation is a bit more complicated: any
21633 other than those described below will produce arabic numerals.
21634 It would not be surprising to see this change in the future.
21640 \begin_inset Flex Code
21643 \begin_layout Plain Layout
21649 : 1, 2, 3,\SpecialChar ldots
21651 \begin_inset Flex Code
21654 \begin_layout Plain Layout
21660 for lower-case letters: a, b, c, \SpecialChar ldots
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21671 for upper-case letters: A, B, C, \SpecialChar ldots
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21682 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21693 for upper-case roman numerals: I, II, III\SpecialChar ldots
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21704 for hebrew numerals.
21708 \begin_layout Standard
21709 If LabelString is not defined, a default value is constructed as follows:
21710 if the counter has a master counter
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21731 \begin_inset Newline newline
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21748 is used; otherwise the string
21749 \begin_inset Flex Code
21752 \begin_layout Plain Layout
21763 \begin_layout Description
21764 \begin_inset Flex Code
21767 \begin_layout Plain Layout
21768 LabelStringAppendix
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21784 \begin_inset Quotes erd
21788 \begin_inset Quotes erd
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21801 , but for use in the Appendix.
21804 \begin_layout Description
21805 \begin_inset Flex Code
21808 \begin_layout Plain Layout
21815 \begin_inset Flex Code
21818 \begin_layout Plain Layout
21825 \begin_inset Quotes erd
21829 \begin_inset Quotes erd
21832 ] A format for use with formatted references to this counter.
21833 For example, one might want to have references to section numbers appear
21835 \begin_inset Quotes eld
21839 \begin_inset Quotes erd
21843 The string should contain
21844 \begin_inset Quotes eld
21848 \begin_inset Quotes erd
21852 This will be replaced by the counter number itself.
21853 So, for sections, it would be: Section ##.
21856 \begin_layout Description
21857 \begin_inset Flex Code
21860 \begin_layout Plain Layout
21867 \begin_inset Flex Code
21870 \begin_layout Plain Layout
21877 \begin_inset Quotes erd
21881 \begin_inset Quotes erd
21884 ] If this is set to the name of another counter, the present counter will
21885 be reset every time the other one is increased.
21887 \begin_inset Flex Code
21890 \begin_layout Plain Layout
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21909 \begin_layout Subsection
21911 \begin_inset CommandInset label
21913 name "subsec:Font-description"
21920 \begin_layout Standard
21921 A font description looks like this:
21924 \begin_layout LyX-Code
21941 \begin_layout LyX-Code
21945 \begin_layout LyX-Code
21949 \begin_layout Standard
21950 The following commands are available:
21953 \begin_layout Description
21954 \begin_inset Flex Code
21957 \begin_layout Plain Layout
21964 \begin_inset Flex Code
21967 \begin_layout Plain Layout
21976 \begin_inset Flex Code
21979 \begin_layout Plain Layout
21986 \begin_inset Flex Code
21989 \begin_layout Plain Layout
21996 \begin_inset Flex Code
21999 \begin_layout Plain Layout
22006 \begin_inset Flex Code
22009 \begin_layout Plain Layout
22016 \begin_inset Flex Code
22019 \begin_layout Plain Layout
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22056 \begin_inset Flex Code
22059 \begin_layout Plain Layout
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22136 \begin_inset Flex Code
22139 \begin_layout Plain Layout
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22168 \begin_layout Description
22169 \begin_inset Flex Code
22172 \begin_layout Plain Layout
22179 \begin_inset Flex Code
22182 \begin_layout Plain Layout
22191 \begin_inset Flex Code
22194 \begin_layout Plain Layout
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22213 \begin_layout Description
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22233 ] Valid arguments are:
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22264 \begin_inset Flex Code
22267 \begin_layout Plain Layout
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22294 \begin_inset Flex Code
22297 \begin_layout Plain Layout
22304 \begin_inset Flex Code
22307 \begin_layout Plain Layout
22314 \begin_inset Flex Code
22317 \begin_layout Plain Layout
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22354 Each of these turns on or off the corresponding attribute.
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22365 turns on emphasis, and
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22377 \begin_inset Newline newline
22380 If the latter seems puzzling, remember that the font settings for the present
22381 context are generally inherited from the surrounding context.
22383 \begin_inset Flex Code
22386 \begin_layout Plain Layout
22392 would turn off the emphasis that was anyway in effect, say, in a theorem
22396 \begin_layout Description
22397 \begin_inset Flex Code
22400 \begin_layout Plain Layout
22407 \begin_inset Flex Code
22410 \begin_layout Plain Layout
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22431 \begin_layout Description
22432 \begin_inset Flex Code
22435 \begin_layout Plain Layout
22442 \begin_inset Flex Code
22445 \begin_layout Plain Layout
22454 \begin_inset Flex Code
22457 \begin_layout Plain Layout
22464 \begin_inset Flex Code
22467 \begin_layout Plain Layout
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22486 \begin_layout Description
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22497 \begin_inset Flex Code
22500 \begin_layout Plain Layout
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22539 \begin_inset Flex Code
22542 \begin_layout Plain Layout
22549 \begin_inset Flex Code
22552 \begin_layout Plain Layout
22559 \begin_inset Flex Code
22562 \begin_layout Plain Layout
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22581 \begin_layout Subsection
22582 \begin_inset CommandInset label
22584 name "subsec:Citation-engine-description"
22588 Cite engine description
22591 \begin_layout Standard
22593 \begin_inset Flex Code
22596 \begin_layout Plain Layout
22602 blocks, as used mainly in cite engine files (see
22603 \begin_inset CommandInset ref
22605 reference "subsec:Cite-Engine-Files"
22612 ), define the citation commands provided by a specific
22613 \begin_inset Quotes eld
22617 \begin_inset Quotes erd
22621 A cite engine, in \SpecialChar LyX
22622 terms, is way specific way to format citations, using
22623 numbers, author names and/or years.
22624 Currently, \SpecialChar LyX
22625 supports three such engine types, namely:
22628 \begin_layout Enumerate
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22638 : the default Bib\SpecialChar TeX
22639 way to format citations, a simple numeric style (e.
22640 \begin_inset space \thinspace{}
22644 \begin_inset Quotes eld
22648 \begin_inset Quotes erd
22654 \begin_layout Enumerate
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22664 : Harvard-styled citations using author names and publication year (e.
22665 \begin_inset space \thinspace{}
22669 \begin_inset Quotes eld
22672 Smith and Miller (2017b)
22673 \begin_inset Quotes erd
22679 \begin_layout Enumerate
22680 \begin_inset Flex Code
22683 \begin_layout Plain Layout
22689 : extended numerical citations that also allow for author or title next
22691 \begin_inset space \thinspace{}
22695 \begin_inset Quotes eld
22698 Smith and Miller [1]
22699 \begin_inset Quotes erd
22705 \begin_layout Standard
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22715 blocks look like this:
22718 \begin_layout LyX-Code
22722 \begin_layout LyX-Code
22726 \begin_layout LyX-Code
22730 \begin_layout LyX-Code
22731 citeyearpar[][]=parencite*
22734 \begin_layout LyX-Code
22738 \begin_layout LyX-Code
22742 \begin_layout Standard
22744 \begin_inset Flex Code
22747 \begin_layout Plain Layout
22753 denotes the engine.
22754 The individual lines respectively define a cite command or cite command
22755 paradigm supported by this engine.
22756 The line can be as simple as a cite command that is used both to name the
22757 respective \SpecialChar LyX
22758 command and the \SpecialChar LaTeX
22759 output or more complex in order to differentiate
22761 The full syntax is:
22764 \begin_layout LyX-Code
22765 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22768 \begin_layout Itemize
22769 \begin_inset Flex Code
22772 \begin_layout Plain Layout
22778 : The name as used in the
22779 \begin_inset Flex Code
22782 \begin_layout Plain Layout
22792 \begin_layout Standard
22793 For portability reasons, we try to use the same name for same-formatted
22794 commands in different cite packages (thus many names stem from natbib,
22795 and thus we need to differentiate a
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22805 sometimes, if the \SpecialChar LaTeX
22806 command names differ).
22810 \begin_layout Itemize
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22820 : a (comma-separated) list of commands that fall back to the given
22821 \begin_inset Flex Code
22824 \begin_layout Plain Layout
22830 in the current engine.
22831 This eases the switch of citation packages and engines.
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22852 in layout definitions.
22855 \begin_layout Itemize
22856 \begin_inset Flex Code
22859 \begin_layout Plain Layout
22865 : The actual \SpecialChar LaTeX
22866 command that is output.
22870 \begin_layout Standard
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22892 \begin_inset Flex Code
22895 \begin_layout Plain Layout
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22911 will be output to \SpecialChar LaTeX
22915 \begin_layout Standard
22919 \begin_layout Itemize
22920 Capitalization indicates that the command also has a capitalized form (
22921 \begin_inset Flex Code
22924 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22946 These usually enforce up-casing of name prefixes (
22951 \begin_inset Formula $\Rightarrow$
22961 \begin_layout Itemize
22963 \begin_inset Flex Code
22966 \begin_layout Plain Layout
22972 indicate the number of optional arguments (there can be 0–2).
22975 \begin_layout Itemize
22977 \begin_inset Flex Code
22980 \begin_layout Plain Layout
22986 indicates there is a starred version of the command (
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
23000 \begin_inset Flex Code
23003 \begin_layout Plain Layout
23016 \begin_layout Standard
23017 By default, the starred version means: Output all authors even if it should
23019 \begin_inset Quotes eld
23023 \begin_inset Quotes erd
23027 \begin_inset Flex Code
23030 \begin_layout Plain Layout
23039 \begin_layout Standard
23040 If the star has a different meaning for a given command, it can be specified
23042 \begin_inset Flex Code
23045 \begin_layout Plain Layout
23046 <!_stardesc!_stardesctooltip>
23052 Maximal two translatable macro keywords, marked by the prefix
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23063 The first points to the string that replaces the
23064 \begin_inset Quotes eld
23068 \begin_inset Quotes erd
23071 checkbox label in the citation dialog, the second one to an optional tool
23072 tip for this checkbox.
23076 \begin_layout Standard
23077 Note that these two macros have to be defined in a
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23087 (see next section), dropping the
23088 \begin_inset Flex Code
23091 \begin_layout Plain Layout
23097 from the prefix, like this:
23100 \begin_layout LyX-Code
23101 _stardesc Sta&rred command label
23104 \begin_layout LyX-Code
23105 _stardesctooltip Tooltip for the starred command checkbox.
23109 \begin_layout Itemize
23111 \begin_inset Flex Code
23114 \begin_layout Plain Layout
23120 indicates that this command features
23121 \begin_inset Quotes eld
23124 qualified citation lists
23125 \begin_inset Quotes erd
23133 -specific feature for multi-reference citations where an individual pre-
23134 and postnote can be given to each reference in the list.
23135 Please refer to the
23139 manual for details.
23140 \change_inserted -712698321 1526898670
23144 \begin_layout Standard
23146 \change_inserted -712698321 1526899524
23147 If you want to add a cite command to a cite engine (e.
23148 \begin_inset space \thinspace{}
23151 g., add a specific command provided by a class), you can use
23152 \begin_inset Flex Code
23155 \begin_layout Plain Layout
23157 \change_inserted -712698321 1526898768
23158 AddToCiteEngine <engine type> \SpecialChar ldots
23167 Note that only cite commands that do not exist yet are added.
23172 \begin_layout Subsection
23173 \begin_inset CommandInset label
23175 name "subsec:Citation-format-description"
23179 Cite format description
23182 \begin_layout Standard
23184 \begin_inset Flex Code
23187 \begin_layout Plain Layout
23193 blocks are used to describe how bibliographic information should be displayed,
23194 both within \SpecialChar LyX
23195 itself (in the citation dialog and in tooltips, for example)
23196 and in XHTML output.
23197 Such a block might look like this:
23200 \begin_layout LyX-Code
23204 \begin_layout LyX-Code
23208 \begin_layout LyX-Code
23212 \begin_layout LyX-Code
23216 \begin_layout Standard
23220 \begin_layout LyX-Code
23224 \begin_layout LyX-Code
23228 \begin_layout LyX-Code
23232 \begin_layout LyX-Code
23236 \begin_layout Standard
23237 In the first case, the individual lines define how the bibliographic information
23238 associated with an article or book, respectively, is to be displayed, and
23239 such a definition can be given for any
23240 \begin_inset Quotes els
23244 \begin_inset Quotes ers
23247 that might be present in a Bib\SpecialChar TeX
23250 defines a default format in the source code that will be used if no specific
23251 definition has been given.
23253 predefines several formats in the file
23254 \begin_inset Flex Code
23257 \begin_layout Plain Layout
23263 , which is included in most of \SpecialChar LyX
23264 's document classes.
23267 \begin_layout Standard
23268 In the second case, the lines define how a specific citation command (in
23270 \begin_inset Flex Code
23273 \begin_layout Plain Layout
23282 \begin_inset Flex Code
23285 \begin_layout Plain Layout
23293 ) is to be displayed on the citation inset label, in the citation dialog,
23294 menu or XHTML output.
23296 defines such formats for the citation style variants it supports via
23298 Document\SpecialChar menuseparator
23299 Setting\SpecialChar menuseparator
23300 Bibliography\SpecialChar ldots
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23313 files that are shipped with \SpecialChar LyX
23315 \begin_inset CommandInset ref
23317 reference "subsec:Cite-Engine-Files"
23327 \begin_layout Standard
23328 The definitions use a simple language that allows Bib\SpecialChar TeX
23329 keys to be replaced
23331 Keys should be enclosed in
23332 \begin_inset Flex Code
23335 \begin_layout Plain Layout
23342 \begin_inset Flex Code
23345 \begin_layout Plain Layout
23352 So a simple definition might look like this:
23355 \begin_layout LyX-Code
23357 \begin_inset Quotes eld
23361 \begin_inset Quotes erd
23367 \begin_layout Standard
23368 This would print the author, followed by a comma, followed by the title,
23369 in quotes, followed by a period.
23372 \begin_layout Standard
23373 Of course, sometimes you may want to print a key only if it exists.
23374 This can be done by using a conditional construction, such as:
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23380 \begin_inset space ~
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23399 key exists, then print
23400 \begin_inset Quotes eld
23404 \begin_inset space ~
23408 \begin_inset Quotes erd
23411 followed by the volume key.
23412 It is also possible to have an else clause in the conditional, such as:
23413 \begin_inset Newline newline
23417 \begin_inset Flex Code
23420 \begin_layout Plain Layout
23421 {%author%[[%author%]][[%editor%, ed.]]}
23427 \begin_inset Newline newline
23431 \begin_inset Flex Code
23434 \begin_layout Plain Layout
23440 key is printed if it exists; otherwise, the editor key is printed, followed
23442 \begin_inset Quotes eld
23446 \begin_inset space ~
23450 \begin_inset Quotes erd
23453 Note that the key is again enclosed in
23454 \begin_inset Flex Code
23457 \begin_layout Plain Layout
23463 signs; the entire conditional is enclosed in braces; and the if and else
23464 clauses are enclosed in double brackets,
23465 \begin_inset Quotes eld
23469 \begin_inset Flex Code
23472 \begin_layout Plain Layout
23479 \begin_inset Quotes eld
23483 \begin_inset Quotes eld
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23497 \begin_inset Quotes erd
23501 There must be no space between any of these.
23504 \begin_layout Standard
23505 Next to the entry keys, there are some special keys that can be used for
23506 these conditionals:
23509 \begin_layout Itemize
23510 \begin_inset Flex Code
23513 \begin_layout Plain Layout
23514 {%dialog%[[true]][[false]]}
23520 \begin_inset Quotes eld
23524 \begin_inset Quotes erd
23527 part for dialogs and menus, the
23528 \begin_inset Quotes eld
23532 \begin_inset Quotes erd
23535 part for other contexts (workarea, export)
23538 \begin_layout Itemize
23539 \begin_inset Flex Code
23542 \begin_layout Plain Layout
23543 {%export%[[true]][[false]]}
23549 \begin_inset Quotes eld
23553 \begin_inset Quotes erd
23556 part for export and menus, the
23557 \begin_inset Quotes eld
23561 \begin_inset Quotes erd
23564 part for other contexts (workarea, dialog)
23567 \begin_layout Itemize
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23578 \begin_inset Quotes eld
23582 \begin_inset Quotes erd
23585 part if another item follows (e.
23586 \begin_inset space \thinspace{}
23589 g., in a citation with multiple keys)
23592 \begin_layout Itemize
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23597 {%second%[[true]][[false]]}
23603 \begin_inset Quotes eld
23607 \begin_inset Quotes erd
23610 if this is the second of multiple items, else the
23611 \begin_inset Quotes eld
23615 \begin_inset Quotes erd
23621 \begin_layout Itemize
23622 \begin_inset Flex Code
23625 \begin_layout Plain Layout
23626 {%ifstar%[[true]][[false]]}
23632 \begin_inset Quotes eld
23636 \begin_inset Quotes erd
23639 part for starred citation commands (such as
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23651 ), the false part for unstarred
23654 \begin_layout Itemize
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23659 {%ifentrytype:<type>%[[true]][[false]]}
23665 \begin_inset Quotes eld
23669 \begin_inset Quotes erd
23672 if the current entry type matches
23673 \begin_inset Flex Code
23676 \begin_layout Plain Layout
23682 , else the false part (e.g., in a citation definition:
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23687 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23695 \begin_layout Itemize
23696 \begin_inset Flex Code
23699 \begin_layout Plain Layout
23700 {%ifmultiple:<authortype>%[[true]][[false]]}
23706 \begin_inset Quotes eld
23710 \begin_inset Quotes erd
23713 if the current author type (author, editor etc.) has multiple authors, else
23714 the false part (e.g., in a bibliography definition:
23715 \begin_inset Flex Code
23718 \begin_layout Plain Layout
23719 {%ifmultiple:editor%[[eds.]][[ed.]]}
23727 \begin_layout Itemize
23728 \begin_inset Flex Code
23731 \begin_layout Plain Layout
23732 {%ifqualified%[[true]][[false]]}
23738 \begin_inset Quotes eld
23742 \begin_inset Quotes erd
23745 part if the current citation is a qualified citation list (a specific
23749 format for multi-reference citations), the false part if this is not the
23753 \begin_layout Standard
23755 \begin_inset Flex Code
23758 \begin_layout Plain Layout
23764 prints the author key as it is recorded in the bibliography file.
23765 This might not be what you want, since it will result in a string such
23767 \begin_inset Quotes eld
23770 Miller, Peter and Smith, Mary and White, Jane
23771 \begin_inset Quotes erd
23775 \begin_inset Quotes eld
23779 \begin_inset Quotes erd
23782 is used by Bib\SpecialChar TeX
23783 to delimit authors).
23785 therefore provides some methods to get properly formatted name lists (which
23786 will also get translated).
23787 The following keys are provided:
23790 \begin_layout Enumerate
23791 For name lists with pre- and surname, suitable for the main authors/editors
23792 of a bibliography item.
23794 \begin_inset Flex Code
23797 \begin_layout Plain Layout
23803 part denotes the kind of list that is requested (e.g.
23805 \begin_inset Flex Code
23808 \begin_layout Plain Layout
23818 \begin_layout Itemize
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23823 %abbrvnames:<nametype>%
23828 : Provides a name list which is abbreviated (with
23829 \begin_inset Quotes eld
23833 \begin_inset Quotes erd
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23849 \begin_layout Itemize
23850 \begin_inset Flex Code
23853 \begin_layout Plain Layout
23854 %fullnames:<nametype>%
23859 : Provides a full name list (never abbreviated with
23860 \begin_inset Quotes eld
23864 \begin_inset Quotes erd
23870 \begin_layout Itemize
23871 \begin_inset Flex Code
23874 \begin_layout Plain Layout
23875 %forceabbrvnames:<nametype>%
23880 : Provides a name list which is always abbreviated (with
23881 \begin_inset Quotes eld
23885 \begin_inset Quotes erd
23889 \begin_inset Flex Code
23892 \begin_layout Plain Layout
23902 \begin_layout Enumerate
23903 Alternative name lists with pre- and surname, if the order of pre- and surname
23904 inside the bibliography item differs (as in:
23905 \begin_inset Quotes eld
23908 Miller, John: Some text, in: Mary Smith, ed.: A volume
23909 \begin_inset Quotes erd
23916 \begin_layout Itemize
23917 \begin_inset Flex Code
23920 \begin_layout Plain Layout
23921 %abbrvbynames:<nametype>%
23926 : Provides a name list which is abbreviated (with
23927 \begin_inset Quotes eld
23931 \begin_inset Quotes erd
23935 \begin_inset Flex Code
23938 \begin_layout Plain Layout
23947 \begin_layout Itemize
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23952 %fullbynames:<nametype>%
23957 : Provides a full name list (never abbreviated with
23958 \begin_inset Quotes eld
23962 \begin_inset Quotes erd
23968 \begin_layout Itemize
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23973 %forceabbrvbynames:<nametype>%
23978 : Provides a name list which is always abbreviated (with
23979 \begin_inset Quotes eld
23983 \begin_inset Quotes erd
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
24000 \begin_layout Enumerate
24001 And finally name lists which consist of family names only, as used in author-yea
24003 These do not take a
24004 \begin_inset Flex Code
24007 \begin_layout Plain Layout
24013 part, but always return either an author list or, if this does not exist,
24014 an editor list (as common in author-year labels):
24018 \begin_layout Itemize
24019 \begin_inset Flex Code
24022 \begin_layout Plain Layout
24028 : Provides a name list which is abbreviated (with
24029 \begin_inset Quotes eld
24033 \begin_inset Quotes erd
24037 \begin_inset Flex Code
24040 \begin_layout Plain Layout
24049 \begin_layout Itemize
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24059 : Provides a full name list (never abbreviated with
24060 \begin_inset Quotes eld
24064 \begin_inset Quotes erd
24070 \begin_layout Itemize
24071 \begin_inset Flex Code
24074 \begin_layout Plain Layout
24075 %forceabbrvciteauthor%
24080 : Provides a name list which is always abbreviated (with
24081 \begin_inset Quotes eld
24085 \begin_inset Quotes erd
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24102 \begin_layout Standard
24103 The order of pre- and surname in the former two lists can be adjusted by
24107 \begin_layout Itemize
24108 \begin_inset Flex Code
24111 \begin_layout Plain Layout
24112 !firstnameform %surname%, %prename%
24117 (first author in lists of type 1)
24120 \begin_layout Itemize
24121 \begin_inset Flex Code
24124 \begin_layout Plain Layout
24125 !othernameform %surname%, %prename%
24130 (other authors in lists of type 1)
24133 \begin_layout Itemize
24134 \begin_inset Flex Code
24137 \begin_layout Plain Layout
24138 !firstbynameform %prename% %surname%
24143 (first author in lists of type 2)
24146 \begin_layout Itemize
24147 \begin_inset Flex Code
24150 \begin_layout Plain Layout
24151 !otherbynameform %prename% %surname%
24156 (other authors in lists of type 2)
24159 \begin_layout Standard
24160 This allows you to configure namings like
24161 \begin_inset Quotes eld
24164 Miller, Peter and Mary Smith: \SpecialChar ldots
24165 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24167 \begin_inset Quotes erd
24173 \begin_layout Standard
24174 There is one other piece of syntax available in definitions, which looks
24176 \begin_inset Flex Code
24179 \begin_layout Plain Layout
24186 This defines a piece of formatting information that is to be used when
24188 \begin_inset Quotes eld
24192 \begin_inset Quotes erd
24196 Obviously, we do not want to output HTML tags when writing plain text,
24197 so they should be wrapped in
24198 \begin_inset Quotes eld
24202 \begin_inset Quotes erd
24206 \begin_inset Quotes eld
24210 \begin_inset Quotes erd
24216 \begin_layout Standard
24217 Two special sorts of definitions are also possible in a
24218 \begin_inset Flex Code
24221 \begin_layout Plain Layout
24228 An example of the first would be:
24231 \begin_layout LyX-Code
24233 \begin_inset Quotes eld
24237 \begin_inset Quotes erd
24243 \begin_layout Standard
24244 This is an abbreviation, or macro, and it can be used by treating it as
24246 \begin_inset Flex Code
24249 \begin_layout Plain Layout
24258 \begin_inset Flex Code
24261 \begin_layout Plain Layout
24267 exactly as it would treat its definition.
24268 So, let us issue the obvious
24276 \begin_layout LyX-Code
24280 \begin_layout Standard
24281 or anything like it.
24283 shouldn't go into an infinite loop, but it may go into a long one before
24287 \begin_layout Standard
24288 The second sort of special definition might look like this:
24291 \begin_layout LyX-Code
24295 \begin_layout Standard
24296 This defines a translatable piece of text, which allows relevant parts of
24297 the bibliography or citation to be translated.
24298 It can be included in a definition by treating it as a key:
24299 \begin_inset Flex Code
24302 \begin_layout Plain Layout
24309 Note that there are two different translation paths: All definitions starting
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24320 , such as in the example above, will be translated to the currently active
24321 buffer language (so the translation will match the generated document).
24322 All definitions starting with underscore only will be translated to the
24324 This is the proper translation for strings that only occur in the dialogs
24325 or on buttons, such as this one:
24328 \begin_layout LyX-Code
24329 _addtobib Add to bibliography only.
24332 \begin_layout Standard
24333 Several of these translatable strings are predefined in
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24344 \begin_inset Flex Code
24347 \begin_layout Plain Layout
24354 Note that these are not macros, in the sense just defined.
24355 They will not be expanded.
24358 \begin_layout Standard
24359 So here then is an example that uses several of these features:
24360 \begin_inset VSpace defskip
24366 \begin_layout Standard
24370 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24373 \begin_layout Standard
24374 \begin_inset VSpace defskip
24377 This defines a macro that prints the author, followed by a comma, if the
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24388 key is defined, or else prints the name of the editor, followed by the
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24399 or its translation (it is by default
24400 \begin_inset Quotes eld
24404 \begin_inset Quotes erd
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24418 Note that this is in fact defined in
24419 \begin_inset Flex Code
24422 \begin_layout Plain Layout
24428 , so you can use it in your own definitions, or re-definitions, if you load
24432 \begin_layout Section
24433 \begin_inset CommandInset label
24435 name "sec:Tags-for-XHTML"
24439 Tags for XHTML output
24442 \begin_layout Standard
24443 As with \SpecialChar LaTeX
24444 or DocBook, the format of \SpecialChar LyX
24445 's XHTML output is also controlled by
24446 layout information.
24447 In general, \SpecialChar LyX
24448 provides sensible defaults and, as mentioned earlier, it will
24449 even construct default CSS style rules from the other layout tags.
24450 For example, \SpecialChar LyX
24451 will attempt to use the information provided in the
24452 \begin_inset Flex Code
24455 \begin_layout Plain Layout
24461 declaration for the Chapter style to write CSS that will appropriately
24462 format chapter headings.
24465 \begin_layout Standard
24466 In many cases, then, you may not have to do anything at all to get acceptable
24467 XHTML output for your own environments, custom insets, and so forth.
24468 But in some cases you will, and so \SpecialChar LyX
24469 provides a number of layout tags that
24470 can be used to customize the XHTML and CSS that are generated.
24473 \begin_layout Standard
24474 Note that there are two tags,
24475 \begin_inset Flex Code
24478 \begin_layout Plain Layout
24485 \begin_inset Flex Code
24488 \begin_layout Plain Layout
24494 that may appear outside style and inset declarations.
24496 \begin_inset CommandInset ref
24498 reference "subsec:General-text-class"
24502 for details on these.
24505 \begin_layout Subsection
24506 \begin_inset CommandInset label
24508 name "subsec:Paragraph-Style-XHTML"
24515 \begin_layout Standard
24516 The sort of XHTML \SpecialChar LyX
24517 outputs for a paragraph depends upon whether we are dealing
24518 with a normal paragraph, a command, or an environment, where this is itself
24519 determined by the contents of the corresponding
24520 \begin_inset Flex Code
24523 \begin_layout Plain Layout
24534 \begin_layout Standard
24535 For a command or normal paragraph, the output XHTML has the following form:
24538 \begin_layout LyX-Code
24542 \begin_inset Quotes erd
24546 \begin_inset Quotes erd
24552 \begin_layout LyX-Code
24556 \begin_inset Quotes erd
24560 \begin_inset Quotes erd
24566 \begin_layout LyX-Code
24569 Contents of the paragraph.
24572 \begin_layout LyX-Code
24578 \begin_layout Standard
24579 The label tags are of course omitted if the paragraph does not have a label.
24582 \begin_layout Standard
24583 For an environment that is not some sort of list, the XHTML takes this form:
24586 \begin_layout LyX-Code
24590 \begin_inset Quotes erd
24594 \begin_inset Quotes erd
24600 \begin_layout LyX-Code
24604 \begin_inset Quotes erd
24608 \begin_inset Quotes erd
24612 \begin_inset Quotes erd
24616 \begin_inset Quotes erd
24619 >Environment Label</labeltag>First paragraph.</itemtag>
24622 \begin_layout LyX-Code
24625 <itemtag>Second paragraph.</itemtag>
24628 \begin_layout LyX-Code
24634 \begin_layout Standard
24635 Note that the label is output only for the first paragraph, as it should
24636 be for a theorem, for example.
24640 \begin_layout Standard
24641 For a list, we have one of these forms:
24644 \begin_layout LyX-Code
24648 \begin_inset Quotes erd
24652 \begin_inset Quotes erd
24658 \begin_layout LyX-Code
24662 \begin_inset Quotes erd
24666 \begin_inset Quotes erd
24670 \begin_inset Quotes erd
24674 \begin_inset Quotes erd
24677 >List Label</labeltag>First item.</itemtag>
24680 \begin_layout LyX-Code
24684 \begin_inset Quotes erd
24688 \begin_inset Quotes erd
24692 \begin_inset Quotes erd
24696 \begin_inset Quotes erd
24699 >List Label</labeltag>Second item.</itemtag>
24702 \begin_layout LyX-Code
24708 \begin_layout LyX-Code
24712 \begin_layout LyX-Code
24716 \begin_inset Quotes erd
24720 \begin_inset Quotes erd
24726 \begin_layout LyX-Code
24730 \begin_inset Quotes erd
24734 \begin_inset Quotes erd
24737 >List Label</labeltag><itemtag attr=
24738 \begin_inset Quotes erd
24742 \begin_inset Quotes erd
24745 >First item.</itemtag>
24748 \begin_layout LyX-Code
24752 \begin_inset Quotes erd
24756 \begin_inset Quotes erd
24759 >List Label</labeltag><itemtag attr=
24760 \begin_inset Quotes erd
24764 \begin_inset Quotes erd
24767 >Second item.</itemtag>
24770 \begin_layout LyX-Code
24776 \begin_layout Standard
24777 Note the different orders of
24778 \begin_inset Flex Code
24781 \begin_layout Plain Layout
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24798 Which order we get depends upon the setting of
24799 \begin_inset Flex Code
24802 \begin_layout Plain Layout
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24818 is false (the default), you get the first of these, with the label within
24819 the item; if true, you get the second, with the label outside the item.
24822 \begin_layout Standard
24823 The specific tags and attributes output for each paragraph type can be controlle
24824 d by means of the layout tags we are about to describe.
24825 As mentioned earlier, however, \SpecialChar LyX
24826 uses sensible defaults for many of these,
24827 so you often may not need to do very much to get good XHTML output.
24828 Think of the available tags as there so you can tweak things to your liking.
24831 \begin_layout Description
24832 \begin_inset Flex Code
24835 \begin_layout Plain Layout
24842 \begin_inset Flex Code
24845 \begin_layout Plain Layout
24851 ] Specifies attribute information to be output with the main tag.
24853 \begin_inset Quotes eld
24857 \begin_inset Flex Code
24860 \begin_layout Plain Layout
24867 \begin_inset Quotes erd
24871 By default, \SpecialChar LyX
24873 \begin_inset Quotes eld
24877 \begin_inset Flex Code
24880 \begin_layout Plain Layout
24887 \begin_inset Quotes erd
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24900 is the \SpecialChar LyX
24901 name of the layout, made lowercase, for example: chapter.
24906 contain any style information.
24908 \begin_inset Flex Code
24911 \begin_layout Plain Layout
24920 \begin_layout Description
24921 \begin_inset Flex Code
24924 \begin_layout Plain Layout
24931 \begin_inset Flex Code
24934 \begin_layout Plain Layout
24944 ] Whether to output the default CSS information \SpecialChar LyX
24945 generates for this layout,
24946 even if additional information is explicitly provided via
24947 \begin_inset Flex Code
24950 \begin_layout Plain Layout
24958 \begin_inset Flex Code
24961 \begin_layout Plain Layout
24967 allows you to alter or augment the generated CSS, rather than to override
24970 \begin_inset Flex Code
24973 \begin_layout Plain Layout
24982 \begin_layout Description
24983 \begin_inset Flex Code
24986 \begin_layout Plain Layout
24993 \begin_inset Flex Code
24996 \begin_layout Plain Layout
25002 ] The tag to be used for individual paragraphs of environments, replacing
25004 \begin_inset Flex Code
25007 \begin_layout Plain Layout
25013 in the examples above.
25015 \begin_inset Flex Code
25018 \begin_layout Plain Layout
25027 \begin_layout Description
25028 \begin_inset Flex Code
25031 \begin_layout Plain Layout
25038 \begin_inset Flex Code
25041 \begin_layout Plain Layout
25047 ] Attributes for the item tag.
25049 \begin_inset Newline newline
25053 \begin_inset Quotes eld
25057 \begin_inset Flex Code
25060 \begin_layout Plain Layout
25061 class=`layoutname_item'
25067 \begin_inset Quotes erd
25075 contain any style information.
25077 \begin_inset Flex Code
25080 \begin_layout Plain Layout
25089 \begin_layout Description
25090 \begin_inset Flex Code
25093 \begin_layout Plain Layout
25100 \begin_inset Flex Code
25103 \begin_layout Plain Layout
25109 ] The tag to be used for paragraph and item labels, replacing
25110 \begin_inset Flex Code
25113 \begin_layout Plain Layout
25119 in the examples above.
25121 \begin_inset Flex Code
25124 \begin_layout Plain Layout
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25141 \begin_inset Flex Code
25144 \begin_layout Plain Layout
25151 \begin_inset Flex Code
25154 \begin_layout Plain Layout
25155 Centered_Top_Environment
25160 , in which case it defaults to
25161 \begin_inset Flex Code
25164 \begin_layout Plain Layout
25173 \begin_layout Description
25174 \begin_inset Flex Code
25177 \begin_layout Plain Layout
25184 \begin_inset Flex Code
25187 \begin_layout Plain Layout
25193 ] Attributes for the label tag.
25195 \begin_inset Newline newline
25199 \begin_inset Quotes eld
25203 \begin_inset Flex Code
25206 \begin_layout Plain Layout
25207 class=`layoutname_label'
25213 \begin_inset Quotes erd
25221 contain any style information.
25223 \begin_inset Flex Code
25226 \begin_layout Plain Layout
25235 \begin_layout Description
25236 \begin_inset Flex Code
25239 \begin_layout Plain Layout
25246 \begin_inset Flex Code
25249 \begin_layout Plain Layout
25259 ] Meaningful only for list-like environments, this tag controls whether
25260 the label tag is output before or inside the item tag.
25261 This is used, for example, in the description environment, where we want
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25267 <dt>\SpecialChar ldots
25268 </dt><dd>\SpecialChar ldots
25276 \begin_inset Flex Code
25279 \begin_layout Plain Layout
25285 : The label tag is output inside the item tag.
25288 \begin_layout Description
25289 \begin_inset Flex Code
25292 \begin_layout Plain Layout
25298 Information to be output in the
25299 \begin_inset Flex Code
25302 \begin_layout Plain Layout
25308 section when this style is used.
25309 This might, for example, be used to include a
25310 \begin_inset Flex Code
25313 \begin_layout Plain Layout
25320 \begin_inset Flex Code
25323 \begin_layout Plain Layout
25332 \begin_layout Description
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25342 CSS style information to be included when this style is used.
25343 Note that this will automatically be wrapped in a layout-generated
25344 \begin_inset Flex Code
25347 \begin_layout Plain Layout
25353 block, so only the CSS itself need be included.
25355 \begin_inset Flex Code
25358 \begin_layout Plain Layout
25367 \begin_layout Description
25368 \begin_inset Flex Code
25371 \begin_layout Plain Layout
25378 \begin_inset Flex Code
25381 \begin_layout Plain Layout
25387 ] The tag to be used for the main label, replacing
25388 \begin_inset Flex Code
25391 \begin_layout Plain Layout
25397 in the examples above.
25399 \begin_inset Flex Code
25402 \begin_layout Plain Layout
25411 \begin_layout Description
25412 \begin_inset Flex Code
25415 \begin_layout Plain Layout
25422 \begin_inset Flex Code
25425 \begin_layout Plain Layout
25435 ] Marks this style as the one to be used to generate the
25436 \begin_inset Flex Code
25439 \begin_layout Plain Layout
25445 tag for the XHTML file.
25446 By default, it is false.
25448 \begin_inset Flex Code
25451 \begin_layout Plain Layout
25457 file sets it to true for the
25458 \begin_inset Flex Code
25461 \begin_layout Plain Layout
25471 \begin_layout Subsection
25475 \begin_layout Standard
25476 The XHTML output of insets can also be controlled by information in layout
25481 \begin_layout Plain Layout
25482 At present, this is true only for
25483 \begin_inset Quotes eld
25487 \begin_inset Quotes erd
25490 insets (insets you can type into) and is not true for
25491 \begin_inset Quotes eld
25495 \begin_inset Quotes erd
25498 insets (insets that are associated with dialog boxes).
25503 Here, too, \SpecialChar LyX
25504 tries to provide sensible defaults, and it constructs default
25506 But everything can be customized.
25509 \begin_layout Standard
25510 The XHTML \SpecialChar LyX
25511 outputs for an inset has the following form:
25514 \begin_layout LyX-Code
25516 \begin_inset Quotes erd
25520 \begin_inset Quotes erd
25526 \begin_layout LyX-Code
25527 <labeltag>Label</labeltag>
25530 \begin_layout LyX-Code
25532 \begin_inset Quotes erd
25536 \begin_inset Quotes erd
25539 >Contents of the inset.</innertag>
25542 \begin_layout LyX-Code
25546 \begin_layout Standard
25547 If the inset permits multiple paragraphs—that is, if
25548 \begin_inset Flex Code
25551 \begin_layout Plain Layout
25557 is true—then the contents of the inset will itself be output as paragraphs
25558 formatted according to the styles used for those paragraphs (standard,
25559 quote, and the like).
25560 The label tag is of course omitted if the paragraph does not have a label
25561 and, at present, is always
25562 \begin_inset Flex Code
25565 \begin_layout Plain Layout
25572 The inner tag is optional and, by default, does not appear.
25575 \begin_layout Standard
25576 The specific tags and attributes output for each inset can be controlled
25577 by means of the following layout tags.
25580 \begin_layout Description
25581 \begin_inset Flex Code
25584 \begin_layout Plain Layout
25591 \begin_inset Flex Code
25594 \begin_layout Plain Layout
25600 ] Specifies attribute information to be output with the main tag.
25602 \begin_inset Quotes eld
25606 \begin_inset Flex Code
25609 \begin_layout Plain Layout
25610 class=`myinset' onclick=`\SpecialChar ldots
25617 \begin_inset Quotes erd
25621 By default, \SpecialChar LyX
25623 \begin_inset Quotes eld
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25637 \begin_inset Quotes erd
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25650 is the \SpecialChar LyX
25651 name of the inset, made lowercase and with non-alphanumeric characters
25652 converted to underscores, for example: footnote.
25655 \begin_layout Description
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25666 \begin_inset Flex Code
25669 \begin_layout Plain Layout
25679 ] Whether to output the default CSS information \SpecialChar LyX
25680 generates for this layout,
25681 even if additional information is explicitly provided via
25682 \begin_inset Flex Code
25685 \begin_layout Plain Layout
25693 \begin_inset Flex Code
25696 \begin_layout Plain Layout
25702 allows you to alter or augment the generated CSS, rather than to override
25707 \begin_layout Description
25708 \begin_inset Flex Code
25711 \begin_layout Plain Layout
25718 \begin_inset Flex Code
25721 \begin_layout Plain Layout
25727 ] Attributes for the inner tag.
25729 \begin_inset Newline newline
25733 \begin_inset Quotes eld
25737 \begin_inset Flex Code
25740 \begin_layout Plain Layout
25741 class=`insetname_inner'
25747 \begin_inset Quotes erd
25753 \begin_layout Description
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25764 \begin_inset Flex Code
25767 \begin_layout Plain Layout
25773 ] The inner tag, replacing
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25783 in the examples above.
25784 By default, there is none.
25787 \begin_layout Description
25788 \begin_inset Flex Code
25791 \begin_layout Plain Layout
25798 \begin_inset Flex Code
25801 \begin_layout Plain Layout
25809 ] Whether this inset represents a standalone block of text (such as a footnote)
25810 or instead represents material that is included in the surrounding text
25811 (such as a branch).
25815 \begin_layout Description
25816 \begin_inset Flex Code
25819 \begin_layout Plain Layout
25826 \begin_inset Flex Code
25829 \begin_layout Plain Layout
25835 ] A label for this inset, possibly including a reference to a counter.
25836 For example, for footnote, it might be:
25837 \begin_inset Flex Code
25840 \begin_layout Plain Layout
25849 This is optional, and there is no default.
25852 \begin_layout Description
25853 \begin_inset Flex Code
25856 \begin_layout Plain Layout
25862 Information to be output in the
25863 \begin_inset Flex Code
25866 \begin_layout Plain Layout
25872 section when this style is used.
25873 This might, for example, be used to include a
25874 \begin_inset Flex Code
25877 \begin_layout Plain Layout
25884 \begin_inset Flex Code
25887 \begin_layout Plain Layout
25896 \begin_layout Description
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25906 CSS style information to be included when this style is used.
25907 Note that this will automatically be wrapped in a layout-generated
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25917 block, so only the CSS itself need be included.
25920 \begin_layout Description
25921 \begin_inset Flex Code
25924 \begin_layout Plain Layout
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25940 ] The tag to be used for the main label, replacing
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25950 in the examples above.
25951 The default depends upon the setting of
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25962 \begin_inset Flex Code
25965 \begin_layout Plain Layout
25971 is true, the default is
25972 \begin_inset Flex Code
25975 \begin_layout Plain Layout
25981 ; if it is false, the default is
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25994 \begin_layout Subsection
25998 \begin_layout Standard
25999 The XHTML output for floats too can be controlled by layout information.
26000 The output has the following form:
26003 \begin_layout LyX-Code
26005 \begin_inset Quotes erd
26009 \begin_inset Quotes erd
26015 \begin_layout LyX-Code
26016 Contents of the float.
26019 \begin_layout LyX-Code
26023 \begin_layout Standard
26024 The caption, if there is one, is a separate inset and will be output as
26026 Its appearance can be controlled via the InsetLayout for caption insets.
26030 \begin_layout Description
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26041 \begin_inset Flex Code
26044 \begin_layout Plain Layout
26050 ] Specifies attribute information to be output with the main tag.
26052 \begin_inset Quotes eld
26056 \begin_inset Flex Code
26059 \begin_layout Plain Layout
26060 class=`myfloat' onclick=`\SpecialChar ldots
26067 \begin_inset Quotes erd
26071 By default, \SpecialChar LyX
26073 \begin_inset Quotes eld
26077 \begin_inset Flex Code
26080 \begin_layout Plain Layout
26081 class=`float float-floattype'
26087 \begin_inset Quotes erd
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26100 is \SpecialChar LyX
26101 's name for this type of float, as determined by the float declaration
26103 \begin_inset CommandInset ref
26105 reference "subsec:Floats"
26109 ), though made lowercase and with non-alphanumeric characters converted
26110 to underscores, for example: float-table.
26113 \begin_layout Description
26114 \begin_inset Flex Code
26117 \begin_layout Plain Layout
26123 CSS style information to be included when this float is used.
26124 Note that this will automatically be wrapped in a layout-generated
26125 \begin_inset Flex Code
26128 \begin_layout Plain Layout
26134 block, so only the CSS itself need be included.
26137 \begin_layout Description
26138 \begin_inset Flex Code
26141 \begin_layout Plain Layout
26148 \begin_inset Flex Code
26151 \begin_layout Plain Layout
26157 ] The tag to be used for this float, replacing
26158 \begin_inset Quotes eld
26162 \begin_inset Flex Code
26165 \begin_layout Plain Layout
26172 \begin_inset Quotes erd
26175 in the example above.
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26186 and will rarely need changing.
26189 \begin_layout Subsection
26190 Bibliography formatting
26193 \begin_layout Standard
26194 The bibliography can be formatted using
26195 \begin_inset Flex Code
26198 \begin_layout Plain Layout
26206 \begin_inset CommandInset ref
26208 reference "subsec:Citation-format-description"
26215 \begin_layout Subsection
26220 \begin_layout Standard
26221 We have several times mentioned that \SpecialChar LyX
26222 will generate default CSS style rules
26223 for both insets and paragraph styles, based upon the other layout information
26225 In this section, we shall say a word about which layout information \SpecialChar LyX
26230 \begin_layout Standard
26231 At present, \SpecialChar LyX
26232 auto-generates CSS only for font information, making use of
26234 \begin_inset Flex Code
26237 \begin_layout Plain Layout
26244 \begin_inset Flex Code
26247 \begin_layout Plain Layout
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26274 \begin_inset Flex Code
26277 \begin_layout Plain Layout
26284 \begin_inset CommandInset ref
26286 reference "subsec:Font-description"
26291 The translation is mostly straightforward and obvious.
26293 \begin_inset Quotes eld
26297 \begin_inset Flex Code
26300 \begin_layout Plain Layout
26307 \begin_inset Quotes erd
26311 \begin_inset Quotes eld
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26319 font-family: sans-serif;
26325 \begin_inset Quotes erd
26329 The correspondence of \SpecialChar LyX
26330 sizes and CSS sizes is a little less obvious but
26331 nonetheless intuitive.
26333 \begin_inset Flex Code
26336 \begin_layout Plain Layout
26343 \begin_inset Flex URL
26346 \begin_layout Plain Layout
26356 \begin_layout Chapter
26357 Including External Material
26358 \begin_inset CommandInset label
26360 name "chap:Including-External-Material"
26367 \begin_layout Standard
26368 \begin_inset Box Shadowbox
26378 height_special "totalheight"
26383 backgroundcolor "none"
26386 \begin_layout Plain Layout
26387 WARNING: This portion of the documentation has not been updated for some
26389 We certainly hope that it is still accurate, but there are no guarantees.
26397 \begin_layout Standard
26398 The use of material from sources external to \SpecialChar LyX
26399 is covered in detail in the
26405 This part of the manual covers what needs to happen behind the scenes for
26406 new sorts of material to be included.
26409 \begin_layout Section
26413 \begin_layout Standard
26414 The external material feature is based on the concept of a
26419 A template is a specification of how \SpecialChar LyX
26420 should interface with a certain kind
26422 As bundled, \SpecialChar LyX
26423 comes with predefined templates for Xfig figures, various
26424 raster format images, chess diagrams, and LilyPond music notation.
26425 You can check the actual list by using the menu
26426 \begin_inset Flex Noun
26429 \begin_layout Plain Layout
26430 Insert\SpecialChar menuseparator
26431 File\SpecialChar menuseparator
26438 Furthermore, it is possible to roll your own template to support a specific
26440 Later we'll describe in more detail what is involved, and hopefully you
26441 will submit all the templates you create so we can include them in a later
26446 \begin_layout Standard
26447 Another basic idea of the external material feature is to distinguish between
26448 the original file that serves as a base for final material and the produced
26449 file that is included in your exported or printed document.
26450 For example, consider the case of a figure produced with
26451 \begin_inset Flex Code
26454 \begin_layout Plain Layout
26461 The Xfig application itself works on an original file with the
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26472 Within Xfig, you create and change your figure, and when you are done,
26474 \begin_inset Flex Code
26477 \begin_layout Plain Layout
26484 When you want to include the figure in your document, you invoke
26485 \begin_inset Flex Code
26488 \begin_layout Plain Layout
26494 in order to create a PostScript file that can readily be included in your
26498 \begin_inset Flex Code
26501 \begin_layout Plain Layout
26507 file is the original file, and the PostScript file is the produced file.
26510 \begin_layout Standard
26511 This distinction is important in order to allow updating of the material
26512 while you are in the process of writing the document.
26513 Furthermore, it provides us with the flexibility that is needed to support
26514 multiple export formats.
26515 For instance, in the case of a plain text file, it is not exactly an award-winn
26516 ing idea to include the figure as raw PostScript.
26517 Instead, you would either prefer to just include a reference to the figure
26518 or try to invoke some graphics to ASCII converter to make the final result
26519 look similar to the real graphics.
26520 The external material management allows you to do this, because it is parametri
26521 zed on the different export formats that \SpecialChar LyX
26525 \begin_layout Standard
26526 Besides supporting the production of different products according to the
26527 exported format, it supports tight integration with editing and viewing
26529 In the case of an Xfig figure, you are able to invoke Xfig on the original
26530 file with a single click from within the external material dialog in \SpecialChar LyX
26532 and also preview the produced PostScript file with Ghostview with another
26534 No more fiddling around with the command line and/or file browsers to locate
26535 and manipulate the original or produced files.
26536 In this way, you are finally able to take full advantage of the many different
26537 applications that are relevant to use when you write your documents, and
26538 ultimately be more productive.
26541 \begin_layout Section
26542 The external template configuration files
26545 \begin_layout Standard
26546 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26548 However, be aware that doing this in an careless manner most probably
26552 introduce an easily exploitable security hole.
26553 So before you do this, please read the discussion about security in
26554 \begin_inset CommandInset ref
26556 reference "sec:Security-discussion"
26563 \begin_layout Standard
26564 Having said that, we encourage you to submit any interesting templates that
26569 \begin_layout Standard
26570 The external templates are defined in the
26571 \begin_inset Flex Code
26574 \begin_layout Plain Layout
26580 files that are stored in the
26581 \begin_inset Flex Code
26584 \begin_layout Plain Layout
26585 LyXDir/lib/xtemplates/
26591 Each template is defined in a file of its own.
26592 You can place your own templates in
26593 \begin_inset Flex Code
26596 \begin_layout Plain Layout
26597 UserDir/xtemplates/
26602 or copy existing templates to that directory in order to modify them.
26605 \begin_layout Standard
26606 A typical template looks like this:
26609 \begin_layout LyX-Code
26613 \begin_layout LyX-Code
26614 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26617 \begin_layout LyX-Code
26621 \begin_layout LyX-Code
26625 \begin_layout LyX-Code
26629 \begin_layout LyX-Code
26633 \begin_layout LyX-Code
26637 \begin_layout LyX-Code
26638 AutomaticProduction true
26641 \begin_layout LyX-Code
26645 \begin_layout LyX-Code
26649 \begin_layout LyX-Code
26653 \begin_layout LyX-Code
26654 TransformCommand Rotate RotationLatexCommand
26657 \begin_layout LyX-Code
26658 TransformCommand Resize ResizeLatexCommand
26661 \begin_layout LyX-Code
26662 Product "$$RotateFront$$ResizeFront
26665 \begin_layout LyX-Code
26670 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26673 \begin_layout LyX-Code
26674 $$ResizeBack$$RotateBack"
26677 \begin_layout LyX-Code
26681 \begin_layout LyX-Code
26682 UpdateResult "$$AbsPath$$Basename.pstex_t"
26685 \begin_layout LyX-Code
26686 Requirement "graphicx"
26689 \begin_layout LyX-Code
26690 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26693 \begin_layout LyX-Code
26694 ReferencedFile latex "$$AbsPath$$Basename.eps"
26697 \begin_layout LyX-Code
26698 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26701 \begin_layout LyX-Code
26705 \begin_layout LyX-Code
26709 \begin_layout LyX-Code
26710 TransformCommand Rotate RotationLatexCommand
26713 \begin_layout LyX-Code
26714 TransformCommand Resize ResizeLatexCommand
26717 \begin_layout LyX-Code
26718 Product "$$RotateFront$$ResizeFront
26721 \begin_layout LyX-Code
26726 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26729 \begin_layout LyX-Code
26730 $$ResizeBack$$RotateBack"
26733 \begin_layout LyX-Code
26734 UpdateFormat pdftex
26737 \begin_layout LyX-Code
26738 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26741 \begin_layout LyX-Code
26742 Requirement "graphicx"
26745 \begin_layout LyX-Code
26746 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26749 \begin_layout LyX-Code
26750 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26753 \begin_layout LyX-Code
26757 \begin_layout LyX-Code
26761 \begin_layout LyX-Code
26762 Product "[XFig: $$FName]"
26765 \begin_layout LyX-Code
26769 \begin_layout LyX-Code
26773 \begin_layout LyX-Code
26774 Product "<graphic fileref=
26776 "$$AbsOrRelPathMaster$$Basename.eps
26781 \begin_layout LyX-Code
26785 \begin_layout LyX-Code
26789 \begin_layout LyX-Code
26790 UpdateResult "$$AbsPath$$Basename.eps"
26793 \begin_layout LyX-Code
26794 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26797 \begin_layout LyX-Code
26798 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26801 \begin_layout LyX-Code
26805 \begin_layout LyX-Code
26809 \begin_layout Standard
26810 As you can see, the template is enclosed in
26811 \begin_inset Flex Code
26814 \begin_layout Plain Layout
26822 \begin_inset Flex Code
26825 \begin_layout Plain Layout
26832 It contains a header specifying some general settings and, for each supported
26833 primary document file format, a section
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26845 \begin_inset Flex Code
26848 \begin_layout Plain Layout
26857 \begin_layout Subsection
26858 The template header
26861 \begin_layout Description
26862 \begin_inset Flex Code
26865 \begin_layout Plain Layout
26866 AutomaticProduction
26867 \begin_inset space ~
26875 Whether the file represented by the template must be generated by \SpecialChar LyX
26877 This command must occur exactly once.
26880 \begin_layout Description
26881 \begin_inset Flex Code
26884 \begin_layout Plain Layout
26886 \begin_inset space ~
26894 A glob pattern that is used in the file dialog to filter out the desired
26896 If there is more than one possible file extension (e.
26897 \begin_inset space \thinspace{}
26901 \begin_inset space \space{}
26905 \begin_inset Flex Code
26908 \begin_layout Plain Layout
26915 \begin_inset Flex Code
26918 \begin_layout Plain Layout
26924 ), use something like
26925 \begin_inset Flex Code
26928 \begin_layout Plain Layout
26935 This command must occur exactly once.
26938 \begin_layout Description
26939 \begin_inset Flex Code
26942 \begin_layout Plain Layout
26944 \begin_inset space ~
26952 The text that is displayed on the button.
26953 This command must occur exactly once.
26956 \begin_layout Description
26957 \begin_inset Flex Code
26960 \begin_layout Plain Layout
26962 \begin_inset space ~
26966 \begin_inset space ~
26974 The help text that is used in the External dialog.
26975 Provide enough information to explain to the user just what the template
26976 can provide him with.
26977 This command must occur exactly once.
26980 \begin_layout Description
26981 \begin_inset Flex Code
26984 \begin_layout Plain Layout
26986 \begin_inset space ~
26994 The file format of the original file.
26995 This must be the name of a format that is known to \SpecialChar LyX
26997 \begin_inset CommandInset ref
26999 reference "sec:Formats"
27005 \begin_inset Quotes eld
27009 \begin_inset Flex Code
27012 \begin_layout Plain Layout
27019 \begin_inset Quotes erd
27022 if the template can handle original files of more than one format.
27024 will attempt to interrogate the file itself in order to deduce its format
27026 This command must occur exactly once.
27029 \begin_layout Description
27030 \begin_inset Flex Code
27033 \begin_layout Plain Layout
27035 \begin_inset space ~
27043 A unique name for the template.
27044 It must not contain substitution macros (see below).
27047 \begin_layout Description
27048 \begin_inset Flex Code
27051 \begin_layout Plain Layout
27053 \begin_inset space ~
27056 Rotate|Resize|Clip|Extra
27061 This command specifies which transformations are supported by this template.
27062 It may occur zero or more times.
27063 This command enables the corresponding tabs in the external dialog.
27065 \begin_inset Flex Code
27068 \begin_layout Plain Layout
27074 command must have either a corresponding
27075 \begin_inset Flex Code
27078 \begin_layout Plain Layout
27085 \begin_inset Flex Code
27088 \begin_layout Plain Layout
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27105 Otherwise the transformation will not be supported by that format.
27108 \begin_layout Subsection
27112 \begin_layout Description
27113 \begin_inset Flex Code
27116 \begin_layout Plain Layout
27118 \begin_inset space ~
27121 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27126 The primary document file format that this format definition is for.
27127 Not every template has a sensible representation in all document file formats.
27128 Please define nevertheless a
27129 \begin_inset Flex Code
27132 \begin_layout Plain Layout
27138 section for all templates.
27139 Use a dummy text when no representation is available.
27140 Then you can at least see a reference to the external material in the exported
27144 \begin_layout Description
27145 \begin_inset Flex Code
27148 \begin_layout Plain Layout
27150 \begin_inset space ~
27154 \begin_inset space ~
27162 This command defines an additional macro
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27172 for substitution in
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27184 \begin_inset Flex Code
27187 \begin_layout Plain Layout
27193 itself may contain substitution macros.
27194 The advantage over using
27195 \begin_inset Flex Code
27198 \begin_layout Plain Layout
27205 \begin_inset Flex Code
27208 \begin_layout Plain Layout
27214 is that the substituted value of
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27224 is sanitized so that it is a valid optional argument in the document format.
27225 This command may occur zero or more times.
27228 \begin_layout Description
27229 \begin_inset Flex Code
27232 \begin_layout Plain Layout
27234 \begin_inset space ~
27242 The text that is inserted in the exported document.
27243 This is actually the most important command and can be quite complex.
27244 This command must occur exactly once.
27247 \begin_layout Description
27248 \begin_inset Flex Code
27251 \begin_layout Plain Layout
27253 \begin_inset space ~
27261 This command specifies a preamble snippet that will be included in the
27264 It has to be defined using
27265 \begin_inset Flex Code
27268 \begin_layout Plain Layout
27276 \begin_inset Flex Code
27279 \begin_layout Plain Layout
27286 This command may occur zero or more times.
27289 \begin_layout Description
27290 \begin_inset Flex Code
27293 \begin_layout Plain Layout
27295 \begin_inset space ~
27299 \begin_inset space ~
27307 This command denotes files that are created by the conversion process and
27308 are needed for a particular export format.
27309 If the filename is relative, it is interpreted relative to the master document.
27310 This command may be given zero or more times.
27313 \begin_layout Description
27314 \begin_inset Flex Code
27317 \begin_layout Plain Layout
27319 \begin_inset space ~
27327 The name of a required \SpecialChar LaTeX
27329 The package is included via
27330 \begin_inset Flex Code
27333 \begin_layout Plain Layout
27341 in the \SpecialChar LaTeX
27343 This command may occur zero or more times.
27346 \begin_layout Description
27347 \begin_inset Flex Code
27350 \begin_layout Plain Layout
27352 \begin_inset space ~
27356 \begin_inset space ~
27359 RotationLatexCommand
27364 This command specifies that the built in \SpecialChar LaTeX
27365 command should be used for rotation.
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 the built in \SpecialChar LaTeX
27388 command should be used for resizing.
27389 This command may occur once or not at all.
27392 \begin_layout Description
27393 \begin_inset Flex Code
27396 \begin_layout Plain Layout
27398 \begin_inset space ~
27402 \begin_inset space ~
27405 RotationLatexOption
27410 This command specifies that rotation is done via an optional argument.
27411 This command may occur once or not at all.
27414 \begin_layout Description
27415 \begin_inset Flex Code
27418 \begin_layout Plain Layout
27420 \begin_inset space ~
27424 \begin_inset space ~
27432 This command specifies that resizing is done via an optional argument.
27433 This command may occur once or not at all.
27436 \begin_layout Description
27437 \begin_inset Flex Code
27440 \begin_layout Plain Layout
27442 \begin_inset space ~
27446 \begin_inset space ~
27454 This command specifies that clipping is done via an optional argument.
27455 This command may occur once or not at all.
27458 \begin_layout Description
27459 \begin_inset Flex Code
27462 \begin_layout Plain Layout
27464 \begin_inset space ~
27468 \begin_inset space ~
27476 This command specifies that an extra optional argument is used.
27477 This command may occur once or not at all.
27480 \begin_layout Description
27481 \begin_inset Flex Code
27484 \begin_layout Plain Layout
27486 \begin_inset space ~
27494 The file format of the converted file.
27495 This must be the name of a format that is known to \SpecialChar LyX
27497 \begin_inset Flex Noun
27500 \begin_layout Plain Layout
27501 Tools\SpecialChar menuseparator
27502 Preferences\SpecialChar menuseparator
27503 File Handling\SpecialChar menuseparator
27510 This command must occur exactly once.
27511 If the resulting file format is PDF, you need to specify the format
27512 \begin_inset Flex Code
27515 \begin_layout Plain Layout
27522 This is the PDF format used for including graphics.
27523 The other defined PDF formats are for document export.
27526 \begin_layout Description
27527 \begin_inset Flex Code
27530 \begin_layout Plain Layout
27532 \begin_inset space ~
27540 The file name of the converted file.
27541 The file name must be absolute.
27542 This command must occur exactly once.
27545 \begin_layout Subsection
27546 Preamble definitions
27549 \begin_layout Standard
27550 The external template configuration file may contain additional preamble
27551 definitions enclosed by
27552 \begin_inset Flex Code
27555 \begin_layout Plain Layout
27563 \begin_inset Flex Code
27566 \begin_layout Plain Layout
27573 They can be used by the templates in the
27574 \begin_inset Flex Code
27577 \begin_layout Plain Layout
27586 \begin_layout Section
27587 The substitution mechanism
27590 \begin_layout Standard
27591 When the external material facility invokes an external program, it is done
27592 on the basis of a command defined in the template configuration file.
27593 These commands can contain various macros that are expanded before execution.
27594 Execution always take place in the directory of the containing document.
27597 \begin_layout Standard
27598 Also, whenever external material is to be displayed, the name will be produced
27599 by the substitution mechanism, and most other commands in the template
27600 definition support substitution as well.
27603 \begin_layout Standard
27604 The available macros are the following:
27607 \begin_layout Description
27608 \begin_inset Flex Code
27611 \begin_layout Plain Layout
27612 $$AbsOrRelPathMaster
27617 The file path, absolute or relative to the master \SpecialChar LyX
27621 \begin_layout Description
27622 \begin_inset Flex Code
27625 \begin_layout Plain Layout
27626 $$AbsOrRelPathParent
27631 The file path, absolute or relative to the \SpecialChar LyX
27635 \begin_layout Description
27636 \begin_inset Flex Code
27639 \begin_layout Plain Layout
27645 The absolute file path.
27648 \begin_layout Description
27649 \begin_inset Flex Code
27652 \begin_layout Plain Layout
27658 The filename without path and without the extension.
27661 \begin_layout Description
27662 \begin_inset Flex Code
27665 \begin_layout Plain Layout
27667 \begin_inset Quotes eld
27671 \begin_inset Quotes erd
27679 This macro will expand to the contents of the file with the name
27680 \begin_inset Flex Code
27683 \begin_layout Plain Layout
27692 \begin_layout Description
27693 \begin_inset Flex Code
27696 \begin_layout Plain Layout
27702 The file extension (including the dot).
27705 \begin_layout Description
27706 \begin_inset Flex Code
27709 \begin_layout Plain Layout
27715 This will be the string
27716 \begin_inset Quotes eld
27720 \begin_inset Quotes erd
27723 if the file is in JPEG format, otherwise it will be the string
27724 \begin_inset Quotes eld
27728 \begin_inset Quotes erd
27732 This is useful to avoid uneeded conversions for output formats that support
27733 both PNG and JPEG fomats.
27734 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27739 \begin_layout Description
27740 \begin_inset Flex Code
27743 \begin_layout Plain Layout
27749 The filename of the file specified in the external material dialog.
27750 This is either an absolute name, or it is relative to the \SpecialChar LyX
27754 \begin_layout Description
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27765 \begin_inset Flex Code
27768 \begin_layout Plain Layout
27774 (absolute name or relative to the \SpecialChar LyX
27778 \begin_layout Description
27779 \begin_inset Flex Code
27782 \begin_layout Plain Layout
27788 The file path, relative to the master \SpecialChar LyX
27792 \begin_layout Description
27793 \begin_inset Flex Code
27796 \begin_layout Plain Layout
27802 The file path, relative to the \SpecialChar LyX
27806 \begin_layout Description
27807 \begin_inset Flex Code
27810 \begin_layout Plain Layout
27816 This macro will expand to the absolute path of the system directory.
27817 This is typically used to point to the various helper scripts that are
27818 bundled with \SpecialChar LyX
27822 \begin_layout Description
27823 \begin_inset Flex Code
27826 \begin_layout Plain Layout
27832 A name and full path to a temporary file which will be automatically deleted
27833 whenever the containing document is closed, or the external material insertion
27837 \begin_layout Standard
27838 All path macros contain a trailing directory separator, so you can construct
27840 \begin_inset space \thinspace{}
27844 \begin_inset space \space{}
27847 the absolute filename with
27848 \begin_inset Flex Code
27851 \begin_layout Plain Layout
27852 $$AbsPath$$Basename$$Extension
27860 \begin_layout Standard
27861 The macros above are substituted in all commands unless otherwise noted.
27863 \begin_inset Flex Code
27866 \begin_layout Plain Layout
27872 supports additionally the following substitutions if they are enabled by
27874 \begin_inset Flex Code
27877 \begin_layout Plain Layout
27884 \begin_inset Flex Code
27887 \begin_layout Plain Layout
27896 \begin_layout Description
27897 \begin_inset Flex Code
27900 \begin_layout Plain Layout
27906 The front part of the resize command.
27909 \begin_layout Description
27910 \begin_inset Flex Code
27913 \begin_layout Plain Layout
27919 The back part of the resize command.
27922 \begin_layout Description
27923 \begin_inset Flex Code
27926 \begin_layout Plain Layout
27932 The front part of the rotation command.
27935 \begin_layout Description
27936 \begin_inset Flex Code
27939 \begin_layout Plain Layout
27945 The back part of the rotation command.
27948 \begin_layout Standard
27949 The value string of the
27950 \begin_inset Flex Code
27953 \begin_layout Plain Layout
27959 command supports additionally the following substitutions if they are enabled
27961 \begin_inset Flex Code
27964 \begin_layout Plain Layout
27971 \begin_inset Flex Code
27974 \begin_layout Plain Layout
27983 \begin_layout Description
27984 \begin_inset Flex Code
27987 \begin_layout Plain Layout
27996 \begin_layout Description
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28009 \begin_layout Description
28010 \begin_inset Flex Code
28013 \begin_layout Plain Layout
28022 \begin_layout Description
28023 \begin_inset Flex Code
28026 \begin_layout Plain Layout
28032 The rotation option.
28035 \begin_layout Standard
28036 You may ask why there are so many path macros.
28037 There are mainly two reasons:
28040 \begin_layout Enumerate
28041 Relative and absolute file names should remain relative or absolute, respectivel
28043 Users may have reasons to prefer either form.
28044 Relative names are useful for portable documents that should work on different
28045 machines, for example.
28046 Absolute names may be required by some programs.
28049 \begin_layout Enumerate
28051 treats relative file names differently than \SpecialChar LyX
28052 and other programs in nested
28054 For \SpecialChar LyX
28055 , a relative file name is always relative to the document that contains
28057 For \SpecialChar LaTeX
28058 , it is always relative to the master document.
28059 These two definitions are identical if you have only one document, but
28060 differ if you have a master document that includes part documents.
28061 That means that relative filenames must be transformed when presented to
28064 Fortunately \SpecialChar LyX
28065 does this automatically for you if you choose the right macros.
28068 \begin_layout Standard
28069 So which path macro should be used in new template definitions? The rule
28073 \begin_layout Itemize
28075 \begin_inset Flex Code
28078 \begin_layout Plain Layout
28084 if an absolute path is required.
28087 \begin_layout Itemize
28089 \begin_inset Flex Code
28092 \begin_layout Plain Layout
28093 $$AbsOrRelPathMaster
28098 if the substituted string is some kind of \SpecialChar LaTeX
28102 \begin_layout Itemize
28104 \begin_inset Flex Code
28107 \begin_layout Plain Layout
28108 $$AbsOrRelPathParent
28113 in order to preserve the user's choice.
28116 \begin_layout Standard
28117 There are special cases where this rule does not work and e.
28118 \begin_inset space \thinspace{}
28122 \begin_inset space \space{}
28125 relative names are needed, but normally it will work just fine.
28126 One example for such a case is the command
28127 \begin_inset Flex Code
28130 \begin_layout Plain Layout
28131 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28136 in the XFig template above: We can't use the absolute name because the
28138 \begin_inset Flex Code
28141 \begin_layout Plain Layout
28147 files needs the relative name in order to rewrite the file content.
28150 \begin_layout Section
28151 Security discussion
28152 \begin_inset CommandInset label
28154 name "sec:Security-discussion"
28161 \begin_layout Standard
28162 The external material feature interfaces with a lot of external programs
28163 and does so automatically, so we have to consider the security implications
28165 In particular, since you have the option of including your own filenames
28166 and/or parameter strings and those are expanded into a command, it seems
28167 that it would be possible to create a malicious document which executes
28168 arbitrary commands when a user views or prints the document.
28169 This is something we definitely want to avoid.
28172 \begin_layout Standard
28173 However, since the external program commands are specified in the template
28174 configuration file only, there are no security issues if \SpecialChar LyX
28175 is properly configure
28176 d with safe templates only.
28177 This is so because the external programs are invoked with the
28178 \begin_inset Flex Code
28181 \begin_layout Plain Layout
28187 -system call rather than the
28188 \begin_inset Flex Code
28191 \begin_layout Plain Layout
28197 system-call, so it's not possible to execute arbitrary commands from the
28198 filename or parameter section via the shell.
28201 \begin_layout Standard
28202 This also implies that you are restricted in what command strings you can
28203 use in the external material templates.
28204 In particular, pipes and redirection are not readily available.
28205 This has to be so if \SpecialChar LyX
28206 should remain safe.
28207 If you want to use some of the shell features, you should write a safe
28208 script to do this in a controlled manner, and then invoke the script from
28209 the command string.
28213 \begin_layout Standard
28214 It is possible to design a template that interacts directly with the shell,
28215 but since this would allow a malicious user to execute arbitrary commands
28216 by writing clever filenames and/or parameters, we generally recommend that
28217 you only use safe scripts that work with the
28218 \begin_inset Flex Code
28221 \begin_layout Plain Layout
28227 system call in a controlled manner.
28228 Of course, for use in a controlled environment, it can be tempting to just
28229 fall back to use ordinary shell scripts.
28230 If you do so, be aware that you
28234 provide an easily exploitable security hole in your system.
28235 Of course it stands to reason that such unsafe templates will never be
28236 included in the standard \SpecialChar LyX
28237 distribution, although we do encourage people
28238 to submit new templates in the open source tradition.
28239 But \SpecialChar LyX
28240 as shipped from the official distribution channels will never have
28244 \begin_layout Standard
28245 Including external material provides a lot of power, and you have to be
28246 careful not to introduce security hazards with this power.
28247 A subtle error in a single line in an innocent looking script can open
28248 the door to huge security problems.
28249 So if you do not fully understand the issues, we recommend that you consult
28250 a knowledgeable security professional or the \SpecialChar LyX
28251 development team if you have
28252 any questions about whether a given template is safe or not.
28253 And do this before you use it in an uncontrolled environment.
28256 \begin_layout Chapter
28258 List of supported \SpecialChar LyX
28259 functions to be used in layouts
28260 \begin_inset CommandInset label
28262 name "chap:List-of-functions"
28269 \begin_layout Standard
28271 \begin_inset Tabular
28272 <lyxtabular version="3" rows="11" columns="8">
28273 <features tabularvalignment="middle">
28274 <column alignment="left" valignment="top">
28275 <column alignment="left" valignment="top">
28276 <column alignment="left" valignment="top">
28277 <column alignment="left" valignment="top">
28278 <column alignment="left" valignment="top">
28279 <column alignment="left" valignment="top">
28280 <column alignment="left" valignment="top">
28281 <column alignment="left" valignment="top">
28283 <cell alignment="left" valignment="top" usebox="none">
28286 \begin_layout Plain Layout
28292 <cell alignment="left" valignment="top" usebox="none">
28295 \begin_layout Plain Layout
28301 <cell alignment="left" valignment="top" usebox="none">
28304 \begin_layout Plain Layout
28310 <cell alignment="left" valignment="top" usebox="none">
28313 \begin_layout Plain Layout
28319 <cell alignment="center" valignment="top" usebox="none">
28322 \begin_layout Plain Layout
28328 <cell alignment="center" valignment="top" usebox="none">
28331 \begin_layout Plain Layout
28337 <cell alignment="center" valignment="top" usebox="none">
28340 \begin_layout Plain Layout
28346 <cell alignment="center" valignment="top" usebox="none">
28349 \begin_layout Plain Layout
28357 <cell alignment="left" valignment="top" usebox="none">
28360 \begin_layout Plain Layout
28366 <cell alignment="left" valignment="top" usebox="none">
28369 \begin_layout Plain Layout
28375 <cell alignment="left" valignment="top" usebox="none">
28378 \begin_layout Plain Layout
28384 <cell alignment="left" valignment="top" usebox="none">
28387 \begin_layout Plain Layout
28393 <cell alignment="center" valignment="top" usebox="none">
28396 \begin_layout Plain Layout
28402 <cell alignment="center" valignment="top" usebox="none">
28405 \begin_layout Plain Layout
28411 <cell alignment="center" valignment="top" usebox="none">
28414 \begin_layout Plain Layout
28420 <cell alignment="center" valignment="top" usebox="none">
28423 \begin_layout Plain Layout
28431 <cell alignment="left" valignment="top" usebox="none">
28434 \begin_layout Plain Layout
28440 <cell alignment="left" valignment="top" usebox="none">
28443 \begin_layout Plain Layout
28449 <cell alignment="left" valignment="top" usebox="none">
28452 \begin_layout Plain Layout
28458 <cell alignment="left" valignment="top" usebox="none">
28461 \begin_layout Plain Layout
28467 <cell alignment="center" valignment="top" usebox="none">
28470 \begin_layout Plain Layout
28476 <cell alignment="center" valignment="top" usebox="none">
28479 \begin_layout Plain Layout
28485 <cell alignment="center" valignment="top" usebox="none">
28488 \begin_layout Plain Layout
28494 <cell alignment="center" valignment="top" usebox="none">
28497 \begin_layout Plain Layout
28505 <cell alignment="left" valignment="top" usebox="none">
28508 \begin_layout Plain Layout
28514 <cell alignment="left" valignment="top" usebox="none">
28517 \begin_layout Plain Layout
28523 <cell alignment="left" valignment="top" usebox="none">
28526 \begin_layout Plain Layout
28532 <cell alignment="left" valignment="top" usebox="none">
28535 \begin_layout Plain Layout
28541 <cell alignment="center" valignment="top" usebox="none">
28544 \begin_layout Plain Layout
28550 <cell alignment="center" valignment="top" usebox="none">
28553 \begin_layout Plain Layout
28559 <cell alignment="center" valignment="top" usebox="none">
28562 \begin_layout Plain Layout
28568 <cell alignment="center" valignment="top" usebox="none">
28571 \begin_layout Plain Layout
28579 <cell alignment="left" valignment="top" usebox="none">
28582 \begin_layout Plain Layout
28588 <cell alignment="left" valignment="top" usebox="none">
28591 \begin_layout Plain Layout
28597 <cell alignment="left" valignment="top" usebox="none">
28600 \begin_layout Plain Layout
28606 <cell alignment="left" valignment="top" usebox="none">
28609 \begin_layout Plain Layout
28615 <cell alignment="center" valignment="top" usebox="none">
28618 \begin_layout Plain Layout
28624 <cell alignment="center" valignment="top" usebox="none">
28627 \begin_layout Plain Layout
28633 <cell alignment="center" valignment="top" usebox="none">
28636 \begin_layout Plain Layout
28642 <cell alignment="center" valignment="top" usebox="none">
28645 \begin_layout Plain Layout
28653 <cell alignment="left" valignment="top" usebox="none">
28656 \begin_layout Plain Layout
28662 <cell alignment="left" valignment="top" usebox="none">
28665 \begin_layout Plain Layout
28671 <cell alignment="left" valignment="top" usebox="none">
28674 \begin_layout Plain Layout
28680 <cell alignment="left" valignment="top" usebox="none">
28683 \begin_layout Plain Layout
28689 <cell alignment="center" valignment="top" usebox="none">
28692 \begin_layout Plain Layout
28698 <cell alignment="center" valignment="top" usebox="none">
28701 \begin_layout Plain Layout
28707 <cell alignment="center" valignment="top" usebox="none">
28710 \begin_layout Plain Layout
28716 <cell alignment="center" valignment="top" usebox="none">
28719 \begin_layout Plain Layout
28727 <cell alignment="left" valignment="top" usebox="none">
28730 \begin_layout Plain Layout
28736 <cell alignment="left" valignment="top" usebox="none">
28739 \begin_layout Plain Layout
28745 <cell alignment="left" valignment="top" usebox="none">
28748 \begin_layout Plain Layout
28754 <cell alignment="left" valignment="top" usebox="none">
28757 \begin_layout Plain Layout
28763 <cell alignment="center" valignment="top" usebox="none">
28766 \begin_layout Plain Layout
28772 <cell alignment="center" valignment="top" usebox="none">
28775 \begin_layout Plain Layout
28781 <cell alignment="center" valignment="top" usebox="none">
28784 \begin_layout Plain Layout
28790 <cell alignment="center" valignment="top" usebox="none">
28793 \begin_layout Plain Layout
28801 <cell alignment="left" valignment="top" usebox="none">
28804 \begin_layout Plain Layout
28810 <cell alignment="left" valignment="top" usebox="none">
28813 \begin_layout Plain Layout
28819 <cell alignment="left" valignment="top" usebox="none">
28822 \begin_layout Plain Layout
28828 <cell alignment="left" valignment="top" usebox="none">
28831 \begin_layout Plain Layout
28837 <cell alignment="center" valignment="top" usebox="none">
28840 \begin_layout Plain Layout
28846 <cell alignment="center" valignment="top" usebox="none">
28849 \begin_layout Plain Layout
28855 <cell alignment="center" valignment="top" usebox="none">
28858 \begin_layout Plain Layout
28864 <cell alignment="center" valignment="top" usebox="none">
28867 \begin_layout Plain Layout
28875 <cell alignment="left" valignment="top" usebox="none">
28878 \begin_layout Plain Layout
28884 <cell alignment="left" valignment="top" usebox="none">
28887 \begin_layout Plain Layout
28893 <cell alignment="left" valignment="top" usebox="none">
28896 \begin_layout Plain Layout
28902 <cell alignment="left" valignment="top" usebox="none">
28905 \begin_layout Plain Layout
28911 <cell alignment="center" valignment="top" usebox="none">
28914 \begin_layout Plain Layout
28920 <cell alignment="center" valignment="top" usebox="none">
28923 \begin_layout Plain Layout
28929 <cell alignment="center" valignment="top" usebox="none">
28932 \begin_layout Plain Layout
28938 <cell alignment="center" valignment="top" usebox="none">
28941 \begin_layout Plain Layout
28949 <cell alignment="left" valignment="top" usebox="none">
28952 \begin_layout Plain Layout
28958 <cell alignment="left" valignment="top" usebox="none">
28961 \begin_layout Plain Layout
28967 <cell alignment="left" valignment="top" usebox="none">
28970 \begin_layout Plain Layout
28976 <cell alignment="left" valignment="top" usebox="none">
28979 \begin_layout Plain Layout
28985 <cell alignment="center" valignment="top" usebox="none">
28988 \begin_layout Plain Layout
28994 <cell alignment="center" valignment="top" usebox="none">
28997 \begin_layout Plain Layout
29003 <cell alignment="center" valignment="top" usebox="none">
29006 \begin_layout Plain Layout
29012 <cell alignment="center" valignment="top" usebox="none">
29015 \begin_layout Plain Layout
29023 <cell alignment="center" valignment="top" usebox="none">
29026 \begin_layout Plain Layout
29032 <cell alignment="center" valignment="top" usebox="none">
29035 \begin_layout Plain Layout
29041 <cell alignment="center" valignment="top" usebox="none">
29044 \begin_layout Plain Layout
29050 <cell alignment="center" valignment="top" usebox="none">
29053 \begin_layout Plain Layout
29059 <cell alignment="center" valignment="top" usebox="none">
29062 \begin_layout Plain Layout
29068 <cell alignment="center" valignment="top" usebox="none">
29071 \begin_layout Plain Layout
29077 <cell alignment="center" valignment="top" usebox="none">
29080 \begin_layout Plain Layout
29086 <cell alignment="center" valignment="top" usebox="none">
29089 \begin_layout Plain Layout
29103 \begin_layout Chapter
29104 Names of available colors to be used in layouts
29105 \begin_inset CommandInset label
29107 name "chap:Names-of-colors"
29114 \begin_layout Standard
29115 The colors listed below are the standard colors and those that you can adjust
29116 in the \SpecialChar LyX
29120 \begin_layout Section
29124 \begin_layout Standard
29125 The following are no real colors, but rather act on color definitions:
29128 \begin_layout Description
29129 ignore The color is ignored
29132 \begin_layout Description
29133 inherit The color is inherited
29136 \begin_layout Description
29149 No particular color – clear or default
29152 \begin_layout Section
29156 \begin_layout Standard
29157 These are fixed colors that cannot me customized:
29160 \begin_layout Description
29164 \begin_layout Description
29168 \begin_layout Description
29172 \begin_layout Description
29176 \begin_layout Description
29180 \begin_layout Description
29184 \begin_layout Description
29188 \begin_layout Description
29192 \begin_layout Description
29196 \begin_layout Description
29200 \begin_layout Description
29204 \begin_layout Description
29208 \begin_layout Description
29212 \begin_layout Description
29216 \begin_layout Description
29220 \begin_layout Description
29224 \begin_layout Description
29228 \begin_layout Description
29232 \begin_layout Description
29236 \begin_layout Section
29240 \begin_layout Standard
29241 These are the colors allocated to specific elements in
29244 arg "dialog-show prefs"
29250 \begin_layout Description
29251 added_space Added space color
29254 \begin_layout Description
29255 addedtext Added text color
29258 \begin_layout Description
29259 appendix Appendix marker color
29262 \begin_layout Description
29263 background Background color
29266 \begin_layout Description
29267 bottomarea Bottom area color
29270 \begin_layout Description
29271 branchlabel Label color for branches
29274 \begin_layout Description
29275 buttonbg Color used for button background
29278 \begin_layout Description
29279 buttonframe Color for inset button frames
29282 \begin_layout Description
29283 buttonhoverbg Color used for button background under focus
29286 \begin_layout Description
29287 changebar Changebar color
29290 \begin_layout Description
29291 changedtextauthor1 Changed text color author 1
29294 \begin_layout Description
29295 changedtextauthor2 Changed text color author 2
29298 \begin_layout Description
29299 changedtextauthor3 Changed text color author 3
29302 \begin_layout Description
29303 changedtextauthor4 Changed text color author 4
29306 \begin_layout Description
29307 changedtextauthor5 Changed text color author 5
29310 \begin_layout Description
29311 collapsible Collapsible insets text color
29314 \begin_layout Description
29315 collapsibleframe Collapsible insets framecolor
29318 \begin_layout Description
29319 command Text color for command insets
29322 \begin_layout Description
29323 commandbg Background color for command insets
29326 \begin_layout Description
29327 commandframe Frame color for command insets
29330 \begin_layout Description
29331 comment Label color for comments
29334 \begin_layout Description
29335 commentbg Background color of comments
29338 \begin_layout Description
29339 cursor Cursor color
29342 \begin_layout Description
29343 deletedtext Deleted text color
29346 \begin_layout Description
29347 deletedtextmodifier Deleted text modifying color
29350 \begin_layout Description
29351 depthbar Color for the depth bars in the margin
29354 \begin_layout Description
29355 eolmarker End of line marker color
29358 \begin_layout Description
29359 error Color of the \SpecialChar LaTeX
29363 \begin_layout Description
29364 footlabel Label color for footnotes
29367 \begin_layout Description
29368 foreground Foreground color
29371 \begin_layout Description
29372 graphicsbg Graphics inset background color
29375 \begin_layout Description
29376 greyedoutbg Background color of greyedout inset
29379 \begin_layout Description
29380 greyedoutlabel Label color for greyedout insets
29383 \begin_layout Description
29384 greyedouttext Color for greyedout inset text
29387 \begin_layout Description
29388 indexlabel Label color for index insets
29391 \begin_layout Description
29392 inlinecompletion Inline completion color
29395 \begin_layout Description
29396 insetbg Inset marker background color
29399 \begin_layout Description
29400 insetframe Inset marker frame color
29403 \begin_layout Description
29404 language Color for marking foreign language words
29407 \begin_layout Description
29408 latex Text color in \SpecialChar LaTeX
29412 \begin_layout Description
29413 listingsbg Background color of listings inset
29416 \begin_layout Description
29417 marginlabel Label color for margin notes
29420 \begin_layout Description
29421 math Math inset text color
29424 \begin_layout Description
29425 mathbg Math inset background color
29428 \begin_layout Description
29429 mathcorners Math inset frame color not under focus
29432 \begin_layout Description
29433 mathframe Math inset frame color under focus
29436 \begin_layout Description
29437 mathline Math line color
29440 \begin_layout Description
29441 mathmacrobg Macro math inset background color
29444 \begin_layout Description
29445 mathmacroblend Macro math blended color
29448 \begin_layout Description
29449 mathmacroframe Macro math frame color
29452 \begin_layout Description
29453 mathmacrohoverbg Macro math inset background color hovered
29456 \begin_layout Description
29457 mathmacrolabel Macro math label color
29460 \begin_layout Description
29461 mathmacronewarg Macro template color for new parameters
29464 \begin_layout Description
29465 mathmacrooldarg Macro template color for old parameters
29468 \begin_layout Description
29469 newpage New page color
29472 \begin_layout Description
29473 nonunique_inlinecompletion Inline completion color for the non-unique part
29476 \begin_layout Description
29477 note Label color for notes
29480 \begin_layout Description
29481 notebg Background color of notes
29484 \begin_layout Description
29485 pagebreak Page break/line break color
29488 \begin_layout Description
29489 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29492 \begin_layout Description
29493 phantomtext Text color for phantom insets
29496 \begin_layout Description
29497 preview The color used for previews
29500 \begin_layout Description
29501 previewframe Preview frame color
29504 \begin_layout Description
29505 regexpframe Color for regexp frame
29508 \begin_layout Description
29509 scroll Color that indicates when a row can be scrolled
29512 \begin_layout Description
29513 selection Background color of selected text
29516 \begin_layout Description
29517 selectiontext Foreground color of selected text
29520 \begin_layout Description
29521 shadedbg Background color of shaded box
29524 \begin_layout Description
29525 special Special chars text color
29528 \begin_layout Description
29529 tabularline Table line color
29532 \begin_layout Description
29533 tabularonoffline Table line color
29536 \begin_layout Description
29537 urllabel Label color for URL insets
29540 \begin_layout Description
29541 urltext Color for URL inset text