1 #LyX 2.3 created this file. For more info see http://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 fleqn,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
61 \default_output_format pdf2
63 \bibtex_command default
64 \index_command default
68 \pdf_title "LyX Configuration Manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX-documentation Customization"
71 \pdf_keywords "LyX, documentation, customization"
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen true
75 \pdf_bookmarksopenlevel 1
80 \pdf_pdfusetitle false
81 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
84 \use_package amsmath 0
85 \use_package amssymb 0
88 \use_package mathdots 1
89 \use_package mathtools 0
91 \use_package stackrel 0
92 \use_package stmaryrd 0
93 \use_package undertilde 0
95 \cite_engine_type default
99 \paperorientation portrait
103 \notefontcolor #0000ff
115 \paragraph_separation indent
116 \paragraph_indentation default
117 \quotes_style english
121 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
127 \author -712698321 "Jürgen Spitzmüller"
128 \author 2047637253 "Guillaume Munch"
129 \author 2089657418 "Usti"
135 Customizing \SpecialChar LyX
136 : Features for the Advanced User
140 by the \SpecialChar LyX
145 \begin_layout Plain Layout
147 If you have comments or error corrections, please send them to the \SpecialChar LyX
150 \begin_inset CommandInset href
152 target "lyx-docs@lists.lyx.org"
159 \begin_inset Quotes eld
163 \begin_inset Quotes erd
166 in the subject header, and please cc the current maintainer of this file,
167 Richard Heck <rgheck@comcast.net>.
173 \begin_inset Newline newline
177 \begin_inset Newline newline
183 \begin_layout Standard
184 \begin_inset CommandInset toc
185 LatexCommand tableofcontents
192 \begin_layout Standard
193 \begin_inset Note Note
196 \begin_layout Plain Layout
197 Please use change tracking when modifying this document.
198 This makes it easier for our translators to recognize things that have
199 been changed, and it helps the maintainer keep up-to-date with what's been
208 \begin_layout Chapter
212 \begin_layout Standard
213 This manual covers the customization features present in \SpecialChar LyX
215 In it, we discuss issues like keyboard shortcuts, screen previewing options,
216 printer options, sending commands to \SpecialChar LyX
217 via the \SpecialChar LyX
218 Server, internationalization,
219 installing new \SpecialChar LaTeX
220 classes and \SpecialChar LyX
222 We can't possibly hope to touch on everything you can change—our developers
223 add new features faster than we can document them—but we will explain the
224 most common customizations and hopefully point you in the right direction
225 for some of the more obscure ones.
228 \begin_layout Standard
229 \begin_inset Branch OutDated
233 \begin_layout Standard
234 Information from previous versions of this document that now seems to be
235 outdated is contained in the OutDated branch of this document.
236 By default, this information will not appear in the \SpecialChar LaTeX
245 \begin_layout Chapter
250 \begin_layout Standard
251 This chapter aims to help you to find your way through the \SpecialChar LyX
254 Before continuing to read this chapter, you should find out where your
256 library and user directories are by using
257 \begin_inset Flex Noun
260 \begin_layout Plain Layout
261 Help\SpecialChar menuseparator
272 The library directory is the place where \SpecialChar LyX
273 places its system-wide configuration
274 files; the user directory is where you can place your modified versions.
275 We will call the former
276 \begin_inset Flex Code
279 \begin_layout Plain Layout
286 \begin_inset Flex Noun
289 \begin_layout Plain Layout
295 in the remainder of this document.
299 \begin_layout Section
301 \begin_inset Flex Code
304 \begin_layout Plain Layout
313 \begin_layout Standard
314 \begin_inset Flex Code
317 \begin_layout Plain Layout
323 and its sub-directories contain a number of files and that can be used
324 to customize \SpecialChar LyX
326 You can change many of these files from within \SpecialChar LyX
328 \begin_inset Flex Noun
331 \begin_layout Plain Layout
332 Tools\SpecialChar menuseparator
339 Most customization that you will want to do in \SpecialChar LyX
340 is possible through this
342 However, many other inner aspects of \SpecialChar LyX
343 can be customized by modifying the
345 \begin_inset Flex Code
348 \begin_layout Plain Layout
355 These files fall in different categories, described in the following subsection
359 \begin_layout Subsection
360 Automatically generated files
363 \begin_layout Standard
364 The files, which are to be found in
365 \begin_inset Flex Noun
368 \begin_layout Plain Layout
374 , are generated when you configure \SpecialChar LyX
376 They contain various default values that are guessed by inspection.
377 In general, it is not a good idea to modify them, since they might be overwritt
381 \begin_layout Labeling
382 \labelwidthstring 00.00.0000
383 \begin_inset Flex Code
386 \begin_layout Plain Layout
392 contains defaults for various commands.
395 \begin_layout Labeling
396 \labelwidthstring 00.00.0000
397 \begin_inset Flex Code
400 \begin_layout Plain Layout
406 contains the list of packages that have been recognized by \SpecialChar LyX
408 It is currently unused by the \SpecialChar LyX
409 program itself, but the information extracted,
410 and more, is made available with
411 \begin_inset Flex Noun
414 \begin_layout Plain Layout
415 Help\SpecialChar menuseparator
429 \begin_layout Labeling
430 \labelwidthstring 00.00.0000
431 \begin_inset Flex Code
434 \begin_layout Plain Layout
440 the list of text classes that have been found in your
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
450 directories, along with the associated \SpecialChar LaTeX
451 document class and their description.
454 \begin_layout Labeling
455 \labelwidthstring 00.00.0000
456 \begin_inset Flex Code
459 \begin_layout Plain Layout
465 the list of layout modules found in your
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
478 \begin_layout Labeling
479 \labelwidthstring 00.00.0000
480 \begin_inset Flex Code
483 \begin_layout Plain Layout
489 lists of various sorts of \SpecialChar LaTeX
490 -related files found on your system
493 \begin_layout Labeling
494 \labelwidthstring 00.00.0000
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
499 doc/\SpecialChar LaTeX
505 is automatically generated during configuration from the file
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
517 It contains information on your \SpecialChar LaTeX
521 \begin_layout Subsection
525 \begin_layout Standard
526 These directories are duplicated between
527 \begin_inset Flex Code
530 \begin_layout Plain Layout
537 \begin_inset Flex Code
540 \begin_layout Plain Layout
547 If a particular files exists in both places, the one in
548 \begin_inset Flex Code
551 \begin_layout Plain Layout
560 \begin_layout Labeling
561 \labelwidthstring 00.00.0000
562 \begin_inset Flex Code
565 \begin_layout Plain Layout
571 this directory contains files with the extension
572 \begin_inset Flex Code
575 \begin_layout Plain Layout
581 that define the keybindings used in \SpecialChar LyX
583 If there exists an internationalized version of the bind file named
584 \begin_inset Flex Code
587 \begin_layout Plain Layout
593 , that will be used first.
594 \change_inserted -712698321 1483535138
598 \begin_layout Labeling
599 \labelwidthstring 00.00.0000
601 \change_inserted -712698321 1483874001
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
607 \change_inserted -712698321 1483535144
613 contains files with the extension
614 \begin_inset Flex Code
617 \begin_layout Plain Layout
619 \change_inserted -712698321 1483869840
627 which define the diverse citation possibilities (natbib, biblatex etc.).
629 \begin_inset CommandInset ref
631 reference "subsec:Cite-Engine-Files"
643 \begin_layout Labeling
644 \labelwidthstring 00.00.0000
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 contains graphics files that can be included in documents.
658 \begin_layout Labeling
659 \labelwidthstring 00.00.0000
660 \begin_inset Flex Code
663 \begin_layout Plain Layout
669 contains \SpecialChar LyX
670 documentation files (including the one you are currently reading).
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
682 deserves special attention, as noted above.
683 The internationalized help docs are in subdirectories
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
694 \begin_inset Quotes eld
698 \begin_inset Quotes erd
701 is the ISO language code.
703 \begin_inset CommandInset ref
705 reference "cha:Internationalizing-LyX"
712 \begin_layout Labeling
713 \labelwidthstring 00.00.0000
714 \begin_inset Flex Code
717 \begin_layout Plain Layout
723 contains example files that explain how to use some features.
724 In the file browser, press the
725 \begin_inset Flex Noun
728 \begin_layout Plain Layout
737 \begin_layout Labeling
738 \labelwidthstring 00.00.0000
739 \begin_inset Flex Code
742 \begin_layout Plain Layout
748 contains image files that are used by the
749 \begin_inset Flex Noun
752 \begin_layout Plain Layout
759 In addition, it also contains the individual icons used in the toolbar
760 and the banners that can be shown when \SpecialChar LyX
764 \begin_layout Labeling
765 \labelwidthstring 00.00.0000
766 \begin_inset Flex Code
769 \begin_layout Plain Layout
775 contains keyboard keymapping files.
777 \begin_inset CommandInset ref
779 reference "sec:International-Keymap-Stuff"
786 \begin_layout Labeling
787 \labelwidthstring 00.00.0000
788 \begin_inset Flex Code
791 \begin_layout Plain Layout
797 contains the text class and module files described in
798 \begin_inset CommandInset ref
800 reference "cha:Installing-New-Document"
807 \begin_layout Labeling
808 \labelwidthstring 00.00.0000
809 \begin_inset Flex Code
812 \begin_layout Plain Layout
819 \begin_inset Flex Code
822 \begin_layout Plain Layout
828 Python scripts used to convert between \SpecialChar LyX
830 These can be run from the command line if, say, you want to batch-convert
834 \begin_layout Labeling
835 \labelwidthstring 00.00.0000
836 \begin_inset Flex Code
839 \begin_layout Plain Layout
845 contains some files that demonstrate the capabilities of the
846 \begin_inset Flex Noun
849 \begin_layout Plain Layout
860 Also contains some scripts used by \SpecialChar LyX
864 \begin_layout Labeling
865 \labelwidthstring 00.00.0000
866 \begin_inset Flex Code
869 \begin_layout Plain Layout
875 contains the standard \SpecialChar LyX
876 template files described in
877 \begin_inset CommandInset ref
879 reference "subsec:Creating-Templates"
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
897 contains files with the extension
898 \begin_inset Flex Code
901 \begin_layout Plain Layout
907 that define the user interface to \SpecialChar LyX
909 That is, the files define which items appear in which menus and the items
910 appearing on the toolbar.
913 \begin_layout Subsection
914 Files you don't want to modify
917 \begin_layout Standard
918 These files are used internally by \SpecialChar LyX
919 and you generally do not need to modify
920 them unless you are a developer.
923 \begin_layout Labeling
924 \labelwidthstring 00.00.0000
925 \begin_inset Flex Code
928 \begin_layout Plain Layout
934 this file contains the list of \SpecialChar LyX
936 The contents are displayed with the menu entry
937 \begin_inset Flex Noun
940 \begin_layout Plain Layout
941 Help\SpecialChar menuseparator
954 \begin_layout Labeling
955 \labelwidthstring 00.00.0000
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 this is a \SpecialChar LaTeX
966 script used during the configuration process.
970 \begin_layout Labeling
971 \labelwidthstring 00.00.0000
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
981 this is a Python script that is used to re-configure \SpecialChar LyX
983 It creates configuration files in the directory it was run from.
986 \begin_layout Subsection
987 Other files needing a line or two
990 \begin_layout Labeling
991 \labelwidthstring 00.00.0000
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1001 this contains tables describing how different character encodings can be
1005 \begin_layout Labeling
1006 \labelwidthstring 00.00.0000
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1016 this file contains the templates available to the new
1017 \begin_inset Flex Noun
1020 \begin_layout Plain Layout
1022 \begin_inset space ~
1031 \begin_inset CommandInset ref
1033 reference "chap:Including-External-Material"
1040 \begin_layout Labeling
1041 \labelwidthstring 00.00.0000
1042 \begin_inset Flex Code
1045 \begin_layout Plain Layout
1051 this file contains a list of all the languages currently supported by \SpecialChar LyX
1055 \begin_layout Labeling
1056 \labelwidthstring 00.00.0000
1057 \begin_inset Flex Code
1060 \begin_layout Plain Layout
1066 contains information about the supported fonts.
1069 \begin_layout Labeling
1070 \labelwidthstring 00.00.0000
1071 \begin_inset Flex Code
1074 \begin_layout Plain Layout
1080 this file contains translations for internationalized paragraph styles
1082 \begin_inset CommandInset ref
1084 reference "subsec:I18n"
1091 \begin_layout Labeling
1092 \labelwidthstring 00.00.0000
1093 \begin_inset Flex Code
1096 \begin_layout Plain Layout
1102 this file contains information about unicode-encoded glyphs and the way
1103 they are supported by \SpecialChar LyX
1104 via \SpecialChar LaTeX
1108 \begin_layout Section
1109 Your local configuration directory
1112 \begin_layout Standard
1113 Even if you are using \SpecialChar LyX
1114 as an unprivileged user, you might want to change
1116 configuration for your own use.
1118 \begin_inset Flex Code
1121 \begin_layout Plain Layout
1127 directory contains all your personal configuration files.
1128 This is the directory described as
1129 \begin_inset Quotes eld
1133 \begin_inset Quotes erd
1137 \begin_inset Flex Noun
1140 \begin_layout Plain Layout
1141 Help\SpecialChar menuseparator
1143 \begin_inset space ~
1152 This directory is used as a mirror of
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 , which means that every file in
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 is a replacement for the corresponding file in
1173 \begin_inset Flex Code
1176 \begin_layout Plain Layout
1183 Any configuration file described in the above sections can be placed either
1184 in the system-wide directory, in which case it will affect all users, or
1185 in your local directory for your own use.
1188 \begin_layout Standard
1189 To make things clearer, let's provide a few examples:
1192 \begin_layout Itemize
1193 The preferences set in the
1194 \begin_inset Flex Noun
1197 \begin_layout Plain Layout
1198 Tools\SpecialChar menuseparator
1204 dialog are saved to a file
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1215 \begin_inset Flex Code
1218 \begin_layout Plain Layout
1227 \begin_layout Itemize
1228 When you reconfigure using
1229 \begin_inset Flex Noun
1232 \begin_layout Plain Layout
1233 Tools\SpecialChar menuseparator
1241 \begin_inset Flex Code
1244 \begin_layout Plain Layout
1250 script, and the resulting files are written in your local configuration
1252 This means that any additional text class file that you might have added
1254 \begin_inset Flex Code
1257 \begin_layout Plain Layout
1263 will be added to the list of classes in the
1264 \begin_inset Flex Noun
1267 \begin_layout Plain Layout
1268 Document\SpecialChar menuseparator
1277 \begin_layout Itemize
1278 If you get some updated documentation from \SpecialChar LyX
1279 ftp site and cannot install
1280 it because you do not have sysadmin rights on your system, you can just
1282 \begin_inset Flex Code
1285 \begin_layout Plain Layout
1291 and the items in the
1292 \begin_inset Flex Noun
1295 \begin_layout Plain Layout
1301 menu will open them!
1304 \begin_layout Section
1305 Running \SpecialChar LyX
1306 with multiple configurations
1309 \begin_layout Standard
1310 The configuration freedom of the local configuration directory may not suffice
1311 if you want to have more than one configuration at your disposal.
1312 For example, you may want to be use different key bindings or printer settings
1314 You can achieve this by having several such directories.
1315 You then specify which directory to use at run-time.
1318 \begin_layout Standard
1319 Invoking \SpecialChar LyX
1320 with the command line switch
1321 \begin_inset Flex Code
1324 \begin_layout Plain Layout
1334 instructs the program to read the configuration from that directory, and
1335 not from the default directory.
1336 (You can determine the default directory by running \SpecialChar LyX
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1347 switch.) If the specified directory does not exist, \SpecialChar LyX
1349 for you, just like it does for the default directory on the first time
1350 you run the program.
1351 You can modify the configuration options in this additional user directory
1352 exactly as you would for the default directory.
1353 These directories are completely independent (but read on).
1354 Note that setting the environment variable
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1364 to some value has exactly the same effect.
1367 \begin_layout Standard
1368 Having several configurations also requires more maintenance: if you want
1369 to add a new layout to
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1379 which you want available from all your configurations, you must add it
1380 to each directory separately.
1381 You can avoid this with the following trick: after \SpecialChar LyX
1382 creates the additional
1383 directory, most of the subdirectories (see above) are empty.
1384 If you want the new configuration to mirror an existing one, replace the
1385 empty subdirectory with a symbolic link to the matching subdirectory in
1386 the existing configuration.
1388 \begin_inset Flex Code
1391 \begin_layout Plain Layout
1397 subdirectory, however, since it contains a file written by the configuration
1398 script (also accessible through
1399 \begin_inset Flex Noun
1402 \begin_layout Plain Layout
1403 Tools\SpecialChar menuseparator
1409 ) which is configuration-specific.
1412 \begin_layout Chapter
1413 The Preferences dialog
1416 \begin_layout Standard
1417 All options of the preferences dialog are described in the Appendix
1419 The Preferences Dialog
1426 For some options you might find here more details.
1429 \begin_layout Section
1431 \begin_inset CommandInset label
1440 \begin_layout Standard
1441 The first step is to define your file formats if they are not already defined.
1443 \begin_inset Flex Noun
1446 \begin_layout Plain Layout
1447 Tools\SpecialChar menuseparator
1455 \begin_inset Flex Noun
1458 \begin_layout Plain Layout
1459 File Handling\SpecialChar menuseparator
1466 \begin_inset Flex Noun
1469 \begin_layout Plain Layout
1475 button to define your new format.
1477 \begin_inset Flex Noun
1480 \begin_layout Plain Layout
1486 field contains the name used to identify the format in the GUI.
1488 \begin_inset Flex Noun
1491 \begin_layout Plain Layout
1497 is used to identify the format internally.
1498 You will also need to enter a file extension.
1499 These are all required.
1501 \begin_inset Flex Noun
1504 \begin_layout Plain Layout
1510 field is used to provide a keyboard shortcut on the menus.
1511 (For example, pressing
1512 \begin_inset Flex Noun
1515 \begin_layout Plain Layout
1522 \begin_inset Flex Noun
1525 \begin_layout Plain Layout
1526 Document\SpecialChar menuseparator
1527 View (Other Formats)\SpecialChar menuseparator
1536 \begin_layout Standard
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1548 \begin_inset Flex Noun
1551 \begin_layout Plain Layout
1558 For example, you might want to use
1559 \begin_inset Flex Noun
1562 \begin_layout Plain Layout
1568 to view PostScript files.
1569 You can enter the command needed to start the program in the corresponding
1571 In defining this command, you can use the four variables listed in the
1573 The viewer is launched when you view an image in \SpecialChar LyX
1575 \begin_inset Flex Noun
1578 \begin_layout Plain Layout
1579 Document\SpecialChar menuseparator
1586 The editor is for example launched when you right-click on an image and
1588 \begin_inset Flex Noun
1591 \begin_layout Plain Layout
1597 in the appearing context menu.
1600 \begin_layout Standard
1602 \begin_inset Flex Noun
1605 \begin_layout Plain Layout
1611 type of a format is optional, but if it is specified, it must be unique
1613 It is used to detect files of this format from the file contents.
1614 For some important file formats there is no MIME type officially registered
1616 \begin_inset CommandInset href
1619 target "http://www.iana.org/assignments/media-types/"
1624 Therefore \SpecialChar LyX
1625 uses the extended list of MIME types as specified by
1626 \begin_inset CommandInset href
1628 name "freedesktop.org"
1629 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1636 \begin_layout Standard
1638 \begin_inset Flex Noun
1641 \begin_layout Plain Layout
1647 option tells \SpecialChar LyX
1648 that a format is suitable for document export.
1649 If this is set and if a suitable conversion route exists (see
1650 \begin_inset CommandInset ref
1652 reference "sec:Converters"
1656 ), the format will appear in the
1657 \begin_inset Flex Noun
1660 \begin_layout Plain Layout
1661 File\SpecialChar menuseparator
1668 The format will also appear in the
1669 \begin_inset Flex Noun
1672 \begin_layout Plain Layout
1673 Document\SpecialChar menuseparator
1679 menu if a viewer is specified for the format.
1680 Pure image formats, such as
1681 \begin_inset Flex Code
1684 \begin_layout Plain Layout
1690 , should not use this option.
1691 Formats that can both represent vector graphics and documents like
1692 \begin_inset Flex Code
1695 \begin_layout Plain Layout
1704 \begin_layout Standard
1706 \begin_inset Flex Noun
1709 \begin_layout Plain Layout
1710 Vector graphics format
1715 tells \SpecialChar LyX
1716 that a format can contain vector graphics.
1717 This information is used to determine the target format of included graphics
1719 \begin_inset Flex Noun
1722 \begin_layout Plain Layout
1729 Included graphics may need to be converted to either
1730 \begin_inset Flex Noun
1733 \begin_layout Plain Layout
1740 \begin_inset Flex Noun
1743 \begin_layout Plain Layout
1750 \begin_inset Flex Noun
1753 \begin_layout Plain Layout
1760 \begin_inset Flex Noun
1763 \begin_layout Plain Layout
1769 cannot handle other image formats.
1770 If an included graphic is not already in
1771 \begin_inset Flex Noun
1774 \begin_layout Plain Layout
1781 \begin_inset Flex Noun
1784 \begin_layout Plain Layout
1791 \begin_inset Flex Noun
1794 \begin_layout Plain Layout
1800 format, it is converted to
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1810 if the vector format option is set, and otherwise to
1811 \begin_inset Flex Noun
1814 \begin_layout Plain Layout
1823 \begin_layout Section
1827 \begin_layout Standard
1828 Since all conversions from one format to another take place in \SpecialChar LyX
1830 directory, it is sometimes necessary to modify a file before copying it
1831 to the temporary directory in order that the conversion may be performed.
1835 \begin_layout Plain Layout
1836 For example, the file may refer to other files—images, for example—using
1837 relative file names, and these may become invalid when the file is copied
1838 to the temporary directory.
1843 This is done by a Copier: It copies a file to (or from) the temporary directory
1844 and may modify it in the process.
1847 \begin_layout Standard
1848 The definitions of the copiers may use eight variables:
1851 \begin_layout Labeling
1852 \labelwidthstring 00.00.0000
1853 \begin_inset Flex Code
1856 \begin_layout Plain Layout
1862 The \SpecialChar LyX
1863 system directory (e.
1864 \begin_inset space \thinspace{}
1868 \begin_inset space \space{}
1872 \begin_inset Flex Noun
1875 \begin_layout Plain Layout
1884 \begin_layout Labeling
1885 \labelwidthstring 00.00.0000
1886 \begin_inset Flex Code
1889 \begin_layout Plain Layout
1898 \begin_layout Labeling
1899 \labelwidthstring 00.00.0000
1900 \begin_inset Flex Code
1903 \begin_layout Plain Layout
1912 \begin_layout Labeling
1913 \labelwidthstring 00.00.0000
1914 \begin_inset Flex Code
1917 \begin_layout Plain Layout
1923 The base name (without filename extension) in the \SpecialChar LyX
1927 \begin_layout Labeling
1928 \labelwidthstring 00.00.0000
1929 \begin_inset Flex Code
1932 \begin_layout Plain Layout
1938 The full directory path of the \SpecialChar LyX
1942 \begin_layout Labeling
1943 \labelwidthstring 00.00.0000
1944 \begin_inset Flex Code
1947 \begin_layout Plain Layout
1953 The full pathname to the original \SpecialChar LyX
1954 file being processed
1957 \begin_layout Labeling
1958 \labelwidthstring 00.00.0000
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1968 The filename (without any directory path) of the \SpecialChar LyX
1972 \begin_layout Labeling
1973 \labelwidthstring 00.00.0000
1974 \begin_inset Flex Code
1977 \begin_layout Plain Layout
1983 The `\SpecialChar LaTeX
1987 \begin_layout Standard
1988 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1996 It is relevant only when exporting files suitable for such inclusion.
1999 \begin_layout Standard
2000 Copiers can be used to do almost anything with output files.
2001 For example, suppose you want generated pdf files to be copied to a special
2003 \begin_inset Flex Code
2006 \begin_layout Plain Layout
2013 Then you could write a shell script such as this one:
2016 \begin_layout Standard
2017 \begin_inset listings
2021 \begin_layout Plain Layout
2026 \begin_layout Plain Layout
2031 \begin_layout Plain Layout
2033 TOFILE=`basename $2`
2036 \begin_layout Plain Layout
2038 cp $FROMFILE /home/you/pdf/$TOFILE
2043 Save it in your local \SpecialChar LyX
2045 \begin_inset Flex Code
2048 \begin_layout Plain Layout
2049 /home/you/.lyx/scripts/pdfcopier.sh
2054 —and make it executable, if you need to do so on your platform.
2056 \begin_inset Flex Noun
2059 \begin_layout Plain Layout
2060 Tools\SpecialChar menuseparator
2066 dialog, select under
2067 \begin_inset Flex Noun
2070 \begin_layout Plain Layout
2071 File Handling\SpecialChar menuseparator
2078 \begin_inset Flex Noun
2081 \begin_layout Plain Layout
2087 format—or one of the other pdf formats—and enter
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2092 pdfcopier.sh $$i $$o
2098 \begin_inset Flex Noun
2101 \begin_layout Plain Layout
2111 \begin_layout Standard
2112 Copiers are used by \SpecialChar LyX
2113 in various of its own conversions.
2114 For example, if appropriate programs are found, \SpecialChar LyX
2115 will automatically install
2117 \begin_inset Flex Noun
2120 \begin_layout Plain Layout
2127 \begin_inset Flex Noun
2130 \begin_layout Plain Layout
2132 \begin_inset space ~
2141 When these formats are exported, the copier sees that not just the main
2142 HTML file but various associated files (style files, images, etc.) are also
2144 All these files are written to a subdirectory of the directory in which
2145 the original \SpecialChar LyX
2150 \begin_layout Plain Layout
2151 This copier can be customized.
2153 \begin_inset Quotes eld
2157 \begin_inset Quotes erd
2160 argument takes a comma-separated list of extensions to be copied; if it
2161 is omitted, all files will be copied.
2163 \begin_inset Quotes eld
2167 \begin_inset Quotes erd
2170 argument determines the extension added to the generated directory.
2172 \begin_inset Quotes eld
2176 \begin_inset Flex Noun
2179 \begin_layout Plain Layout
2186 \begin_inset Quotes erd
2189 , so HTML generated from
2190 \begin_inset Flex Noun
2193 \begin_layout Plain Layout
2194 /path/to/filename.lyx
2200 \begin_inset Flex Noun
2203 \begin_layout Plain Layout
2204 /path/to/filename.html.LyXconv
2218 \begin_layout Section
2220 \begin_inset CommandInset label
2222 name "sec:Converters"
2229 \begin_layout Standard
2230 You can define your own Converters to convert files between different formats.
2232 \begin_inset Flex Noun
2235 \begin_layout Plain Layout
2236 Tools\SpecialChar menuseparator
2237 Preferences\SpecialChar menuseparator
2238 File Handling\SpecialChar menuseparator
2247 \begin_layout Standard
2248 To define a new converter, select the
2249 \begin_inset Flex Noun
2252 \begin_layout Plain Layout
2254 \begin_inset space ~
2263 \begin_inset Flex Noun
2266 \begin_layout Plain Layout
2268 \begin_inset space ~
2276 from the drop-down lists, enter the command needed for the conversion,
2278 \begin_inset Flex Noun
2281 \begin_layout Plain Layout
2288 Several variables can be used in the definition of converters:
2291 \begin_layout Labeling
2292 \labelwidthstring 00.00.0000
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 The \SpecialChar LyX
2306 \begin_layout Labeling
2307 \labelwidthstring 00.00.0000
2308 \begin_inset Flex Code
2311 \begin_layout Plain Layout
2320 \begin_layout Labeling
2321 \labelwidthstring 00.00.0000
2322 \begin_inset Flex Code
2325 \begin_layout Plain Layout
2334 \begin_layout Labeling
2335 \labelwidthstring 00.00.0000
2336 \begin_inset Flex Code
2339 \begin_layout Plain Layout
2345 The base filename of the input file (i.
2346 \begin_inset space \thinspace{}
2349 g., without the extension)
2352 \begin_layout Labeling
2353 \labelwidthstring 00.00.0000
2354 \begin_inset Flex Code
2357 \begin_layout Plain Layout
2363 The path to the input file
2366 \begin_layout Labeling
2367 \labelwidthstring 00.00.0000
2368 \begin_inset Flex Code
2371 \begin_layout Plain Layout
2377 The path to the original input file (this is different from $$p when a
2378 chain of converters is called)
2381 \begin_layout Labeling
2382 \labelwidthstring 00.00.0000
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2392 The iconv name for the encoding of the document.
2395 \begin_layout Standard
2397 \begin_inset Flex Noun
2400 \begin_layout Plain Layout
2402 \begin_inset space ~
2410 field you can enter the following flags, separated by commas:
2413 \begin_layout Labeling
2414 \labelwidthstring 00.00.0000
2415 \begin_inset Flex Code
2418 \begin_layout Plain Layout
2424 This converter runs some form of \SpecialChar LaTeX
2426 This will make \SpecialChar LyX
2427 's \SpecialChar LaTeX
2428 error logs available.
2431 \begin_layout Labeling
2432 \labelwidthstring 00.00.0000
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2442 Needs the \SpecialChar LaTeX
2444 \begin_inset Flex Noun
2447 \begin_layout Plain Layout
2453 file for the conversion.
2456 \begin_layout Labeling
2457 \labelwidthstring 00.00.0000
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Quotes eld
2472 \begin_inset Quotes erd
2475 file from the backend, which in practice means a \SpecialChar LaTeX
2476 file like the one we
2477 would export, without
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2490 \begin_layout Labeling
2491 \labelwidthstring 00.00.0000
2492 \begin_inset Flex Code
2495 \begin_layout Plain Layout
2504 \begin_layout Standard
2505 The following three flags are not really flags at all because they take
2507 \begin_inset Flex Noun
2510 \begin_layout Plain Layout
2512 \begin_inset space ~
2516 \begin_inset space ~
2527 \begin_layout Labeling
2528 \labelwidthstring 00.00.0000
2529 \begin_inset Flex Code
2532 \begin_layout Plain Layout
2538 If set, the converter's standard error will be redirected to a file
2539 \begin_inset Flex Code
2542 \begin_layout Plain Layout
2548 , and the script given as argument will be run as:
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2553 script < infile.out > infile.log
2559 The argument may contain
2560 \begin_inset Flex Code
2563 \begin_layout Plain Layout
2572 \begin_layout Labeling
2573 \labelwidthstring 00.00.0000
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2583 The name of the directory in which the converter will dump the generated
2586 will not create this directory, and it does not copy anything into it,
2587 though it will copy this directory to the destination.
2588 The argument may contain
2589 \begin_inset Flex Code
2592 \begin_layout Plain Layout
2598 , which will be replaced by the base name of the input and output files,
2599 respectively, when the directory is copied.
2600 \begin_inset Newline newline
2603 Note that resultdir and usetempdir make no sense together.
2604 The latter will be ignored if the former is given.
2607 \begin_layout Labeling
2608 \labelwidthstring 00.00.0000
2609 \begin_inset Flex Code
2612 \begin_layout Plain Layout
2618 Determines the output file name and may, contain
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 Sensible only with resultdir and optional even then; if not given, it defaults
2633 \begin_layout Standard
2634 None of these last three are presently used in any of the converters that
2635 are installed with \SpecialChar LyX
2640 \begin_layout Standard
2641 You do not have to define converters for all formats between which you want
2643 For example, you will note that there is no `\SpecialChar LyX
2644 to PostScript' converter,
2645 but \SpecialChar LyX
2646 will export PostScript.
2647 It does so by first creating a \SpecialChar LaTeX
2648 file (no converter needs to be defined
2649 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2651 and finally converting the resulting DVI file to PostScript.
2653 finds such `chains' of converters automatically, and it will always choose
2654 the shortest possible chain.
2655 You can, though, still define multiple conversion methods between file
2657 For example, the standard \SpecialChar LyX
2658 configuration provides five ways to convert
2663 \begin_layout Enumerate
2665 \begin_inset Flex Noun
2668 \begin_layout Plain Layout
2677 \begin_layout Enumerate
2678 via (DVI and) PostScript, using
2679 \begin_inset Flex Noun
2682 \begin_layout Plain Layout
2691 \begin_layout Enumerate
2693 \begin_inset Flex Noun
2696 \begin_layout Plain Layout
2705 \begin_layout Enumerate
2707 \begin_inset Flex Noun
2710 \begin_layout Plain Layout
2720 \begin_layout Enumerate
2722 \begin_inset Flex Noun
2725 \begin_layout Plain Layout
2735 \begin_layout Standard
2736 To define such alternate chains, you must define multiple target `file formats',
2738 \begin_inset CommandInset ref
2740 reference "sec:Formats"
2745 For example, in the standard configuration, the formats named
2746 \begin_inset Flex Noun
2749 \begin_layout Plain Layout
2756 \begin_inset Flex Noun
2759 \begin_layout Plain Layout
2766 \begin_inset Flex Noun
2769 \begin_layout Plain Layout
2776 \begin_inset Flex Noun
2779 \begin_layout Plain Layout
2786 \begin_inset Flex Noun
2789 \begin_layout Plain Layout
2796 \begin_inset Flex Noun
2799 \begin_layout Plain Layout
2806 \begin_inset Flex Noun
2809 \begin_layout Plain Layout
2816 \begin_inset Flex Noun
2819 \begin_layout Plain Layout
2827 \begin_inset Flex Noun
2830 \begin_layout Plain Layout
2837 \begin_inset Flex Noun
2840 \begin_layout Plain Layout
2847 ) are defined, all of which share the extension
2848 \begin_inset Flex Noun
2851 \begin_layout Plain Layout
2857 , and which correspond to the conversion methods just mentioned.
2860 \begin_layout Chapter
2861 Internationalizing \SpecialChar LyX
2863 \begin_inset CommandInset label
2865 name "cha:Internationalizing-LyX"
2872 \begin_layout Standard
2874 supports using a translated interface.
2875 Last time we checked, \SpecialChar LyX
2876 provided text in thirty languages.
2877 The language of choice is called your
2882 (For further reading on locale settings, see also the documentation for
2883 locale that comes with your operating system.
2884 For Linux, the manual page for
2885 \begin_inset Flex Code
2888 \begin_layout Plain Layout
2894 could be a good place to start).
2897 \begin_layout Standard
2898 Notice that these translations will work, but do contain a few flaws.
2899 In particular, all dialogs have been designed with the English text in
2900 mind, which means that some of the translated text will be too large to
2901 fit within the space allocated.
2902 This is only a display problem and will not cause any harm.
2903 Also, you will find that some of the translations do not define shortcut
2904 keys for everything.
2905 Sometimes, there are simply not enough free letters to do it.
2906 Other times, the translator just hasn't got around to doing it yet.
2907 Our localization team, which you may wish to join,
2911 \begin_layout Plain Layout
2912 If you are a fluent speaker of a language other than English, joining these
2913 teams is a great way to give back to the \SpecialChar LyX
2919 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2923 \begin_layout Section
2924 Translating \SpecialChar LyX
2928 \begin_layout Subsection
2929 Translating the graphical user interface (text messages).
2932 \begin_layout Standard
2935 \begin_inset Flex Code
2938 \begin_layout Plain Layout
2944 library to handle the internationalization of the interface.
2945 To have \SpecialChar LyX
2946 speak your favorite language in all menus and dialogs, you need
2948 \begin_inset Flex Code
2951 \begin_layout Plain Layout
2957 -file for that language.
2958 When this is available, you'll have to generate a
2959 \begin_inset Flex Code
2962 \begin_layout Plain Layout
2968 -file from it and install the
2969 \begin_inset Flex Code
2972 \begin_layout Plain Layout
2979 The process of doing all of this is explained in the documentation for
2981 \begin_inset Flex Code
2984 \begin_layout Plain Layout
2991 It is possible to do this just for yourself, but if you're going to do
2992 it, you might as well share the results of your labors with the rest of
2993 the \SpecialChar LyX
2995 Send a message to the \SpecialChar LyX
2996 developers' list for more information about how
3000 \begin_layout Standard
3001 In short, this is what you should do (xx denotes the language code):
3004 \begin_layout Itemize
3005 Check out the \SpecialChar LyX
3008 \begin_inset CommandInset href
3010 name "information on the web"
3011 target "http://www.lyx.org/HowToUseGIT"
3018 \begin_layout Itemize
3020 \begin_inset Flex Code
3023 \begin_layout Plain Layout
3029 to the folder of the
3030 \begin_inset Flex Code
3033 \begin_layout Plain Layout
3041 \begin_inset Flex Code
3044 \begin_layout Plain Layout
3052 \begin_inset Flex Code
3055 \begin_layout Plain Layout
3061 doesn't exist anywhere, it can be remade with the console command
3062 \begin_inset Flex Code
3065 \begin_layout Plain Layout
3071 in that directory, or you can use an existing po-file for some other language
3075 \begin_layout Itemize
3077 \begin_inset Flex Code
3080 \begin_layout Plain Layout
3090 \begin_layout Plain Layout
3091 This is just a text file, so it can be edited in any text editor.
3092 But there are also specialized programs that support such editing, such
3097 (for all platforms) or
3106 contains a `mode' for editing
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3117 \begin_inset Flex URL
3120 \begin_layout Plain Layout
3122 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3134 For some menu- and widget-labels, there are also shortcut keys that should
3136 Those keys are marked after a `|', and should be translated according to
3137 the words and phrases of the language.
3138 You should also fill also out the information at the beginning of the new
3140 \begin_inset Flex Code
3143 \begin_layout Plain Layout
3149 -file with your email-address, etc., so people know where to reach you with
3150 suggestions and entertaining flames.
3153 \begin_layout Standard
3154 If you are just doing this on your own, then:
3157 \begin_layout Itemize
3159 \begin_inset Flex Code
3162 \begin_layout Plain Layout
3169 This can be done with
3170 \begin_inset Flex Code
3173 \begin_layout Plain Layout
3174 msgfmt -o xx.mo < xx.po
3182 \begin_layout Itemize
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3193 -file to your locale-tree, at the correct directory for application messages
3198 xx, and under the name
3199 \begin_inset Flex Code
3202 \begin_layout Plain Layout
3209 \begin_inset space \thinspace{}
3213 \begin_inset space \space{}
3217 \begin_inset Flex Code
3220 \begin_layout Plain Layout
3221 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3231 \begin_layout Standard
3232 As said, however, it would be best if the new
3233 \begin_inset Flex Code
3236 \begin_layout Plain Layout
3242 file could be added to the \SpecialChar LyX
3243 distribution, so others can use it.
3244 Adding it involves making additional changes to \SpecialChar LyX
3246 So send an email to the developers' mailing list if you're interested in
3250 \begin_layout Subsubsection
3254 \begin_layout Standard
3255 Sometimes it turns out that one English message needs to be translated into
3256 different messages in the target language.
3257 One example is the message
3258 \begin_inset Flex Code
3261 \begin_layout Plain Layout
3267 which has the German translation
3275 , depending upon exactly what the English
3276 \begin_inset Quotes eld
3280 \begin_inset Quotes erd
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3294 does not handle such ambiguous translations.
3295 Therefore you have to add some context information to the message: Instead
3297 \begin_inset Flex Code
3300 \begin_layout Plain Layout
3307 \begin_inset Flex Code
3310 \begin_layout Plain Layout
3311 To[[as in 'From format x to format y']]
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3321 To[[as in 'From page x to page y']].
3326 Now the two occurrences of
3327 \begin_inset Flex Code
3330 \begin_layout Plain Layout
3337 \begin_inset Flex Code
3340 \begin_layout Plain Layout
3346 and can be translated correctly to
3357 \begin_layout Standard
3358 Of course the context information needs to be stripped off the original
3359 message when no translation is used.
3360 Therefore you have to put it in double square brackets at the end of the
3361 message (see the example above).
3362 The translation mechanism of \SpecialChar LyX
3363 ensures that everything in double square
3364 brackets at the end of messages is removed before displaying the message.
3367 \begin_layout Subsection
3368 Translating the documentation.
3371 \begin_layout Standard
3372 The online documentation (in the
3373 \begin_inset Flex Noun
3376 \begin_layout Plain Layout
3382 -menu) can (and should!) be translated.
3383 If there are translated versions of the documentation available
3387 \begin_layout Plain Layout
3388 As of March 2008, at least some of the documents have been translated into
3389 fourteen languages, with the Tutorial available in a few more.
3394 and the locale is set accordingly, these will be used automagically by
3398 looks for translated versions as
3399 \begin_inset Flex Code
3402 \begin_layout Plain Layout
3403 LyXDir/doc/xx/DocName.lyx
3409 \begin_inset Flex Code
3412 \begin_layout Plain Layout
3418 is the code for the language currently in use.
3419 If there are no translated documents, the default English versions will
3421 Note that the translated versions must have the same filenames (
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3431 above) as the original.
3432 If you feel up to translating the documentation (an excellent way to proof-read
3433 the original documentation by the way!), there are a few things you should
3437 \begin_layout Itemize
3438 Check out the documentation translation web page at
3439 \begin_inset CommandInset href
3441 name "http://www.lyx.org/Translation"
3442 target "http://www.lyx.org/Translation"
3447 That way, you can find out which (if any) documents have already been translate
3448 d into your language.
3449 You can also find out who (if anyone) is organizing the effort to translate
3450 the documentation into your language.
3451 If no one is organizing the effort, please let us know that you're interested.
3454 \begin_layout Standard
3455 Once you get to actually translating, here's a few hints for you that may
3459 \begin_layout Itemize
3460 Join the documentation team! There is information on how to do that in
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3471 \begin_inset Flex Noun
3474 \begin_layout Plain Layout
3475 Help\SpecialChar menuseparator
3481 ), which by the way is the first document you should translate.
3484 \begin_layout Itemize
3485 Learn the typographic conventions for the language you are translating to.
3486 Typography is an ancient art and over the centuries, a great variety of
3487 conventions have developed throughout different parts of the world.
3488 Also study the professional terminology amongst typographers in your country.
3489 Inventing your own terminology will only confuse the users.
3492 (Warning! Typography is addictive!)
3495 \begin_layout Itemize
3496 Make a copy of the document.
3497 This will be your working copy.
3498 You can use this as your personal translated help-file by placing it in
3500 \begin_inset Flex Code
3503 \begin_layout Plain Layout
3510 \begin_inset Note Greyedout
3513 \begin_layout Plain Layout
3518 For a complex document with external material (images, etc.), if you make
3520 \begin_inset space \thinspace{}
3524 \begin_inset space \space{}
3527 in a temp dir, beware that the links to external material may be broken
3528 when the document is moved to a different place.
3529 The best way is to retrieve the \SpecialChar LyX
3531 \begin_inset Flex URL
3534 \begin_layout Plain Layout
3536 http://www.lyx.org/HowToUseGIT
3541 ) and to edit the doc file in place.
3549 \begin_layout Itemize
3550 Sometimes the original document (from the \SpecialChar LyX
3551 team) will be updated.
3552 Use the source viewer at
3553 \begin_inset CommandInset href
3555 name "http://www.lyx.org/trac/timeline"
3556 target "http://www.lyx.org/trac/timeline"
3560 to see what has been changed.
3561 That way you can easily see which parts of the translated document need
3565 \begin_layout Standard
3566 If you ever find an error in the original document, fix it and notify the
3567 rest of the documentation team of the changes! (You didn't forget to join
3568 the documentation team, did you?)
3571 \begin_layout Standard
3572 \begin_inset Branch OutDated
3576 \begin_layout Section
3577 International Keyboard Support
3580 \begin_layout Standard
3583 [Editor's Note: The following section is by
3591 It needs to be fixed to conform to the new Documentation Style sheet and
3592 to make use of the new v1.0 features.
3593 The whole thing also needs to be merged with the section following it.-jw
3594 It may also be badly out of date.-rh (2008)]
3597 \begin_layout Subsection
3598 Defining Own Keymaps: Keymap File Format
3601 \begin_layout Standard
3602 Let's look at a keyboard definition file a little closer.
3603 It is a plain text file defining
3606 \begin_layout Itemize
3607 key-to-key or key-to-string translations
3610 \begin_layout Itemize
3614 \begin_layout Itemize
3615 dead keys exceptions
3618 \begin_layout Standard
3619 To define key-to-key or key-to-string translation, use this command:
3622 \begin_layout Quotation
3623 \begin_inset Flex Code
3626 \begin_layout Plain Layout
3635 \begin_inset Flex Code
3638 \begin_layout Plain Layout
3647 \begin_layout Standard
3649 \begin_inset Flex Code
3652 \begin_layout Plain Layout
3658 is the key to be translated and
3659 \begin_inset Flex Code
3662 \begin_layout Plain Layout
3668 is the string to be inserted into the document.
3669 To define dead keys, use:
3672 \begin_layout Quotation
3673 \begin_inset Flex Code
3676 \begin_layout Plain Layout
3685 \begin_inset Flex Code
3688 \begin_layout Plain Layout
3697 \begin_layout Standard
3699 \begin_inset Flex Code
3702 \begin_layout Plain Layout
3708 is a keyboard key and
3709 \begin_inset Flex Code
3712 \begin_layout Plain Layout
3719 The following dead keys are supported (shortcut name is in parentheses):
3722 \begin_layout Quotation
3726 \begin_inset space \hfill{}
3732 \begin_layout Quotation
3734 \begin_inset space \hfill{}
3740 \begin_layout Quotation
3742 \begin_inset space \hfill{}
3748 \begin_layout Quotation
3750 \begin_inset space \hfill{}
3756 \begin_layout Quotation
3758 \begin_inset space \hfill{}
3764 \begin_layout Quotation
3766 \begin_inset space \hfill{}
3773 \begin_layout Plain Layout
3785 \begin_layout Quotation
3787 \begin_inset space \hfill{}
3793 \begin_layout Quotation
3795 \begin_inset space \hfill{}
3802 \begin_layout Plain Layout
3814 \begin_layout Quotation
3816 \begin_inset space \hfill{}
3822 \begin_layout Quotation
3824 \begin_inset space \hfill{}
3830 \begin_layout Quotation
3832 \begin_inset space \hfill{}
3839 \begin_layout Plain Layout
3851 \begin_layout Quotation
3853 \begin_inset space \hfill{}
3860 \begin_layout Plain Layout
3872 \begin_layout Quotation
3874 \begin_inset space \hfill{}
3880 \begin_layout Quotation
3881 hungarian umlaut (hug)
3882 \begin_inset space \hfill{}
3888 \begin_layout Quotation
3890 \begin_inset space \hfill{}
3896 \begin_layout Quotation
3898 \begin_inset space \hfill{}
3905 \begin_layout Plain Layout
3917 \begin_layout Standard
3918 Since in many international keyboards there are exceptions to what some
3919 dead keys should do, you can define them using
3922 \begin_layout Quotation
3923 \begin_inset Flex Code
3926 \begin_layout Plain Layout
3934 deadkey key outstring
3937 \begin_layout Standard
3938 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3942 \begin_layout Quotation
3943 \begin_inset Flex Code
3946 \begin_layout Plain Layout
3959 \begin_layout Standard
3960 to make it work correctly.
3961 Also, you have to define as exceptions dead keys over i and j, to remove
3962 the dot from them before inserting an accent mark.
3963 I will change this when the time comes, but so far I haven't had time.
3966 \begin_layout Standard
3967 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3970 \begin_inset Flex Code
3973 \begin_layout Plain Layout
3979 have different meaning.
3981 \begin_inset Flex Code
3984 \begin_layout Plain Layout
3990 marks comments, quotes start and end \SpecialChar LaTeX
3992 To enter quote, you'll need to use
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4005 \begin_inset Flex Code
4008 \begin_layout Plain Layout
4015 \begin_inset Flex Code
4018 \begin_layout Plain Layout
4029 \begin_layout Standard
4030 If you make a keyboard description file that works for your language, please
4031 mail it to me, so I can include it in the next keymap distribution.
4034 \begin_layout Standard
4035 More keywords will be supported in keymap configuration file in future,
4039 \begin_layout Itemize
4040 \begin_inset Flex Code
4043 \begin_layout Plain Layout
4054 \begin_inset space \hfill{}
4058 \begin_inset Flex Code
4061 \begin_layout Plain Layout
4070 \begin_layout Itemize
4071 \begin_inset Flex Code
4074 \begin_layout Plain Layout
4085 \begin_inset space \hfill{}
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4098 an external keymap translation program
4101 \begin_layout Standard
4102 Also, it should look into
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4112 file for defaults, too (for example, a
4113 \begin_inset Flex Code
4116 \begin_layout Plain Layout
4124 option to include default keyboard).
4132 \begin_layout Section
4133 International Keymap Stuff
4134 \begin_inset CommandInset label
4136 name "sec:International-Keymap-Stuff"
4143 \begin_layout Standard
4144 \begin_inset Note Note
4147 \begin_layout Plain Layout
4148 In doing the revisions on this document in March 2008, I did not look over
4149 this stuff, as I do not understand it.
4150 It would be good if someone else could do so.
4159 \begin_layout Standard
4160 The next two sections describe the
4161 \begin_inset Flex Code
4164 \begin_layout Plain Layout
4173 \begin_inset Flex Code
4176 \begin_layout Plain Layout
4184 file syntax in detail.
4185 These sections should help you design your own key map if the ones provided
4186 do not meet your needs.
4189 \begin_layout Subsection
4193 \begin_layout Standard
4197 \begin_inset Flex Code
4200 \begin_layout Plain Layout
4206 file maps keystrokes to characters or strings.
4207 As the name suggests, it sets a keyboard mapping.
4209 \begin_inset Flex Code
4212 \begin_layout Plain Layout
4223 \begin_inset Flex Code
4226 \begin_layout Plain Layout
4241 \begin_inset Flex Code
4244 \begin_layout Plain Layout
4257 \begin_inset Flex Code
4260 \begin_layout Plain Layout
4269 \begin_inset Flex Code
4272 \begin_layout Plain Layout
4280 are described in this section.
4283 \begin_layout Labeling
4284 \labelwidthstring 00.00.0000
4285 \begin_inset Flex Code
4288 \begin_layout Plain Layout
4296 Map a character to a string
4299 \begin_layout LyX-Code
4314 \begin_layout Standard
4347 the double-quote (")
4364 must be escaped with a preceding backslash (
4375 \begin_layout Standard
4377 \begin_inset Flex Noun
4380 \begin_layout Plain Layout
4388 statement to cause the symbol
4389 \begin_inset Flex Noun
4392 \begin_layout Plain Layout
4400 to be output for the keystroke
4401 \begin_inset Flex Noun
4404 \begin_layout Plain Layout
4415 \begin_layout LyX-Code
4421 \begin_layout Labeling
4422 \labelwidthstring 00.00.0000
4423 \begin_inset Flex Code
4426 \begin_layout Plain Layout
4434 Specify an accent character
4437 \begin_layout LyX-Code
4446 \begin_layout Standard
4447 This will make the cha
4485 This is the dead key
4489 \begin_layout Plain Layout
4496 refers to a key that does not produce a character by itself, but when followed
4497 with another key, produces the desired accent character.
4498 For example, a German characte
4500 r with an umlaut like
4510 can be produced in this manner.
4519 \begin_layout Standard
4532 and then another key not in
4549 followed by the other, not allowed key, as output.
4553 \begin_inset Flex Noun
4556 \begin_layout Plain Layout
4564 cancels a dead key, so if
4575 \begin_inset Flex Noun
4578 \begin_layout Plain Layout
4587 , the cursor will not go one position backwards but will instead cancel
4603 might have had on the next keystroke.
4607 \begin_layout Standard
4608 The following example specifies that the character ' is to be an acute accent,
4609 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4612 \begin_layout LyX-Code
4615 kmod ' acute aeiouAEIOU
4618 \begin_layout Labeling
4619 \labelwidthstring 00.00.0000
4620 \begin_inset Flex Code
4623 \begin_layout Plain Layout
4629 Specify an exception to the accent character
4632 \begin_layout LyX-Code
4641 \begin_layout Standard
4642 This defines an exce
4683 have been assigned a keystroke with a previous
4686 \begin_inset Flex Code
4689 \begin_layout Plain Layout
4713 must not belong in the
4760 If such a declaration does not exist in
4768 \begin_inset Flex Code
4771 \begin_layout Plain Layout
4805 \begin_inset Flex Code
4808 \begin_layout Plain Layout
4822 \begin_layout Standard
4823 The following command produces causes äi to be produced when you enter acute-i
4827 \begin_layout LyX-Code
4841 \begin_layout Labeling
4842 \labelwidthstring 00.00.0000
4843 \begin_inset Flex Code
4846 \begin_layout Plain Layout
4852 Combine two accent characters
4855 \begin_layout LyX-Code
4861 accent1 accent2 allowed
4864 \begin_layout Standard
4865 This one is getting pretty esoteric.
4866 It allows you to combine the effect
4922 \begin_inset Flex Code
4925 \begin_layout Plain Layout
4953 \begin_layout Standard
4954 Consider this example from the
4955 \begin_inset Flex Code
4958 \begin_layout Plain Layout
4969 \begin_layout LyX-Code
4972 kmod ; acute aeioyvhAEIOYVH
4976 kcomb acute umlaut iyIY
4979 \begin_layout Standard
4980 This allows you to press
4981 \begin_inset Flex Noun
4984 \begin_layout Plain Layout
4992 and get the effect of
4993 \begin_inset Flex Code
4996 \begin_layout Plain Layout
5015 in this case cancels the last dead key, so if you press
5016 \begin_inset Flex Noun
5019 \begin_layout Plain Layout
5028 \begin_inset Flex Code
5031 \begin_layout Plain Layout
5044 \begin_layout Subsection
5048 \begin_layout Standard
5050 \begin_inset Flex Code
5053 \begin_layout Plain Layout
5061 mapping is performed, a
5062 \begin_inset Flex Code
5065 \begin_layout Plain Layout
5075 file maps the strings that the symbols generate to characters in the current
5077 The \SpecialChar LyX
5078 distribution currently includes at least the
5079 \begin_inset Flex Code
5082 \begin_layout Plain Layout
5091 \begin_inset Flex Code
5094 \begin_layout Plain Layout
5105 \begin_layout Standard
5107 \begin_inset Flex Code
5110 \begin_layout Plain Layout
5118 file is a sequence of declarations of the form
5121 \begin_layout LyX-Code
5134 \begin_layout Standard
5135 For example, in order to map
5136 \begin_inset Flex Noun
5139 \begin_layout Plain Layout
5149 to the corresponding character in the iso-8859-1 set (233), the following
5153 \begin_layout LyX-Code
5161 \begin_layout Standard
5163 \begin_inset Flex Code
5166 \begin_layout Plain Layout
5175 \begin_inset Flex Code
5178 \begin_layout Plain Layout
5196 the same character can apply to more than one string.
5198 \begin_inset Flex Code
5201 \begin_layout Plain Layout
5212 \begin_layout LyX-Code
5224 \begin_inset Newline newline
5240 \begin_layout Standard
5242 cannot find a mapping for the string produced by the keystroke or a
5243 deadkey sequence, it will check if it looks like an accented char and try
5244 to draw an accent over the character on screen.
5247 \begin_layout Subsection
5251 \begin_layout Standard
5252 There is a second way to add support for international characters through
5253 so-called dead-keys.
5254 A dead-key works in combination with a letter to produce an accented character.
5255 Here, we'll explain how to create a really simple dead-key to illustrate
5259 \begin_layout Standard
5260 Suppose you happen to need the circumflex character,
5261 \begin_inset Quotes eld
5265 \begin_inset Quotes erd
5270 \begin_inset Flex Noun
5273 \begin_layout Plain Layout
5280 \begin_inset space ~
5284 \begin_inset Flex Noun
5287 \begin_layout Plain Layout
5293 ] to the \SpecialChar LyX
5295 \begin_inset Flex Code
5298 \begin_layout Plain Layout
5305 \begin_inset Flex Code
5308 \begin_layout Plain Layout
5315 Now, whenever you type the
5316 \begin_inset Flex Noun
5319 \begin_layout Plain Layout
5325 -key followed by a letter, that letter will have a circumflex accent on
5327 For example, the sequence
5328 \begin_inset Quotes eld
5332 \begin_inset Flex Noun
5335 \begin_layout Plain Layout
5342 \begin_inset Quotes erd
5345 produces the letter:
5346 \begin_inset Quotes eld
5350 \begin_inset Quotes erd
5354 If you tried to type
5355 \begin_inset Quotes eld
5359 \begin_inset Flex Noun
5362 \begin_layout Plain Layout
5369 \begin_inset Quotes erd
5372 , however, \SpecialChar LyX
5373 will complain with a beep, since a
5374 \begin_inset Quotes eld
5378 \begin_inset Flex Noun
5381 \begin_layout Plain Layout
5388 \begin_inset Quotes erd
5391 never takes a circumflex accent.
5393 \begin_inset Flex Noun
5396 \begin_layout Plain Layout
5402 after a dead-key produces the bare-accent.
5403 Please note this last point! If you bind a key to a dead-key, you'll need
5404 to rebind the character on that key to yet another key.
5406 \begin_inset Flex Noun
5409 \begin_layout Plain Layout
5415 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5418 \begin_layout Standard
5419 One common way to bind dead-keys is to use
5420 \begin_inset Flex Noun
5423 \begin_layout Plain Layout
5430 \begin_inset Flex Noun
5433 \begin_layout Plain Layout
5440 \begin_inset Flex Noun
5443 \begin_layout Plain Layout
5449 in combination with an accent, like
5450 \begin_inset Quotes eld
5454 \begin_inset Flex Noun
5457 \begin_layout Plain Layout
5464 \begin_inset Quotes erd
5468 \begin_inset Quotes eld
5472 \begin_inset Flex Noun
5475 \begin_layout Plain Layout
5482 \begin_inset Quotes erd
5486 \begin_inset Quotes eld
5490 \begin_inset Flex Noun
5493 \begin_layout Plain Layout
5500 \begin_inset Quotes erd
5504 Another way involves using
5505 \begin_inset Flex Code
5508 \begin_layout Plain Layout
5515 \begin_inset Flex Code
5518 \begin_layout Plain Layout
5524 to set up the special
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5536 \begin_inset Flex Code
5539 \begin_layout Plain Layout
5545 acts in some ways just like
5546 \begin_inset Flex Noun
5549 \begin_layout Plain Layout
5555 and permits you to bind keys to accented characters.
5556 You can also turn keys into dead-keys by binding them to something like
5558 \begin_inset Flex Code
5561 \begin_layout Plain Layout
5567 and then binding this symbolic key to the corresponding \SpecialChar LyX
5572 \begin_layout Plain Layout
5577 : This is exactly what I do in my
5578 \begin_inset Flex Code
5581 \begin_layout Plain Layout
5588 \begin_inset Flex Code
5591 \begin_layout Plain Layout
5599 \begin_inset Flex Noun
5602 \begin_layout Plain Layout
5604 \begin_inset space ~
5613 \begin_inset Flex Code
5616 \begin_layout Plain Layout
5622 and a bunch of these
5623 \begin_inset Quotes eld
5627 \begin_inset Flex Code
5630 \begin_layout Plain Layout
5637 \begin_inset Quotes erd
5640 symbolic keys bound such things as
5641 \begin_inset Flex Noun
5644 \begin_layout Plain Layout
5646 \begin_inset space ~
5655 \begin_inset Flex Noun
5658 \begin_layout Plain Layout
5660 \begin_inset space ~
5669 This is how I produce my accented characters.
5674 You can make just about anything into the
5675 \begin_inset Flex Code
5678 \begin_layout Plain Layout
5685 \begin_inset Flex Noun
5688 \begin_layout Plain Layout
5694 keys, a spare function key, etc.
5695 As for the \SpecialChar LyX
5696 commands that produce accents, check the entry for
5697 \begin_inset Flex Code
5700 \begin_layout Plain Layout
5711 You'll find the complete list there.
5714 \begin_layout Subsection
5715 Saving your Language Configuration
5718 \begin_layout Standard
5719 You can edit your preferences so that your desired language environment
5720 is automatically configured when \SpecialChar LyX
5722 \begin_inset Flex Noun
5725 \begin_layout Plain Layout
5726 Edit\SpecialChar menuseparator
5735 \begin_layout Chapter
5736 Installing New Document Classes, Layouts, and Templates
5737 \begin_inset CommandInset label
5739 name "cha:Installing-New-Document"
5744 \begin_inset Argument 1
5747 \begin_layout Plain Layout
5748 Installing New Document Classes
5756 \begin_layout Standard
5757 In this chapter, we describe the procedures for creating and installing
5758 new \SpecialChar LyX
5759 layout and template files, as well as offer a refresher on correctly
5760 installing new \SpecialChar LaTeX
5765 \begin_layout Standard
5766 First, let us a say a few words about how one ought to think about the relation
5767 between \SpecialChar LyX
5768 and \SpecialChar LaTeX
5770 The thing to understand is that, in a certain sense, \SpecialChar LyX
5771 doesn't know anything
5772 about \SpecialChar LaTeX
5774 Indeed, from \SpecialChar LyX
5775 's point of view, \SpecialChar LaTeX
5776 is just one of several
5777 \begin_inset Quotes eld
5781 \begin_inset Quotes erd
5784 in which it is capable of producing output.
5785 Other such formats are DocBook, plaintext, and XHTML.
5787 is, of course, a particularly important format, but very little of the
5788 information \SpecialChar LyX
5789 has about \SpecialChar LaTeX
5790 is actually contained in the program itself.
5794 \begin_layout Plain Layout
5795 Some commands are sufficiently complex that they are
5796 \begin_inset Quotes eld
5800 \begin_inset Quotes erd
5803 into \SpecialChar LyX
5805 But the developers generally regard this as a Bad Thing.
5810 Rather, that information, even for the standard classes like
5811 \begin_inset Flex Code
5814 \begin_layout Plain Layout
5820 , is contained in `layout files'.
5821 Similarly, \SpecialChar LyX
5822 itself does not know much about DocBook or XHTML.
5823 What it knows is contained in layout files.
5826 \begin_layout Standard
5827 You can think of the layout file for a given document class as a translation
5828 manual between \SpecialChar LyX
5829 constructs—paragraphs with their corresponding styles,
5830 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5833 Almost everything \SpecialChar LyX
5835 \begin_inset Flex Code
5838 \begin_layout Plain Layout
5844 , for example, is contained in the file
5845 \begin_inset Flex Code
5848 \begin_layout Plain Layout
5854 and in various other files it includes.
5855 For this reason, anyone intending to write layout files should plan to
5856 study the existing files.
5857 A good place to start is with
5858 \begin_inset Flex Code
5861 \begin_layout Plain Layout
5867 , which is included in
5868 \begin_inset Flex Code
5871 \begin_layout Plain Layout
5878 \begin_inset Flex Code
5881 \begin_layout Plain Layout
5887 , and many of the other layout files for document classes.
5888 This file is where sections and the like are defined:
5889 \begin_inset Flex Code
5892 \begin_layout Plain Layout
5898 tells \SpecialChar LyX
5899 how paragraphs that are marked with the Section, Subsection, etc,
5900 styles can be translated into corresponding \SpecialChar LaTeX
5901 , DocBook, and XHTML commands
5904 \begin_inset Flex Code
5907 \begin_layout Plain Layout
5913 file basically just includes several of these
5914 \begin_inset Flex Code
5917 \begin_layout Plain Layout
5926 \begin_layout Standard
5927 Defining the \SpecialChar LyX
5929 correspondence is not the only thing layout files do, though.
5930 Their other job is to define how the \SpecialChar LyX
5931 constructs themselves will appear
5933 The fact that layout files have these two jobs is often a source of confusion,
5934 because they are completely separate.
5935 Telling \SpecialChar LyX
5936 how to translate a certain paragraph style into \SpecialChar LaTeX
5939 how to display it; conversely, telling \SpecialChar LyX
5940 how to display a certain paragraph
5941 style does not tell \SpecialChar LyX
5942 how to translate it into \SpecialChar LaTeX
5943 (let alone tell \SpecialChar LaTeX
5946 So, in general, when you define a new \SpecialChar LyX
5947 construct, you must always do two
5948 quite separate things: (i)
5949 \begin_inset space ~
5952 tell \SpecialChar LyX
5953 how to translate it into \SpecialChar LaTeX
5955 \begin_inset space ~
5958 tell \SpecialChar LyX
5962 \begin_layout Standard
5963 Much the same is true, of course, as regards \SpecialChar LyX
5964 's other backend formats, though
5965 XHTML is in some ways different, because in that case \SpecialChar LyX
5970 able, to some extent, to use information about how it should display a
5971 paragraph on the screen to output information (in the form of CSS) about
5972 how the paragraph should be displayed in a browser.
5973 Even in this case, however, the distinction between what \SpecialChar LyX
5975 and how things are rendered externally remains in force, and the two can
5976 be controlled separately.
5978 \begin_inset CommandInset ref
5980 reference "sec:Tags-for-XHTML"
5987 \begin_layout Section
5988 Installing new \SpecialChar LaTeX
5992 \begin_layout Standard
5993 Some installations may not include a \SpecialChar LaTeX
5994 package or class file that you would
5995 like to use within \SpecialChar LyX
5997 For example, you might need Foil\SpecialChar TeX
5998 , a package for preparing slides for overhead
6000 Modern \SpecialChar LaTeX
6001 distributions like \SpecialChar TeX
6002 Live (2008 or newer) or MiK\SpecialChar TeX
6003 provide a user interface
6004 for installing such packages.
6005 For example, with MiK\SpecialChar TeX
6006 , you start the program
6007 \begin_inset Quotes eld
6011 \begin_inset space ~
6015 \begin_inset Quotes erd
6018 to get a list of available packages.
6019 To install one of them, right click on it or use the corresponding toolbar
6023 \begin_layout Standard
6024 If your \SpecialChar LaTeX
6025 distribution does not provide such a `package manager', or if the
6026 package is not available from your distribution, then follow these steps
6027 to install it manually:
6030 \begin_layout Enumerate
6031 Get the package from
6032 \begin_inset CommandInset href
6035 target "http://www.ctan.org/"
6042 \begin_layout Enumerate
6043 If the package contains a file with the ending
6044 \begin_inset Quotes eld
6048 \begin_inset Flex Code
6051 \begin_layout Plain Layout
6058 \begin_inset Quotes erd
6061 (is the case for Foil\SpecialChar TeX
6062 ) then open a console, change to the folder of this
6063 file and execute the command
6064 \begin_inset Flex Code
6067 \begin_layout Plain Layout
6074 You have now unpacked the package and have all files to install it.
6075 Most \SpecialChar LaTeX
6076 -packages are not packed and you can skip this step.
6079 \begin_layout Enumerate
6080 Now you need to decide if the package should be available for all users
6085 \begin_layout Enumerate
6086 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6087 for all users on your system, then install it in your `local' \SpecialChar TeX
6089 install it in your own `user' \SpecialChar TeX
6091 Where these trees should be created, if they do not already exist, depends
6093 To find this out, look in the file
6094 \begin_inset Flex Code
6097 \begin_layout Plain Layout
6107 \begin_layout Plain Layout
6108 This is usually in the directory
6109 \begin_inset Flex Code
6112 \begin_layout Plain Layout
6118 , though you can execute the command
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6133 The location of the `local' \SpecialChar TeX
6134 tree is defined by the
6135 \begin_inset Flex Code
6138 \begin_layout Plain Layout
6144 variable; this is usually somewhere like
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6149 /usr/local/share/texmf
6154 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6157 The location of the `user' \SpecialChar TeX
6159 \begin_inset Flex Code
6162 \begin_layout Plain Layout
6169 \begin_inset Flex Code
6172 \begin_layout Plain Layout
6179 \begin_inset Flex Code
6182 \begin_layout Plain Layout
6192 (If these variables are not predefined, you have to define them.) You'll
6193 probably need root permissions to create or modify the `local' tree, but
6194 not for your `user' tree.
6195 \begin_inset Newline newline
6198 In general, it is recommended to install in the user tree because your user
6199 will not be modified or even overwritten when you upgrade your system.
6200 It will typically also be backed up together with everything else when
6201 you backup your home directory (which, of course, you do on a regular basis).
6204 \begin_layout Enumerate
6205 On Windows, if you want the new package to be available for all users on
6206 your system, change to the folder where \SpecialChar LaTeX
6207 is installed and then change to
6209 \begin_inset Flex Code
6212 \begin_layout Plain Layout
6223 (For MiK\SpecialChar TeX
6224 , this would be by default the folder
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6246 \begin_layout Plain Layout
6247 Note that this will be the correct path only on English installations.
6248 On a German one, it would be
6249 \begin_inset Flex Code
6252 \begin_layout Plain Layout
6266 , and similarly for other languages.
6271 Create there a new folder
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6281 and copy all files of the package into it.
6283 \begin_inset Newline newline
6286 If the package should only available for you or you don't have admin permissions
6287 , do the same, but in the local \SpecialChar LaTeX
6290 \begin_inset space \thinspace{}
6293 g., for MiK\SpecialChar TeX
6295 \begin_inset space ~
6298 2.8 under Windows XP, this would be the folder:
6299 \begin_inset Newline newline
6305 \begin_inset Flex Code
6308 \begin_layout Plain Layout
6311 Documents and Settings
6323 \begin_inset Newline newline
6329 \begin_inset Phantom HPhantom
6332 \begin_layout Plain Layout
6343 \begin_inset Flex Code
6346 \begin_layout Plain Layout
6359 \begin_inset Newline newline
6362 On Vista, it would be:
6363 \begin_inset Newline newline
6367 \begin_inset Flex Code
6370 \begin_layout Plain Layout
6396 \begin_layout Enumerate
6397 Now one only need to tell \SpecialChar LaTeX
6398 that there are new files.
6399 This depends on the used \SpecialChar LaTeX
6404 \begin_layout Enumerate
6405 For \SpecialChar TeX
6406 Live execute the command
6407 \begin_inset Flex Code
6410 \begin_layout Plain Layout
6417 If you installed the package for all users, then you will probably need
6418 to have root permissions for that.
6421 \begin_layout Enumerate
6422 For MiK\SpecialChar TeX
6423 , if you have installed the package for all users, start the program
6425 \begin_inset Quotes eld
6429 \begin_inset space ~
6433 \begin_inset Quotes erd
6436 and press the button marked
6437 \begin_inset Quotes eld
6441 \begin_inset Quotes erd
6445 Otherwise start the program
6446 \begin_inset Quotes eld
6450 \begin_inset Quotes erd
6457 \begin_layout Enumerate
6458 Finally, you need to tell \SpecialChar LyX
6459 that there are new packages available.
6460 So, in \SpecialChar LyX
6462 \begin_inset Flex Noun
6465 \begin_layout Plain Layout
6468 \SpecialChar menuseparator
6474 and then restart \SpecialChar LyX
6478 \begin_layout Standard
6479 Now the package is installed.
6480 In our example, the document class
6481 \begin_inset Flex Code
6484 \begin_layout Plain Layout
6486 \begin_inset space ~
6494 will now be available under
6495 \begin_inset Flex Noun
6498 \begin_layout Plain Layout
6499 Document\SpecialChar menuseparator
6500 Settings\SpecialChar menuseparator
6510 \begin_layout Standard
6511 If you would like to use a \SpecialChar LaTeX
6512 document class that is not even listed in the
6514 \begin_inset Flex Noun
6517 \begin_layout Plain Layout
6518 Document\SpecialChar menuseparator
6519 Settings\SpecialChar menuseparator
6525 , then you need to create a `layout' file for it.
6526 That is the topic of the next section.
6529 \begin_layout Section
6530 Types of layout files
6533 \begin_layout Standard
6534 This section describes the various sorts of \SpecialChar LyX
6535 files that contain layout informati
6537 These files describe various paragraph and character styles, determining
6538 how \SpecialChar LyX
6539 should display them and how they should be translated into \SpecialChar LaTeX
6541 XHTML, or whatever output format is being used.
6545 \begin_layout Standard
6546 We shall try to provide a thorough description of the process of writing
6548 However, there are so many different types of documents supported even
6549 by just \SpecialChar LaTeX
6550 that we can't hope to cover every different possibility or problem
6551 you might encounter.
6552 The \SpecialChar LyX
6553 users' list is frequented by people with lots of experience with layout
6554 design who are willing to share what they've learned, so please feel free
6555 to ask questions there.
6558 \begin_layout Standard
6559 As you prepare to write a new layout, it is extremely helpful to look at
6560 the layouts distributed with \SpecialChar LyX
6562 If you write a \SpecialChar LyX
6563 layout for a \SpecialChar LaTeX
6564 document class that might also be used by
6565 others, or write a module that might be useful to others, then you should
6566 consider posting your layout to the
6567 \begin_inset CommandInset href
6569 name "layout section on the LyX wiki"
6570 target "http://wiki.lyx.org/Layouts/Layouts"
6574 or even to the \SpecialChar LyX
6575 developers' list, so that it might be included in \SpecialChar LyX
6580 \begin_layout Plain Layout
6581 Note that \SpecialChar LyX
6582 is licensed under the General Public License, so any material
6583 that is contributed to \SpecialChar LyX
6584 must be similarly licensed.
6592 \begin_layout Subsection
6594 \begin_inset CommandInset label
6596 name "subsec:Layout-modules"
6603 \begin_layout Standard
6604 We have spoken to this point about `layout files'.
6605 But there are different sorts of files that contain layout information.
6606 Layout files, strictly so called, have the
6607 \begin_inset Flex Code
6610 \begin_layout Plain Layout
6616 extension and provide \SpecialChar LyX
6617 with information about document classes.
6618 Since \SpecialChar LyX
6619 1.6 layout information can also be contained in layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6634 Modules are to \SpecialChar LaTeX
6635 packages much as layouts are to \SpecialChar LaTeX
6636 classes, and some modules—such
6638 \begin_inset Flex Code
6641 \begin_layout Plain Layout
6647 module—specifically provide support for one package.
6648 In a sense, layout modules are similar to included
6652 \begin_layout Plain Layout
6653 These can have any extension, but by convention have the
6654 \begin_inset Flex Code
6657 \begin_layout Plain Layout
6669 \begin_inset Flex Code
6672 \begin_layout Plain Layout
6678 —in that modules are not specific to a given document class but may be used
6679 with many different classes.
6680 The difference is that using an included file with
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6690 requires editing that file.
6691 Modules, by contrast, are selected in the
6692 \begin_inset Flex Noun
6695 \begin_layout Plain Layout
6696 Document\SpecialChar menuseparator
6705 \begin_layout Standard
6706 Building modules is the easiest way to get started with layout editing,
6707 since it can be as simple as adding a single new paragraph style or flex
6709 But modules may, in principle, contain anything a layout file can contain.
6712 \begin_layout Standard
6713 After creating a new module and copying it to the
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6723 folder, you will need to reconfigure and then restart \SpecialChar LyX
6726 However, changes you make to the module will be seen immediately, if you
6728 \begin_inset Flex Noun
6731 \begin_layout Plain Layout
6732 Document\SpecialChar menuseparator
6738 , highlight something, and then hit
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6749 It is strongly recommended that you save your work before doing this
6754 it is strongly recommended that you not attempt to edit modules while simultaneo
6755 usly working on actual documents
6758 Though of course the developers strive to keep \SpecialChar LyX
6759 stable in such situations,
6760 syntax errors and the like in your module file could cause strange behavior.
6763 \begin_layout Subsubsection
6767 \begin_layout Standard
6768 Modules are to \SpecialChar LyX
6769 as packages are to \SpecialChar LaTeX
6771 Sometimes, however, you find yourself wanting a specific inset or character
6772 style just for one document and writing a module that will also be available
6773 to other documents makes little sense.
6774 What you need is \SpecialChar LyX
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6786 \begin_layout Standard
6787 You will find it under
6789 Document\SpecialChar menuseparator
6790 Settings\SpecialChar menuseparator
6794 The large text box allows you to enter anything that you might enter in
6795 a layout file or module.
6796 You can think of a document's local layout, in fact, as a module that belongs
6798 So, in particular, you must enter a
6799 \begin_inset Flex Code
6802 \begin_layout Plain Layout
6809 Any format is acceptable, but one would normally use the format current
6811 (In \SpecialChar LyX
6812 2.2, the current layout format is 60.)
6815 \begin_layout Standard
6816 When you have entered something in the
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 pane, \SpecialChar LyX
6828 \begin_inset Quotes eld
6832 \begin_inset Quotes erd
6835 button at the bottom.
6836 Clicking this button will cause \SpecialChar LyX
6837 to determine whether what you have entered
6838 is valid layout information for the chosen format.
6840 will report the result but, unfortunately, will not tell you what errors
6841 there might have been.
6842 These will be written to the terminal, however, if \SpecialChar LyX
6843 is started from a terminal.
6844 You will not be permitted to save your local layout until you have entered
6848 \begin_layout Standard
6849 The warnings at the end of the previous section apply here, too.
6850 Do not play with local layout while you are actually working, especially
6851 if you have not saved your document.
6852 That said, using local layout with a test document can be a very convenient
6853 way to try out layout ideas, or even to start developing a module.
6856 \begin_layout Subsection
6858 \begin_inset Flex Noun
6861 \begin_layout Plain Layout
6870 \begin_layout Standard
6871 There are two situations you are likely to encounter when wanting to support
6872 a new \SpecialChar LaTeX
6873 document class, involving style (
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 ) files and \SpecialChar LaTeX2e
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6895 Supporting a style file is usually fairly easy.
6896 Supporting a new class file is a bit harder.
6897 We'll discuss the former in this section and the latter in the next.
6898 Similar remarks apply, of course, if you want to support a new DocBook
6902 \begin_layout Standard
6903 The easier case is the one in which your new document class is provided
6904 as a style file that is to be used in conjunction with an already supported
6906 For the sake of the example, we'll assume that the style file is called
6908 \begin_inset Flex Noun
6911 \begin_layout Plain Layout
6917 and that it is meant to be used with
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6927 , which is a standard class.
6931 \begin_layout Standard
6932 Start by copying the existing class's layout file into your local directory:
6936 \begin_layout Plain Layout
6937 Of course, which directory is your local directory will vary by platform,
6938 and \SpecialChar LyX
6939 allows you to specify your local directory on startup, too, using
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6958 \begin_layout LyX-Code
6959 cp report.layout ~/.lyx/layouts/myclass.layout
6962 \begin_layout Standard
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6973 and change the line:
6976 \begin_layout LyX-Code
6979 DeclareLaTeXClass{report}
6982 \begin_layout Standard
6986 \begin_layout LyX-Code
6989 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6992 \begin_layout Standard
6996 \begin_layout LyX-Code
6998 \begin_inset Newline newline
7004 \begin_inset Newline newline
7010 \begin_layout Standard
7011 near the top of the file.
7014 \begin_layout Standard
7015 Start \SpecialChar LyX
7017 \begin_inset Flex Noun
7020 \begin_layout Plain Layout
7021 Tools\SpecialChar menuseparator
7028 Then restart \SpecialChar LyX
7029 and try creating a new document.
7031 \begin_inset Flex Noun
7034 \begin_layout Plain Layout
7040 " as a document class option in the
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7045 Document\SpecialChar menuseparator
7052 It is likely that some of the sectioning commands and such in your new
7053 class will work differently from how they worked in the base class—
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 in this example—so you can fiddle around with the settings for the different
7064 sections if you wish.
7065 The layout information for sections is contained in
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7075 , but you do not need to copy and change this file.
7076 Instead, you can simply add your changes to your layout file, after the
7078 \begin_inset Flex Code
7081 \begin_layout Plain Layout
7087 , which itself includes
7088 \begin_inset Flex Code
7091 \begin_layout Plain Layout
7098 For example, you might add these lines:
7101 \begin_layout LyX-Code
7105 \begin_layout LyX-Code
7109 \begin_layout LyX-Code
7113 \begin_layout LyX-Code
7117 \begin_layout LyX-Code
7121 \begin_layout Standard
7122 to change the font for chapter headings to sans-serif.
7123 This will override (or, in this case, add to) the existing declaration
7124 for the Chapter style.
7128 \begin_layout Standard
7129 Your new package may also provide commands or environments not present in
7131 In this case, you will want to add these to the layout file.
7133 \begin_inset CommandInset ref
7135 reference "sec:TextClass"
7139 for information on how to do so.
7142 \begin_layout Standard
7144 \begin_inset Flex Noun
7147 \begin_layout Plain Layout
7153 can be used with several different document classes, and even if it cannot,
7154 you might find it easiest just to write a module that you can load with
7156 The simplest possible such module would be:
7159 \begin_layout LyX-Code
7162 DeclareLyXModule{My Package}
7165 \begin_layout LyX-Code
7169 \begin_layout LyX-Code
7170 #Support for mypkg.sty.
7173 \begin_layout LyX-Code
7175 \begin_inset Newline newline
7181 \begin_layout LyX-Code
7183 \begin_inset Newline newline
7189 \begin_layout LyX-Code
7191 \begin_inset Newline newline
7197 \begin_inset Newline newline
7203 \begin_layout Standard
7204 A more complex module might modify the behavior of some existing constructs
7205 or define some new ones.
7207 \begin_inset CommandInset ref
7209 reference "sec:TextClass"
7216 \begin_layout Subsection
7218 \begin_inset Flex Noun
7221 \begin_layout Plain Layout
7230 \begin_layout Standard
7231 There are two possibilities here.
7232 One is that the class file is itself based upon an existing document class.
7233 For example, many thesis classes are based upon
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7244 To see whether yours is, look for a line like
7247 \begin_layout LyX-Code
7253 \begin_layout Standard
7255 If so, then you may proceed largely as in the previous section, though
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7261 Declare\SpecialChar LaTeX
7267 line will be different.
7268 If your new class is
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 and it is based upon
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7288 , then the line should read:
7292 \begin_layout Plain Layout
7293 And it will be easiest if you save the file to
7294 \begin_inset Flex Code
7297 \begin_layout Plain Layout
7304 assumes that the document class has the same name as the layout file.
7313 \begin_layout LyX-Code
7316 DeclareLaTeXClass[thesis,book]{thesis}
7319 \begin_layout Standard
7320 If, on the other hand, the new class is not based upon an existing class,
7321 you will probably have to
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 We strongly suggest copying an existing layout file which uses a similar
7332 class and then modifying it, if you can do so.
7333 At least use an existing file as a starting point so you can find out what
7334 items you need to worry about.
7335 Again, the specifics are covered below.
7338 \begin_layout Subsection
7340 \begin_inset CommandInset label
7342 name "subsec:Creating-Templates"
7349 \begin_layout Standard
7350 Once you have written a layout file for a new document class, you might
7351 want to consider writing a
7356 A template acts as a kind of tutorial for your layout, showing how it might
7357 be used, though containing dummy content.
7358 You can of course look at the various templates included with \SpecialChar LyX
7362 \begin_layout Standard
7363 Templates are created just like usual documents: using \SpecialChar LyX
7365 The only difference is that usual documents contain all possible settings,
7366 including the font scheme and the paper size.
7367 Usually a user doesn't want a template to overwrite his preferred settings
7368 for such parameters.
7369 For that reason, the designer of a template should remove the corresponding
7371 \begin_inset Flex Code
7374 \begin_layout Plain Layout
7383 \begin_inset Flex Code
7386 \begin_layout Plain Layout
7394 from the template \SpecialChar LyX
7396 This can be done with any simple text-editor, for example
7397 \begin_inset Flex Code
7400 \begin_layout Plain Layout
7407 \begin_inset Flex Code
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 Put the edited template files you create in
7421 \begin_inset Flex Code
7424 \begin_layout Plain Layout
7430 , copy the ones you use from the global template directory in
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 to the same place, and redefine the template path in the
7441 \begin_inset Flex Noun
7444 \begin_layout Plain Layout
7445 Tools\SpecialChar menuseparator
7446 Preferences\SpecialChar menuseparator
7455 \begin_layout Standard
7456 Note, by the way, that there is a template which has a particular meaning:
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7468 This template is loaded every time you create a new document with
7469 \begin_inset Flex Noun
7472 \begin_layout Plain Layout
7473 File\SpecialChar menuseparator
7479 in order to provide useful defaults.
7480 To create this template from inside \SpecialChar LyX
7481 , all you have to do is to open a document
7482 with the correct settings, and use the
7483 \begin_inset Flex Noun
7486 \begin_layout Plain Layout
7487 Save as Document Defaults
7495 \begin_layout Subsection
7496 Upgrading old layout files
7499 \begin_layout Standard
7500 The format of layout files changes with each \SpecialChar LyX
7501 release, so old layout files
7502 need to be converted to the new format.
7504 reads a layout file in an older format, it automatically calls the
7506 \begin_inset Flex Code
7509 \begin_layout Plain Layout
7515 to convert it to a temporary file in current format.
7516 The original file is left untouched.
7517 If you use the layout file often, then, you may want to convert it permanently,
7518 so that \SpecialChar LyX
7519 does not have to do so itself every time.
7520 To do this, you can call the converter manually:
7523 \begin_layout Enumerate
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7547 \begin_layout Enumerate
7549 \begin_inset Newline newline
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7557 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7563 \begin_inset Newline newline
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7576 is the name of your \SpecialChar LyX
7580 \begin_layout Standard
7581 Note that manual conversion does not affect included files, so these will
7582 have to be converted separately.
7583 \change_inserted -712698321 1483873435
7587 \begin_layout Subsection
7589 \change_inserted -712698321 1483875083
7590 \begin_inset CommandInset label
7592 name "subsec:Cite-Engine-Files"
7599 \begin_layout Standard
7601 \change_inserted -712698321 1483874213
7602 A specific form of layout files are the so-called
7603 \begin_inset Flex Code
7606 \begin_layout Plain Layout
7608 \change_inserted -712698321 1483873546
7614 files that are located in the
7615 \begin_inset Flex Code
7618 \begin_layout Plain Layout
7620 \change_inserted -712698321 1483873546
7627 Their purpose is to define the specifics of \SpecialChar LaTeX
7628 packages aimed at bibliography
7641 , but also the way how normal Bib\SpecialChar TeX
7642 citations (without additional packages)
7643 are handled in \SpecialChar LyX
7644 is defined in such a file.
7648 \begin_layout Standard
7650 \change_inserted -712698321 1483874969
7651 More specifically, it is defined which packages \SpecialChar LyX
7652 needs to load, which citation
7653 commands are available, how these are to be displayed in \SpecialChar LyX
7655 the dialogs, the context menus) as well as in the XHTML and plain text
7657 Furthermore, the files specify available style variants (author-year, numerical
7658 , etc.) and their specifics.
7659 The cite engine files are also used to generate the options that are available
7662 Document\SpecialChar menuseparator
7663 Settings\SpecialChar ldots
7664 \SpecialChar menuseparator
7665 Bibliography\SpecialChar menuseparator
7671 \begin_layout Standard
7673 \change_inserted -712698321 1483875180
7674 Even though a cite engine file is essentially a normal layout file that
7675 could theoretically include any layout information, it usually primarily
7676 includes some specific parameters such as
7677 \begin_inset Flex Code
7680 \begin_layout Plain Layout
7682 \change_inserted -712698321 1483874688
7691 \begin_inset Flex Code
7694 \begin_layout Plain Layout
7696 \change_inserted -712698321 1483875180
7705 \begin_inset Flex Code
7708 \begin_layout Plain Layout
7710 \change_inserted -712698321 1483874477
7719 \begin_inset Flex Code
7722 \begin_layout Plain Layout
7724 \change_inserted -712698321 1483874482
7733 The syntax of the latter two is described in
7734 \begin_inset CommandInset ref
7736 reference "subsec:Citation-engine-description"
7744 \begin_inset CommandInset ref
7746 reference "subsec:Citation-format-description"
7750 , as well as in the files themselves.
7755 \begin_layout Section
7756 \begin_inset CommandInset label
7758 name "sec:TextClass"
7762 The layout file format
7765 \begin_layout Standard
7766 The following sections describe how layout files are structured and written.
7767 Our advice is to go slowly, save and test often.
7768 It is really not that hard, except that the multitude of options can become
7769 overwhelming, especially if you try to check out too many at once.
7770 It becomes easier if you use existing layouts of \SpecialChar LyX
7771 as examples/reference
7772 or if you modify an existing layout to your needs.
7775 \begin_layout Standard
7776 Note that all the tags used in layout files are case-insensitive.
7778 \begin_inset Flex Code
7781 \begin_layout Plain Layout
7788 \begin_inset Flex Code
7791 \begin_layout Plain Layout
7798 \begin_inset Flex Code
7801 \begin_layout Plain Layout
7807 are really the same tag.
7808 The possible arguments are printed in brackets after the tag's name.
7809 The default argument is typeset
7810 \begin_inset Flex Code
7813 \begin_layout Plain Layout
7822 If the argument has a data type like
7823 \begin_inset Quotes eld
7827 \begin_inset Quotes erd
7831 \begin_inset Quotes eld
7835 \begin_inset Quotes erd
7838 , the default is shown like this:
7839 \begin_inset Flex Code
7842 \begin_layout Plain Layout
7853 \begin_layout Subsection
7854 The document class declaration and classification
7857 \begin_layout Standard
7858 Lines in a layout file which begin with
7859 \begin_inset Flex Code
7862 \begin_layout Plain Layout
7869 There is one exception to this rule.
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7880 files should begin with lines like:
7883 \begin_layout LyX-Code
7886 #% Do not delete the line below; configure depends on this
7889 \begin_layout LyX-Code
7894 DeclareLaTeXClass{Article (Standard Class)}
7897 \begin_layout LyX-Code
7902 DeclareCategory{Articles}
7905 \begin_layout Standard
7906 The second and third lines are used when you (re)configure \SpecialChar LyX
7908 The layout file is read by the \SpecialChar LaTeX
7910 \begin_inset Flex Code
7913 \begin_layout Plain Layout
7919 , in a special mode where
7920 \begin_inset Flex Code
7923 \begin_layout Plain Layout
7930 The first line is just a \SpecialChar LaTeX
7931 comment, the second one contains the mandatory
7932 declaration of the text class and the third line contains the optional
7933 classification of the class.
7934 If these lines appear in a file named
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7944 , then they define a text class of name
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7954 (the name of the layout file) which uses the \SpecialChar LaTeX
7956 \begin_inset Flex Code
7959 \begin_layout Plain Layout
7965 (the default is to use the same name as the layout).
7967 \begin_inset Quotes eld
7970 Article (Standard Class)
7971 \begin_inset Quotes erd
7974 that appears above is used as a description of the text class in the
7975 \begin_inset Flex Noun
7978 \begin_layout Plain Layout
7979 Document\SpecialChar menuseparator
7987 \begin_inset Quotes eld
7991 \begin_inset Quotes erd
7994 in the example) is also used in the
7995 \begin_inset Flex Noun
7998 \begin_layout Plain Layout
7999 Document\SpecialChar menuseparator
8005 dialog: the text classes are grouped by these categories (which are usually
8006 genres, so typical categories are
8007 \begin_inset Quotes eld
8011 \begin_inset Quotes erd
8015 \begin_inset Quotes eld
8019 \begin_inset Quotes erd
8023 \begin_inset Quotes eld
8027 \begin_inset Quotes erd
8031 \begin_inset Quotes eld
8035 \begin_inset Quotes erd
8039 \begin_inset Quotes eld
8043 \begin_inset Quotes erd
8047 \begin_inset Quotes eld
8051 \begin_inset Quotes erd
8055 If no category has been declared, the class will be put in the
8056 \begin_inset Quotes eld
8060 \begin_inset Quotes erd
8066 \begin_layout Standard
8067 Let's assume that you wrote your own text class that uses the
8068 \begin_inset Flex Code
8071 \begin_layout Plain Layout
8077 document class, but where you changed the appearance of the section headings.
8078 If you put it in a file
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8088 , the header of this file should be:
8091 \begin_layout LyX-Code
8094 #% Do not delete the line below; configure depends on this
8097 \begin_layout LyX-Code
8102 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8105 \begin_layout LyX-Code
8110 DeclareCategory{Articles}
8113 \begin_layout Standard
8114 This declares a text class
8115 \begin_inset Flex Code
8118 \begin_layout Plain Layout
8124 , associated with the \SpecialChar LaTeX
8126 \begin_inset Flex Code
8129 \begin_layout Plain Layout
8136 \begin_inset Quotes eld
8139 Article (with My Own Headings)
8140 \begin_inset Quotes erd
8144 If your text class depends on several packages, you can declare it as:
8147 \begin_layout LyX-Code
8150 #% Do not delete the line below; configure depends on this
8153 \begin_layout LyX-Code
8158 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8161 \begin_layout LyX-Code
8166 DeclareCategory{Articles}
8169 \begin_layout Standard
8170 This indicates that your text class uses the
8171 \begin_inset Flex Code
8174 \begin_layout Plain Layout
8181 Finally, it is also possible to declare classes for DocBook code.
8182 Typical declarations will look like:
8185 \begin_layout LyX-Code
8188 #% Do not delete the line below; configure depends on this
8191 \begin_layout LyX-Code
8196 DeclareDocBookClass[article]{SGML (DocBook Article)}
8199 \begin_layout LyX-Code
8204 DeclareCategory{Articles (DocBook)}
8207 \begin_layout Standard
8208 Note that these declarations can also be given an optional parameter declaring
8209 the name of the document class (but not a list).
8212 \begin_layout Standard
8213 So, to be as explicit as possible, the form of the layout declaration is:
8216 \begin_layout LyX-Code
8221 DeclareLaTeXClass[class,package.sty]{layout description}
8224 \begin_layout LyX-Code
8229 DeclareCategory{category}
8232 \begin_layout Standard
8233 The class need only be specified if the name of the \SpecialChar LaTeX
8235 name of the layout file are different or if there are packages to load.
8236 If the name of the class file is not specified, then \SpecialChar LyX
8238 that it is the same as the name of the layout file.
8241 \begin_layout Standard
8242 When the text class has been modified to your taste, all you have to do
8243 is to copy it either to
8244 \begin_inset Flex Code
8247 \begin_layout Plain Layout
8254 \begin_inset Flex Code
8257 \begin_layout Plain Layout
8264 \begin_inset Flex Noun
8267 \begin_layout Plain Layout
8268 Tools\SpecialChar menuseparator
8274 , exit \SpecialChar LyX
8276 Then your new text class should be available along with the others.
8279 \begin_layout Standard
8280 Once the layout file is installed, you can edit it and see your changes
8281 without having to reconfigure or to restart \SpecialChar LyX
8287 \begin_layout Plain Layout
8288 In versions of \SpecialChar LyX
8289 prior to 1.6, this was not true.
8290 As a result, editing layout files was very time consuming, since you had
8291 constantly to restart \SpecialChar LyX
8297 You can force a reload of the current layout by using the \SpecialChar LyX
8299 \begin_inset Flex Noun
8302 \begin_layout Plain Layout
8309 There is no default binding for this function—though, of course, you can
8310 bind it to a key yourself.
8311 But you will normally use this function simply by entering it in the mini-buffe
8316 \begin_layout Standard
8322 \begin_inset Flex Noun
8325 \begin_layout Plain Layout
8331 is very much an `advanced feature'.
8336 recommended that you save your work before using this function.
8341 recommended that you not attempt to edit layout information while simultaneousl
8342 y working on a document that you care about.
8343 Use a test document.
8344 Syntax errors and the like in your layout file could cause peculiar behavior.
8345 In particular, such errors could cause \SpecialChar LyX
8346 to regard the current layout as
8347 invalid and to attempt to switch to some other layout.
8351 \begin_layout Plain Layout
8352 Really bad syntax errors may even caused \SpecialChar LyX
8354 This is because certain sorts of errors may make \SpecialChar LyX
8365 The \SpecialChar LyX
8366 team strives to keep \SpecialChar LyX
8367 stable in such situations, but safe is better
8372 \begin_layout Plain Layout
8373 While we're giving advice: make regular backups.
8374 And be nice to your mother.
8382 \begin_layout Subsection
8383 The Module declaration
8386 \begin_layout Standard
8387 A module must begin with a line like the following:
8390 \begin_layout LyX-Code
8393 DeclareLyXModule[endnotes.sty]{Endnotes}
8396 \begin_layout Standard
8397 The mandatory argument, in curly brackets, is the name of the module, as
8399 \begin_inset Flex Noun
8402 \begin_layout Plain Layout
8403 Document\SpecialChar menuseparator
8404 Settings\SpecialChar menuseparator
8411 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8413 on which the module depends.
8414 It is also possible to use the form
8415 \begin_inset Flex Noun
8418 \begin_layout Plain Layout
8424 as an optional argument, which declares that the module can only be used
8425 when there exists a conversion chain between the formats `
8426 \begin_inset Flex Code
8429 \begin_layout Plain Layout
8436 \begin_inset Flex Code
8439 \begin_layout Plain Layout
8448 \begin_layout Standard
8449 The module declaration should then be followed by lines like the following
8453 \begin_layout Plain Layout
8454 Preferably in English if the module should be published with \SpecialChar LyX
8456 This description will appear in the list of messages to be translated and
8457 will be thus translated with the next interface update.
8465 \begin_layout LyX-Code
8469 \begin_layout LyX-Code
8470 #Adds an endnote command, in addition to footnotes.
8474 \begin_layout LyX-Code
8475 #You will need to add
8477 theendnotes in TeX code where you
8480 \begin_layout LyX-Code
8481 #want the endnotes to appear.
8485 \begin_layout LyX-Code
8489 \begin_layout LyX-Code
8490 #Requires: somemodule | othermodule
8493 \begin_layout LyX-Code
8494 #Excludes: badmodule
8497 \begin_layout Standard
8498 The description is used in
8499 \begin_inset Flex Noun
8502 \begin_layout Plain Layout
8503 Document\SpecialChar menuseparator
8504 Settings\SpecialChar menuseparator
8510 to provide the user with information about what the module does.
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8521 line is used to identify other modules with which this one must be used;
8523 \begin_inset Flex Code
8526 \begin_layout Plain Layout
8532 line is used to identify modules with which this one may not be used.
8533 Both are optional, and, as shown, multiple modules should be separated
8534 with the pipe symbol: |.
8535 Note that the required modules are treated disjunctively:
8539 of the required modules must be used.
8544 excluded module may be used.
8545 Note that modules are identified here by their filenames without the
8546 \begin_inset Flex Code
8549 \begin_layout Plain Layout
8557 \begin_inset Flex Code
8560 \begin_layout Plain Layout
8567 \begin_inset Flex Code
8570 \begin_layout Plain Layout
8577 \change_inserted -712698321 1483873000
8581 \begin_layout Subsection
8583 \change_inserted -712698321 1483873010
8584 The CiteEngine file declaration
8587 \begin_layout Standard
8589 \change_inserted -712698321 1483873022
8590 A cite engine file must begin with a line like the following:
8593 \begin_layout LyX-Code
8595 \change_inserted -712698321 1483873047
8598 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8601 \begin_layout Standard
8603 \change_inserted -712698321 1483873077
8604 The mandatory argument, in curly brackets, is the name of the module, as
8606 \begin_inset Flex Noun
8609 \begin_layout Plain Layout
8611 \change_inserted -712698321 1483873068
8612 Document\SpecialChar menuseparator
8613 Settings\SpecialChar menuseparator
8620 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8622 on which the cite engine depends.
8625 \begin_layout Standard
8627 \change_inserted -712698321 1483873102
8628 The cite engine declaration should then be followed by lines like the following
8632 \begin_layout Plain Layout
8634 \change_inserted -712698321 1483873000
8635 Preferably in English if the module should be published with \SpecialChar LyX
8637 This description will appear in the list of messages to be translated and
8638 will be thus translated with the next interface update.
8646 \begin_layout LyX-Code
8648 \change_inserted -712698321 1483873128
8652 \begin_layout LyX-Code
8654 \change_inserted -712698321 1483873140
8655 # Biblatex supports many author-year and numerical styles.
8658 \begin_layout LyX-Code
8660 \change_inserted -712698321 1483873152
8661 # It is mainly aimed at the Humanities.
8665 \begin_layout LyX-Code
8667 \change_inserted -712698321 1483873160
8668 # customizable, fully localized and provides many features
8671 \begin_layout LyX-Code
8673 \change_inserted -712698321 1483873170
8674 # that are not possible with BibTeX.
8675 The use of 'biber' as
8678 \begin_layout LyX-Code
8680 \change_inserted -712698321 1483873174
8681 # bibliography processor is advised.
8684 \begin_layout LyX-Code
8686 \change_inserted -712698321 1483873224
8690 \begin_layout Standard
8692 \change_inserted -712698321 1483873207
8693 The description is used in
8694 \begin_inset Flex Noun
8697 \begin_layout Plain Layout
8699 \change_inserted -712698321 1483873194
8700 Document\SpecialChar menuseparator
8701 Settings\SpecialChar menuseparator
8707 to provide the user with information about the cite engine.
8712 \begin_layout Subsection
8716 \begin_layout Standard
8717 The first non-comment line of any layout file, included file, or module
8722 contain the file format number:
8725 \begin_layout Description
8726 \begin_inset Flex Code
8729 \begin_layout Plain Layout
8736 \begin_inset Flex Code
8739 \begin_layout Plain Layout
8745 ] The format number of the layout file.
8748 \begin_layout Standard
8749 This tag was introduced with \SpecialChar LyX
8751 \begin_inset space ~
8755 Layout files from older \SpecialChar LyX
8756 versions do not have an explicit file format and
8757 are considered to have
8758 \begin_inset Flex Code
8761 \begin_layout Plain Layout
8763 \begin_inset space ~
8772 The format for the present version of \SpecialChar LyX
8774 But each version of \SpecialChar LyX
8775 is capable of reading earlier versions' layout files,
8776 just as they are capable of reading files produced by earlier versions
8779 There is, however, no provision for converting to earlier formats.
8782 \begin_layout Subsection
8783 \begin_inset CommandInset label
8785 name "subsec:General-text-class"
8789 General text class parameters
8792 \begin_layout Standard
8793 These are general parameters that govern the behavior of an entire document
8799 mean that they must appear in
8800 \begin_inset Flex Code
8803 \begin_layout Plain Layout
8809 files rather than in modules.
8810 A module can contain any layout tag.)
8813 \begin_layout Description
8814 \begin_inset Flex Code
8817 \begin_layout Plain Layout
8823 Adds information that will be output in the
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8833 block when the document is output to XHTML.
8834 Typically, this would be used to output CSS style information, but it can
8835 be used for anything that can appear in
8836 \begin_inset Flex Code
8839 \begin_layout Plain Layout
8847 \begin_inset Quotes eld
8851 \begin_inset Flex Code
8854 \begin_layout Plain Layout
8861 \begin_inset Quotes erd
8867 \begin_layout Description
8868 \begin_inset Flex Code
8871 \begin_layout Plain Layout
8877 Adds information to the document preamble.
8879 \begin_inset Newline newline
8883 \begin_inset Quotes eld
8887 \begin_inset Flex Code
8890 \begin_layout Plain Layout
8897 \begin_inset Quotes erd
8901 \change_inserted -712698321 1483872509
8905 \begin_layout Description
8907 \change_inserted -712698321 1483874560
8908 \begin_inset Flex Code
8911 \begin_layout Plain Layout
8913 \change_inserted -712698321 1483872558
8919 Defines the possibilities for displaying citation references.
8921 \begin_inset CommandInset ref
8923 reference "subsec:Citation-engine-description"
8932 \begin_inset Quotes eld
8936 \begin_inset Flex Code
8939 \begin_layout Plain Layout
8941 \change_inserted -712698321 1483872548
8948 \begin_inset Quotes erd
8952 Primarily used in cite engine files (see
8953 \begin_inset CommandInset ref
8955 reference "subsec:Cite-Engine-Files"
8967 \begin_layout Description
8968 \begin_inset Flex Code
8971 \begin_layout Plain Layout
8977 Defines formats for use in the display of bibliographic information.
8979 \begin_inset CommandInset ref
8981 reference "subsec:Citation-format-description"
8987 \begin_inset Quotes eld
8991 \begin_inset Flex Code
8994 \begin_layout Plain Layout
9001 \begin_inset Quotes erd
9006 \change_inserted -712698321 1483875199
9007 Primarily used in cite engine files (see
9008 \begin_inset CommandInset ref
9010 reference "subsec:Cite-Engine-Files"
9022 \begin_layout Description
9024 \change_inserted -712698321 1483874578
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9030 \change_inserted -712698321 1483872820
9037 \begin_inset Flex Code
9040 \begin_layout Plain Layout
9042 \change_inserted -712698321 1483872852
9053 \begin_inset Flex Code
9056 \begin_layout Plain Layout
9058 \change_inserted -712698321 1483872857
9066 ] Determines whether
9070 or Bib\SpecialChar TeX
9071 is used to generate a Bibliography.
9072 Primarily used in cite engine files (see
9073 \begin_inset CommandInset ref
9075 reference "subsec:Cite-Engine-Files"
9087 \begin_layout Description
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9097 Describes various global options supported by the document class.
9099 \begin_inset CommandInset ref
9101 reference "subsec:ClassOptions"
9107 \begin_inset Quotes eld
9111 \begin_inset Flex Code
9114 \begin_layout Plain Layout
9121 \begin_inset Quotes erd
9127 \begin_layout Description
9128 \begin_inset Flex Code
9131 \begin_layout Plain Layout
9138 \begin_inset Flex Code
9141 \begin_layout Plain Layout
9150 \begin_inset space \thinspace{}
9154 \begin_inset Flex Code
9157 \begin_layout Plain Layout
9163 ] Whether the class should
9167 to having one or two columns.
9168 Can be changed in the
9169 \begin_inset Flex Noun
9172 \begin_layout Plain Layout
9173 Document\SpecialChar menuseparator
9182 \begin_layout Description
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9202 ] This sequence defines the properties for a counter.
9203 If the counter does not yet exist, it is created; if it does exist, it
9206 \begin_inset Quotes eld
9210 \begin_inset Flex Code
9213 \begin_layout Plain Layout
9220 \begin_inset Quotes erd
9224 \begin_inset Newline newline
9228 \begin_inset CommandInset ref
9230 reference "subsec:Counters"
9234 for details on counters.
9237 \begin_layout Description
9238 \begin_inset Flex Code
9241 \begin_layout Plain Layout
9247 Sets the default font used to display the document.
9249 \begin_inset CommandInset ref
9251 reference "subsec:Font-description"
9255 for how to declare fonts.
9257 \begin_inset Quotes eld
9261 \begin_inset Flex Code
9264 \begin_layout Plain Layout
9271 \begin_inset Quotes erd
9277 \begin_layout Description
9278 \begin_inset Flex Code
9281 \begin_layout Plain Layout
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9297 ] Specifies a module to be included by default with this document class.
9298 The module is specified as filename without the
9299 \begin_inset Flex Code
9302 \begin_layout Plain Layout
9309 The user can still remove the module, but it will be active at the outset.
9310 (This applies only when new files are created, or when this class is chosen
9311 for an existing document.)
9314 \begin_layout Description
9315 \begin_inset Flex Code
9318 \begin_layout Plain Layout
9325 \begin_inset Flex Code
9328 \begin_layout Plain Layout
9334 ] This is the style that will be assigned to new paragraphs, usually
9335 \begin_inset Flex Noun
9338 \begin_layout Plain Layout
9345 This will default to the first defined style if not given, but you are
9346 encouraged to use this directive.
9349 \begin_layout Description
9350 \begin_inset Flex Code
9353 \begin_layout Plain Layout
9360 \begin_inset Flex Code
9363 \begin_layout Plain Layout
9369 ] This tag indicates that the module (which is specified by filename without
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9380 extension) cannot be used with this document class.
9381 This might be used in a journal-specific layout file to prevent, say, the
9383 \begin_inset Flex Code
9386 \begin_layout Plain Layout
9392 module that numbers theorems by section.
9397 be used in a module.
9398 Modules have their own way of excluding other modules (see
9399 \begin_inset CommandInset ref
9401 reference "subsec:Layout-modules"
9408 \begin_layout Description
9409 \begin_inset Flex Code
9412 \begin_layout Plain Layout
9418 Defines a new float.
9420 \begin_inset CommandInset ref
9422 reference "subsec:Floats"
9428 \begin_inset Quotes eld
9432 \begin_inset Flex Code
9435 \begin_layout Plain Layout
9442 \begin_inset Quotes erd
9448 \begin_layout Description
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9458 Sets the information that will be output in the
9459 \begin_inset Flex Code
9462 \begin_layout Plain Layout
9468 block when this document class is output to XHTML.
9469 Note that this will completely override any prior
9470 \begin_inset Flex Code
9473 \begin_layout Plain Layout
9480 \begin_inset Flex Code
9483 \begin_layout Plain Layout
9491 \begin_inset Newline newline
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9504 if you just want to add material to the preamble.) Must end with
9505 \begin_inset Quotes eld
9509 \begin_inset Flex Code
9512 \begin_layout Plain Layout
9519 \begin_inset Quotes erd
9525 \begin_layout Description
9526 \begin_inset Flex Code
9529 \begin_layout Plain Layout
9536 \begin_inset Flex Code
9539 \begin_layout Plain Layout
9545 ] The style to use for the table of contents, bibliography, and so forth,
9546 when the document is output to HTML.
9547 For articles, this should normally be
9548 \begin_inset Flex Code
9551 \begin_layout Plain Layout
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9568 If it is not given, then \SpecialChar LyX
9569 will attempt to figure out which layout to use.
9572 \begin_layout Description
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9583 \begin_inset Flex Code
9586 \begin_layout Plain Layout
9592 ] Modifies the properties of the given counter.
9593 If the counter does not exist, the statement is ignored.
9595 \begin_inset Quotes eld
9599 \begin_inset Flex Code
9602 \begin_layout Plain Layout
9609 \begin_inset Quotes erd
9613 \begin_inset Newline newline
9617 \begin_inset CommandInset ref
9619 reference "subsec:Counters"
9623 for details on counters.
9626 \begin_layout Description
9627 \begin_inset Flex Code
9630 \begin_layout Plain Layout
9637 \begin_inset Flex Code
9640 \begin_layout Plain Layout
9646 ] This allows you to include another layout definition file within yours
9647 to avoid duplicating commands.
9648 Common examples are the standard layout files, for example,
9649 \begin_inset Flex Code
9652 \begin_layout Plain Layout
9658 , which contains most of the basic layouts.
9661 \begin_layout Description
9662 \begin_inset Flex Code
9665 \begin_layout Plain Layout
9672 \begin_inset Flex Code
9675 \begin_layout Plain Layout
9681 ] This section (re-)defines the layout of an inset.
9682 It can be applied to an existing inset or to a new, user-defined inset,
9683 e.g., a new character style.
9685 \begin_inset Quotes eld
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9699 \begin_inset Quotes erd
9703 \begin_inset Newline newline
9707 \begin_inset CommandInset ref
9709 reference "subsec:Flex-insets-and"
9713 for more information.
9717 \begin_layout Description
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9728 \begin_inset Flex Code
9731 \begin_layout Plain Layout
9737 ] A string that indicates the width of the left margin on the screen, for
9739 \begin_inset Quotes eld
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9753 \begin_inset Quotes erd
9757 (Note that this is not a `length', like
9758 \begin_inset Quotes eld
9762 \begin_inset Quotes erd
9766 \change_inserted -712698321 1483872681
9770 \begin_layout Description
9772 \change_inserted -712698321 1483874598
9773 \begin_inset Flex Code
9776 \begin_layout Plain Layout
9778 \change_inserted -712698321 1483872687
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9790 \change_inserted -712698321 1483872692
9796 ] An integer that determines the maximal number of names displayed in an
9797 author-year citation before the citation switches to
9798 \begin_inset Quotes eld
9802 \begin_inset Quotes erd
9806 Primarily used in cite engine files (see
9807 \begin_inset CommandInset ref
9809 reference "subsec:Cite-Engine-Files"
9821 \begin_layout Description
9822 \begin_inset Flex Code
9825 \begin_layout Plain Layout
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9841 ] Modifies the properties of the given paragraph style.
9842 If the style does not exist, this section is ignored.
9844 \begin_inset Quotes eld
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9858 \begin_inset Quotes erd
9864 \begin_layout Description
9865 \begin_inset Flex Code
9868 \begin_layout Plain Layout
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9884 ] Deletes an existing counter, usually one defined in an included file.
9887 \begin_layout Description
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9898 \begin_inset Flex Code
9901 \begin_layout Plain Layout
9907 ] Deletes an existing float.
9908 This is particularly useful when you want to suppress a float that has
9909 been defined in an input file.
9912 \begin_layout Description
9913 \begin_inset Flex Code
9916 \begin_layout Plain Layout
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9932 ] Deletes an existing style.
9933 \change_inserted 2047637253 1483900342
9937 \begin_layout Description
9939 \change_inserted 2047637253 1483900479
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9945 \change_inserted 2047637253 1483900346
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9957 \change_inserted 2047637253 1483900369
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9969 \change_inserted 2047637253 1483900418
9975 ] Define a new table of contents with type
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9981 \change_inserted 2047637253 1483900414
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
9993 \change_inserted 2047637253 1483900419
10000 See also the AddToToc commands.
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 ] The file format (as defined in the \SpecialChar LyX
10026 preferences) produced by this document
10028 It is mainly useful when
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10048 and one wants to define a new type of literate document.
10049 The format is reset to
10050 \begin_inset Quotes eld
10054 \begin_inset Flex Code
10057 \begin_layout Plain Layout
10064 \begin_inset Quotes erd
10068 \begin_inset Quotes eld
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10082 \begin_inset Quotes erd
10085 when the corresponding
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10095 parameter is encountered.
10098 \begin_layout Description
10099 \begin_inset Flex Code
10102 \begin_layout Plain Layout
10109 \begin_inset Flex Code
10112 \begin_layout Plain Layout
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10142 ] Specifies what sort of output documents using this class will produce.
10145 \begin_layout Description
10146 \begin_inset Flex Code
10149 \begin_layout Plain Layout
10156 \begin_inset Flex Code
10159 \begin_layout Plain Layout
10166 \begin_inset Flex Code
10169 \begin_layout Plain Layout
10175 ] Specifies options, given in the second string, for the package named by
10178 \begin_inset Quotes eld
10182 \begin_inset Flex Code
10185 \begin_layout Plain Layout
10186 PackageOptions natbib square
10192 \begin_inset Quotes erd
10196 \begin_inset Flex Code
10199 \begin_layout Plain Layout
10205 to be loaded with the
10206 \begin_inset Flex Code
10209 \begin_layout Plain Layout
10216 (For \SpecialChar TeX
10217 perts, this causes \SpecialChar LyX
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10225 PassOptionsToPackage{natbib}{square}
10231 \begin_inset Flex Code
10234 \begin_layout Plain Layout
10243 \begin_layout Description
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10266 \begin_inset Flex Code
10269 \begin_layout Plain Layout
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10285 ] The default pagestyle.
10286 Can be changed in the
10287 \begin_inset Flex Noun
10290 \begin_layout Plain Layout
10291 Document\SpecialChar menuseparator
10300 \begin_layout Description
10301 \begin_inset Flex Code
10304 \begin_layout Plain Layout
10310 Sets the preamble for the \SpecialChar LaTeX
10312 Note that this will completely override any prior
10313 \begin_inset Flex Code
10316 \begin_layout Plain Layout
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10334 \begin_inset Flex Code
10337 \begin_layout Plain Layout
10343 if you just want to add material to the preamble.) Must end with
10344 \begin_inset Quotes eld
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10358 \begin_inset Quotes erd
10364 \begin_layout Description
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10397 \begin_inset space \thinspace{}
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10410 ] Whether the class already provides the feature
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10421 A feature is in general the name of a package (e.
10422 \begin_inset space \thinspace{}
10426 \begin_inset space \space{}
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10440 \begin_inset Flex Code
10443 \begin_layout Plain Layout
10450 \begin_inset space \thinspace{}
10454 \begin_inset space \space{}
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10479 \begin_inset CommandInset ref
10481 reference "chap:List-of-functions"
10485 for the list of features.
10488 \begin_layout Description
10489 \begin_inset Flex Code
10492 \begin_layout Plain Layout
10499 \begin_inset Flex Code
10502 \begin_layout Plain Layout
10508 ] Indicates that this layout provides the functionality of the module mentioned,
10509 which should be specified by the filename without the
10510 \begin_inset Flex Code
10513 \begin_layout Plain Layout
10520 This will typically be used if the layout includes the module directly,
10521 rather than using the
10522 \begin_inset Flex Code
10525 \begin_layout Plain Layout
10531 tag to indicate that it ought to be used.
10532 It could also be used in a module that provided an alternate implementation
10533 of the same functionality.
10536 \begin_layout Description
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10547 \begin_inset Flex Code
10550 \begin_layout Plain Layout
10556 ] Creates a new paragraph style if it does not already exist.
10557 If the style does exist, this section is ignored.
10559 \begin_inset Quotes eld
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10573 \begin_inset Quotes erd
10579 \begin_layout Description
10580 \begin_inset Flex Code
10583 \begin_layout Plain Layout
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10599 ] Whether the class requires the feature
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10610 Multiple features must be separated by commas.
10611 Note that you can only request supported features.
10613 \begin_inset CommandInset ref
10615 reference "chap:List-of-functions"
10619 for the list of features.).
10620 If you require a package with specific options, you can additionally use
10622 \begin_inset Flex Code
10625 \begin_layout Plain Layout
10634 \begin_layout Description
10635 \begin_inset Flex Code
10638 \begin_layout Plain Layout
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10654 ] A string that indicates the width of the right margin on the screen, for
10656 \begin_inset Quotes eld
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10670 \begin_inset Quotes erd
10676 \begin_layout Description
10677 \begin_inset Flex Code
10680 \begin_layout Plain Layout
10687 \begin_inset Flex Code
10690 \begin_layout Plain Layout
10696 ] Sets which divisions get numbered.
10698 \begin_inset Newline newline
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10711 counter in \SpecialChar LaTeX
10715 \begin_layout Description
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10726 \begin_inset Flex Code
10729 \begin_layout Plain Layout
10738 \begin_inset space \thinspace{}
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10751 ] Whether the class-default should be printing on one or both sides of the
10753 Can be changed in the
10754 \begin_inset Flex Noun
10757 \begin_layout Plain Layout
10758 Document\SpecialChar menuseparator
10767 \begin_layout Description
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10778 \begin_inset Flex Code
10781 \begin_layout Plain Layout
10787 ] This sequence defines a paragraph style.
10788 If the style does not yet exist, it is created; if it does exist, its parameter
10791 \begin_inset Quotes eld
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10805 \begin_inset Quotes erd
10809 \begin_inset Newline newline
10813 \begin_inset CommandInset ref
10815 reference "subsec:Paragraph-Styles"
10819 for details on paragraph styles.
10822 \begin_layout Description
10823 \begin_inset Flex Code
10826 \begin_layout Plain Layout
10833 \begin_inset Flex Code
10836 \begin_layout Plain Layout
10842 ] The name of the command or environment to be used with
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10855 \begin_layout Description
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10887 ] Indicates what kind of markup is used to define the title of a document.
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10898 means that the macro with name
10899 \begin_inset Flex Code
10902 \begin_layout Plain Layout
10908 will be inserted after the last layout which has
10909 \begin_inset Quotes eld
10913 \begin_inset Flex Code
10916 \begin_layout Plain Layout
10918 \begin_inset space ~
10927 \begin_inset Quotes erd
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10941 corresponds to the case where all layouts which have
10942 \begin_inset Quotes eld
10946 \begin_inset Flex Code
10949 \begin_layout Plain Layout
10951 \begin_inset space ~
10960 \begin_inset Quotes erd
10963 should be enclosed into the
10964 \begin_inset Flex Code
10967 \begin_layout Plain Layout
10976 \begin_layout Description
10977 \begin_inset Flex Code
10980 \begin_layout Plain Layout
10987 \begin_inset Flex Code
10990 \begin_layout Plain Layout
10996 ] Sets which divisions are included in the table of contents.
10998 \begin_inset Flex Code
11001 \begin_layout Plain Layout
11007 counter in \SpecialChar LaTeX
11011 \begin_layout Subsection
11012 \begin_inset Flex Code
11015 \begin_layout Plain Layout
11022 \begin_inset CommandInset label
11024 name "subsec:ClassOptions"
11031 \begin_layout Standard
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11042 section can contain the following entries:
11045 \begin_layout Description
11046 \begin_inset Flex Code
11049 \begin_layout Plain Layout
11056 \begin_inset Flex Code
11059 \begin_layout Plain Layout
11065 ] The list of available font sizes for the document's main font, separated
11067 \begin_inset Quotes eld
11071 \begin_inset Flex Code
11074 \begin_layout Plain Layout
11081 \begin_inset Quotes erd
11087 \begin_layout Description
11088 \begin_inset Flex Code
11091 \begin_layout Plain Layout
11097 Used to set the DTD line with XML-based output classes.
11099 \begin_inset space \thinspace{}
11103 \begin_inset Quotes eld
11106 -//OASIS//DTD DocBook V4.2//EN
11107 \begin_inset Quotes erd
11113 \begin_layout Description
11114 \begin_inset Flex Code
11117 \begin_layout Plain Layout
11124 \begin_inset Flex Code
11127 \begin_layout Plain Layout
11128 string="empty|plain|headings|fancy"
11133 ] The list of available page sty\SpecialChar softhyphen
11135 \begin_inset Quotes eld
11139 \begin_inset Flex Code
11142 \begin_layout Plain Layout
11149 \begin_inset Quotes erd
11155 \begin_layout Description
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11166 \begin_inset Flex Code
11169 \begin_layout Plain Layout
11175 ] Some document class options, separated by a comma, that will be added
11176 to the optional part of the
11177 \begin_inset Flex Code
11180 \begin_layout Plain Layout
11191 \begin_layout Standard
11193 \begin_inset Flex Code
11196 \begin_layout Plain Layout
11202 section must end with
11203 \begin_inset Quotes eld
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11217 \begin_inset Quotes erd
11223 \begin_layout Subsection
11225 \begin_inset CommandInset label
11227 name "subsec:Paragraph-Styles"
11234 \begin_layout Standard
11235 A paragraph style description looks like this:
11239 \begin_layout Plain Layout
11240 Note that this will either define a new style or modify an existing one.
11248 \begin_layout LyX-Code
11255 \begin_layout LyX-Code
11259 \begin_layout LyX-Code
11263 \begin_layout Standard
11264 where the following commands are allowed:
11267 \begin_layout Description
11269 \change_inserted 2047637253 1483963019
11270 \begin_inset Flex Code
11273 \begin_layout Plain Layout
11275 \change_inserted 2047637253 1483901753
11282 \begin_inset Flex Code
11285 \begin_layout Plain Layout
11287 \change_inserted 2047637253 1483963007
11293 =""] This paragraph will appear in the table of contents of the given type.
11294 An empty string disables.
11295 See also the OutlinerName and the IsTocCaption commands.
11299 \begin_layout Description
11300 \begin_inset Flex Code
11303 \begin_layout Plain Layout
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11318 , left, right, center
11323 ] Paragraph alignment.
11326 \begin_layout Description
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11337 \begin_inset Flex Code
11340 \begin_layout Plain Layout
11345 , left, right, center
11350 ] A comma separated list of permitted alignments.
11351 (Some \SpecialChar LaTeX
11352 styles prohibit certain alignments, since those wouldn't make sense.
11353 For example a right-aligned or centered enumeration isn't possible.)
11356 \begin_layout Description
11357 \begin_inset Flex Code
11360 \begin_layout Plain Layout
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11376 ] Defines argument number <int> of a command\SpecialChar breakableslash
11377 environment associated with
11379 This is useful for things like section headings, and only makes sense with
11382 Every (optional or required) argument of a command or environment – except
11383 for the required argument that is associated with the content of the paragraph
11384 itself – has a separate definition, where the number specifies the order
11386 The definition must end with
11387 \begin_inset Flex Code
11390 \begin_layout Plain Layout
11397 So a command with two optional arguments has:
11401 \begin_layout Quote
11407 \begin_layout Quote
11413 \begin_layout Quote
11419 \begin_layout Quote
11425 \begin_layout Quote
11431 \begin_layout Quote
11437 \begin_layout Standard
11439 \begin_inset Flex Code
11442 \begin_layout Plain Layout
11448 definition, the following specifications are possible:
11451 \begin_layout Itemize
11452 \begin_inset Flex Code
11455 \begin_layout Plain Layout
11462 \begin_inset Flex Code
11465 \begin_layout Plain Layout
11471 The string that will appear both in the menu (to insert this argument)
11472 and on the argument inset button (unless you also specify a separate
11473 \begin_inset Flex Code
11476 \begin_layout Plain Layout
11483 For the menu, you can define an accelerator by appending the respective
11484 character to the string, divided by
11485 \begin_inset Quotes eld
11489 \begin_inset Quotes erd
11493 \begin_inset space \thinspace{}
11497 \begin_inset space \space{}
11501 \begin_inset Quotes eld
11505 \begin_inset Flex Code
11508 \begin_layout Plain Layout
11515 \begin_inset Quotes erd
11521 \begin_layout Itemize
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11532 \begin_inset Flex Code
11535 \begin_layout Plain Layout
11541 A separate string for the menu.
11542 You can define an accelerator by appending the respective character to
11543 the string, divided by
11544 \begin_inset Quotes eld
11548 \begin_inset Quotes erd
11552 \begin_inset space \thinspace{}
11556 \begin_inset space \space{}
11560 \begin_inset Quotes eld
11564 \begin_inset Flex Code
11567 \begin_layout Plain Layout
11574 \begin_inset Quotes erd
11578 This specification is optional.
11579 If it is not given the
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11589 will be used instead for the menu.
11592 \begin_layout Itemize
11593 \begin_inset Flex Code
11596 \begin_layout Plain Layout
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11612 A longer explanatory text that appears in the tooltip when hovering over
11613 the argument inset.
11616 \begin_layout Itemize
11617 \begin_inset Flex Code
11620 \begin_layout Plain Layout
11627 \begin_inset Flex Code
11630 \begin_layout Plain Layout
11639 \begin_inset space \thinspace{}
11643 \begin_inset Flex Code
11646 \begin_layout Plain Layout
11652 ] Declare if this is a mandatory (1) or an optional (0) argument.
11653 Mandatory arguments will be output empty if not given, while optional arguments
11654 will not be output at all.
11655 By default, mandatory arguments are delimited by
11656 \begin_inset Flex Code
11659 \begin_layout Plain Layout
11665 , while optional arguments are delimited by
11666 \begin_inset Flex Code
11669 \begin_layout Plain Layout
11678 \begin_layout Itemize
11679 \begin_inset Flex Code
11682 \begin_layout Plain Layout
11689 \begin_inset Flex Code
11692 \begin_layout Plain Layout
11698 defines another argument (by its number) which this argument requires to
11699 be output if it is itself output.
11701 \begin_inset space \thinspace{}
11704 g., in \SpecialChar LaTeX
11705 commands, optional arguments often require previous optional arguments
11706 to be output (at least empty), as in
11707 \begin_inset Flex Code
11710 \begin_layout Plain Layout
11713 command[][argument]{text}
11719 This can be achieved by the statement
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11742 \begin_layout Itemize
11743 \begin_inset Flex Code
11746 \begin_layout Plain Layout
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11762 defines a custom left delimiter (instead of
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11773 \begin_inset Flex Code
11776 \begin_layout Plain Layout
11783 A line break in the output can be indicated by
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11796 \begin_layout Itemize
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11816 defines a custom right delimiter (instead of
11817 \begin_inset Flex Code
11820 \begin_layout Plain Layout
11827 \begin_inset Flex Code
11830 \begin_layout Plain Layout
11837 A line break in the output can be indicated by
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11850 \begin_layout Itemize
11851 \begin_inset Flex Code
11854 \begin_layout Plain Layout
11861 \begin_inset Flex Code
11864 \begin_layout Plain Layout
11870 defines an argument that is inserted if and only if no user-specified arguments
11872 \begin_inset space \thinspace{}
11876 \begin_inset space \space{}
11879 if no argument inset has been inserted (note that also an empty argument
11880 inset omits the DefaultArg).
11881 Multiple arguments need to be separated by comma.
11884 \begin_layout Itemize
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11904 defines an argument that is inserted in any case (alone or in addition
11905 to user-specified arguments).
11906 Multiple arguments need to be separated by comma.
11909 \begin_layout Itemize
11910 \begin_inset Flex Code
11913 \begin_layout Plain Layout
11919 The font used for the argument content, see
11920 \begin_inset CommandInset ref
11922 reference "subsec:Font-description"
11929 \begin_layout Itemize
11930 \begin_inset Flex Code
11933 \begin_layout Plain Layout
11939 The font used for the label; see
11940 \begin_inset CommandInset ref
11942 reference "subsec:Font-description"
11949 \begin_layout Itemize
11950 \begin_inset Flex Code
11953 \begin_layout Plain Layout
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11968 , Minimalistic, Conglomerate
11973 ] describes the rendering style used for the inset's frame and buttons.
11976 \begin_layout Itemize
11977 \begin_inset Flex Code
11980 \begin_layout Plain Layout
11987 \begin_inset Flex Code
11990 \begin_layout Plain Layout
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12006 , this argument is automatically inserted when the respective style is selected.
12007 Currently, only one argument per style\SpecialChar breakableslash
12008 layout can be automatically inserted.
12011 \begin_layout Itemize
12012 \begin_inset Flex Code
12015 \begin_layout Plain Layout
12022 \begin_inset Flex Code
12025 \begin_layout Plain Layout
12032 \begin_inset Flex Code
12035 \begin_layout Plain Layout
12041 , this argument will be inserted with a copy of the co-text (either selected
12042 text or the whole paragraph) as content.
12043 \change_inserted -712698321 1477038290
12047 \begin_layout Itemize
12049 \change_inserted -712698321 1477038425
12050 \begin_inset Flex Code
12053 \begin_layout Plain Layout
12055 \change_inserted -712698321 1477038295
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12067 \change_inserted -712698321 1477038311
12077 ] Whether the contents of this argument should be output in raw form, meaning
12078 without special translations that \SpecialChar LaTeX
12081 \begin_inset Flex Code
12084 \begin_layout Plain Layout
12086 \change_inserted -712698321 1477038356
12092 status is inherited by the inset or paragraph layout the argument belongs
12093 to, true and false change the status for the given argument only.
12098 \begin_layout Itemize
12099 \begin_inset Flex Code
12102 \begin_layout Plain Layout
12109 \begin_inset Flex Code
12112 \begin_layout Plain Layout
12113 string of characters
12122 Defines individual characters that should be output in raw form, meaning
12123 without special translations that \SpecialChar LaTeX
12125 Note that, contrary to PassThru, this needs to be explicitly defined for
12127 That is, arguments do not inherit PassThruChars from their parent inset
12129 \change_inserted 2047637253 1483899840
12133 \begin_layout Itemize
12135 \change_inserted 2047637253 1483900841
12136 \begin_inset Flex Code
12139 \begin_layout Plain Layout
12141 \change_inserted 2047637253 1483900841
12148 \begin_inset Flex Code
12151 \begin_layout Plain Layout
12153 \change_inserted 2047637253 1483900841
12162 \begin_inset space \thinspace{}
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12171 \change_inserted 2047637253 1483900841
12177 ] If this is set to 1, the argument will output its content in the corresponding
12178 item in the table of contents.
12184 \begin_layout Standard
12185 By default, the text entered in the \SpecialChar LyX
12186 workarea in the respective layout is
12187 the last (mandatory) argument of a command if the
12188 \begin_inset Flex Code
12191 \begin_layout Plain Layout
12198 \begin_inset Flex Code
12201 \begin_layout Plain Layout
12208 However, arguments with the prefix
12209 \begin_inset Flex Code
12212 \begin_layout Plain Layout
12218 are output after this workarea argument.
12219 Note that post-argument numbering restarts at 1, so the first argument
12220 following the workarea argument is
12221 \begin_inset Flex Code
12224 \begin_layout Plain Layout
12231 Post-arguments are ignored in any other
12232 \begin_inset Flex Code
12235 \begin_layout Plain Layout
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12254 \begin_layout Standard
12256 \begin_inset Flex Code
12259 \begin_layout Plain Layout
12268 \begin_inset Flex Code
12271 \begin_layout Plain Layout
12280 \begin_inset Flex Code
12283 \begin_layout Plain Layout
12289 followed by the number (e.
12290 \begin_inset space \thinspace{}
12294 \begin_inset space \space{}
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12311 \begin_layout Description
12312 \begin_inset Flex Code
12315 \begin_layout Plain Layout
12321 Note that this will completely override any prior
12322 \begin_inset Flex Code
12325 \begin_layout Plain Layout
12331 declaration for this style.
12333 \begin_inset Quotes eld
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12347 \begin_inset Quotes erd
12352 \begin_inset CommandInset ref
12354 reference "subsec:I18n"
12358 for details on its use.
12361 \begin_layout Description
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12372 \begin_inset Flex Code
12375 \begin_layout Plain Layout
12385 \begin_layout Plain Layout
12386 Note that a `float' here is a real number, such as: 1.5.
12391 The vertical space with which the last of a chain of paragraphs with this
12392 style is separated from the following paragraph.
12393 If the next paragraph has another style, the separations are not simply
12394 added, but the maximum is taken.
12397 \begin_layout Description
12398 \begin_inset Flex Code
12401 \begin_layout Plain Layout
12408 \begin_inset Flex Code
12411 \begin_layout Plain Layout
12417 ] The category for this style.
12418 This is used to group related styles in the style combobox on the toolbar.
12419 Any string can be used, but you may want to use existing categories with
12424 \begin_layout Description
12425 \begin_inset Flex Code
12428 \begin_layout Plain Layout
12434 Depth of XML command.
12435 Used only with XML-type formats.
12438 \begin_layout Description
12439 \begin_inset Flex Code
12442 \begin_layout Plain Layout
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12458 ] Copies all the features of an existing style into the current one.
12462 \begin_layout Description
12463 \begin_inset Flex Code
12466 \begin_layout Plain Layout
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12482 ] The name of a style whose preamble should be output
12487 This allows to ensure some ordering of the preamble snippets when macros
12488 definitions depend on one another.
12492 \begin_layout Plain Layout
12493 Note that, besides that functionality, there is no way to ensure any ordering
12495 The ordering that you see in a given version of \SpecialChar LyX
12496 may change without warning
12505 \begin_layout Description
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12516 \begin_inset Flex Code
12519 \begin_layout Plain Layout
12524 , Box, Filled_Box, Static
12529 ] The type of label that stands at the end of the paragraph (or sequence
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12541 \begin_inset Newline newline
12545 \begin_inset Flex Code
12548 \begin_layout Plain Layout
12555 \begin_inset Flex Code
12558 \begin_layout Plain Layout
12565 \begin_inset Flex Code
12568 \begin_layout Plain Layout
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12586 \begin_inset Quotes eld
12590 \begin_inset Quotes erd
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12604 \begin_inset space \space{}
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12617 ) is a white (resp.
12618 \begin_inset space ~
12621 black) square suitable for end of proof markers,
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12631 is an explicit text string.
12634 \begin_layout Description
12635 \begin_inset Flex Code
12638 \begin_layout Plain Layout
12645 \begin_inset Flex Code
12648 \begin_layout Plain Layout
12654 ] The string used for a label with a
12655 \begin_inset Flex Code
12658 \begin_layout Plain Layout
12665 \begin_inset Newline newline
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12682 \begin_layout Description
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12692 The font used for both the text body
12698 \begin_inset CommandInset ref
12700 reference "subsec:Font-description"
12705 Note that defining this font automatically defines the
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12716 So you should define this one first if you also want to define
12717 \begin_inset Flex Code
12720 \begin_layout Plain Layout
12729 \begin_layout Description
12730 \begin_inset Flex Code
12733 \begin_layout Plain Layout
12740 \begin_inset Flex Code
12743 \begin_layout Plain Layout
12749 ] Used for backporting new styles to stable \SpecialChar LyX
12751 The first stable version that supports this tag is \SpecialChar LyX
12753 The argument is a number which may either be 0, -1 or any value greater
12756 \begin_inset Flex Code
12759 \begin_layout Plain Layout
12765 flag of a style is greater than zero, it will always be written to the
12767 If a .lyx file is read, the style definitions from the document header are
12768 added to the document class.
12769 Therefore even older \SpecialChar LyX
12770 versions can handle the style.
12772 \begin_inset Flex Code
12775 \begin_layout Plain Layout
12781 is a version number: if the style is read, and the version number is less
12782 than the version number of the already existing style in the document class,
12783 the new style is ignored.
12784 If the version number is greater, the new style replaces the existing style.
12785 A value of -1 means an infinite version number, i.
12786 \begin_inset space \thinspace{}
12790 \begin_inset space \space{}
12793 the style is always used.
12796 \begin_layout Description
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12807 \begin_inset Flex Code
12810 \begin_layout Plain Layout
12819 \begin_inset space \thinspace{}
12823 \begin_inset Flex Code
12826 \begin_layout Plain Layout
12832 ] Usually \SpecialChar LyX
12833 does not allow you to insert more than one space between words,
12834 since a space is considered as the separation between two words, not a
12835 character or symbol of its own.
12836 This is a very fine thing but sometimes annoying, for example, when typing
12837 program code or plain \SpecialChar LaTeX
12840 \begin_inset Flex Code
12843 \begin_layout Plain Layout
12850 Note that \SpecialChar LyX
12851 will create protected blanks for the additional blanks when
12852 in another mode than \SpecialChar LaTeX
12856 \begin_layout Description
12857 \begin_inset Flex Code
12860 \begin_layout Plain Layout
12866 These tags are used with XHTML output.
12868 \begin_inset CommandInset ref
12870 reference "subsec:Paragraph-Style-XHTML"
12877 \begin_layout Description
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12887 [FIXME] (Used only with XML-type formats.)
12890 \begin_layout Description
12891 \begin_inset Flex Code
12894 \begin_layout Plain Layout
12901 \begin_inset Flex Code
12904 \begin_layout Plain Layout
12913 \begin_inset space \thinspace{}
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12927 \begin_inset Flex Code
12930 \begin_layout Plain Layout
12936 , marks the style as to be included in the document preamble and not in
12938 This is useful for document classes that want such information as the title
12939 and author to appear in the preamble.
12940 Note that this works only for styles for which the
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12951 \begin_inset Flex Code
12954 \begin_layout Plain Layout
12961 \begin_inset Flex Code
12964 \begin_layout Plain Layout
12973 \begin_layout Description
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12996 \begin_inset space \thinspace{}
13000 \begin_inset Flex Code
13003 \begin_layout Plain Layout
13010 \begin_inset Flex Code
13013 \begin_layout Plain Layout
13019 , marks the style as being part of a title block (see also the
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13030 \begin_inset Flex Code
13033 \begin_layout Plain Layout
13042 \begin_layout Description
13044 \change_inserted 2047637253 1483902824
13045 \begin_inset Flex Code
13048 \begin_layout Plain Layout
13050 \change_inserted 2047637253 1483902211
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13062 \change_inserted 2047637253 1483902211
13071 \begin_inset space \thinspace{}
13075 \begin_inset Flex Code
13078 \begin_layout Plain Layout
13080 \change_inserted 2047637253 1483902211
13086 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13087 of its contents in its item in the table of contents.
13088 Otherwise, only the label, if it exists, appears.
13091 \begin_layout Description
13092 \begin_inset Flex Code
13095 \begin_layout Plain Layout
13102 \begin_inset Flex Code
13105 \begin_layout Plain Layout
13111 ] The \SpecialChar LaTeX
13112 command sequence declaring an item in a list.
13113 The command is to be defined without the preceding backslash (the default
13115 \begin_inset Quotes eld
13119 \begin_inset Quotes erd
13123 \begin_inset Flex Code
13126 \begin_layout Plain Layout
13134 in the \SpecialChar LaTeX
13138 \begin_layout Description
13139 \begin_inset Flex Code
13142 \begin_layout Plain Layout
13149 \begin_inset Flex Code
13152 \begin_layout Plain Layout
13158 ] This provides extra space between paragraphs that have the same style.
13159 If you put other styles into an environment, each is separated with the
13161 \begin_inset Flex Code
13164 \begin_layout Plain Layout
13171 But the whole items of the environment are additionally separated with
13173 \begin_inset Flex Code
13176 \begin_layout Plain Layout
13183 Note that this is a
13188 \begin_layout Description
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13198 [FIXME] (Used only with XML-type formats.)
13201 \begin_layout Description
13202 \begin_inset Flex Code
13205 \begin_layout Plain Layout
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13224 \begin_inset space \thinspace{}
13228 \begin_inset Flex Code
13231 \begin_layout Plain Layout
13237 ] Usually \SpecialChar LyX
13238 does not allow you to leave a paragraph empty, since it would
13239 lead to empty \SpecialChar LaTeX
13241 There are some cases where this could be desirable however: in a letter
13242 template, the required fields can be provided as empty fields, so that
13243 people do not forget them; in some special classes, a style can be used
13244 as some kind of break, which does not contain actual text.
13247 \begin_layout Description
13248 \begin_inset Flex Code
13251 \begin_layout Plain Layout
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13267 ] The vertical space between the label and the text body.
13268 Only used for labels that are above the text body (
13269 \begin_inset Flex Code
13272 \begin_layout Plain Layout
13279 \begin_inset Newline newline
13283 \begin_inset Flex Code
13286 \begin_layout Plain Layout
13287 Centered_Top_Environment
13295 \begin_layout Description
13296 \begin_inset Flex Code
13299 \begin_layout Plain Layout
13306 \begin_inset Flex Code
13309 \begin_layout Plain Layout
13315 ] The name of the counter for automatic numbering.
13316 In order to have the counter appear with your label, you will need to reference
13318 \begin_inset Flex Code
13321 \begin_layout Plain Layout
13330 This will work with
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13371 \begin_inset Newline newline
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13389 \begin_inset Flex Code
13392 \begin_layout Plain Layout
13398 , though this case is a bit complicated.
13399 Suppose you declare
13400 \begin_inset Quotes eld
13404 \begin_inset Flex Code
13407 \begin_layout Plain Layout
13408 LabelCounter myenum
13414 \begin_inset Quotes erd
13418 Then the actual counters used are
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13449 \begin_inset Flex Code
13452 \begin_layout Plain Layout
13458 , much as in \SpecialChar LaTeX
13460 These counters must all be declared separately.
13461 \begin_inset Newline newline
13465 \begin_inset CommandInset ref
13467 reference "subsec:Counters"
13471 for details on counters.
13474 \begin_layout Description
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13484 The font used for the label.
13486 \begin_inset CommandInset ref
13488 reference "subsec:Font-description"
13495 \begin_layout Description
13496 \begin_inset Flex Code
13499 \begin_layout Plain Layout
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13515 ] Text that indicates how far a label should be indented.
13518 \begin_layout Description
13519 \begin_inset Flex Code
13522 \begin_layout Plain Layout
13529 \begin_inset Flex Code
13532 \begin_layout Plain Layout
13538 ] Text that indicates the amount of horizontal space between the label and
13540 Only used for labels that are not above the text body.
13543 \begin_layout Description
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13554 \begin_inset Flex Code
13557 \begin_layout Plain Layout
13563 ] The string used for the label.
13565 \begin_inset Flex Code
13568 \begin_layout Plain Layout
13574 is set, this string can be contain the special formatting commands described
13576 \begin_inset CommandInset ref
13578 reference "subsec:Counters"
13585 \begin_layout Description
13586 \begin_inset Flex Code
13589 \begin_layout Plain Layout
13590 LabelStringAppendix
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13605 ] This is used inside the appendix instead of
13606 \begin_inset Newline newline
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 \begin_inset Newline newline
13635 \begin_inset Flex Code
13638 \begin_layout Plain Layout
13639 LabelStringAppendix
13647 \begin_layout Description
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13657 [FIXME] (Used only with XML-type formats.)
13660 \begin_layout Description
13661 \begin_inset Flex Code
13664 \begin_layout Plain Layout
13671 \begin_inset Flex Code
13674 \begin_layout Plain Layout
13679 , Manual, Static, Above,
13680 \begin_inset Newline newline
13683 Centered, Sensitive, Enumerate,
13684 \begin_inset Newline newline
13687 Itemize, Bibliography
13696 \begin_layout Description
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13706 means the label is the very first word (up to the first real blank).
13707 Use protected spaces if you want more than one word as the label.
13711 \begin_layout Description
13712 \begin_inset Flex Code
13715 \begin_layout Plain Layout
13721 means the label is simply what is declared as
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13732 This will be displayed
13733 \begin_inset Quotes eld
13737 \begin_inset Quotes erd
13740 , at the beginning of the paragraph.
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13761 , then it will be displayed only in the first paragraph of any sequence
13762 of paragraphs with the same
13763 \begin_inset Flex Code
13766 \begin_layout Plain Layout
13775 \begin_layout Description
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13786 \begin_inset space ~
13790 \begin_inset space ~
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 are special cases of
13804 \begin_inset Flex Code
13807 \begin_layout Plain Layout
13814 The label will be printed above the paragraph either at the beginning of
13815 the line or centered.
13818 \begin_layout Description
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13828 is a special case for the caption-labels
13829 \begin_inset Quotes eld
13833 \begin_inset Quotes erd
13837 \begin_inset Quotes eld
13841 \begin_inset Quotes erd
13845 \begin_inset Newline newline
13849 \begin_inset Flex Code
13852 \begin_layout Plain Layout
13858 means the (hardcoded) label string depends on the kind of float: It is
13859 hardcoded to be `FloatType N', where N is the value of the counter associated
13861 For the case that a caption is inserted outside of a float the
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13872 \begin_inset Quotes eld
13876 \begin_inset Quotes erd
13882 \begin_layout Description
13883 \begin_inset Flex Code
13886 \begin_layout Plain Layout
13892 produces the usual sort of enumeration labels.
13893 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13894 small Roman numerals, and uppercase letters for the four possible depths.
13897 \begin_layout Description
13898 \begin_inset Flex Code
13901 \begin_layout Plain Layout
13907 produces various bullets at the different levels.
13908 It is also hardcoded.
13911 \begin_layout Description
13912 \begin_inset Flex Code
13915 \begin_layout Plain Layout
13921 should be used only with
13922 \begin_inset Flex Code
13925 \begin_layout Plain Layout
13926 LatexType BibEnvironment
13935 \begin_layout Description
13936 \begin_inset Flex Code
13939 \begin_layout Plain Layout
13945 Note that this will completely override any prior
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13955 declaration for this style.
13957 \begin_inset Quotes eld
13961 \begin_inset Flex Code
13964 \begin_layout Plain Layout
13971 \begin_inset Quotes erd
13976 \begin_inset CommandInset ref
13978 reference "subsec:I18n"
13982 for details on its use.
13985 \begin_layout Description
13986 \begin_inset Flex Code
13989 \begin_layout Plain Layout
13996 \begin_inset Flex Code
13999 \begin_layout Plain Layout
14005 ] The name of the corresponding \SpecialChar LaTeX
14007 Either the environment or command name.
14010 \begin_layout Description
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14030 ] An optional parameter for the corresponding
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14041 This parameter cannot be changed from within \SpecialChar LyX
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14052 for customizable parameters).
14053 This will be output as is after all \SpecialChar LaTeX
14055 \begin_inset Flex Code
14058 \begin_layout Plain Layout
14067 \begin_layout Description
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14086 , Command, Environment, Item_Environment,
14087 \begin_inset Newline newline
14090 List_Environment, Bib_Environment
14095 ] How the style should be translated into \SpecialChar LaTeX
14100 \begin_layout Plain Layout
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14110 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14111 Visit the SGML class files for specific examples.
14120 \begin_layout Description
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14130 means nothing special.
14133 \begin_layout Description
14134 \begin_inset Flex Code
14137 \begin_layout Plain Layout
14144 \begin_inset Flex Code
14147 \begin_layout Plain Layout
14154 {\SpecialChar ldots
14163 \begin_layout Description
14164 \begin_inset Flex Code
14167 \begin_layout Plain Layout
14174 \begin_inset Flex Code
14177 \begin_layout Plain Layout
14184 }\SpecialChar ldots
14200 \begin_layout Description
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14221 \begin_inset Flex Code
14224 \begin_layout Plain Layout
14232 is generated for each paragraph of this environment.
14236 \begin_layout Description
14237 \begin_inset Flex Code
14240 \begin_layout Plain Layout
14247 \begin_inset Flex Code
14250 \begin_layout Plain Layout
14257 \begin_inset Newline newline
14261 \begin_inset Flex Code
14264 \begin_layout Plain Layout
14270 is passed as an argument to the environment.
14271 \begin_inset Newline newline
14275 \begin_inset Flex Code
14278 \begin_layout Plain Layout
14284 can be defined in the
14285 \begin_inset Flex Noun
14288 \begin_layout Plain Layout
14289 Edit\SpecialChar menuseparator
14291 \begin_inset space ~
14302 \begin_layout Description
14303 \begin_inset Flex Code
14306 \begin_layout Plain Layout
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14322 but adds the necessary mandatory argument (the longest label) to the begin
14323 statement of the bibliography environment:
14324 \begin_inset Newline newline
14328 \begin_inset Flex Code
14331 \begin_layout Plain Layout
14334 begin{thebibliography}{99}
14340 It is therefore only useful for bibliography environments.
14341 The default longest label
14342 \begin_inset Quotes eld
14346 \begin_inset Quotes erd
14349 can be changed by the user in the paragraph settings of a bibliography
14353 \begin_layout Standard
14354 Putting the last few things together, the \SpecialChar LaTeX
14355 output will be either:
14358 \begin_layout LyX-Code
14361 LatexName[LatexParam]{\SpecialChar ldots
14365 \begin_layout Standard
14369 \begin_layout LyX-Code
14372 begin{LatexName}[LatexParam] \SpecialChar ldots
14378 \begin_layout Standard
14379 depending upon the \SpecialChar LaTeX
14384 \begin_layout Description
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14404 ] A string that is put at the beginning of the style content.
14405 A line break in the output can be indicated by
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14418 \begin_layout Description
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14438 ] If you put styles into environments, the different
14439 \begin_inset Flex Code
14442 \begin_layout Plain Layout
14448 are not simply added, but added with a factor
14449 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14453 Note that this parameter is also used when
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14464 \begin_inset Flex Code
14467 \begin_layout Plain Layout
14474 \begin_inset Flex Code
14477 \begin_layout Plain Layout
14484 Then it is added to the manual or dynamic margin.
14485 \begin_inset Newline newline
14489 \begin_inset Quotes eld
14493 \begin_inset Flex Code
14496 \begin_layout Plain Layout
14503 \begin_inset Quotes erd
14506 means that the paragraph is indented with the width of
14507 \begin_inset Quotes eld
14511 \begin_inset Flex Code
14514 \begin_layout Plain Layout
14521 \begin_inset Quotes erd
14524 in the normal font.
14525 You can get a negative width by prefixing the string with
14526 \begin_inset Quotes eld
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14540 \begin_inset Quotes erd
14544 This way was chosen so that the look is the same with each used screen
14548 \begin_layout Description
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14559 \begin_inset Flex Code
14562 \begin_layout Plain Layout
14567 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14573 \begin_inset Newline newline
14576 The kind of margin that the style has on the left side.
14580 \begin_layout Description
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14590 just means a fixed margin.
14593 \begin_layout Description
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14603 means that the left margin depends on the string entered in the
14604 \begin_inset Flex Noun
14607 \begin_layout Plain Layout
14608 Edit\SpecialChar menuseparator
14610 \begin_inset space ~
14619 This is used to typeset nice lists without tabulators.
14622 \begin_layout Description
14623 \begin_inset Flex Code
14626 \begin_layout Plain Layout
14632 means that the margin depends on the size of the label.
14633 This is used for automatic enumerated headlines.
14634 It is obvious that the headline
14635 \begin_inset Quotes eld
14638 5.4.3.2.1 Very long headline
14639 \begin_inset Quotes erd
14642 must have a wider left margin (as wide as
14643 \begin_inset Quotes eld
14647 \begin_inset Quotes erd
14650 plus the space) than
14651 \begin_inset Quotes eld
14654 3.2 Very long headline
14655 \begin_inset Quotes erd
14659 \begin_inset Quotes eld
14663 \begin_inset Quotes erd
14666 are not able to do this.
14669 \begin_layout Description
14670 \begin_inset Flex Code
14673 \begin_layout Plain Layout
14679 is similar, but only the very first row of the paragraph is dynamic, while
14680 the others are static; this is used, for example, for descriptions.
14683 \begin_layout Description
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14693 means the margin is chosen in a way that the longest row of this paragraph
14694 fits to the right margin.
14695 This is used to typeset an address on the right edge of the page.
14699 \begin_layout Description
14700 \begin_inset Flex Code
14703 \begin_layout Plain Layout
14710 \begin_inset Flex Code
14713 \begin_layout Plain Layout
14722 \begin_inset space \thinspace{}
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14735 ] Whether fragile commands in this style should be
14736 \begin_inset Flex Code
14739 \begin_layout Plain Layout
14752 whether this command should itself be protected.)
14755 \begin_layout Description
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14776 \begin_inset space \thinspace{}
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14791 ] Whether newlines are translated into \SpecialChar LaTeX
14793 \begin_inset Flex Code
14796 \begin_layout Plain Layout
14807 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14809 inside \SpecialChar LyX
14813 \begin_layout Description
14814 \begin_inset Flex Code
14817 \begin_layout Plain Layout
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14836 \begin_inset space \thinspace{}
14840 \begin_inset Flex Code
14843 \begin_layout Plain Layout
14849 ] If set to true, and if
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14869 ) paragraphs are being indented, then the indentation of such a paragraph
14870 following one of this type will be suppressed.
14871 (So this will not affect the display of non-default paragraphs.)
14874 \begin_layout Description
14875 \begin_inset Flex Code
14878 \begin_layout Plain Layout
14885 \begin_inset Flex Code
14888 \begin_layout Plain Layout
14894 ] Name of a style that has replaced this style.
14895 This is used to rename a style, while keeping backward compatibility.
14898 \begin_layout Description
14899 \begin_inset Flex Code
14902 \begin_layout Plain Layout
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14919 \begin_inset space \thinspace{}
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14932 ] Determines whether consecutive pragraphs of the same type are treated
14933 as belonging together.
14934 This has the effect that the
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14944 is only printed once before such a group.
14945 By default, this is true for
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14956 \begin_inset Flex Code
14959 \begin_layout Plain Layout
14966 \begin_inset Flex Code
14969 \begin_layout Plain Layout
14975 and false for all other types.
14978 \begin_layout Description
14979 \begin_inset Flex Code
14982 \begin_layout Plain Layout
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
15001 \begin_inset space \thinspace{}
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15014 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15016 but only by a line break; together with
15017 \begin_inset Flex Code
15020 \begin_layout Plain Layout
15026 , this allows to emulate a plain text editor (like the ERT inset).
15029 \begin_layout Description
15030 \begin_inset Flex Code
15033 \begin_layout Plain Layout
15040 \begin_inset Flex Code
15043 \begin_layout Plain Layout
15049 ] The indent of the very first line of a paragraph.
15051 \begin_inset Newline newline
15055 \begin_inset Flex Code
15058 \begin_layout Plain Layout
15064 will be fixed for a certain style.
15065 The exception is the default style, since the indentation for these paragraphs
15066 can be prohibited with
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15078 \begin_inset Flex Code
15081 \begin_layout Plain Layout
15087 style paragraphs inside environments use the
15088 \begin_inset Flex Code
15091 \begin_layout Plain Layout
15097 of the environment, not their native one.
15099 \begin_inset Flex Code
15102 \begin_layout Plain Layout
15108 paragraphs inside an enumeration are not indented.
15111 \begin_layout Description
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15122 \begin_inset Flex Code
15125 \begin_layout Plain Layout
15131 ] The vertical space between two paragraphs of this style.
15134 \begin_layout Description
15135 \begin_inset Flex Code
15138 \begin_layout Plain Layout
15145 \begin_inset Flex Code
15148 \begin_layout Plain Layout
15155 allows the user to choose either
15156 \begin_inset Quotes eld
15160 \begin_inset Quotes erd
15164 \begin_inset Quotes eld
15168 \begin_inset Quotes erd
15171 to separate paragraphs.
15173 \begin_inset Quotes eld
15177 \begin_inset Quotes erd
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15192 \begin_inset Quotes eld
15196 \begin_inset Quotes erd
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15209 is ignored and all paragraphs are separated by the
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15220 The vertical space is calculated with
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15226 \begin_inset space ~
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15244 is the height of a row with the normal font.
15245 This way, the look stays the same with different screen fonts.
15248 \begin_layout Description
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15259 \begin_inset Flex Code
15262 \begin_layout Plain Layout
15271 \begin_inset space \thinspace{}
15275 \begin_inset Flex Code
15278 \begin_layout Plain Layout
15284 ] Whether the contents of this paragraph should be output in raw form, meaning
15285 without special translations that \SpecialChar LaTeX
15289 \begin_layout Description
15290 \begin_inset Flex Code
15293 \begin_layout Plain Layout
15300 \begin_inset Flex Code
15303 \begin_layout Plain Layout
15313 Defines individual characters that should be output in raw form, meaning
15314 without special translations that \SpecialChar LaTeX
15318 \begin_layout Description
15319 \begin_inset Flex Code
15322 \begin_layout Plain Layout
15328 Information to be included in the \SpecialChar LaTeX
15329 preamble when this style is used.
15330 Used to define macros, load packages, etc., required by this particular
15333 \begin_inset Quotes eld
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 \begin_inset Quotes erd
15353 \begin_layout Description
15354 \begin_inset Flex Code
15357 \begin_layout Plain Layout
15364 \begin_inset Flex Code
15367 \begin_layout Plain Layout
15373 ] The prefix to use when creating labels referring to paragraphs of this
15375 This allows the use of formatted references.
15378 \begin_layout Description
15379 \begin_inset Flex Code
15382 \begin_layout Plain Layout
15389 \begin_inset Flex Code
15392 \begin_layout Plain Layout
15398 ] Whether the style requires the feature
15399 \begin_inset Flex Code
15402 \begin_layout Plain Layout
15409 \begin_inset CommandInset ref
15411 reference "chap:List-of-functions"
15415 for the list of features).
15416 If you require a package with specific options, you can additionally use
15418 \begin_inset Flex Code
15421 \begin_layout Plain Layout
15427 as a general text class parameter (see
15428 \begin_inset CommandInset ref
15430 reference "subsec:General-text-class"
15437 \begin_layout Description
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15448 \begin_inset Flex Code
15451 \begin_layout Plain Layout
15460 \begin_inset Flex Code
15463 \begin_layout Plain Layout
15469 ] Resets the \SpecialChar LaTeX
15470 arguments of this style (as defined via the
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15481 This is useful if you have copied a style via
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15491 , but you do not want to inherit its (required and optional) arguments.
15492 \change_inserted 2089657418 1476488475
15496 \begin_layout Description
15498 \change_inserted 2089657418 1476488475
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15504 \change_inserted 2089657418 1476488475
15511 \begin_inset Flex Code
15514 \begin_layout Plain Layout
15516 \change_inserted 2089657418 1476488475
15525 \begin_inset Flex Code
15528 \begin_layout Plain Layout
15530 \change_inserted 2089657418 1476488475
15536 ] Resumes a counter that is usually reset at each new sequence of layouts.
15537 This is currently only useful when
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15543 \change_inserted 2089657418 1476488475
15550 \begin_inset Flex Code
15553 \begin_layout Plain Layout
15555 \change_inserted 2089657418 1476488475
15566 \begin_layout Description
15567 \begin_inset Flex Code
15570 \begin_layout Plain Layout
15577 \begin_inset Flex Code
15580 \begin_layout Plain Layout
15586 ] A string that is put at the end of the layout content.
15587 A line break in the output can be indicated by
15588 \begin_inset Flex Code
15591 \begin_layout Plain Layout
15600 \begin_layout Description
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15633 \begin_layout Description
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15644 \begin_inset Flex Code
15647 \begin_layout Plain Layout
15656 \begin_inset Flex Code
15659 \begin_layout Plain Layout
15666 \begin_inset Flex Code
15669 \begin_layout Plain Layout
15676 \begin_inset Flex Code
15679 \begin_layout Plain Layout
15681 \begin_inset space ~
15689 ] This defines what the default spacing should be in the style.
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15720 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15721 If you specify the argument
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15731 , then you must also provide a value argument which will be the actual multiplie
15733 Note that, contrary to other parameters,
15734 \begin_inset Flex Code
15737 \begin_layout Plain Layout
15743 implies the generation of specific \SpecialChar LaTeX
15744 code, using the \SpecialChar LaTeX
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15760 \begin_layout Description
15761 \begin_inset Flex Code
15764 \begin_layout Plain Layout
15771 \begin_inset Flex Code
15774 \begin_layout Plain Layout
15781 \begin_inset space \thinspace{}
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15796 ] Allow spell-checking paragraphs of this style.
15798 \change_inserted 2089657418 1476488264
15802 \begin_layout Description
15804 \change_inserted 2089657418 1476488264
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15810 \change_inserted 2089657418 1476488264
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15822 \change_inserted 2089657418 1476488264
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15836 \change_inserted 2089657418 1476488264
15842 ] Steps the master counter of a given counter at the beginning of a new
15843 sequence of layouts.
15844 This is currently only useful when
15845 \begin_inset Flex Code
15848 \begin_layout Plain Layout
15850 \change_inserted 2089657418 1476488264
15857 \begin_inset Flex Code
15860 \begin_layout Plain Layout
15862 \change_inserted 2089657418 1476488264
15873 \begin_layout Description
15874 \begin_inset Flex Code
15877 \begin_layout Plain Layout
15883 The font used for the text body .
15885 \begin_inset CommandInset ref
15887 reference "subsec:Font-description"
15894 \begin_layout Description
15895 \begin_inset Flex Code
15898 \begin_layout Plain Layout
15907 \begin_inset Flex Code
15910 \begin_layout Plain Layout
15920 The level of the style in the table of contents.
15921 This is used for automatic numbering of section headings.
15924 \begin_layout Description
15925 \begin_inset Flex Code
15928 \begin_layout Plain Layout
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15951 \begin_inset Flex Code
15954 \begin_layout Plain Layout
15961 \begin_inset Flex Code
15964 \begin_layout Plain Layout
15970 ] This tag determines whether the first line indentation of this paragraph
15971 can be toggled via the Paragraph settings dialog.
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15988 is set, indentation can be toggled if the document settings use
15989 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
15996 paragraph style, with
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16006 , indentation can always be toggled, notwithstanding the document settings,
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16017 , indentation can never be toggled.
16020 \begin_layout Description
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16040 ] The vertical space with which the very first of a chain of paragraphs
16041 with this style is separated from the previous paragraph.
16042 If the previous paragraph has another style, the separations are not simply
16043 added, but the maximum is taken.
16046 \begin_layout Subsection
16047 \begin_inset CommandInset label
16053 Internationalization of Paragraph Styles
16056 \begin_layout Standard
16058 has long supported internationalization of layout information, but, until
16059 version 2.0, this applied only to the user interface and not to, say, PDF
16061 Thus, French authors were forced to resort to ugly hacks if they wanted
16066 1' instead of `Theorem 1'.
16067 Thanks to Georg Baum, that is no longer the case.
16070 \begin_layout Standard
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16081 defines text that is to appear in the typeset document, it may use
16082 \begin_inset Flex Code
16085 \begin_layout Plain Layout
16092 \begin_inset Flex Code
16095 \begin_layout Plain Layout
16101 to support non-English and even multi-language documents correctly.
16102 The following excerpt (from the
16103 \begin_inset Flex Code
16106 \begin_layout Plain Layout
16112 file) shows how this works:
16115 \begin_layout LyX-Code
16120 \begin_layout LyX-Code
16123 theoremstyle{remark}
16126 \begin_layout LyX-Code
16129 newtheorem{claim}[thm]{
16136 \begin_layout LyX-Code
16140 \begin_layout LyX-Code
16144 \begin_layout LyX-Code
16149 claimname}{_(Claim)}
16152 \begin_layout LyX-Code
16156 \begin_layout LyX-Code
16160 \begin_layout LyX-Code
16169 claimname}{_(Claim)}}
16172 \begin_layout LyX-Code
16177 \begin_layout Standard
16178 In principle, any legal \SpecialChar LaTeX
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16199 tags, but in practice they will typically look as they do here.
16200 The key to correct translation of the typeset text is the definition of
16201 the \SpecialChar LaTeX
16203 \begin_inset Flex Code
16206 \begin_layout Plain Layout
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16230 \begin_layout Standard
16232 \begin_inset Flex Code
16235 \begin_layout Plain Layout
16241 tag provides for internationalization based upon the overall language of
16243 The contents of the tag will be included in the preamble, just as with
16245 \begin_inset Flex Code
16248 \begin_layout Plain Layout
16255 What makes it special is the use of the
16256 \begin_inset Quotes eld
16260 \begin_inset Quotes erd
16264 \begin_inset Flex Code
16267 \begin_layout Plain Layout
16273 , which will be replaced, when \SpecialChar LyX
16274 produces \SpecialChar LaTeX
16275 output, with the translation of
16276 its argument into the document language.
16279 \begin_layout Standard
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16290 tag is more complex, since it is meant to provide support for multi-language
16291 documents and so offers an interface to the
16292 \begin_inset Flex Code
16295 \begin_layout Plain Layout
16302 Its contents will be added to the preamble once for each language that
16303 appears in the document.
16304 In this case, the argument to
16305 \begin_inset Flex Code
16308 \begin_layout Plain Layout
16314 will be replaced with its translation into the language in question; the
16316 \begin_inset Flex Code
16319 \begin_layout Plain Layout
16325 is replaced by the language name (as used by the babel package).
16328 \begin_layout Standard
16329 A German document that also included a French section would thus have the
16330 following in the preamble:
16333 \begin_layout LyX-Code
16342 claimname}{Affirmation}}
16343 \begin_inset Newline newline
16354 claimname}{Behauptung}}
16355 \begin_inset Newline newline
16362 claimname}{Behauptung}
16365 \begin_layout Standard
16368 \begin_inset Flex Code
16371 \begin_layout Plain Layout
16377 will then conspire to produce the correct text in the output.
16380 \begin_layout Standard
16381 One important point to note here is that the translations are provided by
16383 itself, through the file
16384 \begin_inset Flex Code
16387 \begin_layout Plain Layout
16394 This means, in effect, that
16395 \begin_inset Flex Code
16398 \begin_layout Plain Layout
16405 \begin_inset Flex Code
16408 \begin_layout Plain Layout
16414 are really only of use in layout files that are provided with \SpecialChar LyX
16416 entered in user-created layout files will not be seen by \SpecialChar LyX
16417 's internationalizatio
16418 n routines unless the
16419 \begin_inset Flex Code
16422 \begin_layout Plain Layout
16428 file is modified accordingly.
16429 That said, however, any layout created with the intention that it will
16430 be included with \SpecialChar LyX
16431 should use these tags where appropriate.
16432 Please note that the paragraph style translations provided by \SpecialChar LyX
16434 change with a minor update (e.
16435 \begin_inset space \thinspace{}
16439 \begin_inset space \space{}
16442 from version 2.1.x to 2.1.y).
16443 It is however quite likely that a major update (e.
16444 \begin_inset space \thinspace{}
16448 \begin_inset space \space{}
16451 from 2.0.x to 2.1.y) will introduce new translations or corrections.
16454 \begin_layout Subsection
16456 \begin_inset CommandInset label
16458 name "subsec:Floats"
16465 \begin_layout Standard
16466 It is necessary to define the floats (
16467 \begin_inset Flex Noun
16470 \begin_layout Plain Layout
16477 \begin_inset Flex Noun
16480 \begin_layout Plain Layout
16486 , \SpecialChar ldots
16487 ) in the text class itself.
16488 Standard floats are included in the file
16489 \begin_inset Flex Code
16492 \begin_layout Plain Layout
16498 , so you may have to do no more than add
16501 \begin_layout LyX-Code
16502 Input stdfloats.inc
16505 \begin_layout Standard
16506 to your layout file.
16507 If you want to implement a text class that proposes some other float types
16508 (like the AGU class bundled with \SpecialChar LyX
16509 ), the information below will hopefully
16513 \begin_layout Description
16514 \begin_inset Flex Code
16517 \begin_layout Plain Layout
16524 \begin_inset Flex Code
16527 \begin_layout Plain Layout
16533 =!htbpH] Allowed placement options for this float type.
16534 The value is a string of placement characters.
16535 Possible characters include:
16540 \begin_inset Quotes eld
16544 \begin_inset Quotes erd
16552 \begin_inset Quotes eld
16556 \begin_inset Quotes erd
16564 \begin_inset Quotes eld
16568 \begin_inset Quotes erd
16576 \begin_inset Quotes eld
16580 \begin_inset Quotes erd
16588 \begin_inset Quotes eld
16592 \begin_inset Quotes erd
16600 \begin_inset Quotes eld
16604 \begin_inset Quotes erd
16608 The order of the characters in the string does not matter.
16609 If no placement options are allowed, use the string
16616 \begin_layout Description
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16627 \begin_inset Flex Code
16630 \begin_layout Plain Layout
16639 \begin_inset space \thinspace{}
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16658 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16665 \begin_inset Flex Code
16668 \begin_layout Plain Layout
16674 if the float does not support this feature.
16677 \begin_layout Description
16678 \begin_inset Flex Code
16681 \begin_layout Plain Layout
16688 \begin_inset Flex Code
16691 \begin_layout Plain Layout
16700 \begin_inset space \thinspace{}
16706 \begin_inset Flex Code
16709 \begin_layout Plain Layout
16719 ] Defines whether the float has a starred variant that spans columns in
16720 a two column paragraph.
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16731 if the float does not support this feature.
16734 \begin_layout Description
16735 \begin_inset Flex Code
16738 \begin_layout Plain Layout
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16755 \begin_inset Quotes erd
16759 \begin_inset Quotes erd
16762 ] The file name extension of an auxiliary file for the list of figures (or
16765 writes the captions to this file.
16768 \begin_layout Description
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16789 \begin_inset Quotes erd
16793 \begin_inset Quotes erd
16796 ] The string that will be used in the menus and also for the caption.
16797 This is translated to the current language if babel is used.
16800 \begin_layout Description
16801 \begin_inset Flex Code
16804 \begin_layout Plain Layout
16810 These tags control the XHTML output.
16812 \begin_inset CommandInset ref
16814 reference "sec:Tags-for-XHTML"
16821 \begin_layout Description
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16834 \begin_inset Flex Code
16837 \begin_layout Plain Layout
16846 \begin_inset space \thinspace{}
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16859 ] Indicates whether the float is already defined in the document class or
16860 if instead the \SpecialChar LaTeX
16862 \begin_inset Flex Code
16865 \begin_layout Plain Layout
16871 needs to be loaded to define it on-the-fly.
16873 \begin_inset Flex Code
16876 \begin_layout Plain Layout
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 It should be set to
16894 \begin_inset Flex Code
16897 \begin_layout Plain Layout
16903 if the float is already defined by the \SpecialChar LaTeX
16907 \begin_layout Description
16908 \begin_inset Flex Code
16911 \begin_layout Plain Layout
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16928 \begin_inset Quotes erd
16932 \begin_inset Quotes erd
16935 ] The command used to generate a list of floats of this type; the leading
16944 \begin_inset Flex Code
16947 \begin_layout Plain Layout
16953 is false, since there is no standard way to generate this command.
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 is true, since in that case there is a standard way to define the command.
16967 \begin_layout Description
16968 \begin_inset Flex Code
16971 \begin_layout Plain Layout
16978 \begin_inset Flex Code
16981 \begin_layout Plain Layout
16988 \begin_inset Quotes erd
16992 \begin_inset Quotes erd
16995 ] A title for a list of floats of this kind (list of figures, tables, or
16997 It is used for the screen label within \SpecialChar LyX
16998 , it is used by \SpecialChar LaTeX
17000 it is used as the title in the XHTML output.
17001 It will be translated to the document language.
17004 \begin_layout Description
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17025 \begin_inset Quotes erd
17029 \begin_inset Quotes erd
17032 ] This (optional) argument determines whether floats of this class will
17033 be numbered within some sectional unit of the document.
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17045 \begin_inset Quotes eld
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17059 \begin_inset Quotes erd
17062 , the floats will be numbered within chapters.
17066 \begin_layout Description
17067 \begin_inset Flex Code
17070 \begin_layout Plain Layout
17077 \begin_inset Flex Code
17080 \begin_layout Plain Layout
17087 \begin_inset Quotes erd
17091 \begin_inset Quotes erd
17094 ] The default placement for the given class of floats.
17095 The string should be as in standard \SpecialChar LaTeX
17097 \begin_inset Flex Code
17100 \begin_layout Plain Layout
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17117 \begin_inset Flex Code
17120 \begin_layout Plain Layout
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17136 for top, bottom, page, and here, respectively.
17140 \begin_layout Plain Layout
17141 Note that the order of these letters in the string is irrelevant, like in
17148 On top of that there is a new type,
17149 \begin_inset Flex Code
17152 \begin_layout Plain Layout
17158 , which does not really correspond to a float, since it means: put it
17159 \begin_inset Quotes eld
17163 \begin_inset Quotes erd
17167 Note however that the
17168 \begin_inset Flex Code
17171 \begin_layout Plain Layout
17177 specifier is special and, because of implementation details, cannot be
17178 used in non-built in float types.
17179 If you do not understand what this means, just use
17180 \begin_inset Quotes eld
17184 \begin_inset Flex Code
17187 \begin_layout Plain Layout
17194 \begin_inset Quotes erd
17200 \begin_layout Description
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17211 \begin_inset Flex Code
17214 \begin_layout Plain Layout
17220 ] The prefix to use when creating labels referring to floats of this type.
17221 This allows the use of formatted references.
17222 Note that you can remove any
17223 \begin_inset Flex Code
17226 \begin_layout Plain Layout
17232 set by a copied style by using the special value
17233 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17240 , which must be all caps.
17243 \begin_layout Description
17244 \begin_inset Flex Code
17247 \begin_layout Plain Layout
17254 \begin_inset Flex Code
17257 \begin_layout Plain Layout
17264 \begin_inset Quotes erd
17268 \begin_inset Quotes erd
17271 ] The style used when defining the float using
17272 \begin_inset Flex Code
17275 \begin_layout Plain Layout
17286 \begin_layout Description
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17307 \begin_inset Quotes erd
17311 \begin_inset Quotes erd
17315 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17322 of the new class of floats, like program or algorithm.
17323 After the appropriate
17324 \begin_inset Flex Code
17327 \begin_layout Plain Layout
17336 \begin_inset Flex Code
17339 \begin_layout Plain Layout
17348 \begin_inset Flex Code
17351 \begin_layout Plain Layout
17362 \begin_layout Description
17363 \begin_inset Flex Code
17366 \begin_layout Plain Layout
17373 \begin_inset Flex Code
17376 \begin_layout Plain Layout
17383 \begin_inset space \thinspace{}
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17398 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17409 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17413 \begin_layout Standard
17414 Note that defining a float with type
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17426 automatically defines the corresponding counter with name
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17441 \begin_layout Subsection
17442 Flex insets and InsetLayout
17443 \begin_inset CommandInset label
17445 name "subsec:Flex-insets-and"
17452 \begin_layout Standard
17453 Flex insets come in three different kinds:
17456 \begin_layout Itemize
17458 \begin_inset Flex Code
17461 \begin_layout Plain Layout
17467 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17469 \begin_inset Flex Code
17472 \begin_layout Plain Layout
17481 \begin_inset Flex Code
17484 \begin_layout Plain Layout
17495 \begin_layout Itemize
17497 \begin_inset Flex Code
17500 \begin_layout Plain Layout
17506 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17508 footnote, and the like.
17509 An obvious example is an endnote inset, which is defined in the
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17522 \begin_layout Itemize
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 ): For use with DocBook classes.
17536 \begin_layout Standard
17537 Flex insets are defined using the
17538 \begin_inset Flex Code
17541 \begin_layout Plain Layout
17547 tag, which shall be explained in a moment.
17550 \begin_layout Standard
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17561 tag also serves another function: It can be used to customize the general
17562 layout of many different types of insets.
17564 \begin_inset Flex Code
17567 \begin_layout Plain Layout
17573 can be used to customize the layout parameters for footnotes, marginal
17574 notes, note insets, \SpecialChar TeX
17575 code (ERT) insets, branches, listings, indexes, boxes,
17576 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17579 \begin_layout Standard
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17590 definition must begin with a line of the form:
17593 \begin_layout LyX-Code
17597 \begin_layout Standard
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17608 indicates the inset whose layout is being defined, and here there are four
17612 \begin_layout Enumerate
17613 The layout for a pre-existing inset is being modified.
17614 In this case, can be
17615 \begin_inset Flex Code
17618 \begin_layout Plain Layout
17624 any one of the following:
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17685 \begin_inset Flex Code
17688 \begin_layout Plain Layout
17695 \begin_inset Flex Code
17698 \begin_layout Plain Layout
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17755 \begin_inset Flex Code
17758 \begin_layout Plain Layout
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17827 \begin_layout Enumerate
17828 The layout for a Flex inset is being defined.
17830 \begin_inset Flex Code
17833 \begin_layout Plain Layout
17839 must be of the form
17840 \begin_inset Quotes eld
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17854 \begin_inset Quotes erd
17858 \begin_inset Flex Code
17861 \begin_layout Plain Layout
17867 may be be any valid identifier not used by a pre-existing Flex inset.
17868 The identifier may include spaces, but in that case the whole thing must
17869 be wrapped in quotes.
17870 Note that the definition of a flex inset
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17884 entry, declaring which type of inset it defines.
17887 \begin_layout Enumerate
17888 The layout for user specific branch is being defined.
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17899 must be of the form
17900 \begin_inset Quotes eld
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17914 \begin_inset Quotes erd
17918 \begin_inset Flex Code
17921 \begin_layout Plain Layout
17927 may be be any valid identifier of branch defined in user's document.
17928 The identifier may include spaces, but in that case the whole thing must
17929 be wrapped in quotes.
17930 The main purpose of this feature is to allow \SpecialChar LaTeX
17931 wrapping around specific
17932 branches as user needs.
17935 \begin_layout Enumerate
17936 The layout of a user (or class) specific caption is being defined.
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17947 must be of the form
17948 \begin_inset Quotes eld
17952 \begin_inset Flex Code
17955 \begin_layout Plain Layout
17962 \begin_inset Quotes erd
17966 \begin_inset Flex Code
17969 \begin_layout Plain Layout
17975 specifies the name of the caption as it appears in the menu.
17976 Have a look at the standard caption (
17977 \begin_inset Flex Code
17980 \begin_layout Plain Layout
17986 ), the specific captions of the KOMA-Script classes (
17987 \begin_inset Flex Code
17990 \begin_layout Plain Layout
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18009 \begin_inset space ~
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18024 ) for applications.
18027 \begin_layout Standard
18029 \begin_inset Flex Code
18032 \begin_layout Plain Layout
18038 definition can contain the following entries:
18041 \begin_layout Description
18043 \change_inserted 2047637253 1483963036
18044 \begin_inset Flex Code
18047 \begin_layout Plain Layout
18049 \change_inserted 2047637253 1483900123
18056 \begin_inset Flex Code
18059 \begin_layout Plain Layout
18061 \change_inserted 2047637253 1483962897
18067 =""] This inset will appear in the table of contents of the given type.
18068 An empty string disables.
18069 See also the OutlinerName and the IsTocCaption commands.
18070 This is only implemented for Flex insets.
18074 \begin_layout Description
18075 \begin_inset Flex Code
18078 \begin_layout Plain Layout
18085 \begin_inset Flex Code
18088 \begin_layout Plain Layout
18094 ] Defines argument number of a command\SpecialChar breakableslash
18095 environment associated with the current
18097 The definition must end with
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18109 \begin_inset CommandInset ref
18111 reference "subsec:Paragraph-Styles"
18118 \begin_layout Description
18119 \begin_inset Flex Code
18122 \begin_layout Plain Layout
18128 Preamble for changing language commands; see
18129 \begin_inset CommandInset ref
18131 reference "subsec:I18n"
18138 \begin_layout Description
18139 \begin_inset Flex Code
18142 \begin_layout Plain Layout
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18158 ] The color for the inset's background.
18160 \begin_inset CommandInset ref
18162 reference "chap:Names-of-colors"
18166 for a list of the available color names.
18169 \begin_layout Description
18170 \begin_inset Flex Code
18173 \begin_layout Plain Layout
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18192 \begin_inset space \thinspace{}
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18205 ] Whether to use the content of the inset as the label, when the inset is
18210 \begin_layout Description
18211 \begin_inset Flex Code
18214 \begin_layout Plain Layout
18221 \begin_inset Flex Code
18224 \begin_layout Plain Layout
18230 ] As with paragraph styles, see
18231 \begin_inset CommandInset ref
18233 reference "subsec:Paragraph-Styles"
18238 Note that you need to specify the complete type, e.
18239 \begin_inset space \thinspace{}
18243 \begin_inset space ~
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18251 CopyStyle Flex:<name>
18259 \begin_layout Description
18260 \begin_inset Flex Code
18263 \begin_layout Plain Layout
18270 \begin_inset Flex Code
18273 \begin_layout Plain Layout
18282 \begin_inset space \thinspace{}
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18295 ] Indicates whether the user may employ the Paragraph Settings dialog to
18296 customize the paragraph.
18299 \begin_layout Description
18300 \begin_inset Flex Code
18303 \begin_layout Plain Layout
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18320 \begin_inset Flex Code
18323 \begin_layout Plain Layout
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18339 , describing the rendering style used for the inset's frame and buttons.
18340 Footnotes generally use
18341 \begin_inset Flex Code
18344 \begin_layout Plain Layout
18350 , ERT insets generally
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18360 , and character styles
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18373 \begin_layout Description
18374 \begin_inset Flex Code
18377 \begin_layout Plain Layout
18384 \begin_inset Flex Code
18387 \begin_layout Plain Layout
18396 \begin_inset space \thinspace{}
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18414 \begin_inset Flex Code
18417 \begin_layout Plain Layout
18424 \begin_inset Flex Code
18427 \begin_layout Plain Layout
18434 Indicates whether the environment will stand on its own in the output or
18435 will appear inline with the surrounding text.
18436 If set to false, it is supposed that the \SpecialChar LaTeX
18437 environment ignores white space
18438 (including one newline character) after the
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18455 \begin_inset Flex Code
18458 \begin_layout Plain Layout
18474 \begin_layout Description
18475 \begin_inset Flex Code
18478 \begin_layout Plain Layout
18484 Required at the end of the
18485 \begin_inset Flex Code
18488 \begin_layout Plain Layout
18497 \begin_layout Description
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18507 The font used for both the text body
18513 \begin_inset CommandInset ref
18515 reference "subsec:Font-description"
18520 Note that defining this font automatically defines the
18521 \begin_inset Flex Code
18524 \begin_layout Plain Layout
18530 to the same value, so define this first and define
18531 \begin_inset Flex Code
18534 \begin_layout Plain Layout
18540 later if you want them to be different.
18543 \begin_layout Description
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18548 FixedWidthPreambleEncoding
18554 \begin_inset Flex Code
18557 \begin_layout Plain Layout
18566 \begin_inset space \thinspace{}
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18579 ] Force a fixed width encoding for the translated contents of
18580 \begin_inset Flex Code
18583 \begin_layout Plain Layout
18590 \begin_inset Flex Code
18593 \begin_layout Plain Layout
18599 code generated by this layout.
18600 This is needed for special \SpecialChar LaTeX
18605 that do not work with variable width encodings such as
18610 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18611 backends such as Xe\SpecialChar TeX
18613 Lua\SpecialChar TeX
18617 \begin_layout Description
18618 \begin_inset Flex Code
18621 \begin_layout Plain Layout
18622 ForceLocalFontSwitch
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18640 \begin_inset space \thinspace{}
18644 \begin_inset Flex Code
18647 \begin_layout Plain Layout
18653 ] When using babel, always use a local font switch (
18654 \begin_inset Flex Code
18657 \begin_layout Plain Layout
18665 ), never a global one (such as
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18680 \begin_layout Description
18681 \begin_inset Flex Code
18684 \begin_layout Plain Layout
18691 \begin_inset Flex Code
18694 \begin_layout Plain Layout
18703 \begin_inset space \thinspace{}
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18717 \begin_inset Quotes eld
18721 \begin_inset Quotes erd
18724 language, leading to Left-to-Right (Latin) output, e.
18725 \begin_inset space \thinspace{}
18729 \begin_inset space \space{}
18732 in \SpecialChar TeX
18737 \begin_layout Description
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18748 \begin_inset Flex Code
18751 \begin_layout Plain Layout
18760 \begin_inset space \thinspace{}
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18773 ] Force a a line break in the \SpecialChar LaTeX
18774 output before the inset starts and after
18776 This assures the inset itself is output on its own lines, for parsing purposes.
18779 \begin_layout Description
18780 \begin_inset Flex Code
18783 \begin_layout Plain Layout
18790 \begin_inset Flex Code
18793 \begin_layout Plain Layout
18802 \begin_inset space \thinspace{}
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18815 ] Indicates whether the
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18825 should be used or, instead, the user can change the paragraph style used
18830 \begin_layout Description
18831 \begin_inset Flex Code
18834 \begin_layout Plain Layout
18841 \begin_inset Flex Code
18844 \begin_layout Plain Layout
18853 \begin_inset space \thinspace{}
18857 \begin_inset Flex Code
18860 \begin_layout Plain Layout
18866 ] As with paragraph styles, see
18867 \begin_inset CommandInset ref
18869 reference "subsec:Paragraph-Styles"
18876 \begin_layout Description
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18886 These tags control the XHTML output.
18888 \begin_inset CommandInset ref
18890 reference "sec:Tags-for-XHTML"
18897 \begin_layout Description
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18908 \begin_inset Flex Code
18911 \begin_layout Plain Layout
18920 \begin_inset space \thinspace{}
18924 \begin_inset Flex Code
18927 \begin_layout Plain Layout
18933 ] Whether to include the contents of this inset in the strings generated
18934 for the `Outline' pane
18935 \change_inserted 2047637253 1483900773
18936 for all table of contents, regardless of the AddToToc setting
18939 One would not, for example, want the content of a footnote in a section
18940 header to be included in the TOC displayed in the outline, but one would
18941 normally want the content of a character style displayed.
18942 Default is false: not to include.
18943 \change_inserted 2047637253 1483900609
18947 \begin_layout Description
18949 \change_inserted 2047637253 1483901257
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18955 \change_inserted 2047637253 1483900725
18962 \begin_inset Flex Code
18965 \begin_layout Plain Layout
18967 \change_inserted 2047637253 1483900620
18976 \begin_inset space \thinspace{}
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18985 \change_inserted 2047637253 1483900620
18991 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18992 of its contents in its item in the table of contents.
18993 Otherwise, only the label appears.
18998 \begin_layout Description
18999 \begin_inset Flex Code
19002 \begin_layout Plain Layout
19011 \begin_inset Flex Code
19014 \begin_layout Plain Layout
19023 \begin_inset space \thinspace{}
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19036 ] As with paragraph styles, see
19037 \begin_inset CommandInset ref
19039 reference "subsec:Paragraph-Styles"
19046 \begin_layout Description
19047 \begin_inset Flex Code
19050 \begin_layout Plain Layout
19056 The font used for the label.
19058 \begin_inset CommandInset ref
19060 reference "subsec:Font-description"
19065 Note that this definition can never appear before
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19075 , lest it be ineffective.
19078 \begin_layout Description
19079 \begin_inset Flex Code
19082 \begin_layout Plain Layout
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19099 \begin_inset Quotes erd
19103 \begin_inset Quotes erd
19106 ] What will be displayed on the button or elsewhere as the inset label.
19108 \begin_inset Flex Code
19111 \begin_layout Plain Layout
19119 \begin_inset Flex Code
19122 \begin_layout Plain Layout
19128 ) modify this label on the fly.
19131 \begin_layout Description
19132 \begin_inset Flex Code
19135 \begin_layout Plain Layout
19141 Language dependent preamble; see
19142 \begin_inset CommandInset ref
19144 reference "subsec:I18n"
19151 \begin_layout Description
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19162 \begin_inset Flex Code
19165 \begin_layout Plain Layout
19171 ] The name of the corresponding \SpecialChar LaTeX
19173 Either the environment or command name.
19176 \begin_layout Description
19177 \begin_inset Flex Code
19180 \begin_layout Plain Layout
19187 \begin_inset Flex Code
19190 \begin_layout Plain Layout
19196 ] The optional parameter for the corresponding
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19206 stuff, including possible bracket pairs like
19207 \begin_inset Flex Code
19210 \begin_layout Plain Layout
19217 This parameter cannot be changed from within \SpecialChar LyX
19219 \begin_inset Flex Code
19222 \begin_layout Plain Layout
19228 for customizable parameters).
19229 It will be output as is after all \SpecialChar LaTeX
19231 \begin_inset Flex Code
19234 \begin_layout Plain Layout
19243 \begin_layout Description
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19258 Command, Environment, None
19263 ] How the style should be translated into \SpecialChar LaTeX
19268 \begin_layout Plain Layout
19269 \begin_inset Flex Code
19272 \begin_layout Plain Layout
19278 is perhaps a bit misleading, since these rules apply to SGML classes too.
19279 Visit the SGML class files for specific examples.
19288 \begin_layout Description
19289 \begin_inset Flex Code
19292 \begin_layout Plain Layout
19298 means nothing special
19301 \begin_layout Description
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19322 {\SpecialChar ldots
19331 \begin_layout Description
19332 \begin_inset Flex Code
19335 \begin_layout Plain Layout
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19352 }\SpecialChar ldots
19367 \begin_layout Standard
19368 Putting the last few things together, the \SpecialChar LaTeX
19369 output will be either:
19372 \begin_layout LyX-Code
19375 LatexName[LatexParam]{\SpecialChar ldots
19379 \begin_layout Standard
19383 \begin_layout LyX-Code
19386 begin{LatexName}[LatexParam] \SpecialChar ldots
19392 \begin_layout Standard
19393 depending upon the \SpecialChar LaTeX
19398 \begin_layout Description
19399 \begin_inset Flex Code
19402 \begin_layout Plain Layout
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19418 ] A string that is put at the beginning of the layout content.
19419 A line break in the output can be indicated by
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19432 \begin_layout Description
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19463 \begin_inset Flex Code
19466 \begin_layout Plain Layout
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19482 (indicating a dummy definition ending definitions of charstyles, etc).
19483 This entry is required in and is only meaningful for Flex insets.
19484 Among other things, it determines on which menu this inset will appear.
19486 \begin_inset Flex Code
19489 \begin_layout Plain Layout
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19505 will automatically set
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19516 \begin_inset Flex Code
19519 \begin_layout Plain Layout
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19536 can be set to true, or
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19556 insets by setting it
19561 \begin_inset Flex Code
19564 \begin_layout Plain Layout
19573 \begin_layout Description
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19596 \begin_inset space \thinspace{}
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19609 ] Whether multiple paragraphs are permitted in this inset.
19611 \begin_inset Flex Code
19614 \begin_layout Plain Layout
19620 to the same value and
19621 \begin_inset Flex Code
19624 \begin_layout Plain Layout
19630 to the opposite value.
19631 These can be reset to other values, if they are used
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19649 \begin_layout Description
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19672 \begin_inset space \thinspace{}
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19685 ] Whether fragile commands in this inset should be
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19702 whether the command should itself be protected.) Default is false.
19705 \begin_layout Description
19706 \begin_inset Flex Code
19709 \begin_layout Plain Layout
19716 \begin_inset Flex Code
19719 \begin_layout Plain Layout
19725 ] Deletes an existing
19726 \begin_inset Flex Code
19729 \begin_layout Plain Layout
19738 \begin_layout Description
19739 \begin_inset Flex Code
19742 \begin_layout Plain Layout
19749 \begin_inset Flex Code
19752 \begin_layout Plain Layout
19759 \begin_inset Flex Code
19762 \begin_layout Plain Layout
19768 that has replaced this
19769 \begin_inset Flex Code
19772 \begin_layout Plain Layout
19779 This is used to rename an
19780 \begin_inset Flex Code
19783 \begin_layout Plain Layout
19789 , while keeping backward compatibility.
19792 \begin_layout Description
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19803 \begin_inset Flex Code
19806 \begin_layout Plain Layout
19815 \begin_inset space \thinspace{}
19819 \begin_inset Flex Code
19822 \begin_layout Plain Layout
19828 ] As with paragraph styles, see
19829 \begin_inset CommandInset ref
19831 reference "subsec:Paragraph-Styles"
19839 \begin_layout Description
19840 \begin_inset Flex Code
19843 \begin_layout Plain Layout
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19862 \begin_inset space \thinspace{}
19866 \begin_inset Flex Code
19869 \begin_layout Plain Layout
19875 ] As with paragraph styles, see
19876 \begin_inset CommandInset ref
19878 reference "subsec:Paragraph-Styles"
19886 \begin_layout Description
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19896 As with paragraph styles, see
19897 \begin_inset CommandInset ref
19899 reference "subsec:Paragraph-Styles"
19906 \begin_layout Description
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 ] The prefix to use when creating labels referring to insets of this type.
19927 This allows the use of formatted references.
19930 \begin_layout Description
19931 \begin_inset Flex Code
19934 \begin_layout Plain Layout
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19950 ] As with paragraph styles, see
19951 \begin_inset CommandInset ref
19953 reference "subsec:Paragraph-Styles"
19960 \begin_layout Description
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19971 \begin_inset Flex Code
19974 \begin_layout Plain Layout
19983 \begin_inset space \thinspace{}
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19996 ] Resets the \SpecialChar LaTeX
19997 arguments of this layout (as defined via the
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20008 This is useful if you have copied a style via
20009 \begin_inset Flex Code
20012 \begin_layout Plain Layout
20018 , but you do not want to inherit its (required and optional) arguments.
20021 \begin_layout Description
20022 \begin_inset Flex Code
20025 \begin_layout Plain Layout
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20042 \begin_inset space \thinspace{}
20046 \begin_inset Flex Code
20049 \begin_layout Plain Layout
20057 ] Whether this inset should use the font of its surrounding environment
20059 Default is false: use the font of the surrounding environment.
20062 \begin_layout Description
20063 \begin_inset Flex Code
20066 \begin_layout Plain Layout
20073 \begin_inset Flex Code
20076 \begin_layout Plain Layout
20082 ] A string that is put at the end of the layout content.
20083 A line break in the output can be indicated by
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20096 \begin_layout Description
20097 \begin_inset Flex Code
20100 \begin_layout Plain Layout
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20117 \begin_inset space \thinspace{}
20121 \begin_inset Flex Code
20124 \begin_layout Plain Layout
20132 ] Allow spell-checking the contents of this inset.
20136 \begin_layout Subsection
20138 \begin_inset CommandInset label
20140 name "subsec:Counters"
20147 \begin_layout Standard
20148 It is necessary to define the counters (
20149 \begin_inset Flex Noun
20152 \begin_layout Plain Layout
20159 \begin_inset Flex Noun
20162 \begin_layout Plain Layout
20168 , \SpecialChar ldots
20169 ) in the text class itself.
20170 The standard counters are defined in the file
20171 \begin_inset Flex Code
20174 \begin_layout Plain Layout
20180 , so you may have to do no more than add
20183 \begin_layout LyX-Code
20184 Input stdcounters.inc
20187 \begin_layout Standard
20188 to your layout file to get them to work.
20189 But if you want to define custom counters, then you can do so.
20190 The counter declaration must begin with:
20193 \begin_layout LyX-Code
20194 Counter CounterName
20197 \begin_layout Standard
20199 \begin_inset Flex Code
20202 \begin_layout Plain Layout
20208 ' is replaced by the name of the counter.
20209 And it must end with
20210 \begin_inset Quotes eld
20214 \begin_inset Flex Code
20217 \begin_layout Plain Layout
20224 \begin_inset Quotes erd
20228 The following parameters can also be used:
20231 \begin_layout Description
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20251 ] Sets the initial value for the counter, to which it will be reset whenever
20253 Normally, one will want the default, 1.
20256 \begin_layout Description
20257 \begin_inset Flex Code
20260 \begin_layout Plain Layout
20267 \begin_inset Flex Code
20270 \begin_layout Plain Layout
20277 \begin_inset Quotes erd
20281 \begin_inset Quotes erd
20284 ] When defined, this string defines how the counter is displayed.
20285 Setting this value sets
20286 \begin_inset Flex Code
20289 \begin_layout Plain Layout
20290 LabelStringAppendix
20296 The following special constructs can be used in the string:
20300 \begin_layout Itemize
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20312 will be replaced by the expansion of the
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20327 LabelStringAppendix
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20346 \begin_layout Itemize
20347 counter values can be expressed using \SpecialChar LaTeX
20349 \begin_inset Newline newline
20353 \begin_inset Flex Code
20356 \begin_layout Plain Layout
20373 \begin_inset Flex Code
20376 \begin_layout Plain Layout
20388 \begin_layout Plain Layout
20398 Actually, the situation is a bit more complicated: any
20417 other than those described below will produce arabic numerals.
20418 It would not be surprising to see this change in the future.
20424 \begin_inset Flex Code
20427 \begin_layout Plain Layout
20433 : 1, 2, 3,\SpecialChar ldots
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20444 for lower-case letters: a, b, c, \SpecialChar ldots
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20455 for upper-case letters: A, B, C, \SpecialChar ldots
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20466 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20477 for upper-case roman numerals: I, II, III\SpecialChar ldots
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20488 for hebrew numerals.
20492 \begin_layout Standard
20493 If LabelString is not defined, a default value is constructed as follows:
20494 if the counter has a master counter
20495 \begin_inset Flex Code
20498 \begin_layout Plain Layout
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20515 \begin_inset Newline newline
20519 \begin_inset Flex Code
20522 \begin_layout Plain Layout
20532 is used; otherwise the string
20533 \begin_inset Flex Code
20536 \begin_layout Plain Layout
20547 \begin_layout Description
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20552 LabelStringAppendix
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20568 \begin_inset Quotes erd
20572 \begin_inset Quotes erd
20576 \begin_inset Flex Code
20579 \begin_layout Plain Layout
20585 , but for use in the Appendix.
20588 \begin_layout Description
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 \begin_inset Quotes erd
20613 \begin_inset Quotes erd
20616 ] A format for use with formatted references to this counter.
20617 For example, one might want to have references to section numbers appear
20619 \begin_inset Quotes eld
20623 \begin_inset Quotes erd
20627 The string should contain
20628 \begin_inset Quotes eld
20632 \begin_inset Quotes erd
20636 This will be replaced by the counter number itself.
20637 So, for sections, it would be: Section ##.
20640 \begin_layout Description
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20661 \begin_inset Quotes erd
20665 \begin_inset Quotes erd
20668 ] If this is set to the name of another counter, the present counter will
20669 be reset every time the other one is increased.
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20693 \begin_layout Subsection
20695 \begin_inset CommandInset label
20697 name "subsec:Font-description"
20704 \begin_layout Standard
20705 A font description looks like this:
20708 \begin_layout LyX-Code
20722 \begin_layout LyX-Code
20726 \begin_layout LyX-Code
20730 \begin_layout Standard
20731 The following commands are available:
20734 \begin_layout Description
20735 \begin_inset Flex Code
20738 \begin_layout Plain Layout
20745 \begin_inset Flex Code
20748 \begin_layout Plain Layout
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20797 \begin_inset Flex Code
20800 \begin_layout Plain Layout
20807 \begin_inset Flex Code
20810 \begin_layout Plain Layout
20817 \begin_inset Flex Code
20820 \begin_layout Plain Layout
20827 \begin_inset Flex Code
20830 \begin_layout Plain Layout
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20847 \begin_inset Flex Code
20850 \begin_layout Plain Layout
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20877 \begin_inset Flex Code
20880 \begin_layout Plain Layout
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20907 \begin_inset Flex Code
20910 \begin_layout Plain Layout
20917 \begin_inset Flex Code
20920 \begin_layout Plain Layout
20927 \begin_inset Flex Code
20930 \begin_layout Plain Layout
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20949 \begin_layout Description
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20994 \begin_layout Description
20995 \begin_inset Flex Code
20998 \begin_layout Plain Layout
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 ] Valid arguments are:
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21025 \begin_inset Flex Code
21028 \begin_layout Plain Layout
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21045 \begin_inset Flex Code
21048 \begin_layout Plain Layout
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21085 \begin_inset Flex Code
21088 \begin_layout Plain Layout
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21105 \begin_inset Flex Code
21108 \begin_layout Plain Layout
21115 \begin_inset Flex Code
21118 \begin_layout Plain Layout
21125 \begin_inset Flex Code
21128 \begin_layout Plain Layout
21135 Each of these turns on or off the corresponding attribute.
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21146 turns on emphasis, and
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21158 \begin_inset Newline newline
21161 If the latter seems puzzling, remember that the font settings for the present
21162 context are generally inherited from the surrounding context.
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21173 would turn off the emphasis that was anyway in effect, say, in a theorem
21177 \begin_layout Description
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21188 \begin_inset Flex Code
21191 \begin_layout Plain Layout
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21212 \begin_layout Description
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21223 \begin_inset Flex Code
21226 \begin_layout Plain Layout
21235 \begin_inset Flex Code
21238 \begin_layout Plain Layout
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21267 \begin_layout Description
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21278 \begin_inset Flex Code
21281 \begin_layout Plain Layout
21288 \begin_inset Flex Code
21291 \begin_layout Plain Layout
21298 \begin_inset Flex Code
21301 \begin_layout Plain Layout
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21320 \begin_inset Flex Code
21323 \begin_layout Plain Layout
21330 \begin_inset Flex Code
21333 \begin_layout Plain Layout
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21362 \begin_layout Subsection
21364 \change_inserted -712698321 1483869872
21365 \begin_inset CommandInset label
21367 name "subsec:Citation-engine-description"
21371 Citation engine description
21374 \begin_layout Standard
21376 \change_inserted -712698321 1483875281
21378 \begin_inset Flex Code
21381 \begin_layout Plain Layout
21383 \change_inserted -712698321 1483869913
21391 blocks, as used mainly in cite engine files (see
21392 \begin_inset CommandInset ref
21394 reference "subsec:Cite-Engine-Files"
21401 ), define the citation commands provided by a specific
21402 \begin_inset Quotes eld
21406 \begin_inset Quotes erd
21410 A cite engine, in \SpecialChar LyX
21411 terms, is way specific way to format citations, using
21412 numbers, author names and/or years.
21413 Currently, \SpecialChar LyX
21414 supports three such engine types, namely:
21417 \begin_layout Enumerate
21419 \change_inserted -712698321 1483875764
21420 \begin_inset Flex Code
21423 \begin_layout Plain Layout
21425 \change_inserted -712698321 1483870430
21433 : the default Bib\SpecialChar TeX
21434 way to format citations, a simple numeric style (e.
21435 \begin_inset space \thinspace{}
21439 \begin_inset Quotes eld
21443 \begin_inset Quotes erd
21449 \begin_layout Enumerate
21451 \change_inserted -712698321 1483875766
21452 \begin_inset Flex Code
21455 \begin_layout Plain Layout
21457 \change_inserted -712698321 1483870434
21465 : Harvard-styled citations using author names and publication year (e.
21466 \begin_inset space \thinspace{}
21470 \begin_inset Quotes eld
21473 Smith and Miller (2017b)
21474 \begin_inset Quotes erd
21480 \begin_layout Enumerate
21482 \change_inserted -712698321 1483875769
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21488 \change_inserted -712698321 1483870457
21496 : extended numerical citations that also allow for author or title next
21498 \begin_inset space \thinspace{}
21502 \begin_inset Quotes eld
21505 Smith and Miller [1]
21506 \begin_inset Quotes erd
21512 \begin_layout Standard
21514 \change_inserted -712698321 1483870566
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21520 \change_inserted -712698321 1483870552
21526 blocks look like this:
21529 \begin_layout LyX-Code
21531 \change_inserted -712698321 1483870590
21535 \begin_layout LyX-Code
21537 \change_inserted -712698321 1483870615
21541 \begin_layout LyX-Code
21543 \change_inserted -712698321 1483870633
21547 \begin_layout LyX-Code
21549 \change_inserted -712698321 1483870652
21550 citeyearpar[][]=parencite*
21553 \begin_layout LyX-Code
21555 \change_inserted -712698321 1483870652
21559 \begin_layout LyX-Code
21561 \change_inserted -712698321 1483870668
21565 \begin_layout Standard
21567 \change_inserted -712698321 1483871113
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21574 \change_inserted -712698321 1483871085
21580 denotes the engine.
21581 The individual lines respectively define a cite command or cite command
21582 paradigm supported by this engine.
21583 The line can be as simple as a cite command that is used both to name the
21584 respective \SpecialChar LyX
21585 command and the \SpecialChar LaTeX
21586 output or more complex in order to differentiate
21589 \change_deleted -712698321 1483871114
21593 \begin_layout Standard
21595 \change_inserted -712698321 1483871119
21596 The full syntax is:
21599 \begin_layout LyX-Code
21601 \change_inserted -712698321 1483870927
21602 LyXName|alias*<!_stardesc!_stardesctooltip>[][]=latexcmd
21605 \begin_layout Itemize
21607 \change_inserted -712698321 1483871222
21608 \begin_inset Flex Code
21611 \begin_layout Plain Layout
21613 \change_inserted -712698321 1483871181
21621 : The name as used in the
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21627 \change_inserted -712698321 1483871216
21639 \begin_layout Standard
21641 \change_inserted -712698321 1483871487
21642 For portability reasons, we try to use the same name for same-formatted
21643 commands in different cite packages (thus many names stem from natbib,
21644 and thus we need to differentiate a
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21650 \change_inserted -712698321 1483871402
21656 sometimes, if the \SpecialChar LaTeX
21657 command names differ).
21661 \begin_layout Itemize
21663 \change_inserted -712698321 1483871583
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21669 \change_inserted -712698321 1483871186
21677 : a (comma-separated) list of commands that fall back to the given
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21683 \change_inserted -712698321 1483871257
21689 in the current engine.
21690 This eases the switch of citation packages and engines.
21692 \begin_inset Flex Code
21695 \begin_layout Plain Layout
21697 \change_inserted -712698321 1483871559
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21709 \change_inserted -712698321 1483871278
21717 in layout definitions.
21720 \begin_layout Itemize
21722 \change_inserted -712698321 1483871307
21723 \begin_inset Flex Code
21726 \begin_layout Plain Layout
21728 \change_inserted -712698321 1483871296
21736 : The actual \SpecialChar LaTeX
21737 command that is output.
21741 \begin_layout Standard
21743 \change_inserted -712698321 1483871348
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21749 \change_inserted -712698321 1483871316
21758 \begin_inset Flex Code
21761 \begin_layout Plain Layout
21763 \change_inserted -712698321 1483871321
21773 \begin_inset Flex Code
21776 \begin_layout Plain Layout
21778 \change_inserted -712698321 1483871333
21785 \begin_inset Flex Code
21788 \begin_layout Plain Layout
21790 \change_inserted -712698321 1483871340
21796 will be output to \SpecialChar LaTeX
21800 \begin_layout Standard
21802 \change_inserted -712698321 1483871604
21806 \begin_layout Itemize
21808 \change_inserted -712698321 1483871664
21809 Capitalization indicates that the command also has a capitalized form (
21810 \begin_inset Flex Code
21813 \begin_layout Plain Layout
21815 \change_inserted -712698321 1483871622
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21832 \change_inserted -712698321 1483871626
21843 These usually enforce up-casing of name prefixes (
21848 \begin_inset Formula $\Rightarrow$
21858 \begin_layout Itemize
21860 \change_inserted -712698321 1483871690
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21867 \change_inserted -712698321 1483871670
21875 indicate the number of optional arguments (there can be 0–2).
21878 \begin_layout Itemize
21880 \change_inserted -712698321 1483871747
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21887 \change_inserted -712698321 1483871698
21895 indicates there is a starred version of the command (
21896 \begin_inset Flex Code
21899 \begin_layout Plain Layout
21901 \change_inserted -712698321 1483871718
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21918 \change_inserted -712698321 1483871724
21933 \begin_layout Standard
21935 \change_inserted -712698321 1483871864
21936 By default, the starred version means: Output all authors even if it should
21938 \begin_inset Quotes eld
21942 \begin_inset Quotes erd
21946 \begin_inset Flex Code
21949 \begin_layout Plain Layout
21951 \change_inserted -712698321 1483871835
21962 \begin_layout Standard
21964 \change_inserted -712698321 1483872045
21965 If the star has a different meaning for a given command, it can be specified
21967 \begin_inset Flex Code
21970 \begin_layout Plain Layout
21972 \change_inserted -712698321 1483871856
21973 <!_stardesc!_stardesctooltip>
21981 Maximal two translatable macro keywords, marked by the prefix
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21987 \change_inserted -712698321 1483872014
21996 The first points to the string that replaces the
21997 \begin_inset Quotes eld
22001 \begin_inset Quotes erd
22004 checkbox label in the citation dialog, the second one to an optional tool
22005 tip for this checkbox.
22009 \begin_layout Standard
22011 \change_inserted -712698321 1483872164
22012 Note that these two macros have to be defined in a
22013 \begin_inset Flex Code
22016 \begin_layout Plain Layout
22018 \change_inserted -712698321 1483871983
22026 (see next section), dropping the
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22032 \change_inserted -712698321 1483872023
22040 from the prefix, like this:
22043 \begin_layout LyX-Code
22045 \change_inserted -712698321 1483872092
22046 _stardesc Sta&rred command label
22049 \begin_layout LyX-Code
22051 \change_inserted -712698321 1483872184
22052 _stardesctooltip Tooltip for the starred command checkbox.
22056 \begin_layout Subsection
22057 \begin_inset CommandInset label
22059 name "subsec:Citation-format-description"
22063 Citation format description
22066 \begin_layout Standard
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22077 blocks are used to describe how bibliographic information should be displayed,
22078 both within \SpecialChar LyX
22079 itself (in the citation dialog and in tooltips, for example)
22080 and in XHTML output.
22081 Such a block might look like this:
22084 \begin_layout LyX-Code
22088 \begin_layout LyX-Code
22092 \begin_layout LyX-Code
22096 \begin_layout LyX-Code
22098 \change_inserted -712698321 1483867197
22102 \begin_layout Standard
22104 \change_inserted -712698321 1483867200
22108 \begin_layout LyX-Code
22110 \change_inserted -712698321 1483867195
22114 \begin_layout LyX-Code
22116 \change_inserted -712698321 1483867204
22120 \begin_layout LyX-Code
22122 \change_inserted -712698321 1483867359
22126 \begin_layout LyX-Code
22128 \change_inserted -712698321 1483867195
22134 \begin_layout Standard
22136 \change_inserted -712698321 1483867269
22138 \change_deleted -712698321 1483867270
22140 \change_inserted -712698321 1483867270
22143 he individual lines define how the bibliographic information associated
22144 with an article or book, respectively, is to be displayed, and such a definitio
22145 n can be given for any
22146 \change_deleted -712698321 1483867550
22148 \change_inserted -712698321 1483867550
22150 \begin_inset Quotes els
22156 \change_deleted -712698321 1483867552
22158 \change_inserted -712698321 1483867552
22160 \begin_inset Quotes ers
22165 that might be present in a Bib\SpecialChar TeX
22168 defines a default format in the source code that will be used if no specific
22169 definition has been given.
22171 predefines several formats in the file
22172 \begin_inset Flex Code
22175 \begin_layout Plain Layout
22181 , which is included in most of \SpecialChar LyX
22182 's document classes.
22183 \change_inserted -712698321 1483867288
22187 \begin_layout Standard
22189 \change_inserted -712698321 1483875512
22190 In the second case, the lines define how a specific citation command (in
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22197 \change_inserted -712698321 1483867674
22208 \begin_inset Flex Code
22211 \begin_layout Plain Layout
22213 \change_inserted -712698321 1483867679
22223 ) is to be displayed on the citation inset label, in the citation dialog,
22224 menu or XHTML output.
22226 defines such formats for the citation style variants it supports via
22228 Document\SpecialChar menuseparator
22229 Setting\SpecialChar menuseparator
22230 Bibliography\SpecialChar ldots
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22239 \change_inserted -712698321 1483875503
22245 files that are shipped with \SpecialChar LyX
22247 \begin_inset CommandInset ref
22249 reference "subsec:Cite-Engine-Files"
22261 \begin_layout Standard
22262 The definitions use a simple language that allows Bib\SpecialChar TeX
22263 keys to be replaced
22265 Keys should be enclosed in
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22286 So a simple definition might look like this:
22289 \begin_layout LyX-Code
22291 \begin_inset Quotes eld
22295 \begin_inset Quotes erd
22301 \begin_layout Standard
22302 This would print the author, followed by a comma, followed by the title,
22303 in quotes, followed by a period.
22306 \begin_layout Standard
22307 Of course, sometimes you may want to print a key only if it exists.
22308 This can be done by using a conditional construction, such as:
22309 \begin_inset Flex Code
22312 \begin_layout Plain Layout
22314 \begin_inset space ~
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22333 key exists, then print
22334 \begin_inset Quotes eld
22338 \begin_inset space ~
22342 \begin_inset Quotes erd
22345 followed by the volume key.
22346 It is also possible to have an else clause in the conditional, such as:
22347 \begin_inset Newline newline
22351 \begin_inset Flex Code
22354 \begin_layout Plain Layout
22355 {%author%[[%author%]][[%editor%, ed.]]}
22361 \begin_inset Newline newline
22365 \begin_inset Flex Code
22368 \begin_layout Plain Layout
22374 key is printed if it exists; otherwise, the editor key is printed, followed
22376 \begin_inset Quotes eld
22380 \begin_inset space ~
22384 \begin_inset Quotes erd
22387 Note that the key is again enclosed in
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22397 signs; the entire conditional is enclosed in braces; and the if and else
22398 clauses are enclosed in double brackets,
22399 \begin_inset Quotes eld
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22413 \begin_inset Quotes eld
22417 \begin_inset Quotes eld
22421 \begin_inset Flex Code
22424 \begin_layout Plain Layout
22431 \begin_inset Quotes erd
22435 There must be no space between any of these.
22436 \change_inserted -712698321 1483867855
22440 \begin_layout Standard
22442 \change_inserted -712698321 1483867910
22443 Next to the entry keys, there are some special keys that can be used for
22444 these conditionals:
22447 \begin_layout Itemize
22449 \change_inserted -712698321 1483868049
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22455 \change_inserted -712698321 1483867962
22456 {%dialog%[[true]][[false]]}
22464 \begin_inset Quotes eld
22468 \begin_inset Quotes erd
22471 part for dialogs and menus, the
22472 \begin_inset Quotes eld
22476 \begin_inset Quotes erd
22479 part for other contexts (workarea, export)
22482 \begin_layout Itemize
22484 \change_inserted -712698321 1483868068
22485 \begin_inset Flex Code
22488 \begin_layout Plain Layout
22490 \change_inserted -712698321 1483868052
22491 {%export%[[true]][[false]]}
22497 \begin_inset Quotes eld
22501 \begin_inset Quotes erd
22504 part for export and menus, the
22505 \begin_inset Quotes eld
22509 \begin_inset Quotes erd
22512 part for other contexts (workarea, dialog)
22515 \begin_layout Itemize
22517 \change_inserted -712698321 1483868138
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22523 \change_inserted -712698321 1483868076
22530 \begin_inset Quotes eld
22534 \begin_inset Quotes erd
22537 part if another item follows (e.
22538 \begin_inset space \thinspace{}
22541 g., in a citation with multiple keys)
22544 \begin_layout Itemize
22546 \change_inserted -712698321 1483868174
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22552 \change_inserted -712698321 1483868144
22553 {%second%[[true]][[false]]}
22559 \begin_inset Quotes eld
22563 \begin_inset Quotes erd
22566 if this is the second of multiple items, else the
22567 \begin_inset Quotes eld
22571 \begin_inset Quotes erd
22577 \begin_layout Itemize
22579 \change_inserted -712698321 1483868321
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22585 \change_inserted -712698321 1483868259
22586 {%ifstar%[[true]][[false]]}
22592 \begin_inset Quotes eld
22596 \begin_inset Quotes erd
22599 part for starred citation commands (such as
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22605 \change_inserted -712698321 1483868310
22615 ), the false part for unstarred
22618 \begin_layout Itemize
22620 \change_inserted -712698321 1483978485
22621 \begin_inset Flex Code
22624 \begin_layout Plain Layout
22626 \change_inserted -712698321 1483868330
22627 {%ifentrytype:<type>%[[true]][[false]]}
22633 \begin_inset Quotes eld
22637 \begin_inset Quotes erd
22640 if the current entry type matches
22641 \begin_inset Flex Code
22644 \begin_layout Plain Layout
22646 \change_inserted -712698321 1483868364
22654 , else the false part (e.g., in a citation definition:
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22660 \change_inserted -712698321 1483868420
22661 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22671 \begin_layout Itemize
22673 \change_inserted -712698321 1483978548
22674 \begin_inset Flex Code
22677 \begin_layout Plain Layout
22679 \change_inserted -712698321 1483978499
22680 {%ifmultiple:<authortype>%[[true]][[false]]}
22686 \begin_inset Quotes eld
22690 \begin_inset Quotes erd
22693 if the current author type (author, editor etc.) has multiple authors, else
22694 the false part (e.g., in a bibliography definition:
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22700 \change_inserted -712698321 1483978571
22701 {%ifmultiple:editor%[[eds.]][[ed.]]}
22711 \begin_layout Standard
22713 \change_inserted -712698321 1483978958
22715 \begin_inset Flex Code
22718 \begin_layout Plain Layout
22720 \change_inserted -712698321 1483978693
22726 prints the author key as it is recorded in the bibliography file.
22727 This might not be what you want, since it will result in a string such
22729 \begin_inset Quotes eld
22732 Miller, Peter and Smith, Mary and White, Jane
22733 \begin_inset Quotes erd
22737 \begin_inset Quotes eld
22741 \begin_inset Quotes erd
22744 is used by Bib\SpecialChar TeX
22745 to delimit authors).
22747 therefore provides some methods to get properly formatted name lists (which
22748 will also get translated).
22749 The following keys are provided:
22752 \begin_layout Enumerate
22754 \change_inserted -712698321 1483979807
22755 For name lists with pre- and surname, suitable for the main authors/editors
22756 of a bibliography item.
22758 \begin_inset Flex Code
22761 \begin_layout Plain Layout
22763 \change_inserted -712698321 1483979800
22771 part denotes the kind of list that is requested (e.g.
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22778 \change_inserted -712698321 1483979807
22790 \begin_layout Itemize
22792 \change_inserted -712698321 1483979186
22793 \begin_inset Flex Code
22796 \begin_layout Plain Layout
22798 \change_inserted -712698321 1483979743
22799 %abbrvnames:<nametype>%
22806 : Provides a name list which is abbreviated (with
22807 \begin_inset Quotes eld
22811 \begin_inset Quotes erd
22815 \begin_inset Flex Code
22818 \begin_layout Plain Layout
22820 \change_inserted -712698321 1483979186
22831 \begin_layout Itemize
22833 \change_inserted -712698321 1483979527
22834 \begin_inset Flex Code
22837 \begin_layout Plain Layout
22839 \change_inserted -712698321 1483979748
22840 %fullnames:<nametype>%
22847 : Provides a full name list (never abbreviated with
22848 \begin_inset Quotes eld
22852 \begin_inset Quotes erd
22858 \begin_layout Itemize
22860 \change_inserted -712698321 1483979553
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22866 \change_inserted -712698321 1483980138
22867 %forceabbrvnames:<nametype>%
22874 : Provides a name list which is always abbreviated (with
22875 \begin_inset Quotes eld
22879 \begin_inset Quotes erd
22883 \begin_inset Flex Code
22886 \begin_layout Plain Layout
22888 \change_inserted -712698321 1483979535
22900 \begin_layout Enumerate
22902 \change_inserted -712698321 1483979413
22903 Alternative name lists with pre- and surname, if the order of pre- and surname
22904 inside the bibliography item differs (as in:
22905 \begin_inset Quotes eld
22908 Miller, John: Some text, in: Mary Smith, ed.: A volume
22909 \begin_inset Quotes erd
22918 \begin_layout Itemize
22920 \change_inserted -712698321 1483979565
22921 \begin_inset Flex Code
22924 \begin_layout Plain Layout
22926 \change_inserted -712698321 1483979751
22927 %abbrvbynames:<nametype>%
22934 : Provides a name list which is abbreviated (with
22935 \begin_inset Quotes eld
22939 \begin_inset Quotes erd
22943 \begin_inset Flex Code
22946 \begin_layout Plain Layout
22948 \change_inserted -712698321 1483979565
22959 \begin_layout Itemize
22961 \change_inserted -712698321 1483979570
22962 \begin_inset Flex Code
22965 \begin_layout Plain Layout
22967 \change_inserted -712698321 1483979753
22968 %fullbynames:<nametype>%
22975 : Provides a full name list (never abbreviated with
22976 \begin_inset Quotes eld
22980 \begin_inset Quotes erd
22988 \begin_layout Itemize
22990 \change_inserted -712698321 1483979576
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
22996 \change_inserted -712698321 1483980143
22997 %forceabbrvbynames:<nametype>%
23004 : Provides a name list which is always abbreviated (with
23005 \begin_inset Quotes eld
23009 \begin_inset Quotes erd
23013 \begin_inset Flex Code
23016 \begin_layout Plain Layout
23018 \change_inserted -712698321 1483979574
23028 \begin_layout Enumerate
23030 \change_inserted -712698321 1483980219
23031 And finally name lists which consist of family names only, as used in author-yea
23033 these do not take a
23034 \begin_inset Flex Code
23037 \begin_layout Plain Layout
23039 \change_inserted -712698321 1483979871
23047 part, but always return either an author list or, if this does not exist,
23048 an editor list (as common in author-year labels):
23054 \begin_layout Itemize
23056 \change_inserted -712698321 1483979715
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23062 \change_inserted -712698321 1483979700
23070 : Provides a name list which is abbreviated (with
23071 \begin_inset Quotes eld
23075 \begin_inset Quotes erd
23079 \begin_inset Flex Code
23082 \begin_layout Plain Layout
23084 \change_inserted -712698321 1483979715
23095 \begin_layout Itemize
23097 \change_inserted -712698321 1483979721
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23103 \change_inserted -712698321 1483979703
23111 : Provides a full name list (never abbreviated with
23112 \begin_inset Quotes eld
23116 \begin_inset Quotes erd
23124 \begin_layout Itemize
23126 \change_inserted -712698321 1483980272
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23132 \change_inserted -712698321 1483979705
23133 %forceabbrvciteauthor%
23140 : Provides a name list which is always abbreviated (with
23141 \begin_inset Quotes eld
23145 \begin_inset Quotes erd
23149 \begin_inset Flex Code
23152 \begin_layout Plain Layout
23154 \change_inserted -712698321 1483979726
23164 \begin_layout Standard
23166 \change_inserted -712698321 1483980314
23167 The order of pre- and surname in the former two lists can be adjusted by
23171 \begin_layout Itemize
23173 \change_inserted -712698321 1483980535
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23179 \change_inserted -712698321 1483980354
23180 !firstnameform %surname%, %prename%
23187 (first author in lists of type 1)
23190 \begin_layout Itemize
23192 \change_inserted -712698321 1483980557
23193 \begin_inset Flex Code
23196 \begin_layout Plain Layout
23198 \change_inserted -712698321 1483980367
23199 !othernameform %surname%, %prename%
23206 (other authors in lists of type 1)
23211 \begin_layout Itemize
23213 \change_inserted -712698321 1483980550
23214 \begin_inset Flex Code
23217 \begin_layout Plain Layout
23219 \change_inserted -712698321 1483980373
23220 !firstbynameform %prename% %surname%
23227 (first author in lists of type 2)
23230 \begin_layout Itemize
23232 \change_inserted -712698321 1483980570
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23238 \change_inserted -712698321 1483980381
23239 !otherbynameform %prename% %surname%
23246 (other authors in lists of type 2)
23249 \begin_layout Standard
23251 \change_inserted -712698321 1483980643
23252 This allows you to configure namings like
23253 \begin_inset Quotes eld
23256 Miller, Peter and Mary Smith: \SpecialChar ldots
23257 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23259 \begin_inset Quotes erd
23267 \begin_layout Standard
23268 There is one other piece of syntax available in definitions, which looks
23270 \begin_inset Flex Code
23273 \begin_layout Plain Layout
23280 This defines a piece of formatting information that is to be used when
23282 \begin_inset Quotes eld
23286 \begin_inset Quotes erd
23290 Obviously, we do not want to output HTML tags when writing plain text,
23291 so they should be wrapped in
23292 \begin_inset Quotes eld
23296 \begin_inset Quotes erd
23300 \begin_inset Quotes eld
23304 \begin_inset Quotes erd
23310 \begin_layout Standard
23311 Two special sorts of definitions are also possible in a
23312 \begin_inset Flex Code
23315 \begin_layout Plain Layout
23322 An example of the first would be:
23325 \begin_layout LyX-Code
23327 \begin_inset Quotes eld
23331 \begin_inset Quotes erd
23337 \begin_layout Standard
23338 This is an abbreviation, or macro, and it can be used by treating it as
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23361 exactly as it would treat its definition.
23362 So, let us issue the obvious
23370 \begin_layout LyX-Code
23374 \begin_layout Standard
23375 or anything like it.
23377 shouldn't go into an infinite loop, but it may go into a long one before
23381 \begin_layout Standard
23382 The second sort of special definition might look like this:
23385 \begin_layout LyX-Code
23389 \begin_layout Standard
23390 This defines a translatable piece of text, which allows relevant parts of
23392 \change_inserted -712698321 1483868477
23396 It can be included in a definition by treating it as a key:
23397 \begin_inset Flex Code
23400 \begin_layout Plain Layout
23407 Several of these are predefined in
23408 \begin_inset Flex Code
23411 \begin_layout Plain Layout
23418 \change_inserted -712698321 1483868503
23420 \begin_inset Flex Code
23423 \begin_layout Plain Layout
23425 \change_inserted -712698321 1483868503
23436 Note that these are not macros, in the sense just defined.
23437 They will not be expanded.
23440 \begin_layout Standard
23441 So here then is an example that use all these features:
23442 \begin_inset VSpace defskip
23448 \begin_layout Standard
23452 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
23455 \begin_layout Standard
23456 \begin_inset VSpace defskip
23459 This defines a macro that prints the author, followed by a comma, if the
23461 \begin_inset Flex Code
23464 \begin_layout Plain Layout
23470 key is defined, or else prints the name of the editor, followed by the
23472 \begin_inset Flex Code
23475 \begin_layout Plain Layout
23481 or its translation (it is by default
23482 \begin_inset Quotes eld
23486 \begin_inset Quotes erd
23490 \begin_inset Flex Code
23493 \begin_layout Plain Layout
23500 Note that this is in fact defined in
23501 \begin_inset Flex Code
23504 \begin_layout Plain Layout
23510 , so you can use it in your own definitions, or re-definitions, if you load
23514 \begin_layout Section
23515 \begin_inset CommandInset label
23517 name "sec:Tags-for-XHTML"
23521 Tags for XHTML output
23524 \begin_layout Standard
23525 As with \SpecialChar LaTeX
23526 or DocBook, the format of \SpecialChar LyX
23527 's XHTML output is also controlled by
23528 layout information.
23529 In general, \SpecialChar LyX
23530 provides sensible defaults and, as mentioned earlier, it will
23531 even construct default CSS style rules from the other layout tags.
23532 For example, \SpecialChar LyX
23533 will attempt to use the information provided in the
23534 \begin_inset Flex Code
23537 \begin_layout Plain Layout
23543 declaration for the Chapter style to write CSS that will appropriately
23544 format chapter headings.
23547 \begin_layout Standard
23548 In many cases, then, you may not have to do anything at all to get acceptable
23549 XHTML output for your own environments, custom insets, and so forth.
23550 But in some cases you will, and so \SpecialChar LyX
23551 provides a number of layout tags that
23552 can be used to customize the XHTML and CSS that are generated.
23555 \begin_layout Standard
23556 Note that there are two tags,
23557 \begin_inset Flex Code
23560 \begin_layout Plain Layout
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23576 that may appear outside style and inset declarations.
23578 \begin_inset CommandInset ref
23580 reference "subsec:General-text-class"
23584 for details on these.
23587 \begin_layout Subsection
23588 \begin_inset CommandInset label
23590 name "subsec:Paragraph-Style-XHTML"
23597 \begin_layout Standard
23598 The sort of XHTML \SpecialChar LyX
23599 outputs for a paragraph depends upon whether we are dealing
23600 with a normal paragraph, a command, or an environment, where this is itself
23601 determined by the contents of the corresponding
23602 \begin_inset Flex Code
23605 \begin_layout Plain Layout
23616 \begin_layout Standard
23617 For a command or normal paragraph, the output XHTML has the following form:
23620 \begin_layout LyX-Code
23622 \begin_inset Quotes erd
23626 \begin_inset Quotes erd
23632 \begin_layout LyX-Code
23634 \begin_inset Quotes erd
23638 \begin_inset Quotes erd
23644 \begin_layout LyX-Code
23645 Contents of the paragraph.
23648 \begin_layout LyX-Code
23652 \begin_layout Standard
23653 The label tags are of course omitted if the paragraph does not have a label.
23656 \begin_layout Standard
23657 For an environment that is not some sort of list, the XHTML takes this form:
23660 \begin_layout LyX-Code
23662 \begin_inset Quotes erd
23666 \begin_inset Quotes erd
23672 \begin_layout LyX-Code
23674 \begin_inset Quotes erd
23678 \begin_inset Quotes erd
23682 \begin_inset Quotes erd
23686 \begin_inset Quotes erd
23689 >Environment Label</labeltag>First paragraph.</itemtag>
23692 \begin_layout LyX-Code
23693 <itemtag>Second paragraph.</itemtag>
23696 \begin_layout LyX-Code
23700 \begin_layout Standard
23701 Note that the label is output only for the first paragraph, as it should
23702 be for a theorem, for example.
23706 \begin_layout Standard
23707 For a list, we have one of these forms:
23710 \begin_layout LyX-Code
23712 \begin_inset Quotes erd
23716 \begin_inset Quotes erd
23722 \begin_layout LyX-Code
23724 \begin_inset Quotes erd
23728 \begin_inset Quotes erd
23732 \begin_inset Quotes erd
23736 \begin_inset Quotes erd
23739 >List Label</labeltag>First item.</itemtag>
23742 \begin_layout LyX-Code
23744 \begin_inset Quotes erd
23748 \begin_inset Quotes erd
23752 \begin_inset Quotes erd
23756 \begin_inset Quotes erd
23759 >List Label</labeltag>Second item.</itemtag>
23762 \begin_layout LyX-Code
23766 \begin_layout LyX-Code
23770 \begin_layout LyX-Code
23772 \begin_inset Quotes erd
23776 \begin_inset Quotes erd
23782 \begin_layout LyX-Code
23784 \begin_inset Quotes erd
23788 \begin_inset Quotes erd
23791 >List Label</labeltag><itemtag attr=
23792 \begin_inset Quotes erd
23796 \begin_inset Quotes erd
23799 >First item.</itemtag>
23802 \begin_layout LyX-Code
23804 \begin_inset Quotes erd
23808 \begin_inset Quotes erd
23811 >List Label</labeltag><itemtag attr=
23812 \begin_inset Quotes erd
23816 \begin_inset Quotes erd
23819 >Second item.</itemtag>
23822 \begin_layout LyX-Code
23826 \begin_layout Standard
23827 Note the different orders of
23828 \begin_inset Flex Code
23831 \begin_layout Plain Layout
23838 \begin_inset Flex Code
23841 \begin_layout Plain Layout
23848 Which order we get depends upon the setting of
23849 \begin_inset Flex Code
23852 \begin_layout Plain Layout
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23868 is false (the default), you get the first of these, with the label within
23869 the item; if true, you get the second, with the label outside the item.
23872 \begin_layout Standard
23873 The specific tags and attributes output for each paragraph type can be controlle
23874 d by means of the layout tags we are about to describe.
23875 As mentioned earlier, however, \SpecialChar LyX
23876 uses sensible defaults for many of these,
23877 so you often may not need to do very much to get good XHTML output.
23878 Think of the available tags as there so you can tweak things to your liking.
23881 \begin_layout Description
23882 \begin_inset Flex Code
23885 \begin_layout Plain Layout
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23901 ] Specifies attribute information to be output with the main tag.
23903 \begin_inset Quotes eld
23907 \begin_inset Flex Code
23910 \begin_layout Plain Layout
23917 \begin_inset Quotes erd
23921 By default, \SpecialChar LyX
23923 \begin_inset Quotes eld
23927 \begin_inset Flex Code
23930 \begin_layout Plain Layout
23937 \begin_inset Quotes erd
23941 \begin_inset Flex Code
23944 \begin_layout Plain Layout
23950 is the \SpecialChar LyX
23951 name of the layout, made lowercase, for example: chapter.
23956 contain any style information.
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23970 \begin_layout Description
23971 \begin_inset Flex Code
23974 \begin_layout Plain Layout
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23994 ] Whether to output the default CSS information \SpecialChar LyX
23995 generates for this layout,
23996 even if additional information is explicitly provided via
23997 \begin_inset Flex Code
24000 \begin_layout Plain Layout
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24017 allows you to alter or augment the generated CSS, rather than to override
24020 \begin_inset Flex Code
24023 \begin_layout Plain Layout
24032 \begin_layout Description
24033 \begin_inset Flex Code
24036 \begin_layout Plain Layout
24043 \begin_inset Flex Code
24046 \begin_layout Plain Layout
24052 ] The tag to be used for individual paragraphs of environments, replacing
24054 \begin_inset Flex Code
24057 \begin_layout Plain Layout
24063 in the examples above.
24065 \begin_inset Flex Code
24068 \begin_layout Plain Layout
24077 \begin_layout Description
24078 \begin_inset Flex Code
24081 \begin_layout Plain Layout
24088 \begin_inset Flex Code
24091 \begin_layout Plain Layout
24097 ] Attributes for the item tag.
24099 \begin_inset Quotes eld
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24107 class=`layoutname_item'
24113 \begin_inset Quotes erd
24121 contain any style information.
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24135 \begin_layout Description
24136 \begin_inset Flex Code
24139 \begin_layout Plain Layout
24146 \begin_inset Flex Code
24149 \begin_layout Plain Layout
24155 ] The tag to be used for paragraph and item labels, replacing
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24165 in the examples above.
24167 \begin_inset Flex Code
24170 \begin_layout Plain Layout
24177 \begin_inset Flex Code
24180 \begin_layout Plain Layout
24187 \begin_inset Flex Code
24190 \begin_layout Plain Layout
24197 \begin_inset Flex Code
24200 \begin_layout Plain Layout
24201 Centered_Top_Environment
24206 , in which case it defaults to
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24219 \begin_layout Description
24220 \begin_inset Flex Code
24223 \begin_layout Plain Layout
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24239 ] Attributes for the label tag.
24241 \begin_inset Quotes eld
24245 \begin_inset Flex Code
24248 \begin_layout Plain Layout
24249 class=`layoutname_label'
24255 \begin_inset Quotes erd
24263 contain any style information.
24265 \begin_inset Flex Code
24268 \begin_layout Plain Layout
24277 \begin_layout Description
24278 \begin_inset Flex Code
24281 \begin_layout Plain Layout
24288 \begin_inset Flex Code
24291 \begin_layout Plain Layout
24301 ] Meaningful only for list-like environments, this tag controls whether
24302 the label tag is output before or inside the item tag.
24303 This is used, for example, in the description environment, where we want
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24309 <dt>\SpecialChar ldots
24310 </dt><dd>\SpecialChar ldots
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24327 : The label tag is output inside the item tag.
24330 \begin_layout Description
24331 \begin_inset Flex Code
24334 \begin_layout Plain Layout
24340 Information to be output in the
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24350 section when this style is used.
24351 This might, for example, be used to include a
24352 \begin_inset Flex Code
24355 \begin_layout Plain Layout
24362 \begin_inset Flex Code
24365 \begin_layout Plain Layout
24374 \begin_layout Description
24375 \begin_inset Flex Code
24378 \begin_layout Plain Layout
24384 CSS style information to be included when this style is used.
24385 Note that this will automatically be wrapped in a layout-generated
24386 \begin_inset Flex Code
24389 \begin_layout Plain Layout
24395 block, so only the CSS itself need be included.
24397 \begin_inset Flex Code
24400 \begin_layout Plain Layout
24409 \begin_layout Description
24410 \begin_inset Flex Code
24413 \begin_layout Plain Layout
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24429 ] The tag to be used for the main label, replacing
24430 \begin_inset Flex Code
24433 \begin_layout Plain Layout
24439 in the examples above.
24441 \begin_inset Flex Code
24444 \begin_layout Plain Layout
24453 \begin_layout Description
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24464 \begin_inset Flex Code
24467 \begin_layout Plain Layout
24477 ] Marks this style as the one to be used to generate the
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24487 tag for the XHTML file.
24488 By default, it is false.
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24499 file sets it to true for the
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24513 \begin_layout Subsection
24517 \begin_layout Standard
24518 The XHTML output of insets can also be controlled by information in layout
24523 \begin_layout Plain Layout
24524 At present, this is true only for
24525 \begin_inset Quotes eld
24529 \begin_inset Quotes erd
24532 insets (insets you can type into) and is not true for
24533 \begin_inset Quotes eld
24537 \begin_inset Quotes erd
24540 insets (insets that are associated with dialog boxes).
24545 Here, too, \SpecialChar LyX
24546 tries to provide sensible defaults, and it constructs default
24548 But everything can be customized.
24551 \begin_layout Standard
24552 The XHTML \SpecialChar LyX
24553 outputs for an inset has the following form:
24556 \begin_layout LyX-Code
24558 \begin_inset Quotes erd
24562 \begin_inset Quotes erd
24568 \begin_layout LyX-Code
24569 <labeltag>Label</labeltag>
24572 \begin_layout LyX-Code
24574 \begin_inset Quotes erd
24578 \begin_inset Quotes erd
24581 >Contents of the inset.</innertag>
24584 \begin_layout LyX-Code
24588 \begin_layout Standard
24589 If the inset permits multiple paragraphs—that is, if
24590 \begin_inset Flex Code
24593 \begin_layout Plain Layout
24599 is true—then the contents of the inset will itself be output as paragraphs
24600 formatted according to the styles used for those paragraphs (standard,
24601 quote, and the like).
24602 The label tag is of course omitted if the paragraph does not have a label
24603 and, at present, is always
24604 \begin_inset Flex Code
24607 \begin_layout Plain Layout
24614 The inner tag is optional and, by default, does not appear.
24617 \begin_layout Standard
24618 The specific tags and attributes output for each inset can be controlled
24619 by means of the following layout tags.
24622 \begin_layout Description
24623 \begin_inset Flex Code
24626 \begin_layout Plain Layout
24633 \begin_inset Flex Code
24636 \begin_layout Plain Layout
24642 ] Specifies attribute information to be output with the main tag.
24644 \begin_inset Quotes eld
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24652 class=`myinset' onclick=`\SpecialChar ldots
24659 \begin_inset Quotes erd
24663 By default, \SpecialChar LyX
24665 \begin_inset Quotes eld
24669 \begin_inset Flex Code
24672 \begin_layout Plain Layout
24679 \begin_inset Quotes erd
24683 \begin_inset Flex Code
24686 \begin_layout Plain Layout
24692 is the \SpecialChar LyX
24693 name of the inset, made lowercase and with non-alphanumeric characters
24694 converted to underscores, for example: footnote.
24697 \begin_layout Description
24698 \begin_inset Flex Code
24701 \begin_layout Plain Layout
24708 \begin_inset Flex Code
24711 \begin_layout Plain Layout
24721 ] Whether to output the default CSS information \SpecialChar LyX
24722 generates for this layout,
24723 even if additional information is explicitly provided via
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24735 \begin_inset Flex Code
24738 \begin_layout Plain Layout
24744 allows you to alter or augment the generated CSS, rather than to override
24749 \begin_layout Description
24750 \begin_inset Flex Code
24753 \begin_layout Plain Layout
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24769 ] Attributes for the inner tag.
24771 \begin_inset Quotes eld
24775 \begin_inset Flex Code
24778 \begin_layout Plain Layout
24779 class=`insetname_inner'
24785 \begin_inset Quotes erd
24791 \begin_layout Description
24792 \begin_inset Flex Code
24795 \begin_layout Plain Layout
24802 \begin_inset Flex Code
24805 \begin_layout Plain Layout
24811 ] The inner tag, replacing
24812 \begin_inset Flex Code
24815 \begin_layout Plain Layout
24821 in the examples above.
24822 By default, there is none.
24825 \begin_layout Description
24826 \begin_inset Flex Code
24829 \begin_layout Plain Layout
24836 \begin_inset Flex Code
24839 \begin_layout Plain Layout
24847 ] Whether this inset represents a standalone block of text (such as a footnote)
24848 or instead represents material that is included in the surrounding text
24849 (such as a branch).
24853 \begin_layout Description
24854 \begin_inset Flex Code
24857 \begin_layout Plain Layout
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24873 ] A label for this inset, possibly including a reference to a counter.
24874 For example, for footnote, it might be:
24875 \begin_inset Flex Code
24878 \begin_layout Plain Layout
24887 This is optional, and there is no default.
24890 \begin_layout Description
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24900 Information to be output in the
24901 \begin_inset Flex Code
24904 \begin_layout Plain Layout
24910 section when this style is used.
24911 This might, for example, be used to include a
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24934 \begin_layout Description
24935 \begin_inset Flex Code
24938 \begin_layout Plain Layout
24944 CSS style information to be included when this style is used.
24945 Note that this will automatically be wrapped in a layout-generated
24946 \begin_inset Flex Code
24949 \begin_layout Plain Layout
24955 block, so only the CSS itself need be included.
24958 \begin_layout Description
24959 \begin_inset Flex Code
24962 \begin_layout Plain Layout
24969 \begin_inset Flex Code
24972 \begin_layout Plain Layout
24978 ] The tag to be used for the main label, replacing
24979 \begin_inset Flex Code
24982 \begin_layout Plain Layout
24988 in the examples above.
24989 The default depends upon the setting of
24990 \begin_inset Flex Code
24993 \begin_layout Plain Layout
25000 \begin_inset Flex Code
25003 \begin_layout Plain Layout
25009 is true, the default is
25010 \begin_inset Flex Code
25013 \begin_layout Plain Layout
25019 ; if it is false, the default is
25020 \begin_inset Flex Code
25023 \begin_layout Plain Layout
25032 \begin_layout Subsection
25036 \begin_layout Standard
25037 The XHTML output for floats too can be controlled by layout information.
25038 The output has the following form:
25041 \begin_layout LyX-Code
25043 \begin_inset Quotes erd
25047 \begin_inset Quotes erd
25053 \begin_layout LyX-Code
25054 Contents of the float.
25057 \begin_layout LyX-Code
25061 \begin_layout Standard
25062 The caption, if there is one, is a separate inset and will be output as
25064 Its appearance can be controlled via the InsetLayout for caption insets.
25068 \begin_layout Description
25069 \begin_inset Flex Code
25072 \begin_layout Plain Layout
25079 \begin_inset Flex Code
25082 \begin_layout Plain Layout
25088 ] Specifies attribute information to be output with the main tag.
25090 \begin_inset Quotes eld
25094 \begin_inset Flex Code
25097 \begin_layout Plain Layout
25098 class=`myfloat' onclick=`\SpecialChar ldots
25105 \begin_inset Quotes erd
25109 By default, \SpecialChar LyX
25111 \begin_inset Quotes eld
25115 \begin_inset Flex Code
25118 \begin_layout Plain Layout
25119 class=`float float-floattype'
25125 \begin_inset Quotes erd
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25138 is \SpecialChar LyX
25139 's name for this type of float, as determined by the float declaration
25141 \begin_inset CommandInset ref
25143 reference "subsec:Floats"
25147 ), though made lowercase and with non-alphanumeric characters converted
25148 to underscores, for example: float-table.
25151 \begin_layout Description
25152 \begin_inset Flex Code
25155 \begin_layout Plain Layout
25161 CSS style information to be included when this float is used.
25162 Note that this will automatically be wrapped in a layout-generated
25163 \begin_inset Flex Code
25166 \begin_layout Plain Layout
25172 block, so only the CSS itself need be included.
25175 \begin_layout Description
25176 \begin_inset Flex Code
25179 \begin_layout Plain Layout
25186 \begin_inset Flex Code
25189 \begin_layout Plain Layout
25195 ] The tag to be used for this float, replacing
25196 \begin_inset Quotes eld
25200 \begin_inset Flex Code
25203 \begin_layout Plain Layout
25210 \begin_inset Quotes erd
25213 in the example above.
25215 \begin_inset Flex Code
25218 \begin_layout Plain Layout
25224 and will rarely need changing.
25227 \begin_layout Subsection
25228 Bibliography formatting
25231 \begin_layout Standard
25232 The bibliography can be formatted using
25233 \begin_inset Flex Code
25236 \begin_layout Plain Layout
25244 \begin_inset CommandInset ref
25246 reference "subsec:Citation-format-description"
25253 \begin_layout Subsection
25258 \begin_layout Standard
25259 We have several times mentioned that \SpecialChar LyX
25260 will generate default CSS style rules
25261 for both insets and paragraph styles, based upon the other layout information
25263 In this section, we shall say a word about which layout information \SpecialChar LyX
25268 \begin_layout Standard
25269 At present, \SpecialChar LyX
25270 auto-generates CSS only for font information, making use of
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25282 \begin_inset Flex Code
25285 \begin_layout Plain Layout
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25302 \begin_inset Flex Code
25305 \begin_layout Plain Layout
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25322 \begin_inset CommandInset ref
25324 reference "subsec:Font-description"
25329 The translation is mostly straightforward and obvious.
25331 \begin_inset Quotes eld
25335 \begin_inset Flex Code
25338 \begin_layout Plain Layout
25345 \begin_inset Quotes erd
25349 \begin_inset Quotes eld
25353 \begin_inset Flex Code
25356 \begin_layout Plain Layout
25357 font-family: sans-serif;
25363 \begin_inset Quotes erd
25367 The correspondence of \SpecialChar LyX
25368 sizes and CSS sizes is a little less obvious but
25369 nonetheless intuitive.
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25381 \begin_inset Flex URL
25384 \begin_layout Plain Layout
25394 \begin_layout Chapter
25395 Including External Material
25396 \begin_inset CommandInset label
25398 name "chap:Including-External-Material"
25405 \begin_layout Standard
25406 \begin_inset Box Shadowbox
25416 height_special "totalheight"
25421 backgroundcolor "none"
25424 \begin_layout Plain Layout
25425 WARNING: This portion of the documentation has not been updated for some
25427 We certainly hope that it is still accurate, but there are no guarantees.
25435 \begin_layout Standard
25436 The use of material from sources external to \SpecialChar LyX
25437 is covered in detail in the
25443 This part of the manual covers what needs to happen behind the scenes for
25444 new sorts of material to be included.
25447 \begin_layout Section
25451 \begin_layout Standard
25452 The external material feature is based on the concept of a
25457 A template is a specification of how \SpecialChar LyX
25458 should interface with a certain kind
25460 As bundled, \SpecialChar LyX
25461 comes with predefined templates for Xfig figures, various
25462 raster format images, chess diagrams, and LilyPond music notation.
25463 You can check the actual list by using the menu
25464 \begin_inset Flex Noun
25467 \begin_layout Plain Layout
25468 Insert\SpecialChar menuseparator
25469 File\SpecialChar menuseparator
25476 Furthermore, it is possible to roll your own template to support a specific
25478 Later we'll describe in more detail what is involved, and hopefully you
25479 will submit all the templates you create so we can include them in a later
25484 \begin_layout Standard
25485 Another basic idea of the external material feature is to distinguish between
25486 the original file that serves as a base for final material and the produced
25487 file that is included in your exported or printed document.
25488 For example, consider the case of a figure produced with
25489 \begin_inset Flex Code
25492 \begin_layout Plain Layout
25499 The Xfig application itself works on an original file with the
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25510 Within Xfig, you create and change your figure, and when you are done,
25512 \begin_inset Flex Code
25515 \begin_layout Plain Layout
25522 When you want to include the figure in your document, you invoke
25523 \begin_inset Flex Code
25526 \begin_layout Plain Layout
25532 in order to create a PostScript file that can readily be included in your
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25545 file is the original file, and the PostScript file is the produced file.
25548 \begin_layout Standard
25549 This distinction is important in order to allow updating of the material
25550 while you are in the process of writing the document.
25551 Furthermore, it provides us with the flexibility that is needed to support
25552 multiple export formats.
25553 For instance, in the case of a plain text file, it is not exactly an award-winn
25554 ing idea to include the figure as raw PostScript.
25555 Instead, you would either prefer to just include a reference to the figure
25556 or try to invoke some graphics to ASCII converter to make the final result
25557 look similar to the real graphics.
25558 The external material management allows you to do this, because it is parametri
25559 zed on the different export formats that \SpecialChar LyX
25563 \begin_layout Standard
25564 Besides supporting the production of different products according to the
25565 exported format, it supports tight integration with editing and viewing
25567 In the case of an Xfig figure, you are able to invoke Xfig on the original
25568 file with a single click from within the external material dialog in \SpecialChar LyX
25570 and also preview the produced PostScript file with Ghostview with another
25572 No more fiddling around with the command line and/or file browsers to locate
25573 and manipulate the original or produced files.
25574 In this way, you are finally able to take full advantage of the many different
25575 applications that are relevant to use when you write your documents, and
25576 ultimately be more productive.
25579 \begin_layout Section
25580 The external template configuration file
25583 \begin_layout Standard
25584 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25586 However, be aware that doing this in an careless manner most probably
25590 introduce an easily exploitable security hole.
25591 So before you do this, please read the discussion about security in
25592 \begin_inset CommandInset ref
25594 reference "sec:Security-discussion"
25601 \begin_layout Standard
25602 Having said that, we encourage you to submit any interesting templates that
25607 \begin_layout Standard
25608 The external templates are defined in the
25609 \begin_inset Flex Code
25612 \begin_layout Plain Layout
25613 LyXDir/lib/external_templates
25619 You can place your own version in
25620 \begin_inset Flex Code
25623 \begin_layout Plain Layout
25624 UserDir/external_templates
25632 \begin_layout Standard
25633 A typical template looks like this:
25636 \begin_layout LyX-Code
25640 \begin_layout LyX-Code
25641 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25644 \begin_layout LyX-Code
25648 \begin_layout LyX-Code
25652 \begin_layout LyX-Code
25656 \begin_layout LyX-Code
25660 \begin_layout LyX-Code
25664 \begin_layout LyX-Code
25665 AutomaticProduction true
25668 \begin_layout LyX-Code
25672 \begin_layout LyX-Code
25676 \begin_layout LyX-Code
25680 \begin_layout LyX-Code
25681 TransformCommand Rotate RotationLatexCommand
25684 \begin_layout LyX-Code
25685 TransformCommand Resize ResizeLatexCommand
25688 \begin_layout LyX-Code
25689 Product "$$RotateFront$$ResizeFront
25692 \begin_layout LyX-Code
25697 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25700 \begin_layout LyX-Code
25701 $$ResizeBack$$RotateBack"
25704 \begin_layout LyX-Code
25708 \begin_layout LyX-Code
25709 UpdateResult "$$AbsPath$$Basename.pstex_t"
25712 \begin_layout LyX-Code
25713 Requirement "graphicx"
25716 \begin_layout LyX-Code
25717 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25720 \begin_layout LyX-Code
25721 ReferencedFile latex "$$AbsPath$$Basename.eps"
25724 \begin_layout LyX-Code
25725 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25728 \begin_layout LyX-Code
25732 \begin_layout LyX-Code
25736 \begin_layout LyX-Code
25737 TransformCommand Rotate RotationLatexCommand
25740 \begin_layout LyX-Code
25741 TransformCommand Resize ResizeLatexCommand
25744 \begin_layout LyX-Code
25745 Product "$$RotateFront$$ResizeFront
25748 \begin_layout LyX-Code
25753 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25756 \begin_layout LyX-Code
25757 $$ResizeBack$$RotateBack"
25760 \begin_layout LyX-Code
25761 UpdateFormat pdftex
25764 \begin_layout LyX-Code
25765 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25768 \begin_layout LyX-Code
25769 Requirement "graphicx"
25772 \begin_layout LyX-Code
25773 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25776 \begin_layout LyX-Code
25777 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25780 \begin_layout LyX-Code
25784 \begin_layout LyX-Code
25788 \begin_layout LyX-Code
25789 Product "[XFig: $$FName]"
25792 \begin_layout LyX-Code
25796 \begin_layout LyX-Code
25800 \begin_layout LyX-Code
25801 Product "<graphic fileref=
25803 "$$AbsOrRelPathMaster$$Basename.eps
25808 \begin_layout LyX-Code
25812 \begin_layout LyX-Code
25816 \begin_layout LyX-Code
25817 UpdateResult "$$AbsPath$$Basename.eps"
25820 \begin_layout LyX-Code
25821 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25824 \begin_layout LyX-Code
25825 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25828 \begin_layout LyX-Code
25832 \begin_layout LyX-Code
25836 \begin_layout Standard
25837 As you can see, the template is enclosed in
25838 \begin_inset Flex Code
25841 \begin_layout Plain Layout
25849 \begin_inset Flex Code
25852 \begin_layout Plain Layout
25859 It contains a header specifying some general settings and, for each supported
25860 primary document file format, a section
25861 \begin_inset Flex Code
25864 \begin_layout Plain Layout
25872 \begin_inset Flex Code
25875 \begin_layout Plain Layout
25884 \begin_layout Subsection
25885 The template header
25888 \begin_layout Description
25889 \begin_inset Flex Code
25892 \begin_layout Plain Layout
25893 AutomaticProduction
25894 \begin_inset space ~
25902 Whether the file represented by the template must be generated by \SpecialChar LyX
25904 This command must occur exactly once.
25907 \begin_layout Description
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25913 \begin_inset space ~
25921 A glob pattern that is used in the file dialog to filter out the desired
25923 If there is more than one possible file extension (e.
25924 \begin_inset space \thinspace{}
25928 \begin_inset space \space{}
25932 \begin_inset Flex Code
25935 \begin_layout Plain Layout
25942 \begin_inset Flex Code
25945 \begin_layout Plain Layout
25951 ), use something like
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25962 This command must occur exactly once.
25965 \begin_layout Description
25966 \begin_inset Flex Code
25969 \begin_layout Plain Layout
25971 \begin_inset space ~
25979 The text that is displayed on the button.
25980 This command must occur exactly once.
25983 \begin_layout Description
25984 \begin_inset Flex Code
25987 \begin_layout Plain Layout
25989 \begin_inset space ~
25993 \begin_inset space ~
26001 The help text that is used in the External dialog.
26002 Provide enough information to explain to the user just what the template
26003 can provide him with.
26004 This command must occur exactly once.
26007 \begin_layout Description
26008 \begin_inset Flex Code
26011 \begin_layout Plain Layout
26013 \begin_inset space ~
26021 The file format of the original file.
26022 This must be the name of a format that is known to \SpecialChar LyX
26024 \begin_inset CommandInset ref
26026 reference "sec:Formats"
26032 \begin_inset Quotes eld
26036 \begin_inset Flex Code
26039 \begin_layout Plain Layout
26046 \begin_inset Quotes erd
26049 if the template can handle original files of more than one format.
26051 will attempt to interrogate the file itself in order to deduce its format
26053 This command must occur exactly once.
26056 \begin_layout Description
26057 \begin_inset Flex Code
26060 \begin_layout Plain Layout
26062 \begin_inset space ~
26070 A unique name for the template.
26071 It must not contain substitution macros (see below).
26074 \begin_layout Description
26075 \begin_inset Flex Code
26078 \begin_layout Plain Layout
26080 \begin_inset space ~
26083 Rotate|Resize|Clip|Extra
26088 This command specifies which transformations are supported by this template.
26089 It may occur zero or more times.
26090 This command enables the corresponding tabs in the external dialog.
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26101 command must have either a corresponding
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26112 \begin_inset Flex Code
26115 \begin_layout Plain Layout
26122 \begin_inset Flex Code
26125 \begin_layout Plain Layout
26132 Otherwise the transformation will not be supported by that format.
26135 \begin_layout Subsection
26139 \begin_layout Description
26140 \begin_inset Flex Code
26143 \begin_layout Plain Layout
26145 \begin_inset space ~
26148 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26153 The primary document file format that this format definition is for.
26154 Not every template has a sensible representation in all document file formats.
26155 Please define nevertheless a
26156 \begin_inset Flex Code
26159 \begin_layout Plain Layout
26165 section for all templates.
26166 Use a dummy text when no representation is available.
26167 Then you can at least see a reference to the external material in the exported
26171 \begin_layout Description
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26177 \begin_inset space ~
26181 \begin_inset space ~
26189 This command defines an additional macro
26190 \begin_inset Flex Code
26193 \begin_layout Plain Layout
26199 for substitution in
26200 \begin_inset Flex Code
26203 \begin_layout Plain Layout
26211 \begin_inset Flex Code
26214 \begin_layout Plain Layout
26220 itself may contain substitution macros.
26221 The advantage over using
26222 \begin_inset Flex Code
26225 \begin_layout Plain Layout
26232 \begin_inset Flex Code
26235 \begin_layout Plain Layout
26241 is that the substituted value of
26242 \begin_inset Flex Code
26245 \begin_layout Plain Layout
26251 is sanitized so that it is a valid optional argument in the document format.
26252 This command may occur zero or more times.
26255 \begin_layout Description
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26261 \begin_inset space ~
26269 The text that is inserted in the exported document.
26270 This is actually the most important command and can be quite complex.
26271 This command must occur exactly once.
26274 \begin_layout Description
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26280 \begin_inset space ~
26288 This command specifies a preamble snippet that will be included in the
26291 It has to be defined using
26292 \begin_inset Flex Code
26295 \begin_layout Plain Layout
26303 \begin_inset Flex Code
26306 \begin_layout Plain Layout
26313 This command may occur zero or more times.
26316 \begin_layout Description
26317 \begin_inset Flex Code
26320 \begin_layout Plain Layout
26322 \begin_inset space ~
26326 \begin_inset space ~
26334 This command denotes files that are created by the conversion process and
26335 are needed for a particular export format.
26336 If the filename is relative, it is interpreted relative to the master document.
26337 This command may be given zero or more times.
26340 \begin_layout Description
26341 \begin_inset Flex Code
26344 \begin_layout Plain Layout
26346 \begin_inset space ~
26354 The name of a required \SpecialChar LaTeX
26356 The package is included via
26357 \begin_inset Flex Code
26360 \begin_layout Plain Layout
26368 in the \SpecialChar LaTeX
26370 This command may occur zero or more times.
26373 \begin_layout Description
26374 \begin_inset Flex Code
26377 \begin_layout Plain Layout
26379 \begin_inset space ~
26383 \begin_inset space ~
26386 RotationLatexCommand
26391 This command specifies that the built in \SpecialChar LaTeX
26392 command should be used for rotation.
26393 This command may occur once or not at all.
26396 \begin_layout Description
26397 \begin_inset Flex Code
26400 \begin_layout Plain Layout
26402 \begin_inset space ~
26406 \begin_inset space ~
26414 This command specifies that the built in \SpecialChar LaTeX
26415 command should be used for resizing.
26416 This command may occur once or not at all.
26419 \begin_layout Description
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26425 \begin_inset space ~
26429 \begin_inset space ~
26432 RotationLatexOption
26437 This command specifies that rotation is done via an optional argument.
26438 This command may occur once or not at all.
26441 \begin_layout Description
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26447 \begin_inset space ~
26451 \begin_inset space ~
26459 This command specifies that resizing is done via an optional argument.
26460 This command may occur once or not at all.
26463 \begin_layout Description
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26469 \begin_inset space ~
26473 \begin_inset space ~
26481 This command specifies that clipping is done via an optional argument.
26482 This command may occur once or not at all.
26485 \begin_layout Description
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26491 \begin_inset space ~
26495 \begin_inset space ~
26503 This command specifies that an extra optional argument is used.
26504 This command may occur once or not at all.
26507 \begin_layout Description
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26513 \begin_inset space ~
26521 The file format of the converted file.
26522 This must be the name of a format that is known to \SpecialChar LyX
26524 \begin_inset Flex Noun
26527 \begin_layout Plain Layout
26528 Tools\SpecialChar menuseparator
26529 Preferences\SpecialChar menuseparator
26530 File Handling\SpecialChar menuseparator
26537 This command must occur exactly once.
26538 If the resulting file format is PDF, you need to specify the format
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26549 This is the PDF format used for including graphics.
26550 The other defined PDF formats are for document export.
26553 \begin_layout Description
26554 \begin_inset Flex Code
26557 \begin_layout Plain Layout
26559 \begin_inset space ~
26567 The file name of the converted file.
26568 The file name must be absolute.
26569 This command must occur exactly once.
26572 \begin_layout Subsection
26573 Preamble definitions
26576 \begin_layout Standard
26577 The external template configuration file may contain additional preamble
26578 definitions enclosed by
26579 \begin_inset Flex Code
26582 \begin_layout Plain Layout
26590 \begin_inset Flex Code
26593 \begin_layout Plain Layout
26600 They can be used by the templates in the
26601 \begin_inset Flex Code
26604 \begin_layout Plain Layout
26613 \begin_layout Section
26614 The substitution mechanism
26617 \begin_layout Standard
26618 When the external material facility invokes an external program, it is done
26619 on the basis of a command defined in the template configuration file.
26620 These commands can contain various macros that are expanded before execution.
26621 Execution always take place in the directory of the containing document.
26624 \begin_layout Standard
26625 Also, whenever external material is to be displayed, the name will be produced
26626 by the substitution mechanism, and most other commands in the template
26627 definition support substitution as well.
26630 \begin_layout Standard
26631 The available macros are the following:
26634 \begin_layout Description
26635 \begin_inset Flex Code
26638 \begin_layout Plain Layout
26639 $$AbsOrRelPathMaster
26644 The file path, absolute or relative to the master \SpecialChar LyX
26648 \begin_layout Description
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26653 $$AbsOrRelPathParent
26658 The file path, absolute or relative to the \SpecialChar LyX
26662 \begin_layout Description
26663 \begin_inset Flex Code
26666 \begin_layout Plain Layout
26672 The absolute file path.
26675 \begin_layout Description
26676 \begin_inset Flex Code
26679 \begin_layout Plain Layout
26685 The filename without path and without the extension.
26688 \begin_layout Description
26689 \begin_inset Flex Code
26692 \begin_layout Plain Layout
26694 \begin_inset Quotes eld
26698 \begin_inset Quotes erd
26706 This macro will expand to the contents of the file with the name
26707 \begin_inset Flex Code
26710 \begin_layout Plain Layout
26719 \begin_layout Description
26720 \begin_inset Flex Code
26723 \begin_layout Plain Layout
26729 The file extension (including the dot).
26732 \begin_layout Description
26733 \begin_inset Flex Code
26736 \begin_layout Plain Layout
26742 This will be the string
26743 \begin_inset Quotes eld
26747 \begin_inset Quotes erd
26750 if the file is in JPEG format, otherwise it will be the string
26751 \begin_inset Quotes eld
26755 \begin_inset Quotes erd
26759 This is useful to avoid uneeded conversions for output formats that support
26760 both PNG and JPEG fomats.
26761 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26766 \begin_layout Description
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26776 The filename of the file specified in the external material dialog.
26777 This is either an absolute name, or it is relative to the \SpecialChar LyX
26781 \begin_layout Description
26782 \begin_inset Flex Code
26785 \begin_layout Plain Layout
26792 \begin_inset Flex Code
26795 \begin_layout Plain Layout
26801 (absolute name or relative to the \SpecialChar LyX
26805 \begin_layout Description
26806 \begin_inset Flex Code
26809 \begin_layout Plain Layout
26815 The file path, relative to the master \SpecialChar LyX
26819 \begin_layout Description
26820 \begin_inset Flex Code
26823 \begin_layout Plain Layout
26829 The file path, relative to the \SpecialChar LyX
26833 \begin_layout Description
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26843 This macro will expand to the absolute path of the system directory.
26844 This is typically used to point to the various helper scripts that are
26845 bundled with \SpecialChar LyX
26849 \begin_layout Description
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26859 A name and full path to a temporary file which will be automatically deleted
26860 whenever the containing document is closed, or the external material insertion
26864 \begin_layout Standard
26865 All path macros contain a trailing directory separator, so you can construct
26867 \begin_inset space \thinspace{}
26871 \begin_inset space \space{}
26874 the absolute filename with
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26879 $$AbsPath$$Basename$$Extension
26887 \begin_layout Standard
26888 The macros above are substituted in all commands unless otherwise noted.
26890 \begin_inset Flex Code
26893 \begin_layout Plain Layout
26899 supports additionally the following substitutions if they are enabled by
26901 \begin_inset Flex Code
26904 \begin_layout Plain Layout
26911 \begin_inset Flex Code
26914 \begin_layout Plain Layout
26923 \begin_layout Description
26924 \begin_inset Flex Code
26927 \begin_layout Plain Layout
26933 The front part of the resize command.
26936 \begin_layout Description
26937 \begin_inset Flex Code
26940 \begin_layout Plain Layout
26946 The back part of the resize command.
26949 \begin_layout Description
26950 \begin_inset Flex Code
26953 \begin_layout Plain Layout
26959 The front part of the rotation command.
26962 \begin_layout Description
26963 \begin_inset Flex Code
26966 \begin_layout Plain Layout
26972 The back part of the rotation command.
26975 \begin_layout Standard
26976 The value string of the
26977 \begin_inset Flex Code
26980 \begin_layout Plain Layout
26986 command supports additionally the following substitutions if they are enabled
26988 \begin_inset Flex Code
26991 \begin_layout Plain Layout
26998 \begin_inset Flex Code
27001 \begin_layout Plain Layout
27010 \begin_layout Description
27011 \begin_inset Flex Code
27014 \begin_layout Plain Layout
27023 \begin_layout Description
27024 \begin_inset Flex Code
27027 \begin_layout Plain Layout
27036 \begin_layout Description
27037 \begin_inset Flex Code
27040 \begin_layout Plain Layout
27049 \begin_layout Description
27050 \begin_inset Flex Code
27053 \begin_layout Plain Layout
27059 The rotation option.
27062 \begin_layout Standard
27063 You may ask why there are so many path macros.
27064 There are mainly two reasons:
27067 \begin_layout Enumerate
27068 Relative and absolute file names should remain relative or absolute, respectivel
27070 Users may have reasons to prefer either form.
27071 Relative names are useful for portable documents that should work on different
27072 machines, for example.
27073 Absolute names may be required by some programs.
27076 \begin_layout Enumerate
27078 treats relative file names differently than \SpecialChar LyX
27079 and other programs in nested
27081 For \SpecialChar LyX
27082 , a relative file name is always relative to the document that contains
27084 For \SpecialChar LaTeX
27085 , it is always relative to the master document.
27086 These two definitions are identical if you have only one document, but
27087 differ if you have a master document that includes part documents.
27088 That means that relative filenames must be transformed when presented to
27091 Fortunately \SpecialChar LyX
27092 does this automatically for you if you choose the right macros.
27095 \begin_layout Standard
27096 So which path macro should be used in new template definitions? The rule
27100 \begin_layout Itemize
27102 \begin_inset Flex Code
27105 \begin_layout Plain Layout
27111 if an absolute path is required.
27114 \begin_layout Itemize
27116 \begin_inset Flex Code
27119 \begin_layout Plain Layout
27120 $$AbsOrRelPathMaster
27125 if the substituted string is some kind of \SpecialChar LaTeX
27129 \begin_layout Itemize
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27135 $$AbsOrRelPathParent
27140 in order to preserve the user's choice.
27143 \begin_layout Standard
27144 There are special cases where this rule does not work and e.
27145 \begin_inset space \thinspace{}
27149 \begin_inset space \space{}
27152 relative names are needed, but normally it will work just fine.
27153 One example for such a case is the command
27154 \begin_inset Flex Code
27157 \begin_layout Plain Layout
27158 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27163 in the XFig template above: We can't use the absolute name because the
27165 \begin_inset Flex Code
27168 \begin_layout Plain Layout
27174 files needs the relative name in order to rewrite the file content.
27177 \begin_layout Section
27178 Security discussion
27179 \begin_inset CommandInset label
27181 name "sec:Security-discussion"
27188 \begin_layout Standard
27189 The external material feature interfaces with a lot of external programs
27190 and does so automatically, so we have to consider the security implications
27192 In particular, since you have the option of including your own filenames
27193 and/or parameter strings and those are expanded into a command, it seems
27194 that it would be possible to create a malicious document which executes
27195 arbitrary commands when a user views or prints the document.
27196 This is something we definitely want to avoid.
27199 \begin_layout Standard
27200 However, since the external program commands are specified in the template
27201 configuration file only, there are no security issues if \SpecialChar LyX
27202 is properly configure
27203 d with safe templates only.
27204 This is so because the external programs are invoked with the
27205 \begin_inset Flex Code
27208 \begin_layout Plain Layout
27214 -system call rather than the
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27224 system-call, so it's not possible to execute arbitrary commands from the
27225 filename or parameter section via the shell.
27228 \begin_layout Standard
27229 This also implies that you are restricted in what command strings you can
27230 use in the external material templates.
27231 In particular, pipes and redirection are not readily available.
27232 This has to be so if \SpecialChar LyX
27233 should remain safe.
27234 If you want to use some of the shell features, you should write a safe
27235 script to do this in a controlled manner, and then invoke the script from
27236 the command string.
27240 \begin_layout Standard
27241 It is possible to design a template that interacts directly with the shell,
27242 but since this would allow a malicious user to execute arbitrary commands
27243 by writing clever filenames and/or parameters, we generally recommend that
27244 you only use safe scripts that work with the
27245 \begin_inset Flex Code
27248 \begin_layout Plain Layout
27254 system call in a controlled manner.
27255 Of course, for use in a controlled environment, it can be tempting to just
27256 fall back to use ordinary shell scripts.
27257 If you do so, be aware that you
27261 provide an easily exploitable security hole in your system.
27262 Of course it stands to reason that such unsafe templates will never be
27263 included in the standard \SpecialChar LyX
27264 distribution, although we do encourage people
27265 to submit new templates in the open source tradition.
27266 But \SpecialChar LyX
27267 as shipped from the official distribution channels will never have
27271 \begin_layout Standard
27272 Including external material provides a lot of power, and you have to be
27273 careful not to introduce security hazards with this power.
27274 A subtle error in a single line in an innocent looking script can open
27275 the door to huge security problems.
27276 So if you do not fully understand the issues, we recommend that you consult
27277 a knowledgeable security professional or the \SpecialChar LyX
27278 development team if you have
27279 any questions about whether a given template is safe or not.
27280 And do this before you use it in an uncontrolled environment.
27283 \begin_layout Chapter
27285 List of supported \SpecialChar LyX
27286 functions to be used in layouts
27287 \begin_inset CommandInset label
27289 name "chap:List-of-functions"
27296 \begin_layout Standard
27298 \begin_inset Tabular
27299 <lyxtabular version="3" rows="11" columns="8">
27300 <features tabularvalignment="middle">
27301 <column alignment="left" valignment="top">
27302 <column alignment="left" valignment="top">
27303 <column alignment="left" valignment="top">
27304 <column alignment="left" valignment="top">
27305 <column alignment="left" valignment="top">
27306 <column alignment="left" valignment="top">
27307 <column alignment="left" valignment="top">
27308 <column alignment="left" valignment="top">
27310 <cell alignment="left" valignment="top" usebox="none">
27313 \begin_layout Plain Layout
27319 <cell alignment="left" valignment="top" usebox="none">
27322 \begin_layout Plain Layout
27328 <cell alignment="left" valignment="top" usebox="none">
27331 \begin_layout Plain Layout
27337 <cell alignment="left" valignment="top" usebox="none">
27340 \begin_layout Plain Layout
27346 <cell alignment="center" valignment="top" usebox="none">
27349 \begin_layout Plain Layout
27355 <cell alignment="center" valignment="top" usebox="none">
27358 \begin_layout Plain Layout
27364 <cell alignment="center" valignment="top" usebox="none">
27367 \begin_layout Plain Layout
27373 <cell alignment="center" valignment="top" usebox="none">
27376 \begin_layout Plain Layout
27384 <cell alignment="left" valignment="top" usebox="none">
27387 \begin_layout Plain Layout
27393 <cell alignment="left" valignment="top" usebox="none">
27396 \begin_layout Plain Layout
27402 <cell alignment="left" valignment="top" usebox="none">
27405 \begin_layout Plain Layout
27411 <cell alignment="left" valignment="top" usebox="none">
27414 \begin_layout Plain Layout
27420 <cell alignment="center" valignment="top" usebox="none">
27423 \begin_layout Plain Layout
27429 <cell alignment="center" valignment="top" usebox="none">
27432 \begin_layout Plain Layout
27438 <cell alignment="center" valignment="top" usebox="none">
27441 \begin_layout Plain Layout
27447 <cell alignment="center" valignment="top" usebox="none">
27450 \begin_layout Plain Layout
27458 <cell alignment="left" valignment="top" usebox="none">
27461 \begin_layout Plain Layout
27467 <cell alignment="left" valignment="top" usebox="none">
27470 \begin_layout Plain Layout
27476 <cell alignment="left" valignment="top" usebox="none">
27479 \begin_layout Plain Layout
27485 <cell alignment="left" valignment="top" usebox="none">
27488 \begin_layout Plain Layout
27494 <cell alignment="center" valignment="top" usebox="none">
27497 \begin_layout Plain Layout
27503 <cell alignment="center" valignment="top" usebox="none">
27506 \begin_layout Plain Layout
27512 <cell alignment="center" valignment="top" usebox="none">
27515 \begin_layout Plain Layout
27521 <cell alignment="center" valignment="top" usebox="none">
27524 \begin_layout Plain Layout
27532 <cell alignment="left" valignment="top" usebox="none">
27535 \begin_layout Plain Layout
27541 <cell alignment="left" valignment="top" usebox="none">
27544 \begin_layout Plain Layout
27550 <cell alignment="left" valignment="top" usebox="none">
27553 \begin_layout Plain Layout
27559 <cell alignment="left" valignment="top" usebox="none">
27562 \begin_layout Plain Layout
27568 <cell alignment="center" valignment="top" usebox="none">
27571 \begin_layout Plain Layout
27577 <cell alignment="center" valignment="top" usebox="none">
27580 \begin_layout Plain Layout
27586 <cell alignment="center" valignment="top" usebox="none">
27589 \begin_layout Plain Layout
27595 <cell alignment="center" valignment="top" usebox="none">
27598 \begin_layout Plain Layout
27606 <cell alignment="left" valignment="top" usebox="none">
27609 \begin_layout Plain Layout
27615 <cell alignment="left" valignment="top" usebox="none">
27618 \begin_layout Plain Layout
27624 <cell alignment="left" valignment="top" usebox="none">
27627 \begin_layout Plain Layout
27633 <cell alignment="left" valignment="top" usebox="none">
27636 \begin_layout Plain Layout
27642 <cell alignment="center" valignment="top" usebox="none">
27645 \begin_layout Plain Layout
27651 <cell alignment="center" valignment="top" usebox="none">
27654 \begin_layout Plain Layout
27660 <cell alignment="center" valignment="top" usebox="none">
27663 \begin_layout Plain Layout
27669 <cell alignment="center" valignment="top" usebox="none">
27672 \begin_layout Plain Layout
27680 <cell alignment="left" valignment="top" usebox="none">
27683 \begin_layout Plain Layout
27689 <cell alignment="left" valignment="top" usebox="none">
27692 \begin_layout Plain Layout
27698 <cell alignment="left" valignment="top" usebox="none">
27701 \begin_layout Plain Layout
27707 <cell alignment="left" valignment="top" usebox="none">
27710 \begin_layout Plain Layout
27716 <cell alignment="center" valignment="top" usebox="none">
27719 \begin_layout Plain Layout
27725 <cell alignment="center" valignment="top" usebox="none">
27728 \begin_layout Plain Layout
27734 <cell alignment="center" valignment="top" usebox="none">
27737 \begin_layout Plain Layout
27743 <cell alignment="center" valignment="top" usebox="none">
27746 \begin_layout Plain Layout
27754 <cell alignment="left" valignment="top" usebox="none">
27757 \begin_layout Plain Layout
27763 <cell alignment="left" valignment="top" usebox="none">
27766 \begin_layout Plain Layout
27772 <cell alignment="left" valignment="top" usebox="none">
27775 \begin_layout Plain Layout
27781 <cell alignment="left" valignment="top" usebox="none">
27784 \begin_layout Plain Layout
27790 <cell alignment="center" valignment="top" usebox="none">
27793 \begin_layout Plain Layout
27799 <cell alignment="center" valignment="top" usebox="none">
27802 \begin_layout Plain Layout
27808 <cell alignment="center" valignment="top" usebox="none">
27811 \begin_layout Plain Layout
27817 <cell alignment="center" valignment="top" usebox="none">
27820 \begin_layout Plain Layout
27828 <cell alignment="left" valignment="top" usebox="none">
27831 \begin_layout Plain Layout
27837 <cell alignment="left" valignment="top" usebox="none">
27840 \begin_layout Plain Layout
27846 <cell alignment="left" valignment="top" usebox="none">
27849 \begin_layout Plain Layout
27855 <cell alignment="left" valignment="top" usebox="none">
27858 \begin_layout Plain Layout
27864 <cell alignment="center" valignment="top" usebox="none">
27867 \begin_layout Plain Layout
27873 <cell alignment="center" valignment="top" usebox="none">
27876 \begin_layout Plain Layout
27882 <cell alignment="center" valignment="top" usebox="none">
27885 \begin_layout Plain Layout
27891 <cell alignment="center" valignment="top" usebox="none">
27894 \begin_layout Plain Layout
27902 <cell alignment="left" valignment="top" usebox="none">
27905 \begin_layout Plain Layout
27911 <cell alignment="left" valignment="top" usebox="none">
27914 \begin_layout Plain Layout
27920 <cell alignment="left" valignment="top" usebox="none">
27923 \begin_layout Plain Layout
27929 <cell alignment="left" valignment="top" usebox="none">
27932 \begin_layout Plain Layout
27938 <cell alignment="center" valignment="top" usebox="none">
27941 \begin_layout Plain Layout
27947 <cell alignment="center" valignment="top" usebox="none">
27950 \begin_layout Plain Layout
27956 <cell alignment="center" valignment="top" usebox="none">
27959 \begin_layout Plain Layout
27965 <cell alignment="center" valignment="top" usebox="none">
27968 \begin_layout Plain Layout
27976 <cell alignment="left" valignment="top" usebox="none">
27979 \begin_layout Plain Layout
27985 <cell alignment="left" valignment="top" usebox="none">
27988 \begin_layout Plain Layout
27994 <cell alignment="left" valignment="top" usebox="none">
27997 \begin_layout Plain Layout
28003 <cell alignment="left" valignment="top" usebox="none">
28006 \begin_layout Plain Layout
28012 <cell alignment="center" valignment="top" usebox="none">
28015 \begin_layout Plain Layout
28021 <cell alignment="center" valignment="top" usebox="none">
28024 \begin_layout Plain Layout
28030 <cell alignment="center" valignment="top" usebox="none">
28033 \begin_layout Plain Layout
28039 <cell alignment="center" valignment="top" usebox="none">
28042 \begin_layout Plain Layout
28050 <cell alignment="center" valignment="top" usebox="none">
28053 \begin_layout Plain Layout
28059 <cell alignment="center" valignment="top" usebox="none">
28062 \begin_layout Plain Layout
28068 <cell alignment="center" valignment="top" usebox="none">
28071 \begin_layout Plain Layout
28077 <cell alignment="center" valignment="top" usebox="none">
28080 \begin_layout Plain Layout
28086 <cell alignment="center" valignment="top" usebox="none">
28089 \begin_layout Plain Layout
28095 <cell alignment="center" valignment="top" usebox="none">
28098 \begin_layout Plain Layout
28104 <cell alignment="center" valignment="top" usebox="none">
28107 \begin_layout Plain Layout
28113 <cell alignment="center" valignment="top" usebox="none">
28116 \begin_layout Plain Layout
28130 \begin_layout Chapter
28131 Names of available colors to be used in layouts
28132 \begin_inset CommandInset label
28134 name "chap:Names-of-colors"
28141 \begin_layout Standard
28142 The colors listed here are the standard colors and the those that you can
28143 adjust in the \SpecialChar LyX
28147 \begin_layout Description
28160 No particular color – clear or default
28163 \begin_layout Description
28167 \begin_layout Description
28171 \begin_layout Description
28175 \begin_layout Description
28179 \begin_layout Description
28183 \begin_layout Description
28187 \begin_layout Description
28191 \begin_layout Description
28195 \begin_layout Description
28196 added_space Added space marker color
28199 \begin_layout Description
28200 addedtext Added text color
28203 \begin_layout Description
28204 appendix Appendix marker color
28207 \begin_layout Description
28208 background Background color
28211 \begin_layout Description
28212 bottomarea Bottom area color
28215 \begin_layout Description
28216 branchlabel Label color for branches
28219 \begin_layout Description
28220 buttonbg Color used for button background
28223 \begin_layout Description
28224 buttonhoverbg Color used for button background under focus
28227 \begin_layout Description
28228 buttonframe Color for inset button frames
28231 \begin_layout Description
28232 changebar Changebar color
28235 \begin_layout Description
28236 changedtextauthor1 Changed text color author 1
28239 \begin_layout Description
28240 changedtextauthor2 Changed text color author 2
28243 \begin_layout Description
28244 changedtextauthor3 Changed text color author 3
28247 \begin_layout Description
28248 changedtextauthor4 Changed text color author 4
28251 \begin_layout Description
28252 changedtextauthor5 Changed text color author 5
28255 \begin_layout Description
28256 collapsable_inset_frame Collapsable insets framecolor
28259 \begin_layout Description
28260 collapsable_inset_text Collapsable insets text color
28263 \begin_layout Description
28264 command Text color for command insets
28267 \begin_layout Description
28268 commandbg Background color for command insets
28271 \begin_layout Description
28272 commandframe Frame color for command insets
28275 \begin_layout Description
28276 comment color for comments
28279 \begin_layout Description
28280 commentbg Background color of comments
28283 \begin_layout Description
28284 cursor Cursor color
28287 \begin_layout Description
28288 deletedtext Deleted text color
28291 \begin_layout Description
28292 deletedtextmodifier Deleted text modifying color
28295 \begin_layout Description
28296 depthbar Color for the depth bars in the margin
28299 \begin_layout Description
28300 eolmarker End of line marker color
28303 \begin_layout Description
28304 error Color of the \SpecialChar LaTeX
28308 \begin_layout Description
28309 footlabel Label color for footnotes
28312 \begin_layout Description
28313 graphicsbg Graphics inset background color
28316 \begin_layout Description
28317 greyedout Label color for greyedout insets
28320 \begin_layout Description
28321 greyedoutbg Background color of greyedout inset
28324 \begin_layout Description
28325 greyedouttext Color for greyedout inset text
28328 \begin_layout Description
28329 indexlabel Label color for index insets
28332 \begin_layout Description
28333 ignore The color is ignored
28336 \begin_layout Description
28337 inherit The color is inherited
28340 \begin_layout Description
28341 inlinecompletion Inline completion color
28344 \begin_layout Description
28345 insetbg Inset marker background color
28348 \begin_layout Description
28349 insetframe Inset marker frame color
28352 \begin_layout Description
28353 language Color for marking foreign language words
28356 \begin_layout Description
28357 latex Text color in \SpecialChar LaTeX
28361 \begin_layout Description
28362 listingsbg Background color of listings inset
28365 \begin_layout Description
28366 marginlabel Label color for margin notes
28369 \begin_layout Description
28370 math Math inset text color
28373 \begin_layout Description
28374 mathbg Math inset background color
28377 \begin_layout Description
28378 mathcorners Math inset frame color not under focus
28381 \begin_layout Description
28382 mathframe Math inset frame color under focus
28385 \begin_layout Description
28386 mathline Math line color
28389 \begin_layout Description
28390 mathmacrobg Macro math inset background color
28393 \begin_layout Description
28394 mathmacroblend Macro math blended color
28397 \begin_layout Description
28398 mathmacroframe Macro math frame color
28401 \begin_layout Description
28402 mathmacrohoverbg Macro math inset background color hovered
28405 \begin_layout Description
28406 mathmacrolabel Macro math label color
28409 \begin_layout Description
28410 mathmacronewarg Macro template color for new parameters
28413 \begin_layout Description
28414 mathmacrooldarg Macro template color for old parameters
28417 \begin_layout Description
28418 newpage New page color
28421 \begin_layout Description
28422 nonunique_inlinecompletion Inline completion color for the non-unique part
28425 \begin_layout Description
28426 notebg Background color of notes
28429 \begin_layout Description
28430 notelabel Label color for notes
28433 \begin_layout Description
28434 pagebreak Page break/line break color
28437 \begin_layout Description
28438 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28441 \begin_layout Description
28442 phantomtext Text color for phantom insets
28445 \begin_layout Description
28446 preview The color used for previews
28449 \begin_layout Description
28450 previewframe Preview frame color
28453 \begin_layout Description
28454 regexpframe Color for regexp frame
28457 \begin_layout Description
28458 selection Background color of selected text
28461 \begin_layout Description
28462 selectiontext Foreground color of selected text
28465 \begin_layout Description
28466 shadedbg Background color of shaded box
28469 \begin_layout Description
28470 special Special chars text color
28473 \begin_layout Description
28474 tabularline Table line color
28477 \begin_layout Description
28478 tabularonoffline Table line color
28481 \begin_layout Description
28482 urllabel Label color for URL insets
28485 \begin_layout Description
28486 urltext Color for URL inset text