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
9109 \change_inserted -712698321 1562592950
9113 \begin_layout Description
9115 \change_inserted -712698321 1562593040
9116 \begin_inset Flex Code
9119 \begin_layout Plain Layout
9121 \change_inserted -712698321 1562592954
9128 \begin_inset Flex Code
9131 \begin_layout Plain Layout
9133 \change_inserted -712698321 1562592950
9142 \begin_inset space \thinspace{}
9146 \begin_inset Flex Code
9149 \begin_layout Plain Layout
9151 \change_inserted -712698321 1562592950
9157 ] If the document class adds the bibliography to the table of contents,
9158 add this option with value
9159 \begin_inset Flex Code
9162 \begin_layout Plain Layout
9164 \change_inserted -712698321 1562592996
9173 \begin_inset Flex Code
9176 \begin_layout Plain Layout
9178 \change_inserted -712698321 1562593006
9187 This prevents the bibliography from being added twice.
9192 \begin_layout Description
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9202 Defines the possibilities for displaying citation references.
9204 \begin_inset CommandInset ref
9206 reference "subsec:Citation-engine-description"
9215 \begin_inset Quotes eld
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9229 \begin_inset Quotes erd
9233 Primarily used in cite engine files (see
9234 \begin_inset CommandInset ref
9236 reference "subsec:Cite-Engine-Files"
9245 \change_inserted -712698321 1526898530
9246 Note that if you specify this in a layout file or module, any cite engine
9247 definition will be overridden.
9249 \begin_inset Flex Code
9252 \begin_layout Plain Layout
9254 \change_inserted -712698321 1526898530
9267 \begin_layout Description
9268 \begin_inset Flex Code
9271 \begin_layout Plain Layout
9277 Defines formats for use in the display of bibliographic information.
9279 \begin_inset CommandInset ref
9281 reference "subsec:Citation-format-description"
9287 \begin_inset Quotes eld
9291 \begin_inset Flex Code
9294 \begin_layout Plain Layout
9301 \begin_inset Quotes erd
9305 Primarily used in cite engine files (see
9306 \begin_inset CommandInset ref
9308 reference "subsec:Cite-Engine-Files"
9317 \change_inserted -712698321 1526898585
9318 A cite format defined in a layout or module will override the cite engine
9324 \begin_layout Description
9325 \begin_inset Flex Code
9328 \begin_layout Plain Layout
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9347 \begin_inset Flex Code
9350 \begin_layout Plain Layout
9356 ] Determines whether
9360 or Bib\SpecialChar TeX
9361 is used to generate a Bibliography.
9362 Primarily used in cite engine files (see
9363 \begin_inset CommandInset ref
9365 reference "subsec:Cite-Engine-Files"
9375 \begin_layout Description
9376 \begin_inset Flex Code
9379 \begin_layout Plain Layout
9385 Describes various global options supported by the document class.
9387 \begin_inset CommandInset ref
9389 reference "subsec:ClassOptions"
9395 \begin_inset Quotes eld
9399 \begin_inset Flex Code
9402 \begin_layout Plain Layout
9409 \begin_inset Quotes erd
9415 \begin_layout Description
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9426 \begin_inset Flex Code
9429 \begin_layout Plain Layout
9438 \begin_inset space \thinspace{}
9442 \begin_inset Flex Code
9445 \begin_layout Plain Layout
9451 ] Whether the class should
9455 to having one or two columns.
9456 Can be changed in the
9457 \begin_inset Flex Noun
9460 \begin_layout Plain Layout
9461 Document\SpecialChar menuseparator
9470 \begin_layout Description
9471 \begin_inset Flex Code
9474 \begin_layout Plain Layout
9481 \begin_inset Flex Code
9484 \begin_layout Plain Layout
9490 ] This sequence defines the properties for a counter.
9491 If the counter does not yet exist, it is created; if it does exist, it
9494 \begin_inset Quotes eld
9498 \begin_inset Flex Code
9501 \begin_layout Plain Layout
9508 \begin_inset Quotes erd
9512 \begin_inset Newline newline
9516 \begin_inset CommandInset ref
9518 reference "subsec:Counters"
9522 for details on counters.
9525 \begin_layout Description
9526 \begin_inset Flex Code
9529 \begin_layout Plain Layout
9535 Sets the default font used to display the document.
9537 \begin_inset CommandInset ref
9539 reference "subsec:Font-description"
9543 for how to declare fonts.
9545 \begin_inset Quotes eld
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9559 \begin_inset Quotes erd
9565 \begin_layout Description
9566 \begin_inset Flex Code
9569 \begin_layout Plain Layout
9576 \begin_inset Flex Code
9579 \begin_layout Plain Layout
9585 ] Specifies a module to be included by default with this document class.
9586 The module is specified as filename without the
9587 \begin_inset Flex Code
9590 \begin_layout Plain Layout
9597 The user can still remove the module, but it will be active at the outset.
9598 (This applies only when new files are created, or when this class is chosen
9599 for an existing document.)
9602 \begin_layout Description
9603 \begin_inset Flex Code
9606 \begin_layout Plain Layout
9613 \begin_inset Flex Code
9616 \begin_layout Plain Layout
9622 ] This is the style that will be assigned to new paragraphs, usually
9623 \begin_inset Flex Noun
9626 \begin_layout Plain Layout
9633 This will default to the first defined style if not given, but you are
9634 encouraged to use this directive.
9637 \begin_layout Description
9638 \begin_inset Flex Code
9641 \begin_layout Plain Layout
9648 \begin_inset Flex Code
9651 \begin_layout Plain Layout
9657 ] This tag indicates that the module (which is specified by filename without
9659 \begin_inset Flex Code
9662 \begin_layout Plain Layout
9668 extension) cannot be used with this document class.
9669 This might be used in a journal-specific layout file to prevent, say, the
9671 \begin_inset Flex Code
9674 \begin_layout Plain Layout
9680 module that numbers theorems by section.
9685 be used in a module.
9686 Modules have their own way of excluding other modules (see
9687 \begin_inset CommandInset ref
9689 reference "subsec:Layout-modules"
9696 \begin_layout Description
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9706 Defines a new float.
9708 \begin_inset CommandInset ref
9710 reference "subsec:Floats"
9716 \begin_inset Quotes eld
9720 \begin_inset Flex Code
9723 \begin_layout Plain Layout
9730 \begin_inset Quotes erd
9736 \begin_layout Description
9737 \begin_inset Flex Code
9740 \begin_layout Plain Layout
9746 Sets the information that will be output in the
9747 \begin_inset Flex Code
9750 \begin_layout Plain Layout
9756 block when this document class is output to XHTML.
9757 Note that this will completely override any prior
9758 \begin_inset Flex Code
9761 \begin_layout Plain Layout
9768 \begin_inset Flex Code
9771 \begin_layout Plain Layout
9779 \begin_inset Newline newline
9783 \begin_inset Flex Code
9786 \begin_layout Plain Layout
9792 if you just want to add material to the preamble.) Must end with
9793 \begin_inset Quotes eld
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9807 \begin_inset Quotes erd
9813 \begin_layout Description
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9833 ] The style to use for the table of contents, bibliography, and so forth,
9834 when the document is output to HTML.
9835 For articles, this should normally be
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9846 \begin_inset Flex Code
9849 \begin_layout Plain Layout
9856 If it is not given, then \SpecialChar LyX
9857 will attempt to figure out which layout to use.
9860 \begin_layout Description
9861 \begin_inset Flex Code
9864 \begin_layout Plain Layout
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9880 ] Modifies the properties of the given counter.
9881 If the counter does not exist, the statement is ignored.
9883 \begin_inset Quotes eld
9887 \begin_inset Flex Code
9890 \begin_layout Plain Layout
9897 \begin_inset Quotes erd
9901 \begin_inset Newline newline
9905 \begin_inset CommandInset ref
9907 reference "subsec:Counters"
9911 for details on counters.
9914 \begin_layout Description
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9934 ] This allows you to include another layout definition file within yours
9935 to avoid duplicating commands.
9936 Common examples are the standard layout files, for example,
9937 \begin_inset Flex Code
9940 \begin_layout Plain Layout
9946 , which contains most of the basic layouts.
9949 \begin_layout Description
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9969 ] This section (re-)defines the layout of an inset.
9970 It can be applied to an existing inset or to a new, user-defined inset,
9971 e.g., a new character style.
9973 \begin_inset Quotes eld
9977 \begin_inset Flex Code
9980 \begin_layout Plain Layout
9987 \begin_inset Quotes erd
9991 \begin_inset Newline newline
9995 \begin_inset CommandInset ref
9997 reference "subsec:Flex-insets-and"
10001 for more information.
10005 \begin_layout Description
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10025 ] A string that indicates the width of the left margin on the screen, for
10027 \begin_inset Quotes eld
10031 \begin_inset Flex Code
10034 \begin_layout Plain Layout
10041 \begin_inset Quotes erd
10045 (Note that this is not a `length', like
10046 \begin_inset Quotes eld
10050 \begin_inset Quotes erd
10056 \begin_layout Description
10057 \begin_inset Flex Code
10060 \begin_layout Plain Layout
10067 \begin_inset Flex Code
10070 \begin_layout Plain Layout
10076 ] An integer that determines the maximal number of names displayed in an
10077 author-year citation before the citation switches to
10078 \begin_inset Quotes eld
10082 \begin_inset Quotes erd
10086 Primarily used in cite engine files (see
10087 \begin_inset CommandInset ref
10089 reference "subsec:Cite-Engine-Files"
10099 \begin_layout Description
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10119 ] Modifies the properties of the given paragraph style.
10120 If the style does not exist, this section is ignored.
10122 \begin_inset Quotes eld
10126 \begin_inset Flex Code
10129 \begin_layout Plain Layout
10136 \begin_inset Quotes erd
10142 \begin_layout Description
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10162 ] Deletes an existing counter, usually one defined in an included file.
10165 \begin_layout Description
10166 \begin_inset Flex Code
10169 \begin_layout Plain Layout
10176 \begin_inset Flex Code
10179 \begin_layout Plain Layout
10185 ] Deletes an existing float.
10186 This is particularly useful when you want to suppress a float that has
10187 been defined in an input file.
10190 \begin_layout Description
10191 \begin_inset Flex Code
10194 \begin_layout Plain Layout
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10210 ] Deletes an existing style.
10213 \begin_layout Description
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10234 \begin_inset Flex Code
10237 \begin_layout Plain Layout
10243 ] Define a new table of contents with type
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10264 See also the AddToToc commands.
10267 \begin_layout Description
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10287 ] The file format (as defined in the \SpecialChar LyX
10288 preferences) produced by this document
10290 It is mainly useful when
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10301 \begin_inset Flex Code
10304 \begin_layout Plain Layout
10310 and one wants to define a new type of literate document.
10311 The format is reset to
10312 \begin_inset Quotes eld
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10326 \begin_inset Quotes erd
10330 \begin_inset Quotes eld
10334 \begin_inset Flex Code
10337 \begin_layout Plain Layout
10344 \begin_inset Quotes erd
10347 when the corresponding
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10357 parameter is encountered.
10360 \begin_layout Description
10361 \begin_inset Flex Code
10364 \begin_layout Plain Layout
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10395 \begin_inset Flex Code
10398 \begin_layout Plain Layout
10404 ] Specifies what sort of output documents using this class will produce.
10407 \begin_layout Description
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10418 \begin_inset Flex Code
10421 \begin_layout Plain Layout
10428 \begin_inset Flex Code
10431 \begin_layout Plain Layout
10437 ] Specifies options, given in the second string, for the package named by
10440 \begin_inset Quotes eld
10444 \begin_inset Flex Code
10447 \begin_layout Plain Layout
10448 PackageOptions natbib square
10454 \begin_inset Quotes erd
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10467 to be loaded with the
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10478 (For \SpecialChar TeX
10479 perts, this causes \SpecialChar LyX
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10487 PassOptionsToPackage{natbib}{square}
10493 \begin_inset Flex Code
10496 \begin_layout Plain Layout
10505 \begin_layout Description
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10528 \begin_inset Flex Code
10531 \begin_layout Plain Layout
10538 \begin_inset Flex Code
10541 \begin_layout Plain Layout
10547 ] The default pagestyle.
10548 Can be changed in the
10549 \begin_inset Flex Noun
10552 \begin_layout Plain Layout
10553 Document\SpecialChar menuseparator
10562 \begin_layout Description
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10572 Sets the preamble for the \SpecialChar LaTeX
10574 Note that this will completely override any prior
10575 \begin_inset Flex Code
10578 \begin_layout Plain Layout
10585 \begin_inset Flex Code
10588 \begin_layout Plain Layout
10596 \begin_inset Flex Code
10599 \begin_layout Plain Layout
10605 if you just want to add material to the preamble.) Must end with
10606 \begin_inset Quotes eld
10610 \begin_inset Flex Code
10613 \begin_layout Plain Layout
10620 \begin_inset Quotes erd
10626 \begin_layout Description
10627 \begin_inset Flex Code
10630 \begin_layout Plain Layout
10637 \begin_inset Flex Code
10640 \begin_layout Plain Layout
10647 \begin_inset Flex Code
10650 \begin_layout Plain Layout
10659 \begin_inset space \thinspace{}
10663 \begin_inset Flex Code
10666 \begin_layout Plain Layout
10672 ] Whether the class already provides the feature
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10683 A feature is in general the name of a package (e.
10684 \begin_inset space \thinspace{}
10688 \begin_inset space \space{}
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10712 \begin_inset space \thinspace{}
10716 \begin_inset space \space{}
10720 \begin_inset Flex Code
10723 \begin_layout Plain Layout
10730 \begin_inset Flex Code
10733 \begin_layout Plain Layout
10741 \begin_inset CommandInset ref
10743 reference "chap:List-of-functions"
10747 for the list of features.
10750 \begin_layout Description
10751 \begin_inset Flex Code
10754 \begin_layout Plain Layout
10761 \begin_inset Flex Code
10764 \begin_layout Plain Layout
10770 ] Indicates that this layout provides the functionality of the module mentioned,
10771 which should be specified by the filename without the
10772 \begin_inset Flex Code
10775 \begin_layout Plain Layout
10782 This will typically be used if the layout includes the module directly,
10783 rather than using the
10784 \begin_inset Flex Code
10787 \begin_layout Plain Layout
10793 tag to indicate that it ought to be used.
10794 It could also be used in a module that provided an alternate implementation
10795 of the same functionality.
10798 \begin_layout Description
10799 \begin_inset Flex Code
10802 \begin_layout Plain Layout
10809 \begin_inset Flex Code
10812 \begin_layout Plain Layout
10818 ] Creates a new paragraph style if it does not already exist.
10819 If the style does exist, this section is ignored.
10821 \begin_inset Quotes eld
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10835 \begin_inset Quotes erd
10841 \begin_layout Description
10842 \begin_inset Flex Code
10845 \begin_layout Plain Layout
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10861 ] Whether the class requires the feature
10862 \begin_inset Flex Code
10865 \begin_layout Plain Layout
10872 Multiple features must be separated by commas.
10873 Note that you can only request supported features.
10875 \begin_inset CommandInset ref
10877 reference "chap:List-of-functions"
10881 for the list of features.).
10882 If you require a package with specific options, you can additionally use
10884 \begin_inset Flex Code
10887 \begin_layout Plain Layout
10896 \begin_layout Description
10897 \begin_inset Flex Code
10900 \begin_layout Plain Layout
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10916 ] A string that indicates the width of the right margin on the screen, for
10918 \begin_inset Quotes eld
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10932 \begin_inset Quotes erd
10938 \begin_layout Description
10939 \begin_inset Flex Code
10942 \begin_layout Plain Layout
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10958 ] Sets which divisions get numbered.
10960 \begin_inset Newline newline
10964 \begin_inset Flex Code
10967 \begin_layout Plain Layout
10973 counter in \SpecialChar LaTeX
10977 \begin_layout Description
10978 \begin_inset Flex Code
10981 \begin_layout Plain Layout
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
11000 \begin_inset space \thinspace{}
11004 \begin_inset Flex Code
11007 \begin_layout Plain Layout
11013 ] Whether the class-default should be printing on one or both sides of the
11015 Can be changed in the
11016 \begin_inset Flex Noun
11019 \begin_layout Plain Layout
11020 Document\SpecialChar menuseparator
11029 \begin_layout Description
11030 \begin_inset Flex Code
11033 \begin_layout Plain Layout
11040 \begin_inset Flex Code
11043 \begin_layout Plain Layout
11049 ] This sequence defines a paragraph style.
11050 If the style does not yet exist, it is created; if it does exist, its parameter
11053 \begin_inset Quotes eld
11057 \begin_inset Flex Code
11060 \begin_layout Plain Layout
11067 \begin_inset Quotes erd
11071 \begin_inset Newline newline
11075 \begin_inset CommandInset ref
11077 reference "subsec:Paragraph-Styles"
11081 for details on paragraph styles.
11082 \change_inserted -712698321 1553617804
11086 \begin_layout Description
11088 \change_inserted -712698321 1553617862
11089 \begin_inset Flex Code
11092 \begin_layout Plain Layout
11094 \change_inserted -712698321 1553617809
11101 \begin_inset Flex Code
11104 \begin_layout Plain Layout
11106 \change_inserted -712698321 1553617805
11112 ] defines the default table style that is used when inserting a table.
11113 The following styles are available:
11117 \begin_layout Itemize
11119 \change_inserted -712698321 1554308039
11120 \begin_inset Flex Code
11123 \begin_layout Plain Layout
11125 \change_inserted -712698321 1554307928
11126 Formal_with_Footline
11134 \begin_inset Quotes eld
11138 \begin_inset Quotes erd
11141 ) style with horizontal lines only, using a bold top and bottom line, the
11142 first and last row are additionally separated from the table body with
11143 a thin middle line.
11146 \begin_layout Itemize
11148 \change_inserted -712698321 1554308087
11149 \begin_inset Flex Code
11152 \begin_layout Plain Layout
11154 \change_inserted -712698321 1554308042
11155 Formal_without_Footline
11160 : same as the above, but the last row is not separated with a middle line
11164 \begin_layout Itemize
11166 \change_inserted -712698321 1553618031
11167 \begin_inset Flex Code
11170 \begin_layout Plain Layout
11172 \change_inserted -712698321 1553618006
11178 : Simple table lines.
11181 \begin_layout Itemize
11183 \change_inserted -712698321 1553618309
11184 \begin_inset Flex Code
11187 \begin_layout Plain Layout
11189 \change_inserted -712698321 1553618031
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11201 \change_inserted -712698321 1553618043
11207 , but with the header column offset with a second horizontal line.
11208 This is also the default style of \SpecialChar LyX
11212 \begin_layout Itemize
11214 \change_inserted -712698321 1553618280
11215 \begin_inset Flex Code
11218 \begin_layout Plain Layout
11220 \change_inserted -712698321 1553618261
11226 : Table without lines.
11232 \begin_layout Description
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11243 \begin_inset Flex Code
11246 \begin_layout Plain Layout
11252 ] The name of the command or environment to be used with
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11265 \begin_layout Description
11266 \begin_inset Flex Code
11269 \begin_layout Plain Layout
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11288 \begin_inset Flex Code
11291 \begin_layout Plain Layout
11297 ] Indicates what kind of markup is used to define the title of a document.
11299 \begin_inset Flex Code
11302 \begin_layout Plain Layout
11308 means that the macro with name
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11318 will be inserted after the last layout which has
11319 \begin_inset Quotes eld
11323 \begin_inset Flex Code
11326 \begin_layout Plain Layout
11328 \begin_inset space ~
11337 \begin_inset Quotes erd
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11351 corresponds to the case where all layouts which have
11352 \begin_inset Quotes eld
11356 \begin_inset Flex Code
11359 \begin_layout Plain Layout
11361 \begin_inset space ~
11370 \begin_inset Quotes erd
11373 should be enclosed into the
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11386 \begin_layout Description
11387 \begin_inset Flex Code
11390 \begin_layout Plain Layout
11397 \begin_inset Flex Code
11400 \begin_layout Plain Layout
11406 ] Sets which divisions are included in the table of contents.
11408 \begin_inset Flex Code
11411 \begin_layout Plain Layout
11417 counter in \SpecialChar LaTeX
11421 \begin_layout Subsection
11422 \begin_inset Flex Code
11425 \begin_layout Plain Layout
11432 \begin_inset CommandInset label
11434 name "subsec:ClassOptions"
11441 \begin_layout Standard
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11452 section can contain the following entries:
11455 \begin_layout Description
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11466 \begin_inset Flex Code
11469 \begin_layout Plain Layout
11475 ] The list of available font sizes for the document's main font, separated
11477 \begin_inset Quotes eld
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11491 \begin_inset Quotes erd
11497 \begin_layout Description
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11507 Used to set the DTD line with XML-based output classes.
11509 \begin_inset space \thinspace{}
11513 \begin_inset Quotes eld
11516 -//OASIS//DTD DocBook V4.2//EN
11517 \begin_inset Quotes erd
11523 \begin_layout Description
11524 \begin_inset Flex Code
11527 \begin_layout Plain Layout
11534 \begin_inset Flex Code
11537 \begin_layout Plain Layout
11538 string="empty|plain|headings|fancy"
11543 ] The list of available page sty\SpecialChar softhyphen
11545 \begin_inset Quotes eld
11549 \begin_inset Flex Code
11552 \begin_layout Plain Layout
11559 \begin_inset Quotes erd
11565 \begin_layout Description
11566 \begin_inset Flex Code
11569 \begin_layout Plain Layout
11576 \begin_inset Flex Code
11579 \begin_layout Plain Layout
11585 ] Some document class options, separated by a comma, that will be added
11586 to the optional part of the
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11601 \begin_layout Standard
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11612 section must end with
11613 \begin_inset Quotes eld
11617 \begin_inset Flex Code
11620 \begin_layout Plain Layout
11627 \begin_inset Quotes erd
11633 \begin_layout Subsection
11635 \begin_inset CommandInset label
11637 name "subsec:Paragraph-Styles"
11644 \begin_layout Standard
11645 A paragraph style description looks like this:
11649 \begin_layout Plain Layout
11650 Note that this will either define a new style or modify an existing one.
11658 \begin_layout LyX-Code
11665 \begin_layout LyX-Code
11669 \begin_layout LyX-Code
11673 \begin_layout Standard
11674 where the following commands are allowed:
11677 \begin_layout Description
11678 \begin_inset Flex Code
11681 \begin_layout Plain Layout
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11697 =""] This paragraph will appear in the table of contents of the given type.
11698 An empty string disables.
11699 See also the OutlinerName and the IsTocCaption commands.
11703 \begin_layout Description
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11714 \begin_inset Flex Code
11717 \begin_layout Plain Layout
11722 , left, right, center
11727 ] Paragraph alignment.
11730 \begin_layout Description
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11741 \begin_inset Flex Code
11744 \begin_layout Plain Layout
11749 , left, right, center
11754 ] A comma separated list of permitted alignments.
11755 (Some \SpecialChar LaTeX
11756 styles prohibit certain alignments, since those wouldn't make sense.
11757 For example a right-aligned or centered enumeration isn't possible.)
11760 \begin_layout Description
11761 \begin_inset Flex Code
11764 \begin_layout Plain Layout
11771 \begin_inset Flex Code
11774 \begin_layout Plain Layout
11780 ] Defines argument number <int> of a command\SpecialChar breakableslash
11781 environment associated with
11783 This is useful for things like section headings, and only makes sense with
11786 Every (optional or required) argument of a command or environment – except
11787 for the required argument that is associated with the content of the paragraph
11788 itself – has a separate definition, where the number specifies the order
11790 The definition must end with
11791 \begin_inset Flex Code
11794 \begin_layout Plain Layout
11801 So a command with two optional arguments has:
11805 \begin_layout Quote
11811 \begin_layout Quote
11817 \begin_layout Quote
11823 \begin_layout Quote
11829 \begin_layout Quote
11835 \begin_layout Quote
11841 \begin_layout Standard
11843 \begin_inset Flex Code
11846 \begin_layout Plain Layout
11852 definition, the following specifications are possible:
11855 \begin_layout Itemize
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11866 \begin_inset Flex Code
11869 \begin_layout Plain Layout
11875 The string that will appear both in the menu (to insert this argument)
11876 and on the argument inset button (unless you also specify a separate
11877 \begin_inset Flex Code
11880 \begin_layout Plain Layout
11887 For the menu, you can define an accelerator by appending the respective
11888 character to the string, divided by
11889 \begin_inset Quotes eld
11893 \begin_inset Quotes erd
11897 \begin_inset space \thinspace{}
11901 \begin_inset space \space{}
11905 \begin_inset Quotes eld
11909 \begin_inset Flex Code
11912 \begin_layout Plain Layout
11919 \begin_inset Quotes erd
11925 \begin_layout Itemize
11926 \begin_inset Flex Code
11929 \begin_layout Plain Layout
11936 \begin_inset Flex Code
11939 \begin_layout Plain Layout
11945 A separate string for the menu.
11946 You can define an accelerator by appending the respective character to
11947 the string, divided by
11948 \begin_inset Quotes eld
11952 \begin_inset Quotes erd
11956 \begin_inset space \thinspace{}
11960 \begin_inset space \space{}
11964 \begin_inset Quotes eld
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11978 \begin_inset Quotes erd
11982 This specification is optional.
11983 If it is not given the
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11993 will be used instead for the menu.
11996 \begin_layout Itemize
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12016 A longer explanatory text that appears in the tooltip when hovering over
12017 the argument inset.
12020 \begin_layout Itemize
12021 \begin_inset Flex Code
12024 \begin_layout Plain Layout
12031 \begin_inset Flex Code
12034 \begin_layout Plain Layout
12043 \begin_inset space \thinspace{}
12047 \begin_inset Flex Code
12050 \begin_layout Plain Layout
12056 ] Declare if this is a mandatory (1) or an optional (0) argument.
12057 Mandatory arguments will be output empty if not given, while optional arguments
12058 will not be output at all.
12059 By default, mandatory arguments are delimited by
12060 \begin_inset Flex Code
12063 \begin_layout Plain Layout
12069 , while optional arguments are delimited by
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12080 \change_inserted -712698321 1555579782
12084 \begin_layout Itemize
12086 \change_inserted -712698321 1555579780
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12092 \change_inserted -712698321 1555579780
12099 \begin_inset Flex Code
12102 \begin_layout Plain Layout
12104 \change_inserted -712698321 1555579780
12110 Option to define a different command (from the default
12111 \begin_inset Flex Code
12114 \begin_layout Plain Layout
12116 \change_inserted -712698321 1555579780
12126 ) to be used for line breaks.
12127 The initial backslash must not be specified.
12132 \begin_layout Itemize
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12143 \begin_inset Flex Code
12146 \begin_layout Plain Layout
12152 defines another argument (by its number) which this argument requires to
12153 be output if it is itself output.
12155 \begin_inset space \thinspace{}
12158 g., in \SpecialChar LaTeX
12159 commands, optional arguments often require previous optional arguments
12160 to be output (at least empty), as in
12161 \begin_inset Flex Code
12164 \begin_layout Plain Layout
12167 command[][argument]{text}
12173 This can be achieved by the statement
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12184 \begin_inset Flex Code
12187 \begin_layout Plain Layout
12196 \begin_layout Itemize
12197 \begin_inset Flex Code
12200 \begin_layout Plain Layout
12207 \begin_inset Flex Code
12210 \begin_layout Plain Layout
12216 defines a custom left delimiter (instead of
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12227 \begin_inset Flex Code
12230 \begin_layout Plain Layout
12237 A line break in the output can be indicated by
12238 \begin_inset Flex Code
12241 \begin_layout Plain Layout
12250 \begin_layout Itemize
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12261 \begin_inset Flex Code
12264 \begin_layout Plain Layout
12270 defines a custom right delimiter (instead of
12271 \begin_inset Flex Code
12274 \begin_layout Plain Layout
12281 \begin_inset Flex Code
12284 \begin_layout Plain Layout
12291 A line break in the output can be indicated by
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12304 \begin_layout Itemize
12305 \begin_inset Flex Code
12308 \begin_layout Plain Layout
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12324 defines an argument that is inserted if and only if no user-specified arguments
12326 \begin_inset space \thinspace{}
12330 \begin_inset space \space{}
12333 if no argument inset has been inserted (note that also an empty argument
12334 inset omits the DefaultArg).
12335 Multiple arguments need to be separated by comma.
12338 \begin_layout Itemize
12339 \begin_inset Flex Code
12342 \begin_layout Plain Layout
12349 \begin_inset Flex Code
12352 \begin_layout Plain Layout
12358 defines an argument that is inserted in any case (alone or in addition
12359 to user-specified arguments).
12360 Multiple arguments need to be separated by comma.
12363 \begin_layout Itemize
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12373 The font used for the argument content, see
12374 \begin_inset CommandInset ref
12376 reference "subsec:Font-description"
12381 \change_inserted -712698321 1559484228
12385 \begin_layout Itemize
12387 \change_inserted -712698321 1559484228
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12393 \change_inserted -712698321 1559484228
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12405 \change_inserted -712698321 1559484228
12414 \begin_inset space \thinspace{}
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12423 \change_inserted -712698321 1559484228
12429 ] As with paragraph styles, see
12430 \begin_inset CommandInset ref
12432 reference "subsec:Paragraph-Styles"
12441 \begin_layout Itemize
12442 \begin_inset Flex Code
12445 \begin_layout Plain Layout
12451 The font used for the label; see
12452 \begin_inset CommandInset ref
12454 reference "subsec:Font-description"
12461 \begin_layout Itemize
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12472 \begin_inset Flex Code
12475 \begin_layout Plain Layout
12480 , Minimalistic, Conglomerate
12485 ] describes the rendering style used for the inset's frame and buttons.
12488 \begin_layout Itemize
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12499 \begin_inset Flex Code
12502 \begin_layout Plain Layout
12509 \begin_inset Flex Code
12512 \begin_layout Plain Layout
12518 , this argument is automatically inserted when the respective style is selected.
12520 \change_deleted -712698321 1559484200
12521 Currently, only one argument per style\SpecialChar breakableslash
12522 layout can be automatically inserted.
12527 \begin_layout Itemize
12529 \change_inserted -712698321 1559491402
12530 \begin_inset Flex Code
12533 \begin_layout Plain Layout
12535 \change_inserted -712698321 1559490711
12542 \begin_inset Flex Code
12545 \begin_layout Plain Layout
12547 \change_inserted -712698321 1559490703
12554 \begin_inset Flex Code
12557 \begin_layout Plain Layout
12559 \change_inserted -712698321 1559490703
12565 , this argument will be inserted on a new line with
12566 \begin_inset Flex Code
12569 \begin_layout Plain Layout
12571 \change_inserted -712698321 1559491402
12577 (only available within Flex insets).
12580 \begin_layout Itemize
12581 \begin_inset Flex Code
12584 \begin_layout Plain Layout
12591 \begin_inset Flex Code
12594 \begin_layout Plain Layout
12601 \begin_inset Flex Code
12604 \begin_layout Plain Layout
12610 , this argument will be inserted with a copy of the co-text (either selected
12611 text or the whole paragraph) as content.
12614 \begin_layout Itemize
12615 \begin_inset Flex Code
12618 \begin_layout Plain Layout
12625 \begin_inset Flex Code
12628 \begin_layout Plain Layout
12638 ] Whether the contents of this argument should be output in raw form, meaning
12639 without special translations that \SpecialChar LaTeX
12642 \begin_inset Flex Code
12645 \begin_layout Plain Layout
12651 status is inherited by the inset or paragraph layout the argument belongs
12652 to, true and false change the status for the given argument only.
12655 \begin_layout Itemize
12656 \begin_inset Flex Code
12659 \begin_layout Plain Layout
12666 \begin_inset Flex Code
12669 \begin_layout Plain Layout
12670 string of characters
12679 Defines individual characters
12680 \begin_inset Newline linebreak
12683 that should be output in raw form, meaning without special translations
12684 that \SpecialChar LaTeX
12686 Note that, contrary to PassThru, this needs to be explicitly defined for
12688 That is, arguments do not inherit PassThruChars from their parent inset
12692 \begin_layout Itemize
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12715 \begin_inset space \thinspace{}
12719 \begin_inset Flex Code
12722 \begin_layout Plain Layout
12728 ] If this is set to 1, the argument will output its content in the corresponding
12729 item in the table of contents.
12733 \begin_layout Standard
12734 By default, the text entered in the \SpecialChar LyX
12735 workarea in the respective layout is
12736 the last (mandatory) argument of a command if the
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12757 However, arguments with the prefix
12758 \begin_inset Flex Code
12761 \begin_layout Plain Layout
12767 are output after this workarea argument.
12768 Note that post-argument numbering restarts at 1, so the first argument
12769 following the workarea argument is
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12780 Post-arguments are ignored in any other
12781 \begin_inset Flex Code
12784 \begin_layout Plain Layout
12791 \begin_inset Flex Code
12794 \begin_layout Plain Layout
12803 \begin_layout Standard
12805 \begin_inset Flex Code
12808 \begin_layout Plain Layout
12817 \begin_inset Flex Code
12820 \begin_layout Plain Layout
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12838 followed by the number (e.
12839 \begin_inset space \thinspace{}
12843 \begin_inset space \space{}
12847 \begin_inset Flex Code
12850 \begin_layout Plain Layout
12857 \change_inserted -712698321 1534487781
12861 \begin_layout Standard
12863 \change_inserted -712698321 1534488561
12864 Finally, there is a special argument type with the prefix
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12870 \change_inserted -712698321 1534487844
12879 It is not really an argument, but uses the argument interface (thus, the
12880 prefix is also followed by a number, e.
12881 \begin_inset space \thinspace{}
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12891 \change_inserted -712698321 1534488412
12892 Argument listpreamble:1
12898 As the name implies, it is targeted at lists such as
12915 Its content will be output at the list start, before the first
12916 \begin_inset Flex Code
12919 \begin_layout Plain Layout
12921 \change_inserted -712698321 1534488058
12931 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
12933 This way, users can insert redefinitions (of lengths etc.) to individual
12935 By default, these arguments do not have a delimiter.
12941 \begin_layout Description
12942 \begin_inset Flex Code
12945 \begin_layout Plain Layout
12951 Includes a comma-separated list of layouts that should be nested in and
12952 after the current layout.
12953 Only makes sense for nestable layouts (such as environments).
12955 \begin_inset Quotes eld
12959 \begin_inset Flex Code
12962 \begin_layout Plain Layout
12969 \begin_inset Quotes erd
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12986 \begin_layout Description
12987 \begin_inset Flex Code
12990 \begin_layout Plain Layout
12996 Note that this will completely override any prior
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13006 declaration for this style.
13008 \begin_inset Quotes eld
13012 \begin_inset Flex Code
13015 \begin_layout Plain Layout
13022 \begin_inset Quotes erd
13027 \begin_inset CommandInset ref
13029 reference "subsec:I18n"
13033 for details on its use.
13036 \begin_layout Description
13037 \begin_inset Flex Code
13040 \begin_layout Plain Layout
13047 \begin_inset Flex Code
13050 \begin_layout Plain Layout
13060 \begin_layout Plain Layout
13061 Note that a `float' here is a real number, such as: 1.5.
13066 The vertical space with which the last of a chain of paragraphs with this
13067 style is separated from the following paragraph.
13068 If the next paragraph has another style, the separations are not simply
13069 added, but the maximum is taken.
13072 \begin_layout Description
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13083 \begin_inset Flex Code
13086 \begin_layout Plain Layout
13092 ] The category for this style.
13093 This is used to group related styles in the style combobox on the toolbar.
13094 Any string can be used, but you may want to use existing categories with
13099 \begin_layout Description
13100 \begin_inset Flex Code
13103 \begin_layout Plain Layout
13109 Depth of XML command.
13110 Used only with XML-type formats.
13113 \begin_layout Description
13114 \begin_inset Flex Code
13117 \begin_layout Plain Layout
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13133 ] Copies all the features of an existing style into the current one.
13137 \begin_layout Description
13138 \begin_inset Flex Code
13141 \begin_layout Plain Layout
13148 \begin_inset Flex Code
13151 \begin_layout Plain Layout
13157 ] The name of a style whose preamble should be output
13162 This allows to ensure some ordering of the preamble snippets when macros
13163 definitions depend on one another.
13167 \begin_layout Plain Layout
13168 Note that, besides that functionality, there is no way to ensure any ordering
13170 The ordering that you see in a given version of \SpecialChar LyX
13171 may change without warning
13180 \begin_layout Description
13181 \begin_inset Flex Code
13184 \begin_layout Plain Layout
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13199 , Box, Filled_Box, Static
13204 ] The type of label that stands at the end of the paragraph (or sequence
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13216 \begin_inset Newline newline
13220 \begin_inset Flex Code
13223 \begin_layout Plain Layout
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13251 \begin_inset Flex Code
13254 \begin_layout Plain Layout
13261 \begin_inset Quotes eld
13265 \begin_inset Quotes erd
13269 \begin_inset Flex Code
13272 \begin_layout Plain Layout
13279 \begin_inset space \space{}
13283 \begin_inset Flex Code
13286 \begin_layout Plain Layout
13292 ) is a white (resp.
13293 \begin_inset space ~
13296 black) square suitable for end of proof markers,
13297 \begin_inset Flex Code
13300 \begin_layout Plain Layout
13306 is an explicit text string.
13309 \begin_layout Description
13310 \begin_inset Flex Code
13313 \begin_layout Plain Layout
13320 \begin_inset Flex Code
13323 \begin_layout Plain Layout
13329 ] The string used for a label with a
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13340 \begin_inset Newline newline
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13357 \begin_layout Description
13358 \begin_inset Flex Code
13361 \begin_layout Plain Layout
13367 The font used for both the text body
13373 \begin_inset CommandInset ref
13375 reference "subsec:Font-description"
13380 Note that defining this font automatically defines the
13381 \begin_inset Flex Code
13384 \begin_layout Plain Layout
13391 So you should define this one first if you also want to define
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13404 \begin_layout Description
13405 \begin_inset Flex Code
13408 \begin_layout Plain Layout
13415 \begin_inset Flex Code
13418 \begin_layout Plain Layout
13424 ] Used for backporting new styles to stable \SpecialChar LyX
13426 The first stable version that supports this tag is \SpecialChar LyX
13428 The argument is a number which may either be 0, -1 or any value greater
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13440 flag of a style is greater than zero, it will always be written to the
13442 If a .lyx file is read, the style definitions from the document header are
13443 added to the document class.
13444 Therefore even older \SpecialChar LyX
13445 versions can handle the style.
13447 \begin_inset Flex Code
13450 \begin_layout Plain Layout
13456 is a version number: if the style is read, and the version number is less
13457 than the version number of the already existing style in the document class,
13458 the new style is ignored.
13459 If the version number is greater, the new style replaces the existing style.
13460 A value of -1 means an infinite version number, i.
13461 \begin_inset space \thinspace{}
13465 \begin_inset space \space{}
13468 the style is always used.
13471 \begin_layout Description
13472 \begin_inset Flex Code
13475 \begin_layout Plain Layout
13482 \begin_inset Flex Code
13485 \begin_layout Plain Layout
13494 \begin_inset space \thinspace{}
13498 \begin_inset Flex Code
13501 \begin_layout Plain Layout
13507 ] Usually \SpecialChar LyX
13508 does not allow you to insert more than one space between words,
13509 since a space is considered as the separation between two words, not a
13510 character or symbol of its own.
13511 This is a very fine thing but sometimes annoying, for example, when typing
13512 program code or plain \SpecialChar LaTeX
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13526 \change_deleted -495245474 1550490105
13530 will create protected blanks for the additional blanks when in
13531 \change_inserted -495245474 1550490096
13533 \begin_inset Flex Code
13536 \begin_layout Plain Layout
13538 \change_inserted -495245474 1550490089
13545 \change_deleted -495245474 1550490116
13546 another mode than \SpecialChar LaTeX
13549 \change_inserted -495245474 1550247760
13551 \begin_inset Flex Code
13554 \begin_layout Plain Layout
13556 \change_inserted -495245474 1550247736
13563 \begin_inset Flex Code
13566 \begin_layout Plain Layout
13568 \change_inserted -495245474 1550247755
13579 \begin_layout Description
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13589 These tags are used with XHTML output.
13591 \begin_inset CommandInset ref
13593 reference "subsec:Paragraph-Style-XHTML"
13600 \begin_layout Description
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13610 [FIXME] (Used only with XML-type formats.)
13613 \begin_layout Description
13614 \begin_inset Flex Code
13617 \begin_layout Plain Layout
13624 \begin_inset Flex Code
13627 \begin_layout Plain Layout
13636 \begin_inset space \thinspace{}
13640 \begin_inset Flex Code
13643 \begin_layout Plain Layout
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13659 , marks the style as to be included in the document preamble and not in
13661 This is useful for document classes that want such information as the title
13662 and author to appear in the preamble.
13663 Note that this works only for styles for which the
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13674 \begin_inset Flex Code
13677 \begin_layout Plain Layout
13684 \begin_inset Flex Code
13687 \begin_layout Plain Layout
13696 \begin_layout Description
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13719 \begin_inset space \thinspace{}
13723 \begin_inset Flex Code
13726 \begin_layout Plain Layout
13733 \begin_inset Flex Code
13736 \begin_layout Plain Layout
13742 , marks the style as being part of a title block (see also the
13743 \begin_inset Flex Code
13746 \begin_layout Plain Layout
13753 \begin_inset Flex Code
13756 \begin_layout Plain Layout
13765 \begin_layout Description
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13775 Includes a comma-separated list of layouts after which this one should
13777 Only makes sense with regard to nestable layouts (such as environments).
13779 \begin_inset Quotes eld
13783 \begin_inset Flex Code
13786 \begin_layout Plain Layout
13793 \begin_inset Quotes erd
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13810 \begin_layout Description
13811 \begin_inset Flex Code
13814 \begin_layout Plain Layout
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13833 \begin_inset space \thinspace{}
13837 \begin_inset Flex Code
13840 \begin_layout Plain Layout
13846 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13847 of its contents in its item in the table of contents.
13848 Otherwise, only the label, if it exists, appears.
13851 \begin_layout Description
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13871 ] The \SpecialChar LaTeX
13872 command sequence declaring an item in a list.
13873 The command is to be defined without the preceding backslash (the default
13875 \begin_inset Quotes eld
13879 \begin_inset Quotes erd
13883 \begin_inset Flex Code
13886 \begin_layout Plain Layout
13894 in the \SpecialChar LaTeX
13898 \begin_layout Description
13899 \begin_inset Flex Code
13902 \begin_layout Plain Layout
13909 \begin_inset Flex Code
13912 \begin_layout Plain Layout
13918 ] This provides extra space between paragraphs that have the same style.
13919 If you put other styles into an environment, each is separated with the
13921 \begin_inset Flex Code
13924 \begin_layout Plain Layout
13931 But the whole items of the environment are additionally separated with
13933 \begin_inset Flex Code
13936 \begin_layout Plain Layout
13943 Note that this is a
13948 \begin_layout Description
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13958 [FIXME] (Used only with XML-type formats.)
13961 \begin_layout Description
13962 \begin_inset Flex Code
13965 \begin_layout Plain Layout
13972 \begin_inset Flex Code
13975 \begin_layout Plain Layout
13984 \begin_inset space \thinspace{}
13988 \begin_inset Flex Code
13991 \begin_layout Plain Layout
13997 ] Usually \SpecialChar LyX
13998 does not allow you to leave a paragraph empty, since it would
13999 lead to empty \SpecialChar LaTeX
14001 There are some cases where this could be desirable however: in a letter
14002 template, the required fields can be provided as empty fields, so that
14003 people do not forget them; in some special classes, a style can be used
14004 as some kind of break, which does not contain actual text.
14007 \begin_layout Description
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14018 \begin_inset Flex Code
14021 \begin_layout Plain Layout
14027 ] The vertical space between the label and the text body.
14028 Only used for labels that are above the text body (
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14039 \begin_inset Newline newline
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14047 Centered_Top_Environment
14055 \begin_layout Description
14056 \begin_inset Flex Code
14059 \begin_layout Plain Layout
14066 \begin_inset Flex Code
14069 \begin_layout Plain Layout
14075 ] The name of the counter for automatic numbering.
14076 In order to have the counter appear with your label, you will need to reference
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14090 This will work with
14091 \begin_inset Flex Code
14094 \begin_layout Plain Layout
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14111 \begin_inset Flex Code
14114 \begin_layout Plain Layout
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14131 \begin_inset Newline newline
14139 \begin_inset Flex Code
14142 \begin_layout Plain Layout
14149 \begin_inset Flex Code
14152 \begin_layout Plain Layout
14158 , though this case is a bit complicated.
14159 Suppose you declare
14160 \begin_inset Quotes eld
14164 \begin_inset Flex Code
14167 \begin_layout Plain Layout
14168 LabelCounter myenum
14174 \begin_inset Quotes erd
14178 Then the actual counters used are
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14189 \begin_inset Flex Code
14192 \begin_layout Plain Layout
14199 \begin_inset Flex Code
14202 \begin_layout Plain Layout
14209 \begin_inset Flex Code
14212 \begin_layout Plain Layout
14218 , much as in \SpecialChar LaTeX
14220 These counters must all be declared separately.
14221 \begin_inset Newline newline
14225 \begin_inset CommandInset ref
14227 reference "subsec:Counters"
14231 for details on counters.
14234 \begin_layout Description
14235 \begin_inset Flex Code
14238 \begin_layout Plain Layout
14244 The font used for the label.
14246 \begin_inset CommandInset ref
14248 reference "subsec:Font-description"
14255 \begin_layout Description
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14275 ] Text that indicates how far a label should be indented.
14278 \begin_layout Description
14279 \begin_inset Flex Code
14282 \begin_layout Plain Layout
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14298 ] Text that indicates the amount of horizontal space between the label and
14300 Only used for labels that are not above the text body.
14303 \begin_layout Description
14304 \begin_inset Flex Code
14307 \begin_layout Plain Layout
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14323 ] The string used for the label.
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14334 is set, this string can be contain the special formatting commands described
14336 \begin_inset CommandInset ref
14338 reference "subsec:Counters"
14345 \begin_layout Description
14346 \begin_inset Flex Code
14349 \begin_layout Plain Layout
14350 LabelStringAppendix
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14365 ] This is used inside the appendix instead of
14366 \begin_inset Newline newline
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14381 \begin_inset Flex Code
14384 \begin_layout Plain Layout
14391 \begin_inset Newline newline
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14399 LabelStringAppendix
14407 \begin_layout Description
14408 \begin_inset Flex Code
14411 \begin_layout Plain Layout
14417 [FIXME] (Used only with XML-type formats.)
14420 \begin_layout Description
14421 \begin_inset Flex Code
14424 \begin_layout Plain Layout
14431 \begin_inset Flex Code
14434 \begin_layout Plain Layout
14439 , Manual, Static, Above,
14440 \begin_inset Newline newline
14443 Centered, Sensitive, Enumerate,
14444 \begin_inset Newline newline
14447 Itemize, Bibliography
14456 \begin_layout Description
14457 \begin_inset Flex Code
14460 \begin_layout Plain Layout
14466 means the label is the very first word (up to the first real blank).
14467 Use protected spaces if you want more than one word as the label.
14471 \begin_layout Description
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14481 means the label is simply what is declared as
14482 \begin_inset Flex Code
14485 \begin_layout Plain Layout
14492 This will be displayed
14493 \begin_inset Quotes eld
14497 \begin_inset Quotes erd
14500 , at the beginning of the paragraph.
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14512 \begin_inset Flex Code
14515 \begin_layout Plain Layout
14521 , then it will be displayed only in the first paragraph of any sequence
14522 of paragraphs with the same
14523 \begin_inset Flex Code
14526 \begin_layout Plain Layout
14535 \begin_layout Description
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14546 \begin_inset space ~
14550 \begin_inset space ~
14554 \begin_inset Flex Code
14557 \begin_layout Plain Layout
14563 are special cases of
14564 \begin_inset Flex Code
14567 \begin_layout Plain Layout
14574 The label will be printed above the paragraph either at the beginning of
14575 the line or centered.
14578 \begin_layout Description
14579 \begin_inset Flex Code
14582 \begin_layout Plain Layout
14588 is a special case for the caption-labels
14589 \begin_inset Quotes eld
14593 \begin_inset Quotes erd
14597 \begin_inset Quotes eld
14601 \begin_inset Quotes erd
14605 \begin_inset Newline newline
14609 \begin_inset Flex Code
14612 \begin_layout Plain Layout
14618 means the (hardcoded) label string depends on the kind of float: It is
14619 hardcoded to be `FloatType N', where N is the value of the counter associated
14621 For the case that a caption is inserted outside of a float the
14622 \begin_inset Flex Code
14625 \begin_layout Plain Layout
14632 \begin_inset Quotes eld
14636 \begin_inset Quotes erd
14642 \begin_layout Description
14643 \begin_inset Flex Code
14646 \begin_layout Plain Layout
14652 produces the usual sort of enumeration labels.
14653 The number type needs to be set in the
14658 \begin_inset CommandInset ref
14660 reference "subsec:Counters"
14667 \begin_layout Description
14668 \begin_inset Flex Code
14671 \begin_layout Plain Layout
14677 produces various bullets at the different levels.
14678 The bullet types displayed can be set via
14679 \begin_inset Flex Noun
14682 \begin_layout Plain Layout
14683 Document\SpecialChar menuseparator
14684 Settings\SpecialChar menuseparator
14693 \begin_layout Description
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14703 should be used only with
14704 \begin_inset Flex Code
14707 \begin_layout Plain Layout
14708 LatexType BibEnvironment
14717 \begin_layout Description
14718 \begin_inset Flex Code
14721 \begin_layout Plain Layout
14727 Note that this will completely override any prior
14728 \begin_inset Flex Code
14731 \begin_layout Plain Layout
14737 declaration for this style.
14739 \begin_inset Quotes eld
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14753 \begin_inset Quotes erd
14758 \begin_inset CommandInset ref
14760 reference "subsec:I18n"
14764 for details on its use.
14767 \begin_layout Description
14768 \begin_inset Flex Code
14771 \begin_layout Plain Layout
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14787 ] The name of the corresponding \SpecialChar LaTeX
14789 Either the environment or command name.
14792 \begin_layout Description
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14812 ] An optional parameter for the corresponding
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14823 This parameter cannot be changed from within \SpecialChar LyX
14825 \begin_inset Flex Code
14828 \begin_layout Plain Layout
14834 for customizable parameters).
14835 This will be output as is after all \SpecialChar LaTeX
14837 \begin_inset Flex Code
14840 \begin_layout Plain Layout
14849 \begin_layout Description
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14868 , Command, Environment, Item_Environment,
14869 \begin_inset Newline newline
14872 List_Environment, Bib_Environment
14877 ] How the style should be translated into \SpecialChar LaTeX
14882 \begin_layout Plain Layout
14883 \begin_inset Flex Code
14886 \begin_layout Plain Layout
14892 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14893 Visit the SGML class files for specific examples.
14902 \begin_layout Description
14903 \begin_inset Flex Code
14906 \begin_layout Plain Layout
14912 means nothing special.
14915 \begin_layout Description
14916 \begin_inset Flex Code
14919 \begin_layout Plain Layout
14926 \begin_inset Flex Code
14929 \begin_layout Plain Layout
14936 {\SpecialChar ldots
14945 \begin_layout Description
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14956 \begin_inset Flex Code
14959 \begin_layout Plain Layout
14966 }\SpecialChar ldots
14982 \begin_layout Description
14983 \begin_inset Flex Code
14986 \begin_layout Plain Layout
14993 \begin_inset Flex Code
14996 \begin_layout Plain Layout
15003 \begin_inset Flex Code
15006 \begin_layout Plain Layout
15014 is generated for each paragraph of this environment.
15018 \begin_layout Description
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15039 \begin_inset Newline newline
15043 \begin_inset Flex Code
15046 \begin_layout Plain Layout
15052 is passed as an argument to the environment.
15053 \begin_inset Newline newline
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15066 can be defined in the
15067 \begin_inset Flex Noun
15070 \begin_layout Plain Layout
15071 Edit\SpecialChar menuseparator
15073 \begin_inset space ~
15084 \begin_layout Description
15085 \begin_inset Flex Code
15088 \begin_layout Plain Layout
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15104 but adds the necessary mandatory argument (the longest label) to the begin
15105 statement of the bibliography environment:
15106 \begin_inset Newline newline
15110 \begin_inset Flex Code
15113 \begin_layout Plain Layout
15116 begin{thebibliography}{99}
15122 It is therefore only useful for bibliography environments.
15123 The default longest label
15124 \begin_inset Quotes eld
15128 \begin_inset Quotes erd
15131 can be changed by the user in the paragraph settings of a bibliography
15135 \begin_layout Standard
15136 Putting the last few things together, the \SpecialChar LaTeX
15137 output will be either:
15140 \begin_layout LyX-Code
15143 LatexName[LatexParam]{\SpecialChar ldots
15147 \begin_layout Standard
15151 \begin_layout LyX-Code
15154 begin{LatexName}[LatexParam] \SpecialChar ldots
15160 \begin_layout Standard
15161 depending upon the \SpecialChar LaTeX
15166 \begin_layout Description
15167 \begin_inset Flex Code
15170 \begin_layout Plain Layout
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15186 ] A string that is put at the beginning of the style content.
15187 A line break in the output can be indicated by
15188 \begin_inset Flex Code
15191 \begin_layout Plain Layout
15200 \begin_layout Description
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15220 ] If you put styles into environments, the different
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15230 are not simply added, but added with a factor
15231 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15235 Note that this parameter is also used when
15236 \begin_inset Flex Code
15239 \begin_layout Plain Layout
15246 \begin_inset Flex Code
15249 \begin_layout Plain Layout
15256 \begin_inset Flex Code
15259 \begin_layout Plain Layout
15266 Then it is added to the manual or dynamic margin.
15267 \begin_inset Newline newline
15271 \begin_inset Quotes eld
15275 \begin_inset Flex Code
15278 \begin_layout Plain Layout
15285 \begin_inset Quotes erd
15288 means that the paragraph is indented with the width of
15289 \begin_inset Quotes eld
15293 \begin_inset Flex Code
15296 \begin_layout Plain Layout
15303 \begin_inset Quotes erd
15306 in the normal font.
15307 You can get a negative width by prefixing the string with
15308 \begin_inset Quotes eld
15312 \begin_inset Flex Code
15315 \begin_layout Plain Layout
15322 \begin_inset Quotes erd
15326 This way was chosen so that the look is the same with each used screen
15330 \begin_layout Description
15331 \begin_inset Flex Code
15334 \begin_layout Plain Layout
15341 \begin_inset Flex Code
15344 \begin_layout Plain Layout
15349 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15355 \begin_inset Newline newline
15358 The kind of margin that the style has on the left side.
15362 \begin_layout Description
15363 \begin_inset Flex Code
15366 \begin_layout Plain Layout
15372 just means a fixed margin.
15375 \begin_layout Description
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15385 means that the left margin depends on the string entered in the
15386 \begin_inset Flex Noun
15389 \begin_layout Plain Layout
15390 Edit\SpecialChar menuseparator
15392 \begin_inset space ~
15401 This is used to typeset nice lists without tabulators.
15404 \begin_layout Description
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15414 means that the margin depends on the size of the label.
15415 This is used for automatic enumerated headlines.
15416 It is obvious that the headline
15417 \begin_inset Quotes eld
15420 5.4.3.2.1 Very long headline
15421 \begin_inset Quotes erd
15424 must have a wider left margin (as wide as
15425 \begin_inset Quotes eld
15429 \begin_inset Quotes erd
15432 plus the space) than
15433 \begin_inset Quotes eld
15436 3.2 Very long headline
15437 \begin_inset Quotes erd
15441 \begin_inset Quotes eld
15445 \begin_inset Quotes erd
15448 are not able to do this.
15451 \begin_layout Description
15452 \begin_inset Flex Code
15455 \begin_layout Plain Layout
15461 is similar, but only the very first row of the paragraph is dynamic, while
15462 the others are static; this is used, for example, for descriptions.
15465 \begin_layout Description
15466 \begin_inset Flex Code
15469 \begin_layout Plain Layout
15475 means the margin is chosen in a way that the longest row of this paragraph
15476 fits to the right margin.
15477 This is used to typeset an address on the right edge of the page.
15481 \begin_layout Description
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15504 \begin_inset space \thinspace{}
15508 \begin_inset Flex Code
15511 \begin_layout Plain Layout
15517 ] Whether fragile commands in this style should be
15518 \begin_inset Flex Code
15521 \begin_layout Plain Layout
15534 whether this command should itself be protected.)
15535 \change_inserted -712698321 1523696949
15539 \begin_layout Description
15541 \change_inserted -712698321 1552395557
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15547 \change_inserted -712698321 1523696950
15554 \begin_inset Flex Code
15557 \begin_layout Plain Layout
15559 \change_inserted -712698321 1523696950
15568 \begin_inset space \thinspace{}
15572 \begin_inset Flex Code
15575 \begin_layout Plain Layout
15577 \change_inserted -712698321 1523696950
15583 ] This causes macros that contain this layout to be protected with
15584 \begin_inset Flex Code
15587 \begin_layout Plain Layout
15589 \change_inserted -712698321 1523696950
15602 ) if necessary and thus allows (some) verbatim stuff in macros.
15605 \begin_layout Description
15607 \change_inserted -712698321 1552395844
15608 \begin_inset Flex Code
15611 \begin_layout Plain Layout
15613 \change_inserted -712698321 1552395561
15620 \begin_inset Flex Code
15623 \begin_layout Plain Layout
15625 \change_inserted -712698321 1552395557
15634 \begin_inset space \thinspace{}
15638 \begin_inset Flex Code
15641 \begin_layout Plain Layout
15643 \change_inserted -712698321 1552395557
15649 ] Whether specific commands in this style (such as
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15655 \change_inserted -712698321 1552395655
15666 \begin_inset Flex Code
15669 \begin_layout Plain Layout
15671 \change_inserted -712698321 1552395661
15681 ) should be protected in an
15682 \begin_inset Flex Code
15685 \begin_layout Plain Layout
15687 \change_inserted -712698321 1552395631
15698 This is particularly needed for styles that draw on
15706 commands which parse their content in complex ways.
15711 \begin_layout Description
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15732 \begin_inset space \thinspace{}
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15747 ] Whether newlines are translated into \SpecialChar LaTeX
15749 \begin_inset Flex Code
15752 \begin_layout Plain Layout
15763 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15765 inside \SpecialChar LyX
15769 \begin_layout Description
15770 \begin_inset Flex Code
15773 \begin_layout Plain Layout
15780 \begin_inset Flex Code
15783 \begin_layout Plain Layout
15792 \begin_inset space \thinspace{}
15796 \begin_inset Flex Code
15799 \begin_layout Plain Layout
15805 ] If set to true, and if
15806 \begin_inset Flex Code
15809 \begin_layout Plain Layout
15816 \begin_inset Flex Code
15819 \begin_layout Plain Layout
15825 ) paragraphs are being indented, then the indentation of such a paragraph
15826 following one of this type will be suppressed.
15827 (So this will not affect the display of non-default paragraphs.)
15830 \begin_layout Description
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15850 ] Name of a style that has replaced this style.
15851 This is used to rename a style, while keeping backward compatibility.
15854 \begin_layout Description
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15865 \begin_inset Flex Code
15868 \begin_layout Plain Layout
15875 \begin_inset space \thinspace{}
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 ] Determines whether consecutive paragraphs of the same type are treated
15889 as belonging together.
15890 This has the effect that the
15891 \begin_inset Flex Code
15894 \begin_layout Plain Layout
15900 is only printed once before such a group.
15901 By default, this is true for
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15931 and false for all other types.
15934 \begin_layout Description
15935 \begin_inset Flex Code
15938 \begin_layout Plain Layout
15945 \begin_inset Flex Code
15948 \begin_layout Plain Layout
15957 \begin_inset space \thinspace{}
15961 \begin_inset Flex Code
15964 \begin_layout Plain Layout
15970 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15972 but only by a line break; together with
15973 \begin_inset Flex Code
15976 \begin_layout Plain Layout
15982 , this allows to emulate a plain text editor (like the ERT inset).
15985 \begin_layout Description
15986 \begin_inset Flex Code
15989 \begin_layout Plain Layout
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16005 ] The indent of the very first line of a paragraph.
16007 \begin_inset Newline newline
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16020 will be fixed for a certain style.
16021 The exception is the default style, since the indentation for these paragraphs
16022 can be prohibited with
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16034 \begin_inset Flex Code
16037 \begin_layout Plain Layout
16043 style paragraphs inside environments use the
16044 \begin_inset Flex Code
16047 \begin_layout Plain Layout
16053 of the environment, not their native one.
16055 \begin_inset Flex Code
16058 \begin_layout Plain Layout
16064 paragraphs inside an enumeration are not indented.
16067 \begin_layout Description
16068 \begin_inset Flex Code
16071 \begin_layout Plain Layout
16078 \begin_inset Flex Code
16081 \begin_layout Plain Layout
16087 ] The vertical space between two paragraphs of this style.
16090 \begin_layout Description
16091 \begin_inset Flex Code
16094 \begin_layout Plain Layout
16101 \begin_inset Flex Code
16104 \begin_layout Plain Layout
16111 allows the user to choose either
16112 \begin_inset Quotes eld
16116 \begin_inset Quotes erd
16120 \begin_inset Quotes eld
16124 \begin_inset Quotes erd
16127 to separate paragraphs.
16129 \begin_inset Quotes eld
16133 \begin_inset Quotes erd
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16148 \begin_inset Quotes eld
16152 \begin_inset Quotes erd
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16165 is ignored and all paragraphs are separated by the
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16176 The vertical space is calculated with
16177 \begin_inset Flex Code
16180 \begin_layout Plain Layout
16182 \begin_inset space ~
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16200 is the height of a row with the normal font.
16201 This way, the look stays the same with different screen fonts.
16204 \begin_layout Description
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16227 \begin_inset space \thinspace{}
16231 \begin_inset Flex Code
16234 \begin_layout Plain Layout
16240 ] Whether the contents of this paragraph should be output in raw form, meaning
16241 without special translations that \SpecialChar LaTeX
16245 \begin_layout Description
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16256 \begin_inset Flex Code
16259 \begin_layout Plain Layout
16269 Defines individual characters that should be output in raw form, meaning
16270 without special translations that \SpecialChar LaTeX
16274 \begin_layout Description
16275 \begin_inset Flex Code
16278 \begin_layout Plain Layout
16284 Information to be included in the \SpecialChar LaTeX
16285 preamble when this style is used.
16286 Used to define macros, load packages, etc., required by this particular
16289 \begin_inset Quotes eld
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16303 \begin_inset Quotes erd
16309 \begin_layout Description
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16329 ] The prefix to use when creating labels referring to paragraphs of this
16331 This allows the use of formatted references.
16334 \begin_layout Description
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16345 \begin_inset Flex Code
16348 \begin_layout Plain Layout
16354 ] Whether the style requires the feature
16355 \begin_inset Flex Code
16358 \begin_layout Plain Layout
16365 \begin_inset CommandInset ref
16367 reference "chap:List-of-functions"
16371 for the list of features).
16372 If you require a package with specific options, you can additionally use
16374 \begin_inset Flex Code
16377 \begin_layout Plain Layout
16383 as a general text class parameter (see
16384 \begin_inset CommandInset ref
16386 reference "subsec:General-text-class"
16393 \begin_layout Description
16394 \begin_inset Flex Code
16397 \begin_layout Plain Layout
16404 \begin_inset Flex Code
16407 \begin_layout Plain Layout
16416 \begin_inset Flex Code
16419 \begin_layout Plain Layout
16425 ] Resets the \SpecialChar LaTeX
16426 arguments of this style (as defined via the
16427 \begin_inset Flex Code
16430 \begin_layout Plain Layout
16437 This is useful if you have copied a style via
16438 \begin_inset Flex Code
16441 \begin_layout Plain Layout
16447 , but you do not want to inherit its (required and optional) arguments.
16450 \begin_layout Description
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16473 \begin_inset Flex Code
16476 \begin_layout Plain Layout
16482 ] Resumes a counter that is usually reset at each new sequence of layouts.
16483 This is currently only useful when
16484 \begin_inset Flex Code
16487 \begin_layout Plain Layout
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16506 \begin_layout Description
16507 \begin_inset Flex Code
16510 \begin_layout Plain Layout
16517 \begin_inset Flex Code
16520 \begin_layout Plain Layout
16526 ] A string that is put at the end of the layout content.
16527 A line break in the output can be indicated by
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16540 \begin_layout Description
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16551 \begin_inset Flex Code
16554 \begin_layout Plain Layout
16561 \begin_inset Flex Code
16564 \begin_layout Plain Layout
16573 \begin_layout Description
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16596 \begin_inset Flex Code
16599 \begin_layout Plain Layout
16606 \begin_inset Flex Code
16609 \begin_layout Plain Layout
16616 \begin_inset Flex Code
16619 \begin_layout Plain Layout
16621 \begin_inset space ~
16629 ] This defines what the default spacing should be in the style.
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16641 \begin_inset Flex Code
16644 \begin_layout Plain Layout
16651 \begin_inset Flex Code
16654 \begin_layout Plain Layout
16660 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16661 If you specify the argument
16662 \begin_inset Flex Code
16665 \begin_layout Plain Layout
16671 , then you must also provide a value argument which will be the actual multiplie
16673 Note that, contrary to other parameters,
16674 \begin_inset Flex Code
16677 \begin_layout Plain Layout
16683 implies the generation of specific \SpecialChar LaTeX
16684 code, using the \SpecialChar LaTeX
16688 \begin_inset Flex Code
16691 \begin_layout Plain Layout
16700 \begin_layout Description
16701 \begin_inset Flex Code
16704 \begin_layout Plain Layout
16711 \begin_inset Flex Code
16714 \begin_layout Plain Layout
16721 \begin_inset space \thinspace{}
16725 \begin_inset Flex Code
16728 \begin_layout Plain Layout
16736 ] Allow spell-checking paragraphs of this style.
16740 \begin_layout Description
16741 \begin_inset Flex Code
16744 \begin_layout Plain Layout
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16772 ] Steps the master counter of a given counter at the beginning of a new
16773 sequence of layouts.
16774 This is currently only useful when
16775 \begin_inset Flex Code
16778 \begin_layout Plain Layout
16785 \begin_inset Flex Code
16788 \begin_layout Plain Layout
16797 \begin_layout Description
16798 \begin_inset Flex Code
16801 \begin_layout Plain Layout
16807 The font used for the text body .
16809 \begin_inset CommandInset ref
16811 reference "subsec:Font-description"
16818 \begin_layout Description
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16831 \begin_inset Flex Code
16834 \begin_layout Plain Layout
16844 The level of the style in the table of contents.
16845 This is used for automatic numbering of section headings.
16848 \begin_layout Description
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16861 \begin_inset Flex Code
16864 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16885 \begin_inset Flex Code
16888 \begin_layout Plain Layout
16894 ] This tag determines whether the first line indentation of this paragraph
16895 can be toggled via the Paragraph settings dialog.
16899 \begin_inset Flex Code
16902 \begin_layout Plain Layout
16912 is set, indentation can be toggled if the document settings use
16913 \begin_inset Quotes eld
16917 \begin_inset Quotes erd
16920 paragraph style, with
16921 \begin_inset Flex Code
16924 \begin_layout Plain Layout
16930 , indentation can always be toggled, notwithstanding the document settings,
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 , indentation can never be toggled.
16944 \begin_layout Description
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 ] The vertical space with which the very first of a chain of paragraphs
16965 with this style is separated from the previous paragraph.
16966 If the previous paragraph has another style, the separations are not simply
16967 added, but the maximum is taken.
16970 \begin_layout Subsection
16971 \begin_inset CommandInset label
16977 Internationalization of Paragraph Styles
16980 \begin_layout Standard
16982 has long supported internationalization of layout information, but, until
16983 version 2.0, this applied only to the user interface and not to, say, PDF
16985 Thus, French authors were forced to resort to ugly hacks if they wanted
16990 1' instead of `Theorem 1'.
16991 Thanks to Georg Baum, that is no longer the case.
16994 \begin_layout Standard
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17005 defines text that is to appear in the typeset document, it may use
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17016 \begin_inset Flex Code
17019 \begin_layout Plain Layout
17025 to support non-English and even multi-language documents correctly.
17026 The following excerpt (from the
17027 \begin_inset Flex Code
17030 \begin_layout Plain Layout
17036 file) shows how this works:
17039 \begin_layout LyX-Code
17044 \begin_layout LyX-Code
17047 theoremstyle{remark}
17050 \begin_layout LyX-Code
17053 newtheorem{claim}[thm]{
17060 \begin_layout LyX-Code
17064 \begin_layout LyX-Code
17068 \begin_layout LyX-Code
17073 claimname}{_(Claim)}
17076 \begin_layout LyX-Code
17080 \begin_layout LyX-Code
17084 \begin_layout LyX-Code
17093 claimname}{_(Claim)}}
17096 \begin_layout LyX-Code
17101 \begin_layout Standard
17102 In principle, any legal \SpecialChar LaTeX
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17123 tags, but in practice they will typically look as they do here.
17124 The key to correct translation of the typeset text is the definition of
17125 the \SpecialChar LaTeX
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17139 \begin_inset Flex Code
17142 \begin_layout Plain Layout
17154 \begin_layout Standard
17156 \begin_inset Flex Code
17159 \begin_layout Plain Layout
17165 tag provides for internationalization based upon the overall language of
17167 The contents of the tag will be included in the preamble, just as with
17169 \begin_inset Flex Code
17172 \begin_layout Plain Layout
17179 What makes it special is the use of the
17180 \begin_inset Quotes eld
17184 \begin_inset Quotes erd
17188 \begin_inset Flex Code
17191 \begin_layout Plain Layout
17197 , which will be replaced, when \SpecialChar LyX
17198 produces \SpecialChar LaTeX
17199 output, with the translation of
17200 its argument into the document language.
17203 \begin_layout Standard
17205 \begin_inset Flex Code
17208 \begin_layout Plain Layout
17214 tag is more complex, since it is meant to provide support for multi-language
17215 documents and so offers an interface to the
17216 \begin_inset Flex Code
17219 \begin_layout Plain Layout
17226 Its contents will be added to the preamble once for each language that
17227 appears in the document.
17228 In this case, the argument to
17229 \begin_inset Flex Code
17232 \begin_layout Plain Layout
17238 will be replaced with its translation into the language in question; the
17240 \begin_inset Flex Code
17243 \begin_layout Plain Layout
17249 is replaced by the language name (as used by the babel package).
17252 \begin_layout Standard
17253 A German document that also included a French section would thus have the
17254 following in the preamble:
17257 \begin_layout LyX-Code
17266 claimname}{Affirmation}}
17267 \begin_inset Newline newline
17278 claimname}{Behauptung}}
17279 \begin_inset Newline newline
17286 claimname}{Behauptung}
17289 \begin_layout Standard
17292 \begin_inset Flex Code
17295 \begin_layout Plain Layout
17301 will then conspire to produce the correct text in the output.
17304 \begin_layout Standard
17305 One important point to note here is that the translations are provided by
17307 itself, through the file
17308 \begin_inset Flex Code
17311 \begin_layout Plain Layout
17318 This means, in effect, that
17319 \begin_inset Flex Code
17322 \begin_layout Plain Layout
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17338 are really only of use in layout files that are provided with \SpecialChar LyX
17340 entered in user-created layout files will not be seen by \SpecialChar LyX
17341 's internationalizatio
17342 n routines unless the
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17352 file is modified accordingly.
17353 That said, however, any layout created with the intention that it will
17354 be included with \SpecialChar LyX
17355 should use these tags where appropriate.
17356 Please note that the paragraph style translations provided by \SpecialChar LyX
17358 change with a minor update (e.
17359 \begin_inset space \thinspace{}
17363 \begin_inset space \space{}
17366 from version 2.1.x to 2.1.y).
17367 It is however quite likely that a major update (e.
17368 \begin_inset space \thinspace{}
17372 \begin_inset space \space{}
17375 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17378 \begin_layout Subsection
17380 \begin_inset CommandInset label
17382 name "subsec:Floats"
17389 \begin_layout Standard
17390 It is necessary to define the floats (
17391 \begin_inset Flex Noun
17394 \begin_layout Plain Layout
17401 \begin_inset Flex Noun
17404 \begin_layout Plain Layout
17410 , \SpecialChar ldots
17411 ) in the text class itself.
17412 Standard floats are included in the file
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17422 , so you may have to do no more than add
17425 \begin_layout LyX-Code
17426 Input stdfloats.inc
17429 \begin_layout Standard
17430 to your layout file.
17431 If you want to implement a text class that proposes some other float types
17432 (like the AGU class bundled with \SpecialChar LyX
17433 ), the information below will hopefully
17437 \begin_layout Description
17438 \begin_inset Flex Code
17441 \begin_layout Plain Layout
17448 \begin_inset Flex Code
17451 \begin_layout Plain Layout
17457 =!htbpH] Allowed placement options for this float type.
17458 The value is a string of placement characters.
17459 Possible characters include:
17464 \begin_inset Quotes eld
17468 \begin_inset Quotes erd
17476 \begin_inset Quotes eld
17480 \begin_inset Quotes erd
17488 \begin_inset Quotes eld
17492 \begin_inset Quotes erd
17500 \begin_inset Quotes eld
17504 \begin_inset Quotes erd
17512 \begin_inset Quotes eld
17516 \begin_inset Quotes erd
17524 \begin_inset Quotes eld
17528 \begin_inset Quotes erd
17532 The order of the characters in the string does not matter.
17533 If no placement options are allowed, use the string
17540 \begin_layout Description
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17551 \begin_inset Flex Code
17554 \begin_layout Plain Layout
17563 \begin_inset space \thinspace{}
17569 \begin_inset Flex Code
17572 \begin_layout Plain Layout
17582 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17598 if the float does not support this feature.
17601 \begin_layout Description
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17612 \begin_inset Flex Code
17615 \begin_layout Plain Layout
17624 \begin_inset space \thinspace{}
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17643 ] Defines whether the float has a starred variant that spans columns in
17644 a two column paragraph.
17646 \begin_inset Flex Code
17649 \begin_layout Plain Layout
17655 if the float does not support this feature.
17658 \begin_layout Description
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17669 \begin_inset Flex Code
17672 \begin_layout Plain Layout
17679 \begin_inset Quotes erd
17683 \begin_inset Quotes erd
17686 ] The file name extension of an auxiliary file for the list of figures (or
17689 writes the captions to this file.
17692 \begin_layout Description
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17703 \begin_inset Flex Code
17706 \begin_layout Plain Layout
17713 \begin_inset Quotes erd
17717 \begin_inset Quotes erd
17720 ] The string that will be used in the menus and also for the caption.
17721 This is translated to the current language if babel is used.
17724 \begin_layout Description
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17734 These tags control the XHTML output.
17736 \begin_inset CommandInset ref
17738 reference "sec:Tags-for-XHTML"
17745 \begin_layout Description
17746 \begin_inset Flex Code
17749 \begin_layout Plain Layout
17758 \begin_inset Flex Code
17761 \begin_layout Plain Layout
17770 \begin_inset space \thinspace{}
17774 \begin_inset Flex Code
17777 \begin_layout Plain Layout
17783 ] Indicates whether the float is already defined in the document class or
17784 if instead the \SpecialChar LaTeX
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17795 needs to be loaded to define it on-the-fly.
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17817 It should be set to
17818 \begin_inset Flex Code
17821 \begin_layout Plain Layout
17827 if the float is already defined by the \SpecialChar LaTeX
17831 \begin_layout Description
17832 \begin_inset Flex Code
17835 \begin_layout Plain Layout
17842 \begin_inset Flex Code
17845 \begin_layout Plain Layout
17852 \begin_inset Quotes erd
17856 \begin_inset Quotes erd
17859 ] The command used to generate a list of floats of this type; the leading
17868 \begin_inset Flex Code
17871 \begin_layout Plain Layout
17877 is false, since there is no standard way to generate this command.
17879 \begin_inset Flex Code
17882 \begin_layout Plain Layout
17888 is true, since in that case there is a standard way to define the command.
17891 \begin_layout Description
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17902 \begin_inset Flex Code
17905 \begin_layout Plain Layout
17912 \begin_inset Quotes erd
17916 \begin_inset Quotes erd
17919 ] A title for a list of floats of this kind (list of figures, tables, or
17921 It is used for the screen label within \SpecialChar LyX
17922 , it is used by \SpecialChar LaTeX
17924 it is used as the title in the XHTML output.
17925 It will be translated to the document language.
17928 \begin_layout Description
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17949 \begin_inset Quotes erd
17953 \begin_inset Quotes erd
17956 ] This (optional) argument determines whether floats of this class will
17957 be numbered within some sectional unit of the document.
17959 \begin_inset Flex Code
17962 \begin_layout Plain Layout
17969 \begin_inset Quotes eld
17973 \begin_inset Flex Code
17976 \begin_layout Plain Layout
17983 \begin_inset Quotes erd
17986 , the floats will be numbered within chapters.
17990 \begin_layout Description
17991 \begin_inset Flex Code
17994 \begin_layout Plain Layout
18001 \begin_inset Flex Code
18004 \begin_layout Plain Layout
18011 \begin_inset Quotes erd
18015 \begin_inset Quotes erd
18018 ] The default placement for the given class of floats.
18019 The string should be as in standard \SpecialChar LaTeX
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18031 \begin_inset Flex Code
18034 \begin_layout Plain Layout
18041 \begin_inset Flex Code
18044 \begin_layout Plain Layout
18051 \begin_inset Flex Code
18054 \begin_layout Plain Layout
18060 for top, bottom, page, and here, respectively.
18064 \begin_layout Plain Layout
18065 Note that the order of these letters in the string is irrelevant, like in
18072 On top of that there is a new type,
18073 \begin_inset Flex Code
18076 \begin_layout Plain Layout
18082 , which does not really correspond to a float, since it means: put it
18083 \begin_inset Quotes eld
18087 \begin_inset Quotes erd
18091 Note however that the
18092 \begin_inset Flex Code
18095 \begin_layout Plain Layout
18101 specifier is special and, because of implementation details, cannot be
18102 used in non-built in float types.
18103 If you do not understand what this means, just use
18104 \begin_inset Quotes eld
18108 \begin_inset Flex Code
18111 \begin_layout Plain Layout
18118 \begin_inset Quotes erd
18124 \begin_layout Description
18125 \begin_inset Flex Code
18128 \begin_layout Plain Layout
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18144 ] The prefix to use when creating labels referring to floats of this type.
18145 This allows the use of formatted references.
18146 Note that you can remove any
18147 \begin_inset Flex Code
18150 \begin_layout Plain Layout
18156 set by a copied style by using the special value
18157 \begin_inset Quotes eld
18161 \begin_inset Quotes erd
18164 , which must be all caps.
18167 \begin_layout Description
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18178 \begin_inset Flex Code
18181 \begin_layout Plain Layout
18188 \begin_inset Quotes erd
18192 \begin_inset Quotes erd
18195 ] The style used when defining the float using
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18210 \begin_layout Description
18211 \begin_inset Flex Code
18214 \begin_layout Plain Layout
18221 \begin_inset Flex Code
18224 \begin_layout Plain Layout
18231 \begin_inset Quotes erd
18235 \begin_inset Quotes erd
18239 \begin_inset Quotes eld
18243 \begin_inset Quotes erd
18246 of the new class of floats, like program or algorithm.
18247 After the appropriate
18248 \begin_inset Flex Code
18251 \begin_layout Plain Layout
18260 \begin_inset Flex Code
18263 \begin_layout Plain Layout
18272 \begin_inset Flex Code
18275 \begin_layout Plain Layout
18286 \begin_layout Description
18287 \begin_inset Flex Code
18290 \begin_layout Plain Layout
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18307 \begin_inset space \thinspace{}
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18322 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18333 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18337 \begin_layout Standard
18338 Note that defining a float with type
18339 \begin_inset Flex Code
18342 \begin_layout Plain Layout
18350 automatically defines the corresponding counter with name
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18365 \begin_layout Subsection
18366 Flex insets and InsetLayout
18367 \begin_inset CommandInset label
18369 name "subsec:Flex-insets-and"
18376 \begin_layout Standard
18377 Flex insets come in three different kinds:
18380 \begin_layout Itemize
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18391 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18393 \begin_inset Flex Code
18396 \begin_layout Plain Layout
18405 \begin_inset Flex Code
18408 \begin_layout Plain Layout
18419 \begin_layout Itemize
18421 \begin_inset Flex Code
18424 \begin_layout Plain Layout
18430 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18432 footnote, and the like.
18433 An obvious example is an endnote inset, which is defined in the
18434 \begin_inset Flex Code
18437 \begin_layout Plain Layout
18446 \begin_layout Itemize
18448 \begin_inset Flex Code
18451 \begin_layout Plain Layout
18457 ): For use with DocBook classes.
18460 \begin_layout Standard
18461 Flex insets are defined using the
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18471 tag, which shall be explained in a moment.
18474 \begin_layout Standard
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 tag also serves another function: It can be used to customize the general
18486 layout of many different types of insets.
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18497 can be used to customize the layout parameters for footnotes, marginal
18498 notes, note insets, \SpecialChar TeX
18499 code (ERT) insets, branches, listings, indexes, boxes,
18500 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18503 \begin_layout Standard
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18514 definition must begin with a line of the form:
18517 \begin_layout LyX-Code
18521 \begin_layout Standard
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18532 indicates the inset whose layout is being defined, and here there are four
18536 \begin_layout Enumerate
18537 The layout for a pre-existing inset is being modified.
18538 In this case, can be
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18548 any one of the following:
18549 \begin_inset Flex Code
18552 \begin_layout Plain Layout
18559 \begin_inset Flex Code
18562 \begin_layout Plain Layout
18569 \begin_inset Flex Code
18572 \begin_layout Plain Layout
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18599 \begin_inset Flex Code
18602 \begin_layout Plain Layout
18609 \begin_inset Flex Code
18612 \begin_layout Plain Layout
18619 \begin_inset Flex Code
18622 \begin_layout Plain Layout
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18719 \begin_inset Flex Code
18722 \begin_layout Plain Layout
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18739 \begin_inset Flex Code
18742 \begin_layout Plain Layout
18751 \begin_layout Enumerate
18752 The layout for a Flex inset is being defined.
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18763 must be of the form
18764 \begin_inset Quotes eld
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18778 \begin_inset Quotes erd
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18791 may be be any valid identifier not used by a pre-existing Flex inset.
18792 The identifier may include spaces, but in that case the whole thing must
18793 be wrapped in quotes.
18794 Note that the definition of a flex inset
18799 \begin_inset Flex Code
18802 \begin_layout Plain Layout
18808 entry, declaring which type of inset it defines.
18811 \begin_layout Enumerate
18812 The layout for user specific branch is being defined.
18814 \begin_inset Flex Code
18817 \begin_layout Plain Layout
18823 must be of the form
18824 \begin_inset Quotes eld
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18838 \begin_inset Quotes erd
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18851 may be be any valid identifier of branch defined in user's document.
18852 The identifier may include spaces, but in that case the whole thing must
18853 be wrapped in quotes.
18854 The main purpose of this feature is to allow \SpecialChar LaTeX
18855 wrapping around specific
18856 branches as user needs.
18859 \begin_layout Enumerate
18860 The layout of a user (or class) specific caption is being defined.
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18871 must be of the form
18872 \begin_inset Quotes eld
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18886 \begin_inset Quotes erd
18890 \begin_inset Flex Code
18893 \begin_layout Plain Layout
18899 specifies the name of the caption as it appears in the menu.
18900 Have a look at the standard caption (
18901 \begin_inset Flex Code
18904 \begin_layout Plain Layout
18910 ), the specific captions of the KOMA-Script classes (
18911 \begin_inset Flex Code
18914 \begin_layout Plain Layout
18921 \begin_inset Flex Code
18924 \begin_layout Plain Layout
18933 \begin_inset space ~
18937 \begin_inset Newline linebreak
18943 \begin_inset Flex Code
18946 \begin_layout Plain Layout
18952 ) for applications.
18955 \begin_layout Standard
18957 \begin_inset Flex Code
18960 \begin_layout Plain Layout
18966 definition can contain the following entries:
18969 \begin_layout Description
18970 \begin_inset Flex Code
18973 \begin_layout Plain Layout
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18989 =""] This inset will appear in the table of contents of the given type.
18990 An empty string disables.
18991 See also the OutlinerName and the IsTocCaption commands.
18992 This is only implemented for Flex insets.
18996 \begin_layout Description
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19016 ] Defines argument number of a command\SpecialChar breakableslash
19017 environment associated with the current
19019 The definition must end with
19020 \begin_inset Flex Code
19023 \begin_layout Plain Layout
19031 \begin_inset CommandInset ref
19033 reference "subsec:Paragraph-Styles"
19040 \begin_layout Description
19041 \begin_inset Flex Code
19044 \begin_layout Plain Layout
19050 Preamble for changing language commands; see
19051 \begin_inset CommandInset ref
19053 reference "subsec:I18n"
19060 \begin_layout Description
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19071 \begin_inset Flex Code
19074 \begin_layout Plain Layout
19080 ] The color for the inset's background.
19082 \begin_inset CommandInset ref
19084 reference "chap:Names-of-colors"
19088 for a list of the available color names.
19091 \begin_layout Description
19092 \begin_inset Flex Code
19095 \begin_layout Plain Layout
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19114 \begin_inset space \thinspace{}
19118 \begin_inset Flex Code
19121 \begin_layout Plain Layout
19127 ] Whether to use the content of the inset as the label, when the inset is
19132 \begin_layout Description
19133 \begin_inset Flex Code
19136 \begin_layout Plain Layout
19143 \begin_inset Flex Code
19146 \begin_layout Plain Layout
19152 ] As with paragraph styles, see
19153 \begin_inset CommandInset ref
19155 reference "subsec:Paragraph-Styles"
19160 Note that you need to specify the complete type, e.
19161 \begin_inset space \thinspace{}
19165 \begin_inset space ~
19169 \begin_inset Flex Code
19172 \begin_layout Plain Layout
19173 CopyStyle Flex:<name>
19181 \begin_layout Description
19182 \begin_inset Flex Code
19185 \begin_layout Plain Layout
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19204 \begin_inset space \thinspace{}
19208 \begin_inset Flex Code
19211 \begin_layout Plain Layout
19217 ] Indicates whether the user may employ the Paragraph Settings dialog to
19218 customize the paragraph.
19221 \begin_layout Description
19222 \begin_inset Flex Code
19225 \begin_layout Plain Layout
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19242 \begin_inset Flex Code
19245 \begin_layout Plain Layout
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19261 , describing the rendering style used for the inset's frame and buttons.
19262 Footnotes generally use
19263 \begin_inset Flex Code
19266 \begin_layout Plain Layout
19272 , ERT insets generally
19273 \begin_inset Flex Code
19276 \begin_layout Plain Layout
19282 , and character styles
19283 \begin_inset Flex Code
19286 \begin_layout Plain Layout
19295 \begin_layout Description
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19306 \begin_inset Flex Code
19309 \begin_layout Plain Layout
19318 \begin_inset space \thinspace{}
19324 \begin_inset Flex Code
19327 \begin_layout Plain Layout
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 Indicates whether the environment will stand on its own in the output or
19357 will appear inline with the surrounding text.
19358 If set to false, it is supposed that the \SpecialChar LaTeX
19359 environment ignores white space
19360 (including one newline character) after the
19361 \begin_inset Flex Code
19364 \begin_layout Plain Layout
19377 \begin_inset Flex Code
19380 \begin_layout Plain Layout
19394 \change_inserted 731793113 1538674858
19398 \begin_layout Description
19400 \change_inserted 731793113 1538674891
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19406 \change_inserted 731793113 1538674863
19418 ,1] Allow the contents of the inset to be edited externally (using whatever
19419 editor is defined for the document's output format).
19424 \begin_layout Description
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19434 Required at the end of the
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19447 \begin_layout Description
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19457 The font used for both the text body
19463 \begin_inset CommandInset ref
19465 reference "subsec:Font-description"
19470 Note that defining this font automatically defines the
19471 \begin_inset Flex Code
19474 \begin_layout Plain Layout
19480 to the same value, so define this first and define
19481 \begin_inset Flex Code
19484 \begin_layout Plain Layout
19490 later if you want them to be different.
19493 \begin_layout Description
19494 \begin_inset Flex Code
19497 \begin_layout Plain Layout
19498 FixedWidthPreambleEncoding
19504 \begin_inset Flex Code
19507 \begin_layout Plain Layout
19516 \begin_inset space \thinspace{}
19520 \begin_inset Flex Code
19523 \begin_layout Plain Layout
19529 ] Force a fixed width encoding for the translated contents of
19530 \begin_inset Flex Code
19533 \begin_layout Plain Layout
19540 \begin_inset Flex Code
19543 \begin_layout Plain Layout
19549 code generated by this layout.
19550 This is needed for special \SpecialChar LaTeX
19555 that do not work with variable width encodings such as
19560 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19561 backends such as Xe\SpecialChar TeX
19563 Lua\SpecialChar TeX
19567 \begin_layout Description
19568 \begin_inset Flex Code
19571 \begin_layout Plain Layout
19572 ForceLocalFontSwitch
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19590 \begin_inset space \thinspace{}
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19603 ] When using babel, always use a local font switch (
19604 \begin_inset Flex Code
19607 \begin_layout Plain Layout
19615 ), never a global one (such as
19616 \begin_inset Flex Code
19619 \begin_layout Plain Layout
19630 \begin_layout Description
19631 \begin_inset Flex Code
19634 \begin_layout Plain Layout
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19653 \begin_inset space \thinspace{}
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19667 \begin_inset Quotes eld
19671 \begin_inset Quotes erd
19674 language, leading to Left-to-Right (Latin) output, e.
19675 \begin_inset space \thinspace{}
19679 \begin_inset space \space{}
19682 in \SpecialChar TeX
19687 \begin_layout Description
19688 \begin_inset Flex Code
19691 \begin_layout Plain Layout
19698 \begin_inset Flex Code
19701 \begin_layout Plain Layout
19710 \begin_inset space \thinspace{}
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19723 ] Force a a line break in the \SpecialChar LaTeX
19724 output before the inset starts and after
19726 This assures the inset itself is output on its own lines, for parsing purposes.
19729 \begin_layout Description
19730 \begin_inset Flex Code
19733 \begin_layout Plain Layout
19740 \begin_inset Flex Code
19743 \begin_layout Plain Layout
19752 \begin_inset space \thinspace{}
19756 \begin_inset Flex Code
19759 \begin_layout Plain Layout
19765 ] Indicates whether the
19766 \begin_inset Flex Code
19769 \begin_layout Plain Layout
19775 should be used or, instead, the user can change the paragraph style used
19780 \begin_layout Description
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19791 \begin_inset Flex Code
19794 \begin_layout Plain Layout
19803 \begin_inset space \thinspace{}
19807 \begin_inset Flex Code
19810 \begin_layout Plain Layout
19816 ] As with paragraph styles, see
19817 \begin_inset CommandInset ref
19819 reference "subsec:Paragraph-Styles"
19826 \begin_layout Description
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19836 These tags control the XHTML output.
19838 \begin_inset CommandInset ref
19840 reference "sec:Tags-for-XHTML"
19847 \begin_layout Description
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19870 \begin_inset space \thinspace{}
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19883 ] Whether to include the contents of this inset in the strings generated
19884 for the `Outline' pane for all table of contents, regardless of the AddToToc
19886 One would not, for example, want the content of a footnote in a section
19887 header to be included in the TOC displayed in the outline, but one would
19888 normally want the content of a character style displayed.
19889 Default is false: not to include.
19892 \begin_layout Description
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19903 \begin_inset Flex Code
19906 \begin_layout Plain Layout
19915 \begin_inset space \thinspace{}
19919 \begin_inset Flex Code
19922 \begin_layout Plain Layout
19928 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19929 of its contents in its item in the table of contents.
19930 Otherwise, only the label appears.
19933 \begin_layout Description
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19958 \begin_inset space \thinspace{}
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19971 ] As with paragraph styles, see
19972 \begin_inset CommandInset ref
19974 reference "subsec:Paragraph-Styles"
19981 \begin_layout Description
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19991 The font used for the label.
19993 \begin_inset CommandInset ref
19995 reference "subsec:Font-description"
20000 Note that this definition can never appear before
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20010 , lest it be ineffective.
20013 \begin_layout Description
20014 \begin_inset Flex Code
20017 \begin_layout Plain Layout
20024 \begin_inset Flex Code
20027 \begin_layout Plain Layout
20034 \begin_inset Quotes erd
20038 \begin_inset Quotes erd
20041 ] What will be displayed on the button or elsewhere as the inset label.
20043 \begin_inset Flex Code
20046 \begin_layout Plain Layout
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20063 ) modify this label on the fly.
20066 \begin_layout Description
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20076 Language dependent preamble; see
20077 \begin_inset CommandInset ref
20079 reference "subsec:I18n"
20086 \begin_layout Description
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20097 \begin_inset Flex Code
20100 \begin_layout Plain Layout
20106 ] The name of the corresponding \SpecialChar LaTeX
20108 Either the environment or command name.
20111 \begin_layout Description
20112 \begin_inset Flex Code
20115 \begin_layout Plain Layout
20122 \begin_inset Flex Code
20125 \begin_layout Plain Layout
20131 ] The optional parameter for the corresponding
20132 \begin_inset Flex Code
20135 \begin_layout Plain Layout
20141 stuff, including possible bracket pairs like
20142 \begin_inset Flex Code
20145 \begin_layout Plain Layout
20152 This parameter cannot be changed from within \SpecialChar LyX
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20163 for customizable parameters).
20164 It will be output as is after all \SpecialChar LaTeX
20166 \begin_inset Flex Code
20169 \begin_layout Plain Layout
20178 \begin_layout Description
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20193 Command, Environment, None
20198 ] How the style should be translated into \SpecialChar LaTeX
20203 \begin_layout Plain Layout
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20213 is perhaps a bit misleading, since these rules apply to SGML classes too.
20214 Visit the SGML class files for specific examples.
20223 \begin_layout Description
20224 \begin_inset Flex Code
20227 \begin_layout Plain Layout
20233 means nothing special
20236 \begin_layout Description
20237 \begin_inset Flex Code
20240 \begin_layout Plain Layout
20247 \begin_inset Flex Code
20250 \begin_layout Plain Layout
20257 {\SpecialChar ldots
20266 \begin_layout Description
20267 \begin_inset Flex Code
20270 \begin_layout Plain Layout
20277 \begin_inset Flex Code
20280 \begin_layout Plain Layout
20287 }\SpecialChar ldots
20302 \begin_layout Standard
20303 Putting the last few things together, the \SpecialChar LaTeX
20304 output will be either:
20307 \begin_layout LyX-Code
20310 LatexName[LatexParam]{\SpecialChar ldots
20314 \begin_layout Standard
20318 \begin_layout LyX-Code
20321 begin{LatexName}[LatexParam] \SpecialChar ldots
20327 \begin_layout Standard
20328 depending upon the \SpecialChar LaTeX
20333 \begin_layout Description
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20353 ] A string that is put at the beginning of the layout content.
20354 A line break in the output can be indicated by
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20367 \begin_layout Description
20368 \begin_inset Flex Code
20371 \begin_layout Plain Layout
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20398 \begin_inset Flex Code
20401 \begin_layout Plain Layout
20408 \begin_inset Flex Code
20411 \begin_layout Plain Layout
20417 (indicating a dummy definition ending definitions of charstyles, etc).
20418 This entry is required in and is only meaningful for Flex insets.
20419 Among other things, it determines on which menu this inset will appear.
20421 \begin_inset Flex Code
20424 \begin_layout Plain Layout
20431 \begin_inset Flex Code
20434 \begin_layout Plain Layout
20440 will automatically set
20441 \begin_inset Flex Code
20444 \begin_layout Plain Layout
20451 \begin_inset Flex Code
20454 \begin_layout Plain Layout
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20471 can be set to true, or
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20491 insets by setting it
20496 \begin_inset Flex Code
20499 \begin_layout Plain Layout
20506 \change_inserted -712698321 1555575738
20510 \begin_layout Description
20512 \change_inserted -712698321 1555575844
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20518 \change_inserted -712698321 1555575740
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20530 \change_inserted -712698321 1555575740
20536 A dedicated string for the menu.
20537 You can define an accelerator by appending the respective character to
20538 the string, divided by
20539 \begin_inset Quotes eld
20543 \begin_inset Quotes erd
20547 \begin_inset space \thinspace{}
20551 \begin_inset space \space{}
20555 \begin_inset Quotes eld
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20564 \change_inserted -712698321 1555575781
20571 \begin_inset Quotes erd
20575 This specification is optional.
20576 If it is not given the inset name as specified in the type declaration
20577 will be used instead for the menu.
20582 \begin_layout Description
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20593 \begin_inset Flex Code
20596 \begin_layout Plain Layout
20605 \begin_inset space \thinspace{}
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20618 ] Whether multiple paragraphs are permitted in this inset.
20620 \begin_inset Flex Code
20623 \begin_layout Plain Layout
20629 to the same value and
20630 \begin_inset Flex Code
20633 \begin_layout Plain Layout
20639 to the opposite value.
20640 These can be reset to other values, if they are used
20645 \begin_inset Flex Code
20648 \begin_layout Plain Layout
20658 \begin_layout Description
20659 \begin_inset Flex Code
20662 \begin_layout Plain Layout
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20681 \begin_inset space \thinspace{}
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20694 ] Whether fragile commands in this inset should be
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20711 whether the command should itself be protected.) Default is false.
20712 \change_inserted -712698321 1523633958
20716 \begin_layout Description
20718 \change_inserted -712698321 1552395786
20719 \begin_inset Flex Code
20722 \begin_layout Plain Layout
20724 \change_inserted -712698321 1523633961
20731 \begin_inset Flex Code
20734 \begin_layout Plain Layout
20736 \change_inserted -712698321 1523633958
20745 \begin_inset space \thinspace{}
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20754 \change_inserted -712698321 1523633958
20760 ] This causes macros that contain this inset to be protected with
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20766 \change_inserted -712698321 1523634038
20781 ) if necessary and thus allows (some) verbatim stuff in macros.
20785 \begin_layout Description
20787 \change_inserted -712698321 1555579651
20788 \begin_inset Flex Code
20791 \begin_layout Plain Layout
20793 \change_inserted -712698321 1552395787
20800 \begin_inset Flex Code
20803 \begin_layout Plain Layout
20805 \change_inserted -712698321 1552395787
20814 \begin_inset space \thinspace{}
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20823 \change_inserted -712698321 1552395787
20829 ] Whether specific commands in this inset (such as
20830 \begin_inset Flex Code
20833 \begin_layout Plain Layout
20835 \change_inserted -712698321 1552395787
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20849 \change_inserted -712698321 1552395787
20857 ) should be protected in an
20858 \begin_inset Flex Code
20861 \begin_layout Plain Layout
20863 \change_inserted -712698321 1552395787
20872 This is particularly needed for insets that draw on
20880 commands which parse their content in complex ways.
20884 \begin_layout Description
20886 \change_inserted -712698321 1555579742
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20892 \change_inserted -712698321 1555579658
20899 \begin_inset Flex Code
20902 \begin_layout Plain Layout
20904 \change_inserted -712698321 1555579651
20910 Option to define a different command (from the default
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20916 \change_inserted -712698321 1555579742
20928 ) to be used for line breaks.
20929 The initial backslash must not be specified.
20934 \begin_layout Description
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20954 ] Deletes an existing
20955 \begin_inset Flex Code
20958 \begin_layout Plain Layout
20967 \begin_layout Description
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20997 that has replaced this
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21008 This is used to rename an
21009 \begin_inset Flex Code
21012 \begin_layout Plain Layout
21018 , while keeping backward compatibility.
21019 \change_inserted -712698321 1559491850
21023 \begin_layout Description
21025 \change_inserted -712698321 1559492002
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21031 \change_inserted -712698321 1559491854
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21043 \change_inserted -712698321 1559491850
21052 \begin_inset space \thinspace{}
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21061 \change_inserted -712698321 1559491850
21067 ] If this is set to
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21073 \change_inserted -712698321 1559491881
21081 , paragraph breaks will be ignored in the output.
21082 This might be useful for insets where the content should be alignable on
21083 different lines only in the \SpecialChar LyX
21084 workarea, without any effect in the output.
21089 \begin_layout Description
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21112 \begin_inset space \thinspace{}
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21125 ] As with paragraph styles, see
21126 \begin_inset CommandInset ref
21128 reference "subsec:Paragraph-Styles"
21136 \begin_layout Description
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21159 \begin_inset space \thinspace{}
21163 \begin_inset Flex Code
21166 \begin_layout Plain Layout
21172 ] As with paragraph styles, see
21173 \begin_inset CommandInset ref
21175 reference "subsec:Paragraph-Styles"
21183 \begin_layout Description
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21193 As with paragraph styles, see
21194 \begin_inset CommandInset ref
21196 reference "subsec:Paragraph-Styles"
21203 \begin_layout Description
21204 \begin_inset Flex Code
21207 \begin_layout Plain Layout
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21223 ] The prefix to use when creating labels referring to insets of this type.
21224 This allows the use of formatted references.
21227 \begin_layout Description
21228 \begin_inset Flex Code
21231 \begin_layout Plain Layout
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21247 ] As with paragraph styles, see
21248 \begin_inset CommandInset ref
21250 reference "subsec:Paragraph-Styles"
21257 \begin_layout Description
21258 \begin_inset Flex Code
21261 \begin_layout Plain Layout
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21280 \begin_inset space \thinspace{}
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21293 ] Resets the \SpecialChar LaTeX
21294 arguments of this layout (as defined via the
21295 \begin_inset Flex Code
21298 \begin_layout Plain Layout
21305 This is useful if you have copied a style via
21306 \begin_inset Flex Code
21309 \begin_layout Plain Layout
21315 , but you do not want to inherit its (required and optional) arguments.
21318 \begin_layout Description
21319 \begin_inset Flex Code
21322 \begin_layout Plain Layout
21329 \begin_inset Flex Code
21332 \begin_layout Plain Layout
21339 \begin_inset space \thinspace{}
21343 \begin_inset Flex Code
21346 \begin_layout Plain Layout
21354 ] Whether this inset should use the font of its surrounding environment
21356 Default is false: use the font of the surrounding environment.
21359 \begin_layout Description
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21379 ] A string that is put at the end of the layout content.
21380 A line break in the output can be indicated by
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21393 \begin_layout Description
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21414 \begin_inset space \thinspace{}
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21429 ] Allow spell-checking the contents of this inset.
21433 \begin_layout Subsection
21435 \begin_inset CommandInset label
21437 name "subsec:Counters"
21444 \begin_layout Standard
21445 It is necessary to define the counters (
21446 \begin_inset Flex Noun
21449 \begin_layout Plain Layout
21456 \begin_inset Flex Noun
21459 \begin_layout Plain Layout
21465 , \SpecialChar ldots
21466 ) in the text class itself.
21467 The standard counters are defined in the file
21468 \begin_inset Flex Code
21471 \begin_layout Plain Layout
21477 , so you may have to do no more than add
21480 \begin_layout LyX-Code
21481 Input stdcounters.inc
21484 \begin_layout Standard
21485 to your layout file to get them to work.
21486 But if you want to define custom counters, then you can do so.
21487 The counter declaration must begin with:
21490 \begin_layout LyX-Code
21491 Counter CounterName
21494 \begin_layout Standard
21496 \begin_inset Flex Code
21499 \begin_layout Plain Layout
21505 ' is replaced by the name of the counter.
21506 And it must end with
21507 \begin_inset Quotes eld
21511 \begin_inset Flex Code
21514 \begin_layout Plain Layout
21521 \begin_inset Quotes erd
21525 The following parameters can also be used:
21528 \begin_layout Description
21529 \begin_inset Flex Code
21532 \begin_layout Plain Layout
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21548 ] Sets the initial value for the counter, to which it will be reset whenever
21550 Normally, one will want the default, 1.
21553 \begin_layout Description
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21564 \begin_inset Flex Code
21567 \begin_layout Plain Layout
21574 \begin_inset Quotes erd
21578 \begin_inset Quotes erd
21581 ] When defined, this string defines how the counter is displayed.
21582 Setting this value sets
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21587 LabelStringAppendix
21593 The following special constructs can be used in the string:
21597 \begin_layout Itemize
21598 \begin_inset Flex Code
21601 \begin_layout Plain Layout
21609 will be replaced by the expansion of the
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21620 \begin_inset Flex Code
21623 \begin_layout Plain Layout
21624 LabelStringAppendix
21630 \begin_inset Flex Code
21633 \begin_layout Plain Layout
21643 \begin_layout Itemize
21644 counter values can be expressed using \SpecialChar LaTeX
21646 \begin_inset Newline newline
21650 \begin_inset Flex Code
21653 \begin_layout Plain Layout
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21685 \begin_layout Plain Layout
21695 Actually, the situation is a bit more complicated: any
21714 other than those described below will produce arabic numerals.
21715 It would not be surprising to see this change in the future.
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21730 : 1, 2, 3,\SpecialChar ldots
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21741 for lower-case letters: a, b, c, \SpecialChar ldots
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21752 for upper-case letters: A, B, C, \SpecialChar ldots
21754 \begin_inset Flex Code
21757 \begin_layout Plain Layout
21763 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21765 \begin_inset Flex Code
21768 \begin_layout Plain Layout
21774 for upper-case roman numerals: I, II, III\SpecialChar ldots
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21785 for hebrew numerals.
21789 \begin_layout Standard
21790 If LabelString is not defined, a default value is constructed as follows:
21791 if the counter has a master counter
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21802 \begin_inset Flex Code
21805 \begin_layout Plain Layout
21812 \begin_inset Newline newline
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21829 is used; otherwise the string
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21844 \begin_layout Description
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21849 LabelStringAppendix
21855 \begin_inset Flex Code
21858 \begin_layout Plain Layout
21865 \begin_inset Quotes erd
21869 \begin_inset Quotes erd
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21882 , but for use in the Appendix.
21885 \begin_layout Description
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21896 \begin_inset Flex Code
21899 \begin_layout Plain Layout
21906 \begin_inset Quotes erd
21910 \begin_inset Quotes erd
21913 ] A format for use with formatted references to this counter.
21914 For example, one might want to have references to section numbers appear
21916 \begin_inset Quotes eld
21920 \begin_inset Quotes erd
21924 The string should contain
21925 \begin_inset Quotes eld
21929 \begin_inset Quotes erd
21933 This will be replaced by the counter number itself.
21934 So, for sections, it would be: Section ##.
21937 \begin_layout Description
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21958 \begin_inset Quotes erd
21962 \begin_inset Quotes erd
21965 ] If this is set to the name of another counter, the present counter will
21966 be reset every time the other one is increased.
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21978 \begin_inset Flex Code
21981 \begin_layout Plain Layout
21990 \begin_layout Subsection
21992 \begin_inset CommandInset label
21994 name "subsec:Font-description"
22001 \begin_layout Standard
22002 A font description looks like this:
22005 \begin_layout LyX-Code
22022 \begin_layout LyX-Code
22026 \begin_layout LyX-Code
22030 \begin_layout Standard
22031 The following commands are available:
22034 \begin_layout Description
22035 \begin_inset Flex Code
22038 \begin_layout Plain Layout
22045 \begin_inset Flex Code
22048 \begin_layout Plain Layout
22057 \begin_inset Flex Code
22060 \begin_layout Plain Layout
22067 \begin_inset Flex Code
22070 \begin_layout Plain Layout
22077 \begin_inset Flex Code
22080 \begin_layout Plain Layout
22087 \begin_inset Flex Code
22090 \begin_layout Plain Layout
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22117 \begin_inset Flex Code
22120 \begin_layout Plain Layout
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22137 \begin_inset Flex Code
22140 \begin_layout Plain Layout
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22187 \begin_inset Flex Code
22190 \begin_layout Plain Layout
22197 \begin_inset Flex Code
22200 \begin_layout Plain Layout
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22217 \begin_inset Flex Code
22220 \begin_layout Plain Layout
22227 \begin_inset Flex Code
22230 \begin_layout Plain Layout
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22249 \begin_layout Description
22250 \begin_inset Flex Code
22253 \begin_layout Plain Layout
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22272 \begin_inset Flex Code
22275 \begin_layout Plain Layout
22282 \begin_inset Flex Code
22285 \begin_layout Plain Layout
22294 \begin_layout Description
22295 \begin_inset Flex Code
22298 \begin_layout Plain Layout
22305 \begin_inset Flex Code
22308 \begin_layout Plain Layout
22314 ] Valid arguments are:
22315 \begin_inset Flex Code
22318 \begin_layout Plain Layout
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22385 \begin_inset Flex Code
22388 \begin_layout Plain Layout
22395 \begin_inset Flex Code
22398 \begin_layout Plain Layout
22405 \begin_inset Flex Code
22408 \begin_layout Plain Layout
22415 \begin_inset Flex Code
22418 \begin_layout Plain Layout
22425 \begin_inset Flex Code
22428 \begin_layout Plain Layout
22435 Each of these turns on or off the corresponding attribute.
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22446 turns on emphasis, and
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22458 \begin_inset Newline newline
22461 If the latter seems puzzling, remember that the font settings for the present
22462 context are generally inherited from the surrounding context.
22464 \begin_inset Flex Code
22467 \begin_layout Plain Layout
22473 would turn off the emphasis that was anyway in effect, say, in a theorem
22477 \begin_layout Description
22478 \begin_inset Flex Code
22481 \begin_layout Plain Layout
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22500 \begin_inset Flex Code
22503 \begin_layout Plain Layout
22512 \begin_layout Description
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22535 \begin_inset Flex Code
22538 \begin_layout Plain Layout
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22567 \begin_layout Description
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22578 \begin_inset Flex Code
22581 \begin_layout Plain Layout
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22620 \begin_inset Flex Code
22623 \begin_layout Plain Layout
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22640 \begin_inset Flex Code
22643 \begin_layout Plain Layout
22650 \begin_inset Flex Code
22653 \begin_layout Plain Layout
22662 \begin_layout Subsection
22663 \begin_inset CommandInset label
22665 name "subsec:Citation-engine-description"
22669 Cite engine description
22672 \begin_layout Standard
22674 \begin_inset Flex Code
22677 \begin_layout Plain Layout
22683 blocks, as used mainly in cite engine files (see
22684 \begin_inset CommandInset ref
22686 reference "subsec:Cite-Engine-Files"
22693 ), define the citation commands provided by a specific
22694 \begin_inset Quotes eld
22698 \begin_inset Quotes erd
22702 A cite engine, in \SpecialChar LyX
22703 terms, is way specific way to format citations, using
22704 numbers, author names and/or years.
22705 Currently, \SpecialChar LyX
22706 supports three such engine types, namely:
22709 \begin_layout Enumerate
22710 \begin_inset Flex Code
22713 \begin_layout Plain Layout
22719 : the default Bib\SpecialChar TeX
22720 way to format citations, a simple numeric style (e.
22721 \begin_inset space \thinspace{}
22725 \begin_inset Quotes eld
22729 \begin_inset Quotes erd
22735 \begin_layout Enumerate
22736 \begin_inset Flex Code
22739 \begin_layout Plain Layout
22745 : Harvard-styled citations using author names and publication year (e.
22746 \begin_inset space \thinspace{}
22750 \begin_inset Quotes eld
22753 Smith and Miller (2017b)
22754 \begin_inset Quotes erd
22760 \begin_layout Enumerate
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22770 : extended numerical citations that also allow for author or title next
22772 \begin_inset space \thinspace{}
22776 \begin_inset Quotes eld
22779 Smith and Miller [1]
22780 \begin_inset Quotes erd
22786 \begin_layout Standard
22787 \begin_inset Flex Code
22790 \begin_layout Plain Layout
22796 blocks look like this:
22799 \begin_layout LyX-Code
22803 \begin_layout LyX-Code
22807 \begin_layout LyX-Code
22811 \begin_layout LyX-Code
22812 citeyearpar[][]=parencite*
22815 \begin_layout LyX-Code
22819 \begin_layout LyX-Code
22823 \begin_layout Standard
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22834 denotes the engine.
22835 The individual lines respectively define a cite command or cite command
22836 paradigm supported by this engine.
22837 The line can be as simple as a cite command that is used both to name the
22838 respective \SpecialChar LyX
22839 command and the \SpecialChar LaTeX
22840 output or more complex in order to differentiate
22842 The full syntax is:
22845 \begin_layout LyX-Code
22846 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
22849 \begin_layout Itemize
22850 \begin_inset Flex Code
22853 \begin_layout Plain Layout
22859 : The name as used in the
22860 \begin_inset Flex Code
22863 \begin_layout Plain Layout
22873 \begin_layout Standard
22874 For portability reasons, we try to use the same name for same-formatted
22875 commands in different cite packages (thus many names stem from natbib,
22876 and thus we need to differentiate a
22877 \begin_inset Flex Code
22880 \begin_layout Plain Layout
22886 sometimes, if the \SpecialChar LaTeX
22887 command names differ).
22891 \begin_layout Itemize
22892 \begin_inset Flex Code
22895 \begin_layout Plain Layout
22901 : a (comma-separated) list of commands that fall back to the given
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22911 in the current engine.
22912 This eases the switch of citation packages and engines.
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22933 in layout definitions.
22936 \begin_layout Itemize
22937 \begin_inset Flex Code
22940 \begin_layout Plain Layout
22946 : The actual \SpecialChar LaTeX
22947 command that is output.
22951 \begin_layout Standard
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22973 \begin_inset Flex Code
22976 \begin_layout Plain Layout
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22992 will be output to \SpecialChar LaTeX
22996 \begin_layout Standard
23000 \begin_layout Itemize
23001 Capitalization indicates that the command also has a capitalized form (
23002 \begin_inset Flex Code
23005 \begin_layout Plain Layout
23015 \begin_inset Flex Code
23018 \begin_layout Plain Layout
23027 These usually enforce up-casing of name prefixes (
23032 \begin_inset Formula $\Rightarrow$
23042 \begin_layout Itemize
23044 \begin_inset Flex Code
23047 \begin_layout Plain Layout
23053 indicate the number of optional arguments (there can be 0–2).
23056 \begin_layout Itemize
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23067 indicates there is a starred version of the command (
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23081 \begin_inset Flex Code
23084 \begin_layout Plain Layout
23097 \begin_layout Standard
23098 By default, the starred version means: Output all authors even if it should
23100 \begin_inset Quotes eld
23104 \begin_inset Quotes erd
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23120 \begin_layout Standard
23121 If the star has a different meaning for a given command, it can be specified
23123 \begin_inset Flex Code
23126 \begin_layout Plain Layout
23127 <!_stardesc!_stardesctooltip>
23133 Maximal two translatable macro keywords, marked by the prefix
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23144 The first points to the string that replaces the
23145 \begin_inset Quotes eld
23149 \begin_inset Quotes erd
23152 checkbox label in the citation dialog, the second one to an optional tool
23153 tip for this checkbox.
23157 \begin_layout Standard
23158 Note that these two macros have to be defined in a
23159 \begin_inset Flex Code
23162 \begin_layout Plain Layout
23168 (see next section), dropping the
23169 \begin_inset Flex Code
23172 \begin_layout Plain Layout
23178 from the prefix, like this:
23181 \begin_layout LyX-Code
23182 _stardesc Sta&rred command label
23185 \begin_layout LyX-Code
23186 _stardesctooltip Tooltip for the starred command checkbox.
23190 \begin_layout Itemize
23192 \begin_inset Flex Code
23195 \begin_layout Plain Layout
23201 indicates that this command features
23202 \begin_inset Quotes eld
23205 qualified citation lists
23206 \begin_inset Quotes erd
23214 -specific feature for multi-reference citations where an individual pre-
23215 and postnote can be given to each reference in the list.
23216 Please refer to the
23220 manual for details.
23221 \change_inserted -712698321 1526898670
23225 \begin_layout Standard
23227 \change_inserted -712698321 1526899524
23228 If you want to add a cite command to a cite engine (e.
23229 \begin_inset space \thinspace{}
23232 g., add a specific command provided by a class), you can use
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23238 \change_inserted -712698321 1526898768
23239 AddToCiteEngine <engine type> \SpecialChar ldots
23248 Note that only cite commands that do not exist yet are added.
23253 \begin_layout Subsection
23254 \begin_inset CommandInset label
23256 name "subsec:Citation-format-description"
23260 Cite format description
23263 \begin_layout Standard
23265 \begin_inset Flex Code
23268 \begin_layout Plain Layout
23274 blocks are used to describe how bibliographic information should be displayed,
23275 both within \SpecialChar LyX
23276 itself (in the citation dialog and in tooltips, for example)
23277 and in XHTML output.
23278 Such a block might look like this:
23281 \begin_layout LyX-Code
23285 \begin_layout LyX-Code
23289 \begin_layout LyX-Code
23293 \begin_layout LyX-Code
23297 \begin_layout Standard
23301 \begin_layout LyX-Code
23305 \begin_layout LyX-Code
23309 \begin_layout LyX-Code
23313 \begin_layout LyX-Code
23317 \begin_layout Standard
23318 In the first case, the individual lines define how the bibliographic information
23319 associated with an article or book, respectively, is to be displayed, and
23320 such a definition can be given for any
23321 \begin_inset Quotes els
23325 \begin_inset Quotes ers
23328 that might be present in a Bib\SpecialChar TeX
23331 defines a default format in the source code that will be used if no specific
23332 definition has been given.
23334 predefines several formats in the file
23335 \begin_inset Flex Code
23338 \begin_layout Plain Layout
23344 , which is included in most of \SpecialChar LyX
23345 's document classes.
23348 \begin_layout Standard
23349 In the second case, the lines define how a specific citation command (in
23351 \begin_inset Flex Code
23354 \begin_layout Plain Layout
23363 \begin_inset Flex Code
23366 \begin_layout Plain Layout
23374 ) is to be displayed on the citation inset label, in the citation dialog,
23375 menu or XHTML output.
23377 defines such formats for the citation style variants it supports via
23379 Document\SpecialChar menuseparator
23380 Setting\SpecialChar menuseparator
23381 Bibliography\SpecialChar ldots
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23394 files that are shipped with \SpecialChar LyX
23396 \begin_inset CommandInset ref
23398 reference "subsec:Cite-Engine-Files"
23408 \begin_layout Standard
23409 The definitions use a simple language that allows Bib\SpecialChar TeX
23410 keys to be replaced
23412 Keys should be enclosed in
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23433 So a simple definition might look like this:
23436 \begin_layout LyX-Code
23438 \begin_inset Quotes eld
23442 \begin_inset Quotes erd
23448 \begin_layout Standard
23449 This would print the author, followed by a comma, followed by the title,
23450 in quotes, followed by a period.
23453 \begin_layout Standard
23454 Of course, sometimes you may want to print a key only if it exists.
23455 This can be done by using a conditional construction, such as:
23456 \begin_inset Flex Code
23459 \begin_layout Plain Layout
23461 \begin_inset space ~
23471 \begin_inset Flex Code
23474 \begin_layout Plain Layout
23480 key exists, then print
23481 \begin_inset Quotes eld
23485 \begin_inset space ~
23489 \begin_inset Quotes erd
23492 followed by the volume key.
23493 It is also possible to have an else clause in the conditional, such as:
23494 \begin_inset Newline newline
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23502 {%author%[[%author%]][[%editor%, ed.]]}
23508 \begin_inset Newline newline
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23521 key is printed if it exists; otherwise, the editor key is printed, followed
23523 \begin_inset Quotes eld
23527 \begin_inset space ~
23531 \begin_inset Quotes erd
23534 Note that the key is again enclosed in
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23544 signs; the entire conditional is enclosed in braces; and the if and else
23545 clauses are enclosed in double brackets,
23546 \begin_inset Quotes eld
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23560 \begin_inset Quotes eld
23564 \begin_inset Quotes eld
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23578 \begin_inset Quotes erd
23582 There must be no space between any of these.
23585 \begin_layout Standard
23586 Next to the entry keys, there are some special keys that can be used for
23587 these conditionals:
23590 \begin_layout Itemize
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23595 {%dialog%[[true]][[false]]}
23601 \begin_inset Quotes eld
23605 \begin_inset Quotes erd
23608 part for dialogs and menus, the
23609 \begin_inset Quotes eld
23613 \begin_inset Quotes erd
23616 part for other contexts (workarea, export)
23619 \begin_layout Itemize
23620 \begin_inset Flex Code
23623 \begin_layout Plain Layout
23624 {%export%[[true]][[false]]}
23630 \begin_inset Quotes eld
23634 \begin_inset Quotes erd
23637 part for export and menus, the
23638 \begin_inset Quotes eld
23642 \begin_inset Quotes erd
23645 part for other contexts (workarea, dialog)
23648 \begin_layout Itemize
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23659 \begin_inset Quotes eld
23663 \begin_inset Quotes erd
23666 part if another item follows (e.
23667 \begin_inset space \thinspace{}
23670 g., in a citation with multiple keys)
23673 \begin_layout Itemize
23674 \begin_inset Flex Code
23677 \begin_layout Plain Layout
23678 {%second%[[true]][[false]]}
23684 \begin_inset Quotes eld
23688 \begin_inset Quotes erd
23691 if this is the second of multiple items, else the
23692 \begin_inset Quotes eld
23696 \begin_inset Quotes erd
23702 \begin_layout Itemize
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23707 {%ifstar%[[true]][[false]]}
23713 \begin_inset Quotes eld
23717 \begin_inset Quotes erd
23720 part for starred citation commands (such as
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23732 ), the false part for unstarred
23735 \begin_layout Itemize
23736 \begin_inset Flex Code
23739 \begin_layout Plain Layout
23740 {%ifentrytype:<type>%[[true]][[false]]}
23746 \begin_inset Quotes eld
23750 \begin_inset Quotes erd
23753 if the current entry type matches
23754 \begin_inset Flex Code
23757 \begin_layout Plain Layout
23763 , else the false part (e.g., in a citation definition:
23764 \begin_inset Flex Code
23767 \begin_layout Plain Layout
23768 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23776 \begin_layout Itemize
23777 \begin_inset Flex Code
23780 \begin_layout Plain Layout
23781 {%ifmultiple:<authortype>%[[true]][[false]]}
23787 \begin_inset Quotes eld
23791 \begin_inset Quotes erd
23794 if the current author type (author, editor etc.) has multiple authors, else
23795 the false part (e.g., in a bibliography definition:
23796 \begin_inset Flex Code
23799 \begin_layout Plain Layout
23800 {%ifmultiple:editor%[[eds.]][[ed.]]}
23808 \begin_layout Itemize
23809 \begin_inset Flex Code
23812 \begin_layout Plain Layout
23813 {%ifqualified%[[true]][[false]]}
23819 \begin_inset Quotes eld
23823 \begin_inset Quotes erd
23826 part if the current citation is a qualified citation list (a specific
23830 format for multi-reference citations), the false part if this is not the
23834 \begin_layout Standard
23836 \begin_inset Flex Code
23839 \begin_layout Plain Layout
23845 prints the author key as it is recorded in the bibliography file.
23846 This might not be what you want, since it will result in a string such
23848 \begin_inset Quotes eld
23851 Miller, Peter and Smith, Mary and White, Jane
23852 \begin_inset Quotes erd
23856 \begin_inset Quotes eld
23860 \begin_inset Quotes erd
23863 is used by Bib\SpecialChar TeX
23864 to delimit authors).
23866 therefore provides some methods to get properly formatted name lists (which
23867 will also get translated).
23868 The following keys are provided:
23871 \begin_layout Enumerate
23872 For name lists with pre- and surname, suitable for the main authors/editors
23873 of a bibliography item.
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23884 part denotes the kind of list that is requested (e.g.
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23899 \begin_layout Itemize
23900 \begin_inset Flex Code
23903 \begin_layout Plain Layout
23904 %abbrvnames:<nametype>%
23909 : Provides a name list which is abbreviated (with
23910 \begin_inset Quotes eld
23914 \begin_inset Quotes erd
23918 \begin_inset Flex Code
23921 \begin_layout Plain Layout
23930 \begin_layout Itemize
23931 \begin_inset Flex Code
23934 \begin_layout Plain Layout
23935 %fullnames:<nametype>%
23940 : Provides a full name list (never abbreviated with
23941 \begin_inset Quotes eld
23945 \begin_inset Quotes erd
23951 \begin_layout Itemize
23952 \begin_inset Flex Code
23955 \begin_layout Plain Layout
23956 %forceabbrvnames:<nametype>%
23961 : Provides a name list which is always abbreviated (with
23962 \begin_inset Quotes eld
23966 \begin_inset Quotes erd
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23983 \begin_layout Enumerate
23984 Alternative name lists with pre- and surname, if the order of pre- and surname
23985 inside the bibliography item differs (as in:
23986 \begin_inset Quotes eld
23989 Miller, John: Some text, in: Mary Smith, ed.: A volume
23990 \begin_inset Quotes erd
23997 \begin_layout Itemize
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24002 %abbrvbynames:<nametype>%
24007 : Provides a name list which is abbreviated (with
24008 \begin_inset Quotes eld
24012 \begin_inset Quotes erd
24016 \begin_inset Flex Code
24019 \begin_layout Plain Layout
24028 \begin_layout Itemize
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24033 %fullbynames:<nametype>%
24038 : Provides a full name list (never abbreviated with
24039 \begin_inset Quotes eld
24043 \begin_inset Quotes erd
24049 \begin_layout Itemize
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24054 %forceabbrvbynames:<nametype>%
24059 : Provides a name list which is always abbreviated (with
24060 \begin_inset Quotes eld
24064 \begin_inset Quotes erd
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24081 \begin_layout Enumerate
24082 And finally name lists which consist of family names only, as used in author-yea
24084 These do not take a
24085 \begin_inset Flex Code
24088 \begin_layout Plain Layout
24094 part, but always return either an author list or, if this does not exist,
24095 an editor list (as common in author-year labels):
24099 \begin_layout Itemize
24100 \begin_inset Flex Code
24103 \begin_layout Plain Layout
24109 : Provides a name list which is abbreviated (with
24110 \begin_inset Quotes eld
24114 \begin_inset Quotes erd
24118 \begin_inset Flex Code
24121 \begin_layout Plain Layout
24130 \begin_layout Itemize
24131 \begin_inset Flex Code
24134 \begin_layout Plain Layout
24140 : Provides a full name list (never abbreviated with
24141 \begin_inset Quotes eld
24145 \begin_inset Quotes erd
24151 \begin_layout Itemize
24152 \begin_inset Flex Code
24155 \begin_layout Plain Layout
24156 %forceabbrvciteauthor%
24161 : Provides a name list which is always abbreviated (with
24162 \begin_inset Quotes eld
24166 \begin_inset Quotes erd
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24183 \begin_layout Standard
24184 The order of pre- and surname in the former two lists can be adjusted by
24188 \begin_layout Itemize
24189 \begin_inset Flex Code
24192 \begin_layout Plain Layout
24193 !firstnameform %surname%, %prename%
24198 (first author in lists of type 1)
24201 \begin_layout Itemize
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24206 !othernameform %surname%, %prename%
24211 (other authors in lists of type 1)
24214 \begin_layout Itemize
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24219 !firstbynameform %prename% %surname%
24224 (first author in lists of type 2)
24227 \begin_layout Itemize
24228 \begin_inset Flex Code
24231 \begin_layout Plain Layout
24232 !otherbynameform %prename% %surname%
24237 (other authors in lists of type 2)
24240 \begin_layout Standard
24241 This allows you to configure namings like
24242 \begin_inset Quotes eld
24245 Miller, Peter and Mary Smith: \SpecialChar ldots
24246 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24248 \begin_inset Quotes erd
24254 \begin_layout Standard
24255 There is one other piece of syntax available in definitions, which looks
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24267 This defines a piece of formatting information that is to be used when
24269 \begin_inset Quotes eld
24273 \begin_inset Quotes erd
24277 Obviously, we do not want to output HTML tags when writing plain text,
24278 so they should be wrapped in
24279 \begin_inset Quotes eld
24283 \begin_inset Quotes erd
24287 \begin_inset Quotes eld
24291 \begin_inset Quotes erd
24297 \begin_layout Standard
24298 Two special sorts of definitions are also possible in a
24299 \begin_inset Flex Code
24302 \begin_layout Plain Layout
24309 An example of the first would be:
24312 \begin_layout LyX-Code
24314 \begin_inset Quotes eld
24318 \begin_inset Quotes erd
24324 \begin_layout Standard
24325 This is an abbreviation, or macro, and it can be used by treating it as
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24339 \begin_inset Flex Code
24342 \begin_layout Plain Layout
24348 exactly as it would treat its definition.
24349 So, let us issue the obvious
24357 \begin_layout LyX-Code
24361 \begin_layout Standard
24362 or anything like it.
24364 shouldn't go into an infinite loop, but it may go into a long one before
24368 \begin_layout Standard
24369 The second sort of special definition might look like this:
24372 \begin_layout LyX-Code
24376 \begin_layout Standard
24377 This defines a translatable piece of text, which allows relevant parts of
24378 the bibliography or citation to be translated.
24379 It can be included in a definition by treating it as a key:
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24390 Note that there are two different translation paths: All definitions starting
24392 \begin_inset Flex Code
24395 \begin_layout Plain Layout
24401 , such as in the example above, will be translated to the currently active
24402 buffer language (so the translation will match the generated document).
24403 All definitions starting with underscore only will be translated to the
24405 This is the proper translation for strings that only occur in the dialogs
24406 or on buttons, such as this one:
24409 \begin_layout LyX-Code
24410 _addtobib Add to bibliography only.
24413 \begin_layout Standard
24414 Several of these translatable strings are predefined in
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24425 \begin_inset Flex Code
24428 \begin_layout Plain Layout
24435 Note that these are not macros, in the sense just defined.
24436 They will not be expanded.
24439 \begin_layout Standard
24440 So here then is an example that uses several of these features:
24441 \begin_inset VSpace defskip
24447 \begin_layout Standard
24451 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24454 \begin_layout Standard
24455 \begin_inset VSpace defskip
24458 This defines a macro that prints the author, followed by a comma, if the
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24469 key is defined, or else prints the name of the editor, followed by the
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24480 or its translation (it is by default
24481 \begin_inset Quotes eld
24485 \begin_inset Quotes erd
24489 \begin_inset Flex Code
24492 \begin_layout Plain Layout
24499 Note that this is in fact defined in
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24509 , so you can use it in your own definitions, or re-definitions, if you load
24513 \begin_layout Section
24514 \begin_inset CommandInset label
24516 name "sec:Tags-for-XHTML"
24520 Tags for XHTML output
24523 \begin_layout Standard
24524 As with \SpecialChar LaTeX
24525 or DocBook, the format of \SpecialChar LyX
24526 's XHTML output is also controlled by
24527 layout information.
24528 In general, \SpecialChar LyX
24529 provides sensible defaults and, as mentioned earlier, it will
24530 even construct default CSS style rules from the other layout tags.
24531 For example, \SpecialChar LyX
24532 will attempt to use the information provided in the
24533 \begin_inset Flex Code
24536 \begin_layout Plain Layout
24542 declaration for the Chapter style to write CSS that will appropriately
24543 format chapter headings.
24546 \begin_layout Standard
24547 In many cases, then, you may not have to do anything at all to get acceptable
24548 XHTML output for your own environments, custom insets, and so forth.
24549 But in some cases you will, and so \SpecialChar LyX
24550 provides a number of layout tags that
24551 can be used to customize the XHTML and CSS that are generated.
24554 \begin_layout Standard
24555 Note that there are two tags,
24556 \begin_inset Flex Code
24559 \begin_layout Plain Layout
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24575 that may appear outside style and inset declarations.
24577 \begin_inset CommandInset ref
24579 reference "subsec:General-text-class"
24583 for details on these.
24586 \begin_layout Subsection
24587 \begin_inset CommandInset label
24589 name "subsec:Paragraph-Style-XHTML"
24596 \begin_layout Standard
24597 The sort of XHTML \SpecialChar LyX
24598 outputs for a paragraph depends upon whether we are dealing
24599 with a normal paragraph, a command, or an environment, where this is itself
24600 determined by the contents of the corresponding
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24615 \begin_layout Standard
24616 For a command or normal paragraph, the output XHTML has the following form:
24619 \begin_layout LyX-Code
24623 \begin_inset Quotes erd
24627 \begin_inset Quotes erd
24633 \begin_layout LyX-Code
24637 \begin_inset Quotes erd
24641 \begin_inset Quotes erd
24647 \begin_layout LyX-Code
24650 Contents of the paragraph.
24653 \begin_layout LyX-Code
24659 \begin_layout Standard
24660 The label tags are of course omitted if the paragraph does not have a label.
24663 \begin_layout Standard
24664 For an environment that is not some sort of list, the XHTML takes this form:
24667 \begin_layout LyX-Code
24671 \begin_inset Quotes erd
24675 \begin_inset Quotes erd
24681 \begin_layout LyX-Code
24685 \begin_inset Quotes erd
24689 \begin_inset Quotes erd
24693 \begin_inset Quotes erd
24697 \begin_inset Quotes erd
24700 >Environment Label</labeltag>First paragraph.</itemtag>
24703 \begin_layout LyX-Code
24706 <itemtag>Second paragraph.</itemtag>
24709 \begin_layout LyX-Code
24715 \begin_layout Standard
24716 Note that the label is output only for the first paragraph, as it should
24717 be for a theorem, for example.
24721 \begin_layout Standard
24722 For a list, we have one of these forms:
24725 \begin_layout LyX-Code
24729 \begin_inset Quotes erd
24733 \begin_inset Quotes erd
24739 \begin_layout LyX-Code
24743 \begin_inset Quotes erd
24747 \begin_inset Quotes erd
24751 \begin_inset Quotes erd
24755 \begin_inset Quotes erd
24758 >List Label</labeltag>First item.</itemtag>
24761 \begin_layout LyX-Code
24765 \begin_inset Quotes erd
24769 \begin_inset Quotes erd
24773 \begin_inset Quotes erd
24777 \begin_inset Quotes erd
24780 >List Label</labeltag>Second item.</itemtag>
24783 \begin_layout LyX-Code
24789 \begin_layout LyX-Code
24793 \begin_layout LyX-Code
24797 \begin_inset Quotes erd
24801 \begin_inset Quotes erd
24807 \begin_layout LyX-Code
24811 \begin_inset Quotes erd
24815 \begin_inset Quotes erd
24818 >List Label</labeltag><itemtag attr=
24819 \begin_inset Quotes erd
24823 \begin_inset Quotes erd
24826 >First item.</itemtag>
24829 \begin_layout LyX-Code
24833 \begin_inset Quotes erd
24837 \begin_inset Quotes erd
24840 >List Label</labeltag><itemtag attr=
24841 \begin_inset Quotes erd
24845 \begin_inset Quotes erd
24848 >Second item.</itemtag>
24851 \begin_layout LyX-Code
24857 \begin_layout Standard
24858 Note the different orders of
24859 \begin_inset Flex Code
24862 \begin_layout Plain Layout
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24879 Which order we get depends upon the setting of
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24890 \begin_inset Flex Code
24893 \begin_layout Plain Layout
24899 is false (the default), you get the first of these, with the label within
24900 the item; if true, you get the second, with the label outside the item.
24903 \begin_layout Standard
24904 The specific tags and attributes output for each paragraph type can be controlle
24905 d by means of the layout tags we are about to describe.
24906 As mentioned earlier, however, \SpecialChar LyX
24907 uses sensible defaults for many of these,
24908 so you often may not need to do very much to get good XHTML output.
24909 Think of the available tags as there so you can tweak things to your liking.
24912 \begin_layout Description
24913 \begin_inset Flex Code
24916 \begin_layout Plain Layout
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24932 ] Specifies attribute information to be output with the main tag.
24934 \begin_inset Quotes eld
24938 \begin_inset Flex Code
24941 \begin_layout Plain Layout
24948 \begin_inset Quotes erd
24952 By default, \SpecialChar LyX
24954 \begin_inset Quotes eld
24958 \begin_inset Flex Code
24961 \begin_layout Plain Layout
24968 \begin_inset Quotes erd
24972 \begin_inset Flex Code
24975 \begin_layout Plain Layout
24981 is the \SpecialChar LyX
24982 name of the layout, made lowercase, for example: chapter.
24987 contain any style information.
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
25001 \begin_layout Description
25002 \begin_inset Flex Code
25005 \begin_layout Plain Layout
25012 \begin_inset Flex Code
25015 \begin_layout Plain Layout
25025 ] Whether to output the default CSS information \SpecialChar LyX
25026 generates for this layout,
25027 even if additional information is explicitly provided via
25028 \begin_inset Flex Code
25031 \begin_layout Plain Layout
25039 \begin_inset Flex Code
25042 \begin_layout Plain Layout
25048 allows you to alter or augment the generated CSS, rather than to override
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25063 \begin_layout Description
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25074 \begin_inset Flex Code
25077 \begin_layout Plain Layout
25083 ] The tag to be used for individual paragraphs of environments, replacing
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25094 in the examples above.
25096 \begin_inset Flex Code
25099 \begin_layout Plain Layout
25108 \begin_layout Description
25109 \begin_inset Flex Code
25112 \begin_layout Plain Layout
25119 \begin_inset Flex Code
25122 \begin_layout Plain Layout
25128 ] Attributes for the item tag.
25130 \begin_inset Newline newline
25134 \begin_inset Quotes eld
25138 \begin_inset Flex Code
25141 \begin_layout Plain Layout
25142 class=`layoutname_item'
25148 \begin_inset Quotes erd
25156 contain any style information.
25158 \begin_inset Flex Code
25161 \begin_layout Plain Layout
25170 \begin_layout Description
25171 \begin_inset Flex Code
25174 \begin_layout Plain Layout
25181 \begin_inset Flex Code
25184 \begin_layout Plain Layout
25190 ] The tag to be used for paragraph and item labels, replacing
25191 \begin_inset Flex Code
25194 \begin_layout Plain Layout
25200 in the examples above.
25202 \begin_inset Flex Code
25205 \begin_layout Plain Layout
25212 \begin_inset Flex Code
25215 \begin_layout Plain Layout
25222 \begin_inset Flex Code
25225 \begin_layout Plain Layout
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25236 Centered_Top_Environment
25241 , in which case it defaults to
25242 \begin_inset Flex Code
25245 \begin_layout Plain Layout
25254 \begin_layout Description
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25274 ] Attributes for the label tag.
25276 \begin_inset Newline newline
25280 \begin_inset Quotes eld
25284 \begin_inset Flex Code
25287 \begin_layout Plain Layout
25288 class=`layoutname_label'
25294 \begin_inset Quotes erd
25302 contain any style information.
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25316 \begin_layout Description
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25327 \begin_inset Flex Code
25330 \begin_layout Plain Layout
25340 ] Meaningful only for list-like environments, this tag controls whether
25341 the label tag is output before or inside the item tag.
25342 This is used, for example, in the description environment, where we want
25344 \begin_inset Flex Code
25347 \begin_layout Plain Layout
25348 <dt>\SpecialChar ldots
25349 </dt><dd>\SpecialChar ldots
25357 \begin_inset Flex Code
25360 \begin_layout Plain Layout
25366 : The label tag is output inside the item tag.
25369 \begin_layout Description
25370 \begin_inset Flex Code
25373 \begin_layout Plain Layout
25379 Information to be output in the
25380 \begin_inset Flex Code
25383 \begin_layout Plain Layout
25389 section when this style is used.
25390 This might, for example, be used to include a
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25401 \begin_inset Flex Code
25404 \begin_layout Plain Layout
25413 \begin_layout Description
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25423 CSS style information to be included when this style is used.
25424 Note that this will automatically be wrapped in a layout-generated
25425 \begin_inset Flex Code
25428 \begin_layout Plain Layout
25434 block, so only the CSS itself need be included.
25436 \begin_inset Flex Code
25439 \begin_layout Plain Layout
25448 \begin_layout Description
25449 \begin_inset Flex Code
25452 \begin_layout Plain Layout
25459 \begin_inset Flex Code
25462 \begin_layout Plain Layout
25468 ] The tag to be used for the main label, replacing
25469 \begin_inset Flex Code
25472 \begin_layout Plain Layout
25478 in the examples above.
25480 \begin_inset Flex Code
25483 \begin_layout Plain Layout
25492 \begin_layout Description
25493 \begin_inset Flex Code
25496 \begin_layout Plain Layout
25503 \begin_inset Flex Code
25506 \begin_layout Plain Layout
25516 ] Marks this style as the one to be used to generate the
25517 \begin_inset Flex Code
25520 \begin_layout Plain Layout
25526 tag for the XHTML file.
25527 By default, it is false.
25529 \begin_inset Flex Code
25532 \begin_layout Plain Layout
25538 file sets it to true for the
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25552 \begin_layout Subsection
25556 \begin_layout Standard
25557 The XHTML output of insets can also be controlled by information in layout
25562 \begin_layout Plain Layout
25563 At present, this is true only for
25564 \begin_inset Quotes eld
25568 \begin_inset Quotes erd
25571 insets (insets you can type into) and is not true for
25572 \begin_inset Quotes eld
25576 \begin_inset Quotes erd
25579 insets (insets that are associated with dialog boxes).
25584 Here, too, \SpecialChar LyX
25585 tries to provide sensible defaults, and it constructs default
25587 But everything can be customized.
25590 \begin_layout Standard
25591 The XHTML \SpecialChar LyX
25592 outputs for an inset has the following form:
25595 \begin_layout LyX-Code
25597 \begin_inset Quotes erd
25601 \begin_inset Quotes erd
25607 \begin_layout LyX-Code
25608 <labeltag>Label</labeltag>
25611 \begin_layout LyX-Code
25613 \begin_inset Quotes erd
25617 \begin_inset Quotes erd
25620 >Contents of the inset.</innertag>
25623 \begin_layout LyX-Code
25627 \begin_layout Standard
25628 If the inset permits multiple paragraphs—that is, if
25629 \begin_inset Flex Code
25632 \begin_layout Plain Layout
25638 is true—then the contents of the inset will itself be output as paragraphs
25639 formatted according to the styles used for those paragraphs (standard,
25640 quote, and the like).
25641 The label tag is of course omitted if the paragraph does not have a label
25642 and, at present, is always
25643 \begin_inset Flex Code
25646 \begin_layout Plain Layout
25653 The inner tag is optional and, by default, does not appear.
25656 \begin_layout Standard
25657 The specific tags and attributes output for each inset can be controlled
25658 by means of the following layout tags.
25661 \begin_layout Description
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25672 \begin_inset Flex Code
25675 \begin_layout Plain Layout
25681 ] Specifies attribute information to be output with the main tag.
25683 \begin_inset Quotes eld
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25691 class=`myinset' onclick=`\SpecialChar ldots
25698 \begin_inset Quotes erd
25702 By default, \SpecialChar LyX
25704 \begin_inset Quotes eld
25708 \begin_inset Flex Code
25711 \begin_layout Plain Layout
25718 \begin_inset Quotes erd
25722 \begin_inset Flex Code
25725 \begin_layout Plain Layout
25731 is the \SpecialChar LyX
25732 name of the inset, made lowercase and with non-alphanumeric characters
25733 converted to underscores, for example: footnote.
25736 \begin_layout Description
25737 \begin_inset Flex Code
25740 \begin_layout Plain Layout
25747 \begin_inset Flex Code
25750 \begin_layout Plain Layout
25760 ] Whether to output the default CSS information \SpecialChar LyX
25761 generates for this layout,
25762 even if additional information is explicitly provided via
25763 \begin_inset Flex Code
25766 \begin_layout Plain Layout
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25783 allows you to alter or augment the generated CSS, rather than to override
25788 \begin_layout Description
25789 \begin_inset Flex Code
25792 \begin_layout Plain Layout
25799 \begin_inset Flex Code
25802 \begin_layout Plain Layout
25808 ] Attributes for the inner tag.
25810 \begin_inset Newline newline
25814 \begin_inset Quotes eld
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25822 class=`insetname_inner'
25828 \begin_inset Quotes erd
25834 \begin_layout Description
25835 \begin_inset Flex Code
25838 \begin_layout Plain Layout
25845 \begin_inset Flex Code
25848 \begin_layout Plain Layout
25854 ] The inner tag, replacing
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25864 in the examples above.
25865 By default, there is none.
25868 \begin_layout Description
25869 \begin_inset Flex Code
25872 \begin_layout Plain Layout
25879 \begin_inset Flex Code
25882 \begin_layout Plain Layout
25890 ] Whether this inset represents a standalone block of text (such as a footnote)
25891 or instead represents material that is included in the surrounding text
25892 (such as a branch).
25896 \begin_layout Description
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25916 ] A label for this inset, possibly including a reference to a counter.
25917 For example, for footnote, it might be:
25918 \begin_inset Flex Code
25921 \begin_layout Plain Layout
25930 This is optional, and there is no default.
25933 \begin_layout Description
25934 \begin_inset Flex Code
25937 \begin_layout Plain Layout
25943 Information to be output in the
25944 \begin_inset Flex Code
25947 \begin_layout Plain Layout
25953 section when this style is used.
25954 This might, for example, be used to include a
25955 \begin_inset Flex Code
25958 \begin_layout Plain Layout
25965 \begin_inset Flex Code
25968 \begin_layout Plain Layout
25977 \begin_layout Description
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25987 CSS style information to be included when this style is used.
25988 Note that this will automatically be wrapped in a layout-generated
25989 \begin_inset Flex Code
25992 \begin_layout Plain Layout
25998 block, so only the CSS itself need be included.
26001 \begin_layout Description
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26012 \begin_inset Flex Code
26015 \begin_layout Plain Layout
26021 ] The tag to be used for the main label, replacing
26022 \begin_inset Flex Code
26025 \begin_layout Plain Layout
26031 in the examples above.
26032 The default depends upon the setting of
26033 \begin_inset Flex Code
26036 \begin_layout Plain Layout
26043 \begin_inset Flex Code
26046 \begin_layout Plain Layout
26052 is true, the default is
26053 \begin_inset Flex Code
26056 \begin_layout Plain Layout
26062 ; if it is false, the default is
26063 \begin_inset Flex Code
26066 \begin_layout Plain Layout
26075 \begin_layout Subsection
26079 \begin_layout Standard
26080 The XHTML output for floats too can be controlled by layout information.
26081 The output has the following form:
26084 \begin_layout LyX-Code
26086 \begin_inset Quotes erd
26090 \begin_inset Quotes erd
26096 \begin_layout LyX-Code
26097 Contents of the float.
26100 \begin_layout LyX-Code
26104 \begin_layout Standard
26105 The caption, if there is one, is a separate inset and will be output as
26107 Its appearance can be controlled via the InsetLayout for caption insets.
26111 \begin_layout Description
26112 \begin_inset Flex Code
26115 \begin_layout Plain Layout
26122 \begin_inset Flex Code
26125 \begin_layout Plain Layout
26131 ] Specifies attribute information to be output with the main tag.
26133 \begin_inset Quotes eld
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26141 class=`myfloat' onclick=`\SpecialChar ldots
26148 \begin_inset Quotes erd
26152 By default, \SpecialChar LyX
26154 \begin_inset Quotes eld
26158 \begin_inset Flex Code
26161 \begin_layout Plain Layout
26162 class=`float float-floattype'
26168 \begin_inset Quotes erd
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26181 is \SpecialChar LyX
26182 's name for this type of float, as determined by the float declaration
26184 \begin_inset CommandInset ref
26186 reference "subsec:Floats"
26190 ), though made lowercase and with non-alphanumeric characters converted
26191 to underscores, for example: float-table.
26194 \begin_layout Description
26195 \begin_inset Flex Code
26198 \begin_layout Plain Layout
26204 CSS style information to be included when this float is used.
26205 Note that this will automatically be wrapped in a layout-generated
26206 \begin_inset Flex Code
26209 \begin_layout Plain Layout
26215 block, so only the CSS itself need be included.
26218 \begin_layout Description
26219 \begin_inset Flex Code
26222 \begin_layout Plain Layout
26229 \begin_inset Flex Code
26232 \begin_layout Plain Layout
26238 ] The tag to be used for this float, replacing
26239 \begin_inset Quotes eld
26243 \begin_inset Flex Code
26246 \begin_layout Plain Layout
26253 \begin_inset Quotes erd
26256 in the example above.
26258 \begin_inset Flex Code
26261 \begin_layout Plain Layout
26267 and will rarely need changing.
26270 \begin_layout Subsection
26271 Bibliography formatting
26274 \begin_layout Standard
26275 The bibliography can be formatted using
26276 \begin_inset Flex Code
26279 \begin_layout Plain Layout
26287 \begin_inset CommandInset ref
26289 reference "subsec:Citation-format-description"
26296 \begin_layout Subsection
26301 \begin_layout Standard
26302 We have several times mentioned that \SpecialChar LyX
26303 will generate default CSS style rules
26304 for both insets and paragraph styles, based upon the other layout information
26306 In this section, we shall say a word about which layout information \SpecialChar LyX
26311 \begin_layout Standard
26312 At present, \SpecialChar LyX
26313 auto-generates CSS only for font information, making use of
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26325 \begin_inset Flex Code
26328 \begin_layout Plain Layout
26335 \begin_inset Flex Code
26338 \begin_layout Plain Layout
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26355 \begin_inset Flex Code
26358 \begin_layout Plain Layout
26365 \begin_inset CommandInset ref
26367 reference "subsec:Font-description"
26372 The translation is mostly straightforward and obvious.
26374 \begin_inset Quotes eld
26378 \begin_inset Flex Code
26381 \begin_layout Plain Layout
26388 \begin_inset Quotes erd
26392 \begin_inset Quotes eld
26396 \begin_inset Flex Code
26399 \begin_layout Plain Layout
26400 font-family: sans-serif;
26406 \begin_inset Quotes erd
26410 The correspondence of \SpecialChar LyX
26411 sizes and CSS sizes is a little less obvious but
26412 nonetheless intuitive.
26414 \begin_inset Flex Code
26417 \begin_layout Plain Layout
26424 \begin_inset Flex URL
26427 \begin_layout Plain Layout
26437 \begin_layout Chapter
26438 Including External Material
26439 \begin_inset CommandInset label
26441 name "chap:Including-External-Material"
26448 \begin_layout Standard
26449 \begin_inset Box Shadowbox
26459 height_special "totalheight"
26464 backgroundcolor "none"
26467 \begin_layout Plain Layout
26468 WARNING: This portion of the documentation has not been updated for some
26470 We certainly hope that it is still accurate, but there are no guarantees.
26478 \begin_layout Standard
26479 The use of material from sources external to \SpecialChar LyX
26480 is covered in detail in the
26486 This part of the manual covers what needs to happen behind the scenes for
26487 new sorts of material to be included.
26490 \begin_layout Section
26494 \begin_layout Standard
26495 The external material feature is based on the concept of a
26500 A template is a specification of how \SpecialChar LyX
26501 should interface with a certain kind
26503 As bundled, \SpecialChar LyX
26504 comes with predefined templates for Xfig figures, various
26505 raster format images, chess diagrams, and LilyPond music notation.
26506 You can check the actual list by using the menu
26507 \begin_inset Flex Noun
26510 \begin_layout Plain Layout
26511 Insert\SpecialChar menuseparator
26512 File\SpecialChar menuseparator
26519 Furthermore, it is possible to roll your own template to support a specific
26521 Later we'll describe in more detail what is involved, and hopefully you
26522 will submit all the templates you create so we can include them in a later
26527 \begin_layout Standard
26528 Another basic idea of the external material feature is to distinguish between
26529 the original file that serves as a base for final material and the produced
26530 file that is included in your exported or printed document.
26531 For example, consider the case of a figure produced with
26532 \begin_inset Flex Code
26535 \begin_layout Plain Layout
26542 The Xfig application itself works on an original file with the
26543 \begin_inset Flex Code
26546 \begin_layout Plain Layout
26553 Within Xfig, you create and change your figure, and when you are done,
26555 \begin_inset Flex Code
26558 \begin_layout Plain Layout
26565 When you want to include the figure in your document, you invoke
26566 \begin_inset Flex Code
26569 \begin_layout Plain Layout
26575 in order to create a PostScript file that can readily be included in your
26579 \begin_inset Flex Code
26582 \begin_layout Plain Layout
26588 file is the original file, and the PostScript file is the produced file.
26591 \begin_layout Standard
26592 This distinction is important in order to allow updating of the material
26593 while you are in the process of writing the document.
26594 Furthermore, it provides us with the flexibility that is needed to support
26595 multiple export formats.
26596 For instance, in the case of a plain text file, it is not exactly an award-winn
26597 ing idea to include the figure as raw PostScript.
26598 Instead, you would either prefer to just include a reference to the figure
26599 or try to invoke some graphics to ASCII converter to make the final result
26600 look similar to the real graphics.
26601 The external material management allows you to do this, because it is parametri
26602 zed on the different export formats that \SpecialChar LyX
26606 \begin_layout Standard
26607 Besides supporting the production of different products according to the
26608 exported format, it supports tight integration with editing and viewing
26610 In the case of an Xfig figure, you are able to invoke Xfig on the original
26611 file with a single click from within the external material dialog in \SpecialChar LyX
26613 and also preview the produced PostScript file with Ghostview with another
26615 No more fiddling around with the command line and/or file browsers to locate
26616 and manipulate the original or produced files.
26617 In this way, you are finally able to take full advantage of the many different
26618 applications that are relevant to use when you write your documents, and
26619 ultimately be more productive.
26622 \begin_layout Section
26623 The external template configuration files
26626 \begin_layout Standard
26627 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26629 However, be aware that doing this in an careless manner most probably
26633 introduce an easily exploitable security hole.
26634 So before you do this, please read the discussion about security in
26635 \begin_inset CommandInset ref
26637 reference "sec:Security-discussion"
26644 \begin_layout Standard
26645 Having said that, we encourage you to submit any interesting templates that
26650 \begin_layout Standard
26651 The external templates are defined in the
26652 \begin_inset Flex Code
26655 \begin_layout Plain Layout
26661 files that are stored in the
26662 \begin_inset Flex Code
26665 \begin_layout Plain Layout
26666 LyXDir/lib/xtemplates/
26672 Each template is defined in a file of its own.
26673 You can place your own templates in
26674 \begin_inset Flex Code
26677 \begin_layout Plain Layout
26678 UserDir/xtemplates/
26683 or copy existing templates to that directory in order to modify them.
26686 \begin_layout Standard
26687 A typical template looks like this:
26690 \begin_layout LyX-Code
26694 \begin_layout LyX-Code
26695 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26698 \begin_layout LyX-Code
26702 \begin_layout LyX-Code
26706 \begin_layout LyX-Code
26710 \begin_layout LyX-Code
26714 \begin_layout LyX-Code
26718 \begin_layout LyX-Code
26719 AutomaticProduction true
26722 \begin_layout LyX-Code
26726 \begin_layout LyX-Code
26730 \begin_layout LyX-Code
26734 \begin_layout LyX-Code
26735 TransformCommand Rotate RotationLatexCommand
26738 \begin_layout LyX-Code
26739 TransformCommand Resize ResizeLatexCommand
26742 \begin_layout LyX-Code
26743 Product "$$RotateFront$$ResizeFront
26746 \begin_layout LyX-Code
26751 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26754 \begin_layout LyX-Code
26755 $$ResizeBack$$RotateBack"
26758 \begin_layout LyX-Code
26762 \begin_layout LyX-Code
26763 UpdateResult "$$AbsPath$$Basename.pstex_t"
26766 \begin_layout LyX-Code
26767 Requirement "graphicx"
26770 \begin_layout LyX-Code
26771 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26774 \begin_layout LyX-Code
26775 ReferencedFile latex "$$AbsPath$$Basename.eps"
26778 \begin_layout LyX-Code
26779 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26782 \begin_layout LyX-Code
26786 \begin_layout LyX-Code
26790 \begin_layout LyX-Code
26791 TransformCommand Rotate RotationLatexCommand
26794 \begin_layout LyX-Code
26795 TransformCommand Resize ResizeLatexCommand
26798 \begin_layout LyX-Code
26799 Product "$$RotateFront$$ResizeFront
26802 \begin_layout LyX-Code
26807 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
26810 \begin_layout LyX-Code
26811 $$ResizeBack$$RotateBack"
26814 \begin_layout LyX-Code
26815 UpdateFormat pdftex
26818 \begin_layout LyX-Code
26819 UpdateResult "$$AbsPath$$Basename.pdftex_t"
26822 \begin_layout LyX-Code
26823 Requirement "graphicx"
26826 \begin_layout LyX-Code
26827 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
26830 \begin_layout LyX-Code
26831 ReferencedFile latex "$$AbsPath$$Basename.pdf"
26834 \begin_layout LyX-Code
26838 \begin_layout LyX-Code
26842 \begin_layout LyX-Code
26843 Product "[XFig: $$FName]"
26846 \begin_layout LyX-Code
26850 \begin_layout LyX-Code
26854 \begin_layout LyX-Code
26855 Product "<graphic fileref=
26857 "$$AbsOrRelPathMaster$$Basename.eps
26862 \begin_layout LyX-Code
26866 \begin_layout LyX-Code
26870 \begin_layout LyX-Code
26871 UpdateResult "$$AbsPath$$Basename.eps"
26874 \begin_layout LyX-Code
26875 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26878 \begin_layout LyX-Code
26879 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26882 \begin_layout LyX-Code
26886 \begin_layout LyX-Code
26890 \begin_layout Standard
26891 As you can see, the template is enclosed in
26892 \begin_inset Flex Code
26895 \begin_layout Plain Layout
26903 \begin_inset Flex Code
26906 \begin_layout Plain Layout
26913 It contains a header specifying some general settings and, for each supported
26914 primary document file format, a section
26915 \begin_inset Flex Code
26918 \begin_layout Plain Layout
26926 \begin_inset Flex Code
26929 \begin_layout Plain Layout
26938 \begin_layout Subsection
26939 The template header
26942 \begin_layout Description
26943 \begin_inset Flex Code
26946 \begin_layout Plain Layout
26947 AutomaticProduction
26948 \begin_inset space ~
26956 Whether the file represented by the template must be generated by \SpecialChar LyX
26958 This command must occur exactly once.
26961 \begin_layout Description
26962 \begin_inset Flex Code
26965 \begin_layout Plain Layout
26967 \begin_inset space ~
26975 A glob pattern that is used in the file dialog to filter out the desired
26977 If there is more than one possible file extension (e.
26978 \begin_inset space \thinspace{}
26982 \begin_inset space \space{}
26986 \begin_inset Flex Code
26989 \begin_layout Plain Layout
26996 \begin_inset Flex Code
26999 \begin_layout Plain Layout
27005 ), use something like
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27016 This command must occur exactly once.
27019 \begin_layout Description
27020 \begin_inset Flex Code
27023 \begin_layout Plain Layout
27025 \begin_inset space ~
27033 The text that is displayed on the button.
27034 This command must occur exactly once.
27037 \begin_layout Description
27038 \begin_inset Flex Code
27041 \begin_layout Plain Layout
27043 \begin_inset space ~
27047 \begin_inset space ~
27055 The help text that is used in the External dialog.
27056 Provide enough information to explain to the user just what the template
27057 can provide him with.
27058 This command must occur exactly once.
27061 \begin_layout Description
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27067 \begin_inset space ~
27075 The file format of the original file.
27076 This must be the name of a format that is known to \SpecialChar LyX
27078 \begin_inset CommandInset ref
27080 reference "sec:Formats"
27086 \begin_inset Quotes eld
27090 \begin_inset Flex Code
27093 \begin_layout Plain Layout
27100 \begin_inset Quotes erd
27103 if the template can handle original files of more than one format.
27105 will attempt to interrogate the file itself in order to deduce its format
27107 This command must occur exactly once.
27110 \begin_layout Description
27111 \begin_inset Flex Code
27114 \begin_layout Plain Layout
27116 \begin_inset space ~
27124 A unique name for the template.
27125 It must not contain substitution macros (see below).
27128 \begin_layout Description
27129 \begin_inset Flex Code
27132 \begin_layout Plain Layout
27134 \begin_inset space ~
27137 Rotate|Resize|Clip|Extra
27142 This command specifies which transformations are supported by this template.
27143 It may occur zero or more times.
27144 This command enables the corresponding tabs in the external dialog.
27146 \begin_inset Flex Code
27149 \begin_layout Plain Layout
27155 command must have either a corresponding
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27166 \begin_inset Flex Code
27169 \begin_layout Plain Layout
27176 \begin_inset Flex Code
27179 \begin_layout Plain Layout
27186 Otherwise the transformation will not be supported by that format.
27189 \begin_layout Subsection
27193 \begin_layout Description
27194 \begin_inset Flex Code
27197 \begin_layout Plain Layout
27199 \begin_inset space ~
27202 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27207 The primary document file format that this format definition is for.
27208 Not every template has a sensible representation in all document file formats.
27209 Please define nevertheless a
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27219 section for all templates.
27220 Use a dummy text when no representation is available.
27221 Then you can at least see a reference to the external material in the exported
27225 \begin_layout Description
27226 \begin_inset Flex Code
27229 \begin_layout Plain Layout
27231 \begin_inset space ~
27235 \begin_inset space ~
27243 This command defines an additional macro
27244 \begin_inset Flex Code
27247 \begin_layout Plain Layout
27253 for substitution in
27254 \begin_inset Flex Code
27257 \begin_layout Plain Layout
27265 \begin_inset Flex Code
27268 \begin_layout Plain Layout
27274 itself may contain substitution macros.
27275 The advantage over using
27276 \begin_inset Flex Code
27279 \begin_layout Plain Layout
27286 \begin_inset Flex Code
27289 \begin_layout Plain Layout
27295 is that the substituted value of
27296 \begin_inset Flex Code
27299 \begin_layout Plain Layout
27305 is sanitized so that it is a valid optional argument in the document format.
27306 This command may occur zero or more times.
27309 \begin_layout Description
27310 \begin_inset Flex Code
27313 \begin_layout Plain Layout
27315 \begin_inset space ~
27323 The text that is inserted in the exported document.
27324 This is actually the most important command and can be quite complex.
27325 This command must occur exactly once.
27328 \begin_layout Description
27329 \begin_inset Flex Code
27332 \begin_layout Plain Layout
27334 \begin_inset space ~
27342 This command specifies a preamble snippet that will be included in the
27345 It has to be defined using
27346 \begin_inset Flex Code
27349 \begin_layout Plain Layout
27357 \begin_inset Flex Code
27360 \begin_layout Plain Layout
27367 This command may occur zero or more times.
27370 \begin_layout Description
27371 \begin_inset Flex Code
27374 \begin_layout Plain Layout
27376 \begin_inset space ~
27380 \begin_inset space ~
27388 This command denotes files that are created by the conversion process and
27389 are needed for a particular export format.
27390 If the filename is relative, it is interpreted relative to the master document.
27391 This command may be given zero or more times.
27394 \begin_layout Description
27395 \begin_inset Flex Code
27398 \begin_layout Plain Layout
27400 \begin_inset space ~
27408 The name of a required \SpecialChar LaTeX
27410 The package is included via
27411 \begin_inset Flex Code
27414 \begin_layout Plain Layout
27422 in the \SpecialChar LaTeX
27424 This command may occur zero or more times.
27427 \begin_layout Description
27428 \begin_inset Flex Code
27431 \begin_layout Plain Layout
27433 \begin_inset space ~
27437 \begin_inset space ~
27440 RotationLatexCommand
27445 This command specifies that the built in \SpecialChar LaTeX
27446 command should be used for rotation.
27447 This command may occur once or not at all.
27450 \begin_layout Description
27451 \begin_inset Flex Code
27454 \begin_layout Plain Layout
27456 \begin_inset space ~
27460 \begin_inset space ~
27468 This command specifies that the built in \SpecialChar LaTeX
27469 command should be used for resizing.
27470 This command may occur once or not at all.
27473 \begin_layout Description
27474 \begin_inset Flex Code
27477 \begin_layout Plain Layout
27479 \begin_inset space ~
27483 \begin_inset space ~
27486 RotationLatexOption
27491 This command specifies that rotation is done via an optional argument.
27492 This command may occur once or not at all.
27495 \begin_layout Description
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27501 \begin_inset space ~
27505 \begin_inset space ~
27513 This command specifies that resizing is done via an optional argument.
27514 This command may occur once or not at all.
27517 \begin_layout Description
27518 \begin_inset Flex Code
27521 \begin_layout Plain Layout
27523 \begin_inset space ~
27527 \begin_inset space ~
27535 This command specifies that clipping is done via an optional argument.
27536 This command may occur once or not at all.
27539 \begin_layout Description
27540 \begin_inset Flex Code
27543 \begin_layout Plain Layout
27545 \begin_inset space ~
27549 \begin_inset space ~
27557 This command specifies that an extra optional argument is used.
27558 This command may occur once or not at all.
27561 \begin_layout Description
27562 \begin_inset Flex Code
27565 \begin_layout Plain Layout
27567 \begin_inset space ~
27575 The file format of the converted file.
27576 This must be the name of a format that is known to \SpecialChar LyX
27578 \begin_inset Flex Noun
27581 \begin_layout Plain Layout
27582 Tools\SpecialChar menuseparator
27583 Preferences\SpecialChar menuseparator
27584 File Handling\SpecialChar menuseparator
27591 This command must occur exactly once.
27592 If the resulting file format is PDF, you need to specify the format
27593 \begin_inset Flex Code
27596 \begin_layout Plain Layout
27603 This is the PDF format used for including graphics.
27604 The other defined PDF formats are for document export.
27607 \begin_layout Description
27608 \begin_inset Flex Code
27611 \begin_layout Plain Layout
27613 \begin_inset space ~
27621 The file name of the converted file.
27622 The file name must be absolute.
27623 This command must occur exactly once.
27626 \begin_layout Subsection
27627 Preamble definitions
27630 \begin_layout Standard
27631 The external template configuration file may contain additional preamble
27632 definitions enclosed by
27633 \begin_inset Flex Code
27636 \begin_layout Plain Layout
27644 \begin_inset Flex Code
27647 \begin_layout Plain Layout
27654 They can be used by the templates in the
27655 \begin_inset Flex Code
27658 \begin_layout Plain Layout
27667 \begin_layout Section
27668 The substitution mechanism
27671 \begin_layout Standard
27672 When the external material facility invokes an external program, it is done
27673 on the basis of a command defined in the template configuration file.
27674 These commands can contain various macros that are expanded before execution.
27675 Execution always take place in the directory of the containing document.
27678 \begin_layout Standard
27679 Also, whenever external material is to be displayed, the name will be produced
27680 by the substitution mechanism, and most other commands in the template
27681 definition support substitution as well.
27684 \begin_layout Standard
27685 The available macros are the following:
27688 \begin_layout Description
27689 \begin_inset Flex Code
27692 \begin_layout Plain Layout
27693 $$AbsOrRelPathMaster
27698 The file path, absolute or relative to the master \SpecialChar LyX
27702 \begin_layout Description
27703 \begin_inset Flex Code
27706 \begin_layout Plain Layout
27707 $$AbsOrRelPathParent
27712 The file path, absolute or relative to the \SpecialChar LyX
27716 \begin_layout Description
27717 \begin_inset Flex Code
27720 \begin_layout Plain Layout
27726 The absolute file path.
27729 \begin_layout Description
27730 \begin_inset Flex Code
27733 \begin_layout Plain Layout
27739 The filename without path and without the extension.
27742 \begin_layout Description
27743 \begin_inset Flex Code
27746 \begin_layout Plain Layout
27748 \begin_inset Quotes eld
27752 \begin_inset Quotes erd
27760 This macro will expand to the contents of the file with the name
27761 \begin_inset Flex Code
27764 \begin_layout Plain Layout
27773 \begin_layout Description
27774 \begin_inset Flex Code
27777 \begin_layout Plain Layout
27783 The file extension (including the dot).
27786 \begin_layout Description
27787 \begin_inset Flex Code
27790 \begin_layout Plain Layout
27796 This will be the string
27797 \begin_inset Quotes eld
27801 \begin_inset Quotes erd
27804 if the file is in JPEG format, otherwise it will be the string
27805 \begin_inset Quotes eld
27809 \begin_inset Quotes erd
27813 This is useful to avoid uneeded conversions for output formats that support
27814 both PNG and JPEG fomats.
27815 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
27820 \begin_layout Description
27821 \begin_inset Flex Code
27824 \begin_layout Plain Layout
27830 The filename of the file specified in the external material dialog.
27831 This is either an absolute name, or it is relative to the \SpecialChar LyX
27835 \begin_layout Description
27836 \begin_inset Flex Code
27839 \begin_layout Plain Layout
27846 \begin_inset Flex Code
27849 \begin_layout Plain Layout
27855 (absolute name or relative to the \SpecialChar LyX
27859 \begin_layout Description
27860 \begin_inset Flex Code
27863 \begin_layout Plain Layout
27869 The file path, relative to the master \SpecialChar LyX
27873 \begin_layout Description
27874 \begin_inset Flex Code
27877 \begin_layout Plain Layout
27883 The file path, relative to the \SpecialChar LyX
27887 \begin_layout Description
27888 \begin_inset Flex Code
27891 \begin_layout Plain Layout
27897 This macro will expand to the absolute path of the system directory.
27898 This is typically used to point to the various helper scripts that are
27899 bundled with \SpecialChar LyX
27903 \begin_layout Description
27904 \begin_inset Flex Code
27907 \begin_layout Plain Layout
27913 A name and full path to a temporary file which will be automatically deleted
27914 whenever the containing document is closed, or the external material insertion
27918 \begin_layout Standard
27919 All path macros contain a trailing directory separator, so you can construct
27921 \begin_inset space \thinspace{}
27925 \begin_inset space \space{}
27928 the absolute filename with
27929 \begin_inset Flex Code
27932 \begin_layout Plain Layout
27933 $$AbsPath$$Basename$$Extension
27941 \begin_layout Standard
27942 The macros above are substituted in all commands unless otherwise noted.
27944 \begin_inset Flex Code
27947 \begin_layout Plain Layout
27953 supports additionally the following substitutions if they are enabled by
27955 \begin_inset Flex Code
27958 \begin_layout Plain Layout
27965 \begin_inset Flex Code
27968 \begin_layout Plain Layout
27977 \begin_layout Description
27978 \begin_inset Flex Code
27981 \begin_layout Plain Layout
27987 The front part of the resize command.
27990 \begin_layout Description
27991 \begin_inset Flex Code
27994 \begin_layout Plain Layout
28000 The back part of the resize command.
28003 \begin_layout Description
28004 \begin_inset Flex Code
28007 \begin_layout Plain Layout
28013 The front part of the rotation command.
28016 \begin_layout Description
28017 \begin_inset Flex Code
28020 \begin_layout Plain Layout
28026 The back part of the rotation command.
28029 \begin_layout Standard
28030 The value string of the
28031 \begin_inset Flex Code
28034 \begin_layout Plain Layout
28040 command supports additionally the following substitutions if they are enabled
28042 \begin_inset Flex Code
28045 \begin_layout Plain Layout
28052 \begin_inset Flex Code
28055 \begin_layout Plain Layout
28064 \begin_layout Description
28065 \begin_inset Flex Code
28068 \begin_layout Plain Layout
28077 \begin_layout Description
28078 \begin_inset Flex Code
28081 \begin_layout Plain Layout
28090 \begin_layout Description
28091 \begin_inset Flex Code
28094 \begin_layout Plain Layout
28103 \begin_layout Description
28104 \begin_inset Flex Code
28107 \begin_layout Plain Layout
28113 The rotation option.
28116 \begin_layout Standard
28117 You may ask why there are so many path macros.
28118 There are mainly two reasons:
28121 \begin_layout Enumerate
28122 Relative and absolute file names should remain relative or absolute, respectivel
28124 Users may have reasons to prefer either form.
28125 Relative names are useful for portable documents that should work on different
28126 machines, for example.
28127 Absolute names may be required by some programs.
28130 \begin_layout Enumerate
28132 treats relative file names differently than \SpecialChar LyX
28133 and other programs in nested
28135 For \SpecialChar LyX
28136 , a relative file name is always relative to the document that contains
28138 For \SpecialChar LaTeX
28139 , it is always relative to the master document.
28140 These two definitions are identical if you have only one document, but
28141 differ if you have a master document that includes part documents.
28142 That means that relative filenames must be transformed when presented to
28145 Fortunately \SpecialChar LyX
28146 does this automatically for you if you choose the right macros.
28149 \begin_layout Standard
28150 So which path macro should be used in new template definitions? The rule
28154 \begin_layout Itemize
28156 \begin_inset Flex Code
28159 \begin_layout Plain Layout
28165 if an absolute path is required.
28168 \begin_layout Itemize
28170 \begin_inset Flex Code
28173 \begin_layout Plain Layout
28174 $$AbsOrRelPathMaster
28179 if the substituted string is some kind of \SpecialChar LaTeX
28183 \begin_layout Itemize
28185 \begin_inset Flex Code
28188 \begin_layout Plain Layout
28189 $$AbsOrRelPathParent
28194 in order to preserve the user's choice.
28197 \begin_layout Standard
28198 There are special cases where this rule does not work and e.
28199 \begin_inset space \thinspace{}
28203 \begin_inset space \space{}
28206 relative names are needed, but normally it will work just fine.
28207 One example for such a case is the command
28208 \begin_inset Flex Code
28211 \begin_layout Plain Layout
28212 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28217 in the XFig template above: We can't use the absolute name because the
28219 \begin_inset Flex Code
28222 \begin_layout Plain Layout
28228 files needs the relative name in order to rewrite the file content.
28231 \begin_layout Section
28232 Security discussion
28233 \begin_inset CommandInset label
28235 name "sec:Security-discussion"
28242 \begin_layout Standard
28243 The external material feature interfaces with a lot of external programs
28244 and does so automatically, so we have to consider the security implications
28246 In particular, since you have the option of including your own filenames
28247 and/or parameter strings and those are expanded into a command, it seems
28248 that it would be possible to create a malicious document which executes
28249 arbitrary commands when a user views or prints the document.
28250 This is something we definitely want to avoid.
28253 \begin_layout Standard
28254 However, since the external program commands are specified in the template
28255 configuration file only, there are no security issues if \SpecialChar LyX
28256 is properly configure
28257 d with safe templates only.
28258 This is so because the external programs are invoked with the
28259 \begin_inset Flex Code
28262 \begin_layout Plain Layout
28268 -system call rather than the
28269 \begin_inset Flex Code
28272 \begin_layout Plain Layout
28278 system-call, so it's not possible to execute arbitrary commands from the
28279 filename or parameter section via the shell.
28282 \begin_layout Standard
28283 This also implies that you are restricted in what command strings you can
28284 use in the external material templates.
28285 In particular, pipes and redirection are not readily available.
28286 This has to be so if \SpecialChar LyX
28287 should remain safe.
28288 If you want to use some of the shell features, you should write a safe
28289 script to do this in a controlled manner, and then invoke the script from
28290 the command string.
28294 \begin_layout Standard
28295 It is possible to design a template that interacts directly with the shell,
28296 but since this would allow a malicious user to execute arbitrary commands
28297 by writing clever filenames and/or parameters, we generally recommend that
28298 you only use safe scripts that work with the
28299 \begin_inset Flex Code
28302 \begin_layout Plain Layout
28308 system call in a controlled manner.
28309 Of course, for use in a controlled environment, it can be tempting to just
28310 fall back to use ordinary shell scripts.
28311 If you do so, be aware that you
28315 provide an easily exploitable security hole in your system.
28316 Of course it stands to reason that such unsafe templates will never be
28317 included in the standard \SpecialChar LyX
28318 distribution, although we do encourage people
28319 to submit new templates in the open source tradition.
28320 But \SpecialChar LyX
28321 as shipped from the official distribution channels will never have
28325 \begin_layout Standard
28326 Including external material provides a lot of power, and you have to be
28327 careful not to introduce security hazards with this power.
28328 A subtle error in a single line in an innocent looking script can open
28329 the door to huge security problems.
28330 So if you do not fully understand the issues, we recommend that you consult
28331 a knowledgeable security professional or the \SpecialChar LyX
28332 development team if you have
28333 any questions about whether a given template is safe or not.
28334 And do this before you use it in an uncontrolled environment.
28337 \begin_layout Chapter
28339 List of supported \SpecialChar LyX
28340 functions to be used in layouts
28341 \begin_inset CommandInset label
28343 name "chap:List-of-functions"
28350 \begin_layout Standard
28352 \begin_inset Tabular
28353 <lyxtabular version="3" rows="11" columns="8">
28354 <features tabularvalignment="middle">
28355 <column alignment="left" valignment="top">
28356 <column alignment="left" valignment="top">
28357 <column alignment="left" valignment="top">
28358 <column alignment="left" valignment="top">
28359 <column alignment="left" valignment="top">
28360 <column alignment="left" valignment="top">
28361 <column alignment="left" valignment="top">
28362 <column alignment="left" valignment="top">
28364 <cell alignment="left" valignment="top" usebox="none">
28367 \begin_layout Plain Layout
28373 <cell alignment="left" valignment="top" usebox="none">
28376 \begin_layout Plain Layout
28382 <cell alignment="left" valignment="top" usebox="none">
28385 \begin_layout Plain Layout
28391 <cell alignment="left" valignment="top" usebox="none">
28394 \begin_layout Plain Layout
28400 <cell alignment="center" valignment="top" usebox="none">
28403 \begin_layout Plain Layout
28409 <cell alignment="center" valignment="top" usebox="none">
28412 \begin_layout Plain Layout
28418 <cell alignment="center" valignment="top" usebox="none">
28421 \begin_layout Plain Layout
28427 <cell alignment="center" valignment="top" usebox="none">
28430 \begin_layout Plain Layout
28438 <cell alignment="left" valignment="top" usebox="none">
28441 \begin_layout Plain Layout
28447 <cell alignment="left" valignment="top" usebox="none">
28450 \begin_layout Plain Layout
28456 <cell alignment="left" valignment="top" usebox="none">
28459 \begin_layout Plain Layout
28465 <cell alignment="left" valignment="top" usebox="none">
28468 \begin_layout Plain Layout
28474 <cell alignment="center" valignment="top" usebox="none">
28477 \begin_layout Plain Layout
28483 <cell alignment="center" valignment="top" usebox="none">
28486 \begin_layout Plain Layout
28492 <cell alignment="center" valignment="top" usebox="none">
28495 \begin_layout Plain Layout
28501 <cell alignment="center" valignment="top" usebox="none">
28504 \begin_layout Plain Layout
28512 <cell alignment="left" valignment="top" usebox="none">
28515 \begin_layout Plain Layout
28521 <cell alignment="left" valignment="top" usebox="none">
28524 \begin_layout Plain Layout
28530 <cell alignment="left" valignment="top" usebox="none">
28533 \begin_layout Plain Layout
28539 <cell alignment="left" valignment="top" usebox="none">
28542 \begin_layout Plain Layout
28548 <cell alignment="center" valignment="top" usebox="none">
28551 \begin_layout Plain Layout
28557 <cell alignment="center" valignment="top" usebox="none">
28560 \begin_layout Plain Layout
28566 <cell alignment="center" valignment="top" usebox="none">
28569 \begin_layout Plain Layout
28575 <cell alignment="center" valignment="top" usebox="none">
28578 \begin_layout Plain Layout
28586 <cell alignment="left" valignment="top" usebox="none">
28589 \begin_layout Plain Layout
28595 <cell alignment="left" valignment="top" usebox="none">
28598 \begin_layout Plain Layout
28604 <cell alignment="left" valignment="top" usebox="none">
28607 \begin_layout Plain Layout
28613 <cell alignment="left" valignment="top" usebox="none">
28616 \begin_layout Plain Layout
28622 <cell alignment="center" valignment="top" usebox="none">
28625 \begin_layout Plain Layout
28631 <cell alignment="center" valignment="top" usebox="none">
28634 \begin_layout Plain Layout
28640 <cell alignment="center" valignment="top" usebox="none">
28643 \begin_layout Plain Layout
28649 <cell alignment="center" valignment="top" usebox="none">
28652 \begin_layout Plain Layout
28660 <cell alignment="left" valignment="top" usebox="none">
28663 \begin_layout Plain Layout
28669 <cell alignment="left" valignment="top" usebox="none">
28672 \begin_layout Plain Layout
28678 <cell alignment="left" valignment="top" usebox="none">
28681 \begin_layout Plain Layout
28687 <cell alignment="left" valignment="top" usebox="none">
28690 \begin_layout Plain Layout
28696 <cell alignment="center" valignment="top" usebox="none">
28699 \begin_layout Plain Layout
28705 <cell alignment="center" valignment="top" usebox="none">
28708 \begin_layout Plain Layout
28714 <cell alignment="center" valignment="top" usebox="none">
28717 \begin_layout Plain Layout
28723 <cell alignment="center" valignment="top" usebox="none">
28726 \begin_layout Plain Layout
28734 <cell alignment="left" valignment="top" usebox="none">
28737 \begin_layout Plain Layout
28743 <cell alignment="left" valignment="top" usebox="none">
28746 \begin_layout Plain Layout
28752 <cell alignment="left" valignment="top" usebox="none">
28755 \begin_layout Plain Layout
28761 <cell alignment="left" valignment="top" usebox="none">
28764 \begin_layout Plain Layout
28770 <cell alignment="center" valignment="top" usebox="none">
28773 \begin_layout Plain Layout
28779 <cell alignment="center" valignment="top" usebox="none">
28782 \begin_layout Plain Layout
28788 <cell alignment="center" valignment="top" usebox="none">
28791 \begin_layout Plain Layout
28797 <cell alignment="center" valignment="top" usebox="none">
28800 \begin_layout Plain Layout
28808 <cell alignment="left" valignment="top" usebox="none">
28811 \begin_layout Plain Layout
28817 <cell alignment="left" valignment="top" usebox="none">
28820 \begin_layout Plain Layout
28826 <cell alignment="left" valignment="top" usebox="none">
28829 \begin_layout Plain Layout
28835 <cell alignment="left" valignment="top" usebox="none">
28838 \begin_layout Plain Layout
28844 <cell alignment="center" valignment="top" usebox="none">
28847 \begin_layout Plain Layout
28853 <cell alignment="center" valignment="top" usebox="none">
28856 \begin_layout Plain Layout
28862 <cell alignment="center" valignment="top" usebox="none">
28865 \begin_layout Plain Layout
28871 <cell alignment="center" valignment="top" usebox="none">
28874 \begin_layout Plain Layout
28882 <cell alignment="left" valignment="top" usebox="none">
28885 \begin_layout Plain Layout
28891 <cell alignment="left" valignment="top" usebox="none">
28894 \begin_layout Plain Layout
28900 <cell alignment="left" valignment="top" usebox="none">
28903 \begin_layout Plain Layout
28909 <cell alignment="left" valignment="top" usebox="none">
28912 \begin_layout Plain Layout
28918 <cell alignment="center" valignment="top" usebox="none">
28921 \begin_layout Plain Layout
28927 <cell alignment="center" valignment="top" usebox="none">
28930 \begin_layout Plain Layout
28936 <cell alignment="center" valignment="top" usebox="none">
28939 \begin_layout Plain Layout
28945 <cell alignment="center" valignment="top" usebox="none">
28948 \begin_layout Plain Layout
28956 <cell alignment="left" valignment="top" usebox="none">
28959 \begin_layout Plain Layout
28965 <cell alignment="left" valignment="top" usebox="none">
28968 \begin_layout Plain Layout
28974 <cell alignment="left" valignment="top" usebox="none">
28977 \begin_layout Plain Layout
28983 <cell alignment="left" valignment="top" usebox="none">
28986 \begin_layout Plain Layout
28992 <cell alignment="center" valignment="top" usebox="none">
28995 \begin_layout Plain Layout
29001 <cell alignment="center" valignment="top" usebox="none">
29004 \begin_layout Plain Layout
29010 <cell alignment="center" valignment="top" usebox="none">
29013 \begin_layout Plain Layout
29019 <cell alignment="center" valignment="top" usebox="none">
29022 \begin_layout Plain Layout
29030 <cell alignment="left" valignment="top" usebox="none">
29033 \begin_layout Plain Layout
29039 <cell alignment="left" valignment="top" usebox="none">
29042 \begin_layout Plain Layout
29048 <cell alignment="left" valignment="top" usebox="none">
29051 \begin_layout Plain Layout
29057 <cell alignment="left" valignment="top" usebox="none">
29060 \begin_layout Plain Layout
29066 <cell alignment="center" valignment="top" usebox="none">
29069 \begin_layout Plain Layout
29075 <cell alignment="center" valignment="top" usebox="none">
29078 \begin_layout Plain Layout
29084 <cell alignment="center" valignment="top" usebox="none">
29087 \begin_layout Plain Layout
29093 <cell alignment="center" valignment="top" usebox="none">
29096 \begin_layout Plain Layout
29104 <cell alignment="center" valignment="top" usebox="none">
29107 \begin_layout Plain Layout
29113 <cell alignment="center" valignment="top" usebox="none">
29116 \begin_layout Plain Layout
29122 <cell alignment="center" valignment="top" usebox="none">
29125 \begin_layout Plain Layout
29131 <cell alignment="center" valignment="top" usebox="none">
29134 \begin_layout Plain Layout
29140 <cell alignment="center" valignment="top" usebox="none">
29143 \begin_layout Plain Layout
29149 <cell alignment="center" valignment="top" usebox="none">
29152 \begin_layout Plain Layout
29158 <cell alignment="center" valignment="top" usebox="none">
29161 \begin_layout Plain Layout
29167 <cell alignment="center" valignment="top" usebox="none">
29170 \begin_layout Plain Layout
29184 \begin_layout Chapter
29185 Names of available colors to be used in layouts
29186 \begin_inset CommandInset label
29188 name "chap:Names-of-colors"
29195 \begin_layout Standard
29196 The colors listed below are the standard colors and those that you can adjust
29197 in the \SpecialChar LyX
29201 \begin_layout Section
29205 \begin_layout Standard
29206 The following are no real colors, but rather act on color definitions:
29209 \begin_layout Description
29210 ignore The color is ignored
29213 \begin_layout Description
29214 inherit The color is inherited
29217 \begin_layout Description
29230 No particular color – clear or default
29233 \begin_layout Section
29237 \begin_layout Standard
29238 These are fixed colors that cannot me customized:
29241 \begin_layout Description
29245 \begin_layout Description
29249 \begin_layout Description
29253 \begin_layout Description
29257 \begin_layout Description
29261 \begin_layout Description
29265 \begin_layout Description
29269 \begin_layout Description
29273 \begin_layout Description
29277 \begin_layout Description
29281 \begin_layout Description
29285 \begin_layout Description
29289 \begin_layout Description
29293 \begin_layout Description
29297 \begin_layout Description
29301 \begin_layout Description
29305 \begin_layout Description
29309 \begin_layout Description
29313 \begin_layout Description
29317 \begin_layout Section
29321 \begin_layout Standard
29322 These are the colors allocated to specific elements in
29325 arg "dialog-show prefs"
29331 \begin_layout Description
29332 added_space Added space color
29335 \begin_layout Description
29336 addedtext Added text color
29339 \begin_layout Description
29340 appendix Appendix marker color
29343 \begin_layout Description
29344 background Background color
29347 \begin_layout Description
29348 bottomarea Bottom area color
29351 \begin_layout Description
29352 branchlabel Label color for branches
29355 \begin_layout Description
29356 buttonbg Color used for button background
29359 \begin_layout Description
29360 buttonframe Color for inset button frames
29363 \begin_layout Description
29364 buttonhoverbg Color used for button background under focus
29367 \begin_layout Description
29368 changebar Changebar color
29371 \begin_layout Description
29372 changedtextauthor1 Changed text color author 1
29375 \begin_layout Description
29376 changedtextauthor2 Changed text color author 2
29379 \begin_layout Description
29380 changedtextauthor3 Changed text color author 3
29383 \begin_layout Description
29384 changedtextauthor4 Changed text color author 4
29387 \begin_layout Description
29388 changedtextauthor5 Changed text color author 5
29391 \begin_layout Description
29392 collapsible Collapsible insets text color
29395 \begin_layout Description
29396 collapsibleframe Collapsible insets framecolor
29399 \begin_layout Description
29400 command Text color for command insets
29403 \begin_layout Description
29404 commandbg Background color for command insets
29407 \begin_layout Description
29408 commandframe Frame color for command insets
29411 \begin_layout Description
29412 comment Label color for comments
29415 \begin_layout Description
29416 commentbg Background color of comments
29419 \begin_layout Description
29420 cursor Cursor color
29423 \begin_layout Description
29424 deletedtext Deleted text color
29427 \begin_layout Description
29428 deletedtextmodifier Deleted text modifying color
29431 \begin_layout Description
29432 depthbar Color for the depth bars in the margin
29435 \begin_layout Description
29436 eolmarker End of line marker color
29439 \begin_layout Description
29440 error Color of the \SpecialChar LaTeX
29444 \begin_layout Description
29445 footlabel Label color for footnotes
29448 \begin_layout Description
29449 foreground Foreground color
29452 \begin_layout Description
29453 graphicsbg Graphics inset background color
29456 \begin_layout Description
29457 greyedoutbg Background color of greyedout inset
29460 \begin_layout Description
29461 greyedoutlabel Label color for greyedout insets
29464 \begin_layout Description
29465 greyedouttext Color for greyedout inset text
29468 \begin_layout Description
29469 indexlabel Label color for index insets
29472 \begin_layout Description
29473 inlinecompletion Inline completion color
29476 \begin_layout Description
29477 insetbg Inset marker background color
29480 \begin_layout Description
29481 insetframe Inset marker frame color
29484 \begin_layout Description
29485 language Color for marking foreign language words
29488 \begin_layout Description
29489 latex Text color in \SpecialChar LaTeX
29493 \begin_layout Description
29494 listingsbg Background color of listings inset
29497 \begin_layout Description
29498 marginlabel Label color for margin notes
29501 \begin_layout Description
29502 math Math inset text color
29505 \begin_layout Description
29506 mathbg Math inset background color
29509 \begin_layout Description
29510 mathcorners Math inset frame color not under focus
29513 \begin_layout Description
29514 mathframe Math inset frame color under focus
29517 \begin_layout Description
29518 mathline Math line color
29521 \begin_layout Description
29522 mathmacrobg Macro math inset background color
29525 \begin_layout Description
29526 mathmacroblend Macro math blended color
29529 \begin_layout Description
29530 mathmacroframe Macro math frame color
29533 \begin_layout Description
29534 mathmacrohoverbg Macro math inset background color hovered
29537 \begin_layout Description
29538 mathmacrolabel Macro math label color
29541 \begin_layout Description
29542 mathmacronewarg Macro template color for new parameters
29545 \begin_layout Description
29546 mathmacrooldarg Macro template color for old parameters
29549 \begin_layout Description
29550 newpage New page color
29553 \begin_layout Description
29554 nonunique_inlinecompletion Inline completion color for the non-unique part
29557 \begin_layout Description
29558 note Label color for notes
29561 \begin_layout Description
29562 notebg Background color of notes
29565 \begin_layout Description
29566 pagebreak Page break/line break color
29569 \begin_layout Description
29570 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29573 \begin_layout Description
29574 phantomtext Text color for phantom insets
29577 \begin_layout Description
29578 preview The color used for previews
29581 \begin_layout Description
29582 previewframe Preview frame color
29585 \begin_layout Description
29586 regexpframe Color for regexp frame
29589 \begin_layout Description
29590 scroll Color that indicates when a row can be scrolled
29593 \begin_layout Description
29594 selection Background color of selected text
29597 \begin_layout Description
29598 selectiontext Foreground color of selected text
29601 \begin_layout Description
29602 shadedbg Background color of shaded box
29605 \begin_layout Description
29606 special Special chars text color
29609 \begin_layout Description
29610 tabularline Table line color
29613 \begin_layout Description
29614 tabularonoffline Table line color
29617 \begin_layout Description
29618 urllabel Label color for URL insets
29621 \begin_layout Description
29622 urltext Color for URL inset text