1 #LyX 2.2 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
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX Configuration Manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX-documentation Customization"
70 \pdf_keywords "LyX, documentation, customization"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen true
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 0
84 \use_package amssymb 0
87 \use_package mathdots 1
88 \use_package mathtools 0
90 \use_package stackrel 0
91 \use_package stmaryrd 0
92 \use_package undertilde 0
94 \cite_engine_type default
98 \paperorientation portrait
102 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
116 \quotes_language english
119 \paperpagestyle headings
120 \tracking_changes true
121 \output_changes false
125 \author 2089657418 "Usti"
131 Customizing \SpecialChar LyX
132 : Features for the Advanced User
136 by the \SpecialChar LyX
141 \begin_layout Plain Layout
143 If you have comments or error corrections, please send them to the \SpecialChar LyX
146 \begin_inset CommandInset href
148 target "lyx-docs@lists.lyx.org"
155 \begin_inset Quotes eld
159 \begin_inset Quotes erd
162 in the subject header, and please cc the current maintainer of this file,
163 Richard Heck <rgheck@comcast.net>.
169 \begin_inset Newline newline
173 \begin_inset Newline newline
179 \begin_layout Standard
180 \begin_inset CommandInset toc
181 LatexCommand tableofcontents
188 \begin_layout Standard
189 \begin_inset Note Note
192 \begin_layout Plain Layout
193 Please use change tracking when modifying this document.
194 This makes it easier for our translators to recognize things that have
195 been changed, and it helps the maintainer keep up-to-date with what's been
204 \begin_layout Chapter
208 \begin_layout Standard
209 This manual covers the customization features present in \SpecialChar LyX
211 In it, we discuss issues like keyboard shortcuts, screen previewing options,
212 printer options, sending commands to \SpecialChar LyX
213 via the \SpecialChar LyX
214 Server, internationalization,
215 installing new \SpecialChar LaTeX
216 classes and \SpecialChar LyX
218 We can't possibly hope to touch on everything you can change—our developers
219 add new features faster than we can document them—but we will explain the
220 most common customizations and hopefully point you in the right direction
221 for some of the more obscure ones.
224 \begin_layout Standard
225 \begin_inset Branch OutDated
228 \begin_layout Standard
229 Information from previous versions of this document that now seems to be
230 outdated is contained in the OutDated branch of this document.
231 By default, this information will not appear in the \SpecialChar LaTeX
240 \begin_layout Chapter
245 \begin_layout Standard
246 This chapter aims to help you to find your way through the \SpecialChar LyX
249 Before continuing to read this chapter, you should find out where your
251 library and user directories are by using
252 \begin_inset Flex Noun
255 \begin_layout Plain Layout
256 Help\SpecialChar menuseparator
267 The library directory is the place where \SpecialChar LyX
268 places its system-wide configuration
269 files; the user directory is where you can place your modified versions.
270 We will call the former
271 \begin_inset Flex Code
274 \begin_layout Plain Layout
281 \begin_inset Flex Noun
284 \begin_layout Plain Layout
290 in the remainder of this document.
294 \begin_layout Section
296 \begin_inset Flex Code
299 \begin_layout Plain Layout
308 \begin_layout Standard
309 \begin_inset Flex Code
312 \begin_layout Plain Layout
318 and its sub-directories contain a number of files and that can be used
319 to customize \SpecialChar LyX
321 You can change many of these files from within \SpecialChar LyX
323 \begin_inset Flex Noun
326 \begin_layout Plain Layout
327 Tools\SpecialChar menuseparator
334 Most customization that you will want to do in \SpecialChar LyX
335 is possible through this
337 However, many other inner aspects of \SpecialChar LyX
338 can be customized by modifying the
340 \begin_inset Flex Code
343 \begin_layout Plain Layout
350 These files fall in different categories, described in the following subsection
354 \begin_layout Subsection
355 Automatically generated files
358 \begin_layout Standard
359 The files, which are to be found in
360 \begin_inset Flex Noun
363 \begin_layout Plain Layout
369 , are generated when you configure \SpecialChar LyX
371 They contain various default values that are guessed by inspection.
372 In general, it is not a good idea to modify them, since they might be overwritt
376 \begin_layout Labeling
377 \labelwidthstring 00.00.0000
378 \begin_inset Flex Code
381 \begin_layout Plain Layout
387 contains defaults for various commands.
390 \begin_layout Labeling
391 \labelwidthstring 00.00.0000
392 \begin_inset Flex Code
395 \begin_layout Plain Layout
401 contains the list of packages that have been recognized by \SpecialChar LyX
403 It is currently unused by the \SpecialChar LyX
404 program itself, but the information extracted,
405 and more, is made available with
406 \begin_inset Flex Noun
409 \begin_layout Plain Layout
410 Help\SpecialChar menuseparator
424 \begin_layout Labeling
425 \labelwidthstring 00.00.0000
426 \begin_inset Flex Code
429 \begin_layout Plain Layout
435 the list of text classes that have been found in your
436 \begin_inset Flex Code
439 \begin_layout Plain Layout
445 directories, along with the associated \SpecialChar LaTeX
446 document class and their description.
449 \begin_layout Labeling
450 \labelwidthstring 00.00.0000
451 \begin_inset Flex Code
454 \begin_layout Plain Layout
460 the list of layout modules found in your
461 \begin_inset Flex Code
464 \begin_layout Plain Layout
473 \begin_layout Labeling
474 \labelwidthstring 00.00.0000
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
484 lists of various sorts of \SpecialChar LaTeX
485 -related files found on your system
488 \begin_layout Labeling
489 \labelwidthstring 00.00.0000
490 \begin_inset Flex Code
493 \begin_layout Plain Layout
494 doc/\SpecialChar LaTeX
500 is automatically generated during configuration from the file
501 \begin_inset Flex Code
504 \begin_layout Plain Layout
512 It contains information on your \SpecialChar LaTeX
516 \begin_layout Subsection
520 \begin_layout Standard
521 These directories are duplicated between
522 \begin_inset Flex Code
525 \begin_layout Plain Layout
532 \begin_inset Flex Code
535 \begin_layout Plain Layout
542 If a particular files exists in both places, the one in
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
555 \begin_layout Labeling
556 \labelwidthstring 00.00.0000
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
566 this directory contains files with the extension
567 \begin_inset Flex Code
570 \begin_layout Plain Layout
576 that define the keybindings used in \SpecialChar LyX
578 If there exists an internationalized version of the bind file named
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , that will be used first.
591 \begin_layout Labeling
592 \labelwidthstring 00.00.0000
593 \begin_inset Flex Code
596 \begin_layout Plain Layout
602 contains graphics files that can be included in documents.
606 \begin_layout Labeling
607 \labelwidthstring 00.00.0000
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
617 contains \SpecialChar LyX
618 documentation files (including the one you are currently reading).
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
630 deserves special attention, as noted above.
631 The internationalized help docs are in subdirectories
632 \begin_inset Flex Code
635 \begin_layout Plain Layout
642 \begin_inset Quotes eld
646 \begin_inset Quotes erd
649 is the ISO language code.
651 \begin_inset CommandInset ref
653 reference "cha:Internationalizing-LyX"
660 \begin_layout Labeling
661 \labelwidthstring 00.00.0000
662 \begin_inset Flex Code
665 \begin_layout Plain Layout
671 contains example files that explain how to use some features.
672 In the file browser, press the
673 \begin_inset Flex Noun
676 \begin_layout Plain Layout
685 \begin_layout Labeling
686 \labelwidthstring 00.00.0000
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
696 contains image files that are used by the
697 \begin_inset Flex Noun
700 \begin_layout Plain Layout
707 In addition, it also contains the individual icons used in the toolbar
708 and the banners that can be shown when \SpecialChar LyX
712 \begin_layout Labeling
713 \labelwidthstring 00.00.0000
714 \begin_inset Flex Code
717 \begin_layout Plain Layout
723 contains keyboard keymapping files.
725 \begin_inset CommandInset ref
727 reference "sec:International-Keymap-Stuff"
734 \begin_layout Labeling
735 \labelwidthstring 00.00.0000
736 \begin_inset Flex Code
739 \begin_layout Plain Layout
745 contains the text class and module files described in
746 \begin_inset CommandInset ref
748 reference "cha:Installing-New-Document"
755 \begin_layout Labeling
756 \labelwidthstring 00.00.0000
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 Python scripts used to convert between \SpecialChar LyX
778 These can be run from the command line if, say, you want to batch-convert
782 \begin_layout Labeling
783 \labelwidthstring 00.00.0000
784 \begin_inset Flex Code
787 \begin_layout Plain Layout
793 contains some files that demonstrate the capabilities of the
794 \begin_inset Flex Noun
797 \begin_layout Plain Layout
808 Also contains some scripts used by \SpecialChar LyX
812 \begin_layout Labeling
813 \labelwidthstring 00.00.0000
814 \begin_inset Flex Code
817 \begin_layout Plain Layout
823 contains the standard \SpecialChar LyX
824 template files described in
825 \begin_inset CommandInset ref
827 reference "subsec:Creating-Templates"
834 \begin_layout Labeling
835 \labelwidthstring 00.00.0000
836 \begin_inset Flex Code
839 \begin_layout Plain Layout
845 contains files with the extension
846 \begin_inset Flex Code
849 \begin_layout Plain Layout
855 that define the user interface to \SpecialChar LyX
857 That is, the files define which items appear in which menus and the items
858 appearing on the toolbar.
861 \begin_layout Subsection
862 Files you don't want to modify
865 \begin_layout Standard
866 These files are used internally by \SpecialChar LyX
867 and you generally do not need to modify
868 them unless you are a developer.
871 \begin_layout Labeling
872 \labelwidthstring 00.00.0000
873 \begin_inset Flex Code
876 \begin_layout Plain Layout
882 this file contains the list of \SpecialChar LyX
884 The contents are displayed with the menu entry
885 \begin_inset Flex Noun
888 \begin_layout Plain Layout
889 Help\SpecialChar menuseparator
902 \begin_layout Labeling
903 \labelwidthstring 00.00.0000
904 \begin_inset Flex Code
907 \begin_layout Plain Layout
913 this is a \SpecialChar LaTeX
914 script used during the configuration process.
918 \begin_layout Labeling
919 \labelwidthstring 00.00.0000
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
929 this is a Python script that is used to re-configure \SpecialChar LyX
931 It creates configuration files in the directory it was run from.
934 \begin_layout Subsection
935 Other files needing a line or two
938 \begin_layout Labeling
939 \labelwidthstring 00.00.0000
940 \begin_inset Flex Code
943 \begin_layout Plain Layout
949 this contains tables describing how different character encodings can be
953 \begin_layout Labeling
954 \labelwidthstring 00.00.0000
955 \begin_inset Flex Code
958 \begin_layout Plain Layout
964 this file contains the templates available to the new
965 \begin_inset Flex Noun
968 \begin_layout Plain Layout
979 \begin_inset CommandInset ref
981 reference "chap:Including-External-Material"
988 \begin_layout Labeling
989 \labelwidthstring 00.00.0000
990 \begin_inset Flex Code
993 \begin_layout Plain Layout
999 this file contains a list of all the languages currently supported by \SpecialChar LyX
1003 \begin_layout Labeling
1004 \labelwidthstring 00.00.0000
1005 \begin_inset Flex Code
1008 \begin_layout Plain Layout
1014 contains information about the supported fonts.
1017 \begin_layout Labeling
1018 \labelwidthstring 00.00.0000
1019 \begin_inset Flex Code
1022 \begin_layout Plain Layout
1028 this file contains translations for internationalized paragraph styles
1030 \begin_inset CommandInset ref
1032 reference "subsec:I18n"
1039 \begin_layout Labeling
1040 \labelwidthstring 00.00.0000
1041 \begin_inset Flex Code
1044 \begin_layout Plain Layout
1050 this file contains information about unicode-encoded glyphs and the way
1051 they are supported by \SpecialChar LyX
1052 via \SpecialChar LaTeX
1056 \begin_layout Section
1057 Your local configuration directory
1060 \begin_layout Standard
1061 Even if you are using \SpecialChar LyX
1062 as an unprivileged user, you might want to change
1064 configuration for your own use.
1066 \begin_inset Flex Code
1069 \begin_layout Plain Layout
1075 directory contains all your personal configuration files.
1076 This is the directory described as
1077 \begin_inset Quotes eld
1081 \begin_inset Quotes erd
1085 \begin_inset Flex Noun
1088 \begin_layout Plain Layout
1089 Help\SpecialChar menuseparator
1091 \begin_inset space ~
1100 This directory is used as a mirror of
1101 \begin_inset Flex Code
1104 \begin_layout Plain Layout
1110 , which means that every file in
1111 \begin_inset Flex Code
1114 \begin_layout Plain Layout
1120 is a replacement for the corresponding file in
1121 \begin_inset Flex Code
1124 \begin_layout Plain Layout
1131 Any configuration file described in the above sections can be placed either
1132 in the system-wide directory, in which case it will affect all users, or
1133 in your local directory for your own use.
1136 \begin_layout Standard
1137 To make things clearer, let's provide a few examples:
1140 \begin_layout Itemize
1141 The preferences set in the
1142 \begin_inset Flex Noun
1145 \begin_layout Plain Layout
1146 Tools\SpecialChar menuseparator
1152 dialog are saved to a file
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1175 \begin_layout Itemize
1176 When you reconfigure using
1177 \begin_inset Flex Noun
1180 \begin_layout Plain Layout
1181 Tools\SpecialChar menuseparator
1189 \begin_inset Flex Code
1192 \begin_layout Plain Layout
1198 script, and the resulting files are written in your local configuration
1200 This means that any additional text class file that you might have added
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1211 will be added to the list of classes in the
1212 \begin_inset Flex Noun
1215 \begin_layout Plain Layout
1216 Document\SpecialChar menuseparator
1225 \begin_layout Itemize
1226 If you get some updated documentation from \SpecialChar LyX
1227 ftp site and cannot install
1228 it because you do not have sysadmin rights on your system, you can just
1230 \begin_inset Flex Code
1233 \begin_layout Plain Layout
1239 and the items in the
1240 \begin_inset Flex Noun
1243 \begin_layout Plain Layout
1249 menu will open them!
1252 \begin_layout Section
1253 Running \SpecialChar LyX
1254 with multiple configurations
1257 \begin_layout Standard
1258 The configuration freedom of the local configuration directory may not suffice
1259 if you want to have more than one configuration at your disposal.
1260 For example, you may want to be use different key bindings or printer settings
1262 You can achieve this by having several such directories.
1263 You then specify which directory to use at run-time.
1266 \begin_layout Standard
1267 Invoking \SpecialChar LyX
1268 with the command line switch
1269 \begin_inset Flex Code
1272 \begin_layout Plain Layout
1282 instructs the program to read the configuration from that directory, and
1283 not from the default directory.
1284 (You can determine the default directory by running \SpecialChar LyX
1286 \begin_inset Flex Code
1289 \begin_layout Plain Layout
1295 switch.) If the specified directory does not exist, \SpecialChar LyX
1297 for you, just like it does for the default directory on the first time
1298 you run the program.
1299 You can modify the configuration options in this additional user directory
1300 exactly as you would for the default directory.
1301 These directories are completely independent (but read on).
1302 Note that setting the environment variable
1303 \begin_inset Flex Code
1306 \begin_layout Plain Layout
1312 to some value has exactly the same effect.
1315 \begin_layout Standard
1316 Having several configurations also requires more maintenance: if you want
1317 to add a new layout to
1318 \begin_inset Flex Code
1321 \begin_layout Plain Layout
1327 which you want available from all your configurations, you must add it
1328 to each directory separately.
1329 You can avoid this with the following trick: after \SpecialChar LyX
1330 creates the additional
1331 directory, most of the subdirectories (see above) are empty.
1332 If you want the new configuration to mirror an existing one, replace the
1333 empty subdirectory with a symbolic link to the matching subdirectory in
1334 the existing configuration.
1336 \begin_inset Flex Code
1339 \begin_layout Plain Layout
1345 subdirectory, however, since it contains a file written by the configuration
1346 script (also accessible through
1347 \begin_inset Flex Noun
1350 \begin_layout Plain Layout
1351 Tools\SpecialChar menuseparator
1357 ) which is configuration-specific.
1360 \begin_layout Chapter
1361 The Preferences dialog
1364 \begin_layout Standard
1365 All options of the preferences dialog are described in the Appendix
1367 The Preferences Dialog
1374 For some options you might find here more details.
1377 \begin_layout Section
1379 \begin_inset CommandInset label
1388 \begin_layout Standard
1389 The first step is to define your file formats if they are not already defined.
1391 \begin_inset Flex Noun
1394 \begin_layout Plain Layout
1395 Tools\SpecialChar menuseparator
1403 \begin_inset Flex Noun
1406 \begin_layout Plain Layout
1407 File Handling\SpecialChar menuseparator
1414 \begin_inset Flex Noun
1417 \begin_layout Plain Layout
1423 button to define your new format.
1425 \begin_inset Flex Noun
1428 \begin_layout Plain Layout
1434 field contains the name used to identify the format in the GUI.
1436 \begin_inset Flex Noun
1439 \begin_layout Plain Layout
1445 is used to identify the format internally.
1446 You will also need to enter a file extension.
1447 These are all required.
1449 \begin_inset Flex Noun
1452 \begin_layout Plain Layout
1458 field is used to provide a keyboard shortcut on the menus.
1459 (For example, pressing
1460 \begin_inset Flex Noun
1463 \begin_layout Plain Layout
1470 \begin_inset Flex Noun
1473 \begin_layout Plain Layout
1474 Document\SpecialChar menuseparator
1475 View (Other Formats)\SpecialChar menuseparator
1484 \begin_layout Standard
1486 \begin_inset Flex Noun
1489 \begin_layout Plain Layout
1496 \begin_inset Flex Noun
1499 \begin_layout Plain Layout
1506 For example, you might want to use
1507 \begin_inset Flex Noun
1510 \begin_layout Plain Layout
1516 to view PostScript files.
1517 You can enter the command needed to start the program in the corresponding
1519 In defining this command, you can use the four variables listed in the
1521 The viewer is launched when you view an image in \SpecialChar LyX
1523 \begin_inset Flex Noun
1526 \begin_layout Plain Layout
1527 Document\SpecialChar menuseparator
1534 The editor is for example launched when you right-click on an image and
1536 \begin_inset Flex Noun
1539 \begin_layout Plain Layout
1545 in the appearing context menu.
1548 \begin_layout Standard
1550 \begin_inset Flex Noun
1553 \begin_layout Plain Layout
1559 type of a format is optional, but if it is specified, it must be unique
1561 It is used to detect files of this format from the file contents.
1562 For some important file formats there is no MIME type officially registered
1564 \begin_inset CommandInset href
1567 target "http://www.iana.org/assignments/media-types/"
1572 Therefore \SpecialChar LyX
1573 uses the extended list of MIME types as specified by
1574 \begin_inset CommandInset href
1576 name "freedesktop.org"
1577 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1584 \begin_layout Standard
1586 \begin_inset Flex Noun
1589 \begin_layout Plain Layout
1595 option tells \SpecialChar LyX
1596 that a format is suitable for document export.
1597 If this is set and if a suitable conversion route exists (see
1598 \begin_inset CommandInset ref
1600 reference "sec:Converters"
1604 ), the format will appear in the
1605 \begin_inset Flex Noun
1608 \begin_layout Plain Layout
1609 File\SpecialChar menuseparator
1616 The format will also appear in the
1617 \begin_inset Flex Noun
1620 \begin_layout Plain Layout
1621 Document\SpecialChar menuseparator
1627 menu if a viewer is specified for the format.
1628 Pure image formats, such as
1629 \begin_inset Flex Code
1632 \begin_layout Plain Layout
1638 , should not use this option.
1639 Formats that can both represent vector graphics and documents like
1640 \begin_inset Flex Code
1643 \begin_layout Plain Layout
1652 \begin_layout Standard
1654 \begin_inset Flex Noun
1657 \begin_layout Plain Layout
1658 Vector graphics format
1663 tells \SpecialChar LyX
1664 that a format can contain vector graphics.
1665 This information is used to determine the target format of included graphics
1667 \begin_inset Flex Noun
1670 \begin_layout Plain Layout
1677 Included graphics may need to be converted to either
1678 \begin_inset Flex Noun
1681 \begin_layout Plain Layout
1688 \begin_inset Flex Noun
1691 \begin_layout Plain Layout
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1708 \begin_inset Flex Noun
1711 \begin_layout Plain Layout
1717 cannot handle other image formats.
1718 If an included graphic is not already in
1719 \begin_inset Flex Noun
1722 \begin_layout Plain Layout
1729 \begin_inset Flex Noun
1732 \begin_layout Plain Layout
1739 \begin_inset Flex Noun
1742 \begin_layout Plain Layout
1748 format, it is converted to
1749 \begin_inset Flex Noun
1752 \begin_layout Plain Layout
1758 if the vector format option is set, and otherwise to
1759 \begin_inset Flex Noun
1762 \begin_layout Plain Layout
1771 \begin_layout Section
1775 \begin_layout Standard
1776 Since all conversions from one format to another take place in \SpecialChar LyX
1778 directory, it is sometimes necessary to modify a file before copying it
1779 to the temporary directory in order that the conversion may be performed.
1783 \begin_layout Plain Layout
1784 For example, the file may refer to other files—images, for example—using
1785 relative file names, and these may become invalid when the file is copied
1786 to the temporary directory.
1791 This is done by a Copier: It copies a file to (or from) the temporary directory
1792 and may modify it in the process.
1795 \begin_layout Standard
1796 The definitions of the copiers may use eight variables:
1799 \begin_layout Labeling
1800 \labelwidthstring 00.00.0000
1801 \begin_inset Flex Code
1804 \begin_layout Plain Layout
1810 The \SpecialChar LyX
1811 system directory (e.
1812 \begin_inset space \thinspace{}
1816 \begin_inset space \space{}
1820 \begin_inset Flex Noun
1823 \begin_layout Plain Layout
1832 \begin_layout Labeling
1833 \labelwidthstring 00.00.0000
1834 \begin_inset Flex Code
1837 \begin_layout Plain Layout
1846 \begin_layout Labeling
1847 \labelwidthstring 00.00.0000
1848 \begin_inset Flex Code
1851 \begin_layout Plain Layout
1860 \begin_layout Labeling
1861 \labelwidthstring 00.00.0000
1862 \begin_inset Flex Code
1865 \begin_layout Plain Layout
1871 The base name (without filename extension) in the \SpecialChar LyX
1875 \begin_layout Labeling
1876 \labelwidthstring 00.00.0000
1877 \begin_inset Flex Code
1880 \begin_layout Plain Layout
1886 The full directory path of the \SpecialChar LyX
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1901 The full pathname to the original \SpecialChar LyX
1902 file being processed
1905 \begin_layout Labeling
1906 \labelwidthstring 00.00.0000
1907 \begin_inset Flex Code
1910 \begin_layout Plain Layout
1916 The filename (without any directory path) of the \SpecialChar LyX
1920 \begin_layout Labeling
1921 \labelwidthstring 00.00.0000
1922 \begin_inset Flex Code
1925 \begin_layout Plain Layout
1931 The `\SpecialChar LaTeX
1935 \begin_layout Standard
1936 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1944 It is relevant only when exporting files suitable for such inclusion.
1947 \begin_layout Standard
1948 Copiers can be used to do almost anything with output files.
1949 For example, suppose you want generated pdf files to be copied to a special
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1961 Then you could write a shell script such as this one:
1964 \begin_layout Standard
1965 \begin_inset listings
1969 \begin_layout Plain Layout
1974 \begin_layout Plain Layout
1979 \begin_layout Plain Layout
1981 TOFILE=`basename $2`
1984 \begin_layout Plain Layout
1986 cp $FROMFILE /home/you/pdf/$TOFILE
1991 Save it in your local \SpecialChar LyX
1993 \begin_inset Flex Code
1996 \begin_layout Plain Layout
1997 /home/you/.lyx/scripts/pdfcopier.sh
2002 —and make it executable, if you need to do so on your platform.
2004 \begin_inset Flex Noun
2007 \begin_layout Plain Layout
2008 Tools\SpecialChar menuseparator
2014 dialog, select under
2015 \begin_inset Flex Noun
2018 \begin_layout Plain Layout
2019 File Handling\SpecialChar menuseparator
2026 \begin_inset Flex Noun
2029 \begin_layout Plain Layout
2035 format—or one of the other pdf formats—and enter
2036 \begin_inset Flex Code
2039 \begin_layout Plain Layout
2040 pdfcopier.sh $$i $$o
2046 \begin_inset Flex Noun
2049 \begin_layout Plain Layout
2059 \begin_layout Standard
2060 Copiers are used by \SpecialChar LyX
2061 in various of its own conversions.
2062 For example, if appropriate programs are found, \SpecialChar LyX
2063 will automatically install
2065 \begin_inset Flex Noun
2068 \begin_layout Plain Layout
2075 \begin_inset Flex Noun
2078 \begin_layout Plain Layout
2080 \begin_inset space ~
2089 When these formats are exported, the copier sees that not just the main
2090 HTML file but various associated files (style files, images, etc.) are also
2092 All these files are written to a subdirectory of the directory in which
2093 the original \SpecialChar LyX
2098 \begin_layout Plain Layout
2099 This copier can be customized.
2101 \begin_inset Quotes eld
2105 \begin_inset Quotes erd
2108 argument takes a comma-separated list of extensions to be copied; if it
2109 is omitted, all files will be copied.
2111 \begin_inset Quotes eld
2115 \begin_inset Quotes erd
2118 argument determines the extension added to the generated directory.
2120 \begin_inset Quotes eld
2124 \begin_inset Flex Noun
2127 \begin_layout Plain Layout
2134 \begin_inset Quotes erd
2137 , so HTML generated from
2138 \begin_inset Flex Noun
2141 \begin_layout Plain Layout
2142 /path/to/filename.lyx
2148 \begin_inset Flex Noun
2151 \begin_layout Plain Layout
2152 /path/to/filename.html.LyXconv
2166 \begin_layout Section
2168 \begin_inset CommandInset label
2170 name "sec:Converters"
2177 \begin_layout Standard
2178 You can define your own Converters to convert files between different formats.
2180 \begin_inset Flex Noun
2183 \begin_layout Plain Layout
2184 Tools\SpecialChar menuseparator
2185 Preferences\SpecialChar menuseparator
2186 File Handling\SpecialChar menuseparator
2195 \begin_layout Standard
2196 To define a new converter, select the
2197 \begin_inset Flex Noun
2200 \begin_layout Plain Layout
2202 \begin_inset space ~
2211 \begin_inset Flex Noun
2214 \begin_layout Plain Layout
2216 \begin_inset space ~
2224 from the drop-down lists, enter the command needed for the conversion,
2226 \begin_inset Flex Noun
2229 \begin_layout Plain Layout
2236 Several variables can be used in the definition of converters:
2239 \begin_layout Labeling
2240 \labelwidthstring 00.00.0000
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2250 The \SpecialChar LyX
2254 \begin_layout Labeling
2255 \labelwidthstring 00.00.0000
2256 \begin_inset Flex Code
2259 \begin_layout Plain Layout
2268 \begin_layout Labeling
2269 \labelwidthstring 00.00.0000
2270 \begin_inset Flex Code
2273 \begin_layout Plain Layout
2282 \begin_layout Labeling
2283 \labelwidthstring 00.00.0000
2284 \begin_inset Flex Code
2287 \begin_layout Plain Layout
2293 The base filename of the input file (i.
2294 \begin_inset space \thinspace{}
2297 g., without the extension)
2300 \begin_layout Labeling
2301 \labelwidthstring 00.00.0000
2302 \begin_inset Flex Code
2305 \begin_layout Plain Layout
2311 The path to the input file
2314 \begin_layout Labeling
2315 \labelwidthstring 00.00.0000
2316 \begin_inset Flex Code
2319 \begin_layout Plain Layout
2325 The path to the original input file (this is different from $$p when a
2326 chain of converters is called)
2329 \begin_layout Labeling
2330 \labelwidthstring 00.00.0000
2331 \begin_inset Flex Code
2334 \begin_layout Plain Layout
2340 The iconv name for the encoding of the document.
2343 \begin_layout Standard
2345 \begin_inset Flex Noun
2348 \begin_layout Plain Layout
2350 \begin_inset space ~
2358 field you can enter the following flags, separated by commas:
2361 \begin_layout Labeling
2362 \labelwidthstring 00.00.0000
2363 \begin_inset Flex Code
2366 \begin_layout Plain Layout
2372 This converter runs some form of \SpecialChar LaTeX
2374 This will make \SpecialChar LyX
2375 's \SpecialChar LaTeX
2376 error logs available.
2379 \begin_layout Labeling
2380 \labelwidthstring 00.00.0000
2381 \begin_inset Flex Code
2384 \begin_layout Plain Layout
2390 Needs the \SpecialChar LaTeX
2392 \begin_inset Flex Noun
2395 \begin_layout Plain Layout
2401 file for the conversion.
2404 \begin_layout Labeling
2405 \labelwidthstring 00.00.0000
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2416 \begin_inset Quotes eld
2420 \begin_inset Quotes erd
2423 file from the backend, which in practice means a \SpecialChar LaTeX
2424 file like the one we
2425 would export, without
2426 \begin_inset Flex Code
2429 \begin_layout Plain Layout
2438 \begin_layout Labeling
2439 \labelwidthstring 00.00.0000
2440 \begin_inset Flex Code
2443 \begin_layout Plain Layout
2452 \begin_layout Standard
2453 The following three flags are not really flags at all because they take
2455 \begin_inset Flex Noun
2458 \begin_layout Plain Layout
2460 \begin_inset space ~
2464 \begin_inset space ~
2475 \begin_layout Labeling
2476 \labelwidthstring 00.00.0000
2477 \begin_inset Flex Code
2480 \begin_layout Plain Layout
2486 If set, the converter's standard error will be redirected to a file
2487 \begin_inset Flex Code
2490 \begin_layout Plain Layout
2496 , and the script given as argument will be run as:
2497 \begin_inset Flex Code
2500 \begin_layout Plain Layout
2501 script < infile.out > infile.log
2507 The argument may contain
2508 \begin_inset Flex Code
2511 \begin_layout Plain Layout
2520 \begin_layout Labeling
2521 \labelwidthstring 00.00.0000
2522 \begin_inset Flex Code
2525 \begin_layout Plain Layout
2531 The name of the directory in which the converter will dump the generated
2534 will not create this directory, and it does not copy anything into it,
2535 though it will copy this directory to the destination.
2536 The argument may contain
2537 \begin_inset Flex Code
2540 \begin_layout Plain Layout
2546 , which will be replaced by the base name of the input and output files,
2547 respectively, when the directory is copied.
2548 \begin_inset Newline newline
2551 Note that resultdir and usetempdir make no sense together.
2552 The latter will be ignored if the former is given.
2555 \begin_layout Labeling
2556 \labelwidthstring 00.00.0000
2557 \begin_inset Flex Code
2560 \begin_layout Plain Layout
2566 Determines the output file name and may, contain
2567 \begin_inset Flex Code
2570 \begin_layout Plain Layout
2577 Sensible only with resultdir and optional even then; if not given, it defaults
2581 \begin_layout Standard
2582 None of these last three are presently used in any of the converters that
2583 are installed with \SpecialChar LyX
2588 \begin_layout Standard
2589 You do not have to define converters for all formats between which you want
2591 For example, you will note that there is no `\SpecialChar LyX
2592 to PostScript' converter,
2593 but \SpecialChar LyX
2594 will export PostScript.
2595 It does so by first creating a \SpecialChar LaTeX
2596 file (no converter needs to be defined
2597 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2599 and finally converting the resulting DVI file to PostScript.
2601 finds such `chains' of converters automatically, and it will always choose
2602 the shortest possible chain.
2603 You can, though, still define multiple conversion methods between file
2605 For example, the standard \SpecialChar LyX
2606 configuration provides five ways to convert
2611 \begin_layout Enumerate
2613 \begin_inset Flex Noun
2616 \begin_layout Plain Layout
2625 \begin_layout Enumerate
2626 via (DVI and) PostScript, using
2627 \begin_inset Flex Noun
2630 \begin_layout Plain Layout
2639 \begin_layout Enumerate
2641 \begin_inset Flex Noun
2644 \begin_layout Plain Layout
2653 \begin_layout Enumerate
2655 \begin_inset Flex Noun
2658 \begin_layout Plain Layout
2668 \begin_layout Enumerate
2670 \begin_inset Flex Noun
2673 \begin_layout Plain Layout
2683 \begin_layout Standard
2684 To define such alternate chains, you must define multiple target `file formats',
2686 \begin_inset CommandInset ref
2688 reference "sec:Formats"
2693 For example, in the standard configuration, the formats named
2694 \begin_inset Flex Noun
2697 \begin_layout Plain Layout
2704 \begin_inset Flex Noun
2707 \begin_layout Plain Layout
2714 \begin_inset Flex Noun
2717 \begin_layout Plain Layout
2724 \begin_inset Flex Noun
2727 \begin_layout Plain Layout
2734 \begin_inset Flex Noun
2737 \begin_layout Plain Layout
2744 \begin_inset Flex Noun
2747 \begin_layout Plain Layout
2754 \begin_inset Flex Noun
2757 \begin_layout Plain Layout
2764 \begin_inset Flex Noun
2767 \begin_layout Plain Layout
2775 \begin_inset Flex Noun
2778 \begin_layout Plain Layout
2785 \begin_inset Flex Noun
2788 \begin_layout Plain Layout
2795 ) are defined, all of which share the extension
2796 \begin_inset Flex Noun
2799 \begin_layout Plain Layout
2805 , and which correspond to the conversion methods just mentioned.
2808 \begin_layout Chapter
2809 Internationalizing \SpecialChar LyX
2811 \begin_inset CommandInset label
2813 name "cha:Internationalizing-LyX"
2820 \begin_layout Standard
2822 supports using a translated interface.
2823 Last time we checked, \SpecialChar LyX
2824 provided text in thirty languages.
2825 The language of choice is called your
2830 (For further reading on locale settings, see also the documentation for
2831 locale that comes with your operating system.
2832 For Linux, the manual page for
2833 \begin_inset Flex Code
2836 \begin_layout Plain Layout
2842 could be a good place to start).
2845 \begin_layout Standard
2846 Notice that these translations will work, but do contain a few flaws.
2847 In particular, all dialogs have been designed with the English text in
2848 mind, which means that some of the translated text will be too large to
2849 fit within the space allocated.
2850 This is only a display problem and will not cause any harm.
2851 Also, you will find that some of the translations do not define shortcut
2852 keys for everything.
2853 Sometimes, there are simply not enough free letters to do it.
2854 Other times, the translator just hasn't got around to doing it yet.
2855 Our localization team, which you may wish to join,
2859 \begin_layout Plain Layout
2860 If you are a fluent speaker of a language other than English, joining these
2861 teams is a great way to give back to the \SpecialChar LyX
2867 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2871 \begin_layout Section
2872 Translating \SpecialChar LyX
2876 \begin_layout Subsection
2877 Translating the graphical user interface (text messages).
2880 \begin_layout Standard
2883 \begin_inset Flex Code
2886 \begin_layout Plain Layout
2892 library to handle the internationalization of the interface.
2893 To have \SpecialChar LyX
2894 speak your favorite language in all menus and dialogs, you need
2896 \begin_inset Flex Code
2899 \begin_layout Plain Layout
2905 -file for that language.
2906 When this is available, you'll have to generate a
2907 \begin_inset Flex Code
2910 \begin_layout Plain Layout
2916 -file from it and install the
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2927 The process of doing all of this is explained in the documentation for
2929 \begin_inset Flex Code
2932 \begin_layout Plain Layout
2939 It is possible to do this just for yourself, but if you're going to do
2940 it, you might as well share the results of your labors with the rest of
2941 the \SpecialChar LyX
2943 Send a message to the \SpecialChar LyX
2944 developers' list for more information about how
2948 \begin_layout Standard
2949 In short, this is what you should do (xx denotes the language code):
2952 \begin_layout Itemize
2953 Check out the \SpecialChar LyX
2956 \begin_inset CommandInset href
2958 name "information on the web"
2959 target "http://www.lyx.org/HowToUseGIT"
2966 \begin_layout Itemize
2968 \begin_inset Flex Code
2971 \begin_layout Plain Layout
2977 to the folder of the
2978 \begin_inset Flex Code
2981 \begin_layout Plain Layout
2989 \begin_inset Flex Code
2992 \begin_layout Plain Layout
3000 \begin_inset Flex Code
3003 \begin_layout Plain Layout
3009 doesn't exist anywhere, it can be remade with the console command
3010 \begin_inset Flex Code
3013 \begin_layout Plain Layout
3019 in that directory, or you can use an existing po-file for some other language
3023 \begin_layout Itemize
3025 \begin_inset Flex Code
3028 \begin_layout Plain Layout
3038 \begin_layout Plain Layout
3039 This is just a text file, so it can be edited in any text editor.
3040 But there are also specialized programs that support such editing, such
3045 (for all platforms) or
3054 contains a `mode' for editing
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3065 \begin_inset Flex URL
3068 \begin_layout Plain Layout
3070 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3082 For some menu- and widget-labels, there are also shortcut keys that should
3084 Those keys are marked after a `|', and should be translated according to
3085 the words and phrases of the language.
3086 You should also fill also out the information at the beginning of the new
3088 \begin_inset Flex Code
3091 \begin_layout Plain Layout
3097 -file with your email-address, etc., so people know where to reach you with
3098 suggestions and entertaining flames.
3101 \begin_layout Standard
3102 If you are just doing this on your own, then:
3105 \begin_layout Itemize
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3117 This can be done with
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3122 msgfmt -o xx.mo < xx.po
3130 \begin_layout Itemize
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3141 -file to your locale-tree, at the correct directory for application messages
3146 xx, and under the name
3147 \begin_inset Flex Code
3150 \begin_layout Plain Layout
3157 \begin_inset space \thinspace{}
3161 \begin_inset space \space{}
3165 \begin_inset Flex Code
3168 \begin_layout Plain Layout
3169 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3179 \begin_layout Standard
3180 As said, however, it would be best if the new
3181 \begin_inset Flex Code
3184 \begin_layout Plain Layout
3190 file could be added to the \SpecialChar LyX
3191 distribution, so others can use it.
3192 Adding it involves making additional changes to \SpecialChar LyX
3194 So send an email to the developers' mailing list if you're interested in
3198 \begin_layout Subsubsection
3202 \begin_layout Standard
3203 Sometimes it turns out that one English message needs to be translated into
3204 different messages in the target language.
3205 One example is the message
3206 \begin_inset Flex Code
3209 \begin_layout Plain Layout
3215 which has the German translation
3223 , depending upon exactly what the English
3224 \begin_inset Quotes eld
3228 \begin_inset Quotes erd
3233 \begin_inset Flex Code
3236 \begin_layout Plain Layout
3242 does not handle such ambiguous translations.
3243 Therefore you have to add some context information to the message: Instead
3245 \begin_inset Flex Code
3248 \begin_layout Plain Layout
3255 \begin_inset Flex Code
3258 \begin_layout Plain Layout
3259 To[[as in 'From format x to format y']]
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3269 To[[as in 'From page x to page y']].
3274 Now the two occurrences of
3275 \begin_inset Flex Code
3278 \begin_layout Plain Layout
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3294 and can be translated correctly to
3305 \begin_layout Standard
3306 Of course the context information needs to be stripped off the original
3307 message when no translation is used.
3308 Therefore you have to put it in double square brackets at the end of the
3309 message (see the example above).
3310 The translation mechanism of \SpecialChar LyX
3311 ensures that everything in double square
3312 brackets at the end of messages is removed before displaying the message.
3315 \begin_layout Subsection
3316 Translating the documentation.
3319 \begin_layout Standard
3320 The online documentation (in the
3321 \begin_inset Flex Noun
3324 \begin_layout Plain Layout
3330 -menu) can (and should!) be translated.
3331 If there are translated versions of the documentation available
3335 \begin_layout Plain Layout
3336 As of March 2008, at least some of the documents have been translated into
3337 fourteen languages, with the Tutorial available in a few more.
3342 and the locale is set accordingly, these will be used automagically by
3346 looks for translated versions as
3347 \begin_inset Flex Code
3350 \begin_layout Plain Layout
3351 LyXDir/doc/xx/DocName.lyx
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3366 is the code for the language currently in use.
3367 If there are no translated documents, the default English versions will
3369 Note that the translated versions must have the same filenames (
3370 \begin_inset Flex Code
3373 \begin_layout Plain Layout
3379 above) as the original.
3380 If you feel up to translating the documentation (an excellent way to proof-read
3381 the original documentation by the way!), there are a few things you should
3385 \begin_layout Itemize
3386 Check out the documentation translation web page at
3387 \begin_inset CommandInset href
3389 name "http://www.lyx.org/Translation"
3390 target "http://www.lyx.org/Translation"
3395 That way, you can find out which (if any) documents have already been translate
3396 d into your language.
3397 You can also find out who (if anyone) is organizing the effort to translate
3398 the documentation into your language.
3399 If no one is organizing the effort, please let us know that you're interested.
3402 \begin_layout Standard
3403 Once you get to actually translating, here's a few hints for you that may
3407 \begin_layout Itemize
3408 Join the documentation team! There is information on how to do that in
3409 \begin_inset Flex Code
3412 \begin_layout Plain Layout
3419 \begin_inset Flex Noun
3422 \begin_layout Plain Layout
3423 Help\SpecialChar menuseparator
3429 ), which by the way is the first document you should translate.
3432 \begin_layout Itemize
3433 Learn the typographic conventions for the language you are translating to.
3434 Typography is an ancient art and over the centuries, a great variety of
3435 conventions have developed throughout different parts of the world.
3436 Also study the professional terminology amongst typographers in your country.
3437 Inventing your own terminology will only confuse the users.
3440 (Warning! Typography is addictive!)
3443 \begin_layout Itemize
3444 Make a copy of the document.
3445 This will be your working copy.
3446 You can use this as your personal translated help-file by placing it in
3448 \begin_inset Flex Code
3451 \begin_layout Plain Layout
3458 \begin_inset Note Greyedout
3461 \begin_layout Plain Layout
3466 For a complex document with external material (images, etc.), if you make
3468 \begin_inset space \thinspace{}
3472 \begin_inset space \space{}
3475 in a temp dir, beware that the links to external material may be broken
3476 when the document is moved to a different place.
3477 The best way is to retrieve the \SpecialChar LyX
3479 \begin_inset Flex URL
3482 \begin_layout Plain Layout
3484 http://www.lyx.org/HowToUseGIT
3489 ) and to edit the doc file in place.
3497 \begin_layout Itemize
3498 Sometimes the original document (from the \SpecialChar LyX
3499 team) will be updated.
3500 Use the source viewer at
3501 \begin_inset CommandInset href
3503 name "http://www.lyx.org/trac/timeline"
3504 target "http://www.lyx.org/trac/timeline"
3508 to see what has been changed.
3509 That way you can easily see which parts of the translated document need
3513 \begin_layout Standard
3514 If you ever find an error in the original document, fix it and notify the
3515 rest of the documentation team of the changes! (You didn't forget to join
3516 the documentation team, did you?)
3519 \begin_layout Standard
3520 \begin_inset Branch OutDated
3523 \begin_layout Section
3524 International Keyboard Support
3527 \begin_layout Standard
3530 [Editor's Note: The following section is by
3538 It needs to be fixed to conform to the new Documentation Style sheet and
3539 to make use of the new v1.0 features.
3540 The whole thing also needs to be merged with the section following it.-jw
3541 It may also be badly out of date.-rh (2008)]
3544 \begin_layout Subsection
3545 Defining Own Keymaps: Keymap File Format
3548 \begin_layout Standard
3549 Let's look at a keyboard definition file a little closer.
3550 It is a plain text file defining
3553 \begin_layout Itemize
3554 key-to-key or key-to-string translations
3557 \begin_layout Itemize
3561 \begin_layout Itemize
3562 dead keys exceptions
3565 \begin_layout Standard
3566 To define key-to-key or key-to-string translation, use this command:
3569 \begin_layout Quotation
3570 \begin_inset Flex Code
3573 \begin_layout Plain Layout
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3594 \begin_layout Standard
3596 \begin_inset Flex Code
3599 \begin_layout Plain Layout
3605 is the key to be translated and
3606 \begin_inset Flex Code
3609 \begin_layout Plain Layout
3615 is the string to be inserted into the document.
3616 To define dead keys, use:
3619 \begin_layout Quotation
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3632 \begin_inset Flex Code
3635 \begin_layout Plain Layout
3644 \begin_layout Standard
3646 \begin_inset Flex Code
3649 \begin_layout Plain Layout
3655 is a keyboard key and
3656 \begin_inset Flex Code
3659 \begin_layout Plain Layout
3666 The following dead keys are supported (shortcut name is in parentheses):
3669 \begin_layout Quotation
3673 \begin_inset space \hfill{}
3679 \begin_layout Quotation
3681 \begin_inset space \hfill{}
3687 \begin_layout Quotation
3689 \begin_inset space \hfill{}
3695 \begin_layout Quotation
3697 \begin_inset space \hfill{}
3703 \begin_layout Quotation
3705 \begin_inset space \hfill{}
3711 \begin_layout Quotation
3713 \begin_inset space \hfill{}
3720 \begin_layout Plain Layout
3732 \begin_layout Quotation
3734 \begin_inset space \hfill{}
3740 \begin_layout Quotation
3742 \begin_inset space \hfill{}
3749 \begin_layout Plain Layout
3761 \begin_layout Quotation
3763 \begin_inset space \hfill{}
3769 \begin_layout Quotation
3771 \begin_inset space \hfill{}
3777 \begin_layout Quotation
3779 \begin_inset space \hfill{}
3786 \begin_layout Plain Layout
3798 \begin_layout Quotation
3800 \begin_inset space \hfill{}
3807 \begin_layout Plain Layout
3819 \begin_layout Quotation
3821 \begin_inset space \hfill{}
3827 \begin_layout Quotation
3828 hungarian umlaut (hug)
3829 \begin_inset space \hfill{}
3835 \begin_layout Quotation
3837 \begin_inset space \hfill{}
3843 \begin_layout Quotation
3845 \begin_inset space \hfill{}
3852 \begin_layout Plain Layout
3864 \begin_layout Standard
3865 Since in many international keyboards there are exceptions to what some
3866 dead keys should do, you can define them using
3869 \begin_layout Quotation
3870 \begin_inset Flex Code
3873 \begin_layout Plain Layout
3881 deadkey key outstring
3884 \begin_layout Standard
3885 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3889 \begin_layout Quotation
3890 \begin_inset Flex Code
3893 \begin_layout Plain Layout
3906 \begin_layout Standard
3907 to make it work correctly.
3908 Also, you have to define as exceptions dead keys over i and j, to remove
3909 the dot from them before inserting an accent mark.
3910 I will change this when the time comes, but so far I haven't had time.
3913 \begin_layout Standard
3914 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3917 \begin_inset Flex Code
3920 \begin_layout Plain Layout
3926 have different meaning.
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3937 marks comments, quotes start and end \SpecialChar LaTeX
3939 To enter quote, you'll need to use
3940 \begin_inset Flex Code
3943 \begin_layout Plain Layout
3952 \begin_inset Flex Code
3955 \begin_layout Plain Layout
3962 \begin_inset Flex Code
3965 \begin_layout Plain Layout
3976 \begin_layout Standard
3977 If you make a keyboard description file that works for your language, please
3978 mail it to me, so I can include it in the next keymap distribution.
3981 \begin_layout Standard
3982 More keywords will be supported in keymap configuration file in future,
3986 \begin_layout Itemize
3987 \begin_inset Flex Code
3990 \begin_layout Plain Layout
4001 \begin_inset space \hfill{}
4005 \begin_inset Flex Code
4008 \begin_layout Plain Layout
4017 \begin_layout Itemize
4018 \begin_inset Flex Code
4021 \begin_layout Plain Layout
4032 \begin_inset space \hfill{}
4036 \begin_inset Flex Code
4039 \begin_layout Plain Layout
4045 an external keymap translation program
4048 \begin_layout Standard
4049 Also, it should look into
4050 \begin_inset Flex Code
4053 \begin_layout Plain Layout
4059 file for defaults, too (for example, a
4060 \begin_inset Flex Code
4063 \begin_layout Plain Layout
4071 option to include default keyboard).
4079 \begin_layout Section
4080 International Keymap Stuff
4081 \begin_inset CommandInset label
4083 name "sec:International-Keymap-Stuff"
4090 \begin_layout Standard
4091 \begin_inset Note Note
4094 \begin_layout Plain Layout
4095 In doing the revisions on this document in March 2008, I did not look over
4096 this stuff, as I do not understand it.
4097 It would be good if someone else could do so.
4106 \begin_layout Standard
4107 The next two sections describe the
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4120 \begin_inset Flex Code
4123 \begin_layout Plain Layout
4131 file syntax in detail.
4132 These sections should help you design your own key map if the ones provided
4133 do not meet your needs.
4136 \begin_layout Subsection
4140 \begin_layout Standard
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4153 file maps keystrokes to characters or strings.
4154 As the name suggests, it sets a keyboard mapping.
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4170 \begin_inset Flex Code
4173 \begin_layout Plain Layout
4188 \begin_inset Flex Code
4191 \begin_layout Plain Layout
4204 \begin_inset Flex Code
4207 \begin_layout Plain Layout
4216 \begin_inset Flex Code
4219 \begin_layout Plain Layout
4227 are described in this section.
4230 \begin_layout Labeling
4231 \labelwidthstring 00.00.0000
4232 \begin_inset Flex Code
4235 \begin_layout Plain Layout
4243 Map a character to a string
4246 \begin_layout LyX-Code
4261 \begin_layout Standard
4294 the double-quote (")
4311 must be escaped with a preceding backslash (
4322 \begin_layout Standard
4324 \begin_inset Flex Noun
4327 \begin_layout Plain Layout
4335 statement to cause the symbol
4336 \begin_inset Flex Noun
4339 \begin_layout Plain Layout
4347 to be output for the keystroke
4348 \begin_inset Flex Noun
4351 \begin_layout Plain Layout
4362 \begin_layout LyX-Code
4368 \begin_layout Labeling
4369 \labelwidthstring 00.00.0000
4370 \begin_inset Flex Code
4373 \begin_layout Plain Layout
4381 Specify an accent character
4384 \begin_layout LyX-Code
4393 \begin_layout Standard
4394 This will make the cha
4432 This is the dead key
4436 \begin_layout Plain Layout
4443 refers to a key that does not produce a character by itself, but when followed
4444 with another key, produces the desired accent character.
4445 For example, a German characte
4447 r with an umlaut like
4457 can be produced in this manner.
4466 \begin_layout Standard
4479 and then another key not in
4496 followed by the other, not allowed key, as output.
4500 \begin_inset Flex Noun
4503 \begin_layout Plain Layout
4511 cancels a dead key, so if
4522 \begin_inset Flex Noun
4525 \begin_layout Plain Layout
4534 , the cursor will not go one position backwards but will instead cancel
4550 might have had on the next keystroke.
4554 \begin_layout Standard
4555 The following example specifies that the character ' is to be an acute accent,
4556 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4559 \begin_layout LyX-Code
4562 kmod ' acute aeiouAEIOU
4565 \begin_layout Labeling
4566 \labelwidthstring 00.00.0000
4567 \begin_inset Flex Code
4570 \begin_layout Plain Layout
4576 Specify an exception to the accent character
4579 \begin_layout LyX-Code
4588 \begin_layout Standard
4589 This defines an exce
4630 have been assigned a keystroke with a previous
4633 \begin_inset Flex Code
4636 \begin_layout Plain Layout
4660 must not belong in the
4707 If such a declaration does not exist in
4715 \begin_inset Flex Code
4718 \begin_layout Plain Layout
4752 \begin_inset Flex Code
4755 \begin_layout Plain Layout
4769 \begin_layout Standard
4770 The following command produces causes äi to be produced when you enter acute-i
4774 \begin_layout LyX-Code
4788 \begin_layout Labeling
4789 \labelwidthstring 00.00.0000
4790 \begin_inset Flex Code
4793 \begin_layout Plain Layout
4799 Combine two accent characters
4802 \begin_layout LyX-Code
4808 accent1 accent2 allowed
4811 \begin_layout Standard
4812 This one is getting pretty esoteric.
4813 It allows you to combine the effect
4869 \begin_inset Flex Code
4872 \begin_layout Plain Layout
4900 \begin_layout Standard
4901 Consider this example from the
4902 \begin_inset Flex Code
4905 \begin_layout Plain Layout
4916 \begin_layout LyX-Code
4919 kmod ; acute aeioyvhAEIOYVH
4923 kcomb acute umlaut iyIY
4926 \begin_layout Standard
4927 This allows you to press
4928 \begin_inset Flex Noun
4931 \begin_layout Plain Layout
4939 and get the effect of
4940 \begin_inset Flex Code
4943 \begin_layout Plain Layout
4962 in this case cancels the last dead key, so if you press
4963 \begin_inset Flex Noun
4966 \begin_layout Plain Layout
4975 \begin_inset Flex Code
4978 \begin_layout Plain Layout
4991 \begin_layout Subsection
4995 \begin_layout Standard
4997 \begin_inset Flex Code
5000 \begin_layout Plain Layout
5008 mapping is performed, a
5009 \begin_inset Flex Code
5012 \begin_layout Plain Layout
5022 file maps the strings that the symbols generate to characters in the current
5024 The \SpecialChar LyX
5025 distribution currently includes at least the
5026 \begin_inset Flex Code
5029 \begin_layout Plain Layout
5038 \begin_inset Flex Code
5041 \begin_layout Plain Layout
5052 \begin_layout Standard
5054 \begin_inset Flex Code
5057 \begin_layout Plain Layout
5065 file is a sequence of declarations of the form
5068 \begin_layout LyX-Code
5081 \begin_layout Standard
5082 For example, in order to map
5083 \begin_inset Flex Noun
5086 \begin_layout Plain Layout
5096 to the corresponding character in the iso-8859-1 set (233), the following
5100 \begin_layout LyX-Code
5108 \begin_layout Standard
5110 \begin_inset Flex Code
5113 \begin_layout Plain Layout
5122 \begin_inset Flex Code
5125 \begin_layout Plain Layout
5143 the same character can apply to more than one string.
5145 \begin_inset Flex Code
5148 \begin_layout Plain Layout
5159 \begin_layout LyX-Code
5171 \begin_inset Newline newline
5187 \begin_layout Standard
5189 cannot find a mapping for the string produced by the keystroke or a
5190 deadkey sequence, it will check if it looks like an accented char and try
5191 to draw an accent over the character on screen.
5194 \begin_layout Subsection
5198 \begin_layout Standard
5199 There is a second way to add support for international characters through
5200 so-called dead-keys.
5201 A dead-key works in combination with a letter to produce an accented character.
5202 Here, we'll explain how to create a really simple dead-key to illustrate
5206 \begin_layout Standard
5207 Suppose you happen to need the circumflex character,
5208 \begin_inset Quotes eld
5212 \begin_inset Quotes erd
5217 \begin_inset Flex Noun
5220 \begin_layout Plain Layout
5227 \begin_inset space ~
5231 \begin_inset Flex Noun
5234 \begin_layout Plain Layout
5240 ] to the \SpecialChar LyX
5242 \begin_inset Flex Code
5245 \begin_layout Plain Layout
5252 \begin_inset Flex Code
5255 \begin_layout Plain Layout
5262 Now, whenever you type the
5263 \begin_inset Flex Noun
5266 \begin_layout Plain Layout
5272 -key followed by a letter, that letter will have a circumflex accent on
5274 For example, the sequence
5275 \begin_inset Quotes eld
5279 \begin_inset Flex Noun
5282 \begin_layout Plain Layout
5289 \begin_inset Quotes erd
5292 produces the letter:
5293 \begin_inset Quotes eld
5297 \begin_inset Quotes erd
5301 If you tried to type
5302 \begin_inset Quotes eld
5306 \begin_inset Flex Noun
5309 \begin_layout Plain Layout
5316 \begin_inset Quotes erd
5319 , however, \SpecialChar LyX
5320 will complain with a beep, since a
5321 \begin_inset Quotes eld
5325 \begin_inset Flex Noun
5328 \begin_layout Plain Layout
5335 \begin_inset Quotes erd
5338 never takes a circumflex accent.
5340 \begin_inset Flex Noun
5343 \begin_layout Plain Layout
5349 after a dead-key produces the bare-accent.
5350 Please note this last point! If you bind a key to a dead-key, you'll need
5351 to rebind the character on that key to yet another key.
5353 \begin_inset Flex Noun
5356 \begin_layout Plain Layout
5362 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5365 \begin_layout Standard
5366 One common way to bind dead-keys is to use
5367 \begin_inset Flex Noun
5370 \begin_layout Plain Layout
5377 \begin_inset Flex Noun
5380 \begin_layout Plain Layout
5387 \begin_inset Flex Noun
5390 \begin_layout Plain Layout
5396 in combination with an accent, like
5397 \begin_inset Quotes eld
5401 \begin_inset Flex Noun
5404 \begin_layout Plain Layout
5411 \begin_inset Quotes erd
5415 \begin_inset Quotes eld
5419 \begin_inset Flex Noun
5422 \begin_layout Plain Layout
5429 \begin_inset Quotes erd
5433 \begin_inset Quotes eld
5437 \begin_inset Flex Noun
5440 \begin_layout Plain Layout
5447 \begin_inset Quotes erd
5451 Another way involves using
5452 \begin_inset Flex Code
5455 \begin_layout Plain Layout
5462 \begin_inset Flex Code
5465 \begin_layout Plain Layout
5471 to set up the special
5472 \begin_inset Flex Code
5475 \begin_layout Plain Layout
5483 \begin_inset Flex Code
5486 \begin_layout Plain Layout
5492 acts in some ways just like
5493 \begin_inset Flex Noun
5496 \begin_layout Plain Layout
5502 and permits you to bind keys to accented characters.
5503 You can also turn keys into dead-keys by binding them to something like
5505 \begin_inset Flex Code
5508 \begin_layout Plain Layout
5514 and then binding this symbolic key to the corresponding \SpecialChar LyX
5519 \begin_layout Plain Layout
5524 : This is exactly what I do in my
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5535 \begin_inset Flex Code
5538 \begin_layout Plain Layout
5546 \begin_inset Flex Noun
5549 \begin_layout Plain Layout
5551 \begin_inset space ~
5560 \begin_inset Flex Code
5563 \begin_layout Plain Layout
5569 and a bunch of these
5570 \begin_inset Quotes eld
5574 \begin_inset Flex Code
5577 \begin_layout Plain Layout
5584 \begin_inset Quotes erd
5587 symbolic keys bound such things as
5588 \begin_inset Flex Noun
5591 \begin_layout Plain Layout
5593 \begin_inset space ~
5602 \begin_inset Flex Noun
5605 \begin_layout Plain Layout
5607 \begin_inset space ~
5616 This is how I produce my accented characters.
5621 You can make just about anything into the
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5632 \begin_inset Flex Noun
5635 \begin_layout Plain Layout
5641 keys, a spare function key, etc.
5642 As for the \SpecialChar LyX
5643 commands that produce accents, check the entry for
5644 \begin_inset Flex Code
5647 \begin_layout Plain Layout
5658 You'll find the complete list there.
5661 \begin_layout Subsection
5662 Saving your Language Configuration
5665 \begin_layout Standard
5666 You can edit your preferences so that your desired language environment
5667 is automatically configured when \SpecialChar LyX
5669 \begin_inset Flex Noun
5672 \begin_layout Plain Layout
5673 Edit\SpecialChar menuseparator
5682 \begin_layout Chapter
5683 Installing New Document Classes, Layouts, and Templates
5684 \begin_inset CommandInset label
5686 name "cha:Installing-New-Document"
5691 \begin_inset Argument 1
5694 \begin_layout Plain Layout
5695 Installing New Document Classes
5703 \begin_layout Standard
5704 In this chapter, we describe the procedures for creating and installing
5705 new \SpecialChar LyX
5706 layout and template files, as well as offer a refresher on correctly
5707 installing new \SpecialChar LaTeX
5712 \begin_layout Standard
5713 First, let us a say a few words about how one ought to think about the relation
5714 between \SpecialChar LyX
5715 and \SpecialChar LaTeX
5717 The thing to understand is that, in a certain sense, \SpecialChar LyX
5718 doesn't know anything
5719 about \SpecialChar LaTeX
5721 Indeed, from \SpecialChar LyX
5722 's point of view, \SpecialChar LaTeX
5723 is just one of several
5724 \begin_inset Quotes eld
5728 \begin_inset Quotes erd
5731 in which it is capable of producing output.
5732 Other such formats are DocBook, plaintext, and XHTML.
5734 is, of course, a particularly important format, but very little of the
5735 information \SpecialChar LyX
5736 has about \SpecialChar LaTeX
5737 is actually contained in the program itself.
5741 \begin_layout Plain Layout
5742 Some commands are sufficiently complex that they are
5743 \begin_inset Quotes eld
5747 \begin_inset Quotes erd
5750 into \SpecialChar LyX
5752 But the developers generally regard this as a Bad Thing.
5757 Rather, that information, even for the standard classes like
5758 \begin_inset Flex Code
5761 \begin_layout Plain Layout
5767 , is contained in `layout files'.
5768 Similarly, \SpecialChar LyX
5769 itself does not know much about DocBook or XHTML.
5770 What it knows is contained in layout files.
5773 \begin_layout Standard
5774 You can think of the layout file for a given document class as a translation
5775 manual between \SpecialChar LyX
5776 constructs—paragraphs with their corresponding styles,
5777 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5780 Almost everything \SpecialChar LyX
5782 \begin_inset Flex Code
5785 \begin_layout Plain Layout
5791 , for example, is contained in the file
5792 \begin_inset Flex Code
5795 \begin_layout Plain Layout
5801 and in various other files it includes.
5802 For this reason, anyone intending to write layout files should plan to
5803 study the existing files.
5804 A good place to start is with
5805 \begin_inset Flex Code
5808 \begin_layout Plain Layout
5814 , which is included in
5815 \begin_inset Flex Code
5818 \begin_layout Plain Layout
5825 \begin_inset Flex Code
5828 \begin_layout Plain Layout
5834 , and many of the other layout files for document classes.
5835 This file is where sections and the like are defined:
5836 \begin_inset Flex Code
5839 \begin_layout Plain Layout
5845 tells \SpecialChar LyX
5846 how paragraphs that are marked with the Section, Subsection, etc,
5847 styles can be translated into corresponding \SpecialChar LaTeX
5848 , DocBook, and XHTML commands
5851 \begin_inset Flex Code
5854 \begin_layout Plain Layout
5860 file basically just includes several of these
5861 \begin_inset Flex Code
5864 \begin_layout Plain Layout
5873 \begin_layout Standard
5874 Defining the \SpecialChar LyX
5876 correspondence is not the only thing layout files do, though.
5877 Their other job is to define how the \SpecialChar LyX
5878 constructs themselves will appear
5880 The fact that layout files have these two jobs is often a source of confusion,
5881 because they are completely separate.
5882 Telling \SpecialChar LyX
5883 how to translate a certain paragraph style into \SpecialChar LaTeX
5886 how to display it; conversely, telling \SpecialChar LyX
5887 how to display a certain paragraph
5888 style does not tell \SpecialChar LyX
5889 how to translate it into \SpecialChar LaTeX
5890 (let alone tell \SpecialChar LaTeX
5893 So, in general, when you define a new \SpecialChar LyX
5894 construct, you must always do two
5895 quite separate things: (i)
5896 \begin_inset space ~
5899 tell \SpecialChar LyX
5900 how to translate it into \SpecialChar LaTeX
5902 \begin_inset space ~
5905 tell \SpecialChar LyX
5909 \begin_layout Standard
5910 Much the same is true, of course, as regards \SpecialChar LyX
5911 's other backend formats, though
5912 XHTML is in some ways different, because in that case \SpecialChar LyX
5917 able, to some extent, to use information about how it should display a
5918 paragraph on the screen to output information (in the form of CSS) about
5919 how the paragraph should be displayed in a browser.
5920 Even in this case, however, the distinction between what \SpecialChar LyX
5922 and how things are rendered externally remains in force, and the two can
5923 be controlled separately.
5925 \begin_inset CommandInset ref
5927 reference "sec:Tags-for-XHTML"
5934 \begin_layout Section
5935 Installing new \SpecialChar LaTeX
5939 \begin_layout Standard
5940 Some installations may not include a \SpecialChar LaTeX
5941 package or class file that you would
5942 like to use within \SpecialChar LyX
5944 For example, you might need Foil\SpecialChar TeX
5945 , a package for preparing slides for overhead
5947 Modern \SpecialChar LaTeX
5948 distributions like \SpecialChar TeX
5949 Live (2008 or newer) or MiK\SpecialChar TeX
5950 provide a user interface
5951 for installing such packages.
5952 For example, with MiK\SpecialChar TeX
5953 , you start the program
5954 \begin_inset Quotes eld
5958 \begin_inset space ~
5962 \begin_inset Quotes erd
5965 to get a list of available packages.
5966 To install one of them, right click on it or use the corresponding toolbar
5970 \begin_layout Standard
5971 If your \SpecialChar LaTeX
5972 distribution does not provide such a `package manager', or if the
5973 package is not available from your distribution, then follow these steps
5974 to install it manually:
5977 \begin_layout Enumerate
5978 Get the package from
5979 \begin_inset CommandInset href
5982 target "http://www.ctan.org/"
5989 \begin_layout Enumerate
5990 If the package contains a file with the ending
5991 \begin_inset Quotes eld
5995 \begin_inset Flex Code
5998 \begin_layout Plain Layout
6005 \begin_inset Quotes erd
6008 (is the case for Foil\SpecialChar TeX
6009 ) then open a console, change to the folder of this
6010 file and execute the command
6011 \begin_inset Flex Code
6014 \begin_layout Plain Layout
6021 You have now unpacked the package and have all files to install it.
6022 Most \SpecialChar LaTeX
6023 -packages are not packed and you can skip this step.
6026 \begin_layout Enumerate
6027 Now you need to decide if the package should be available for all users
6032 \begin_layout Enumerate
6033 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6034 for all users on your system, then install it in your `local' \SpecialChar TeX
6036 install it in your own `user' \SpecialChar TeX
6038 Where these trees should be created, if they do not already exist, depends
6040 To find this out, look in the file
6041 \begin_inset Flex Code
6044 \begin_layout Plain Layout
6054 \begin_layout Plain Layout
6055 This is usually in the directory
6056 \begin_inset Flex Code
6059 \begin_layout Plain Layout
6065 , though you can execute the command
6066 \begin_inset Flex Code
6069 \begin_layout Plain Layout
6080 The location of the `local' \SpecialChar TeX
6081 tree is defined by the
6082 \begin_inset Flex Code
6085 \begin_layout Plain Layout
6091 variable; this is usually somewhere like
6092 \begin_inset Flex Code
6095 \begin_layout Plain Layout
6096 /usr/local/share/texmf
6101 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6104 The location of the `user' \SpecialChar TeX
6106 \begin_inset Flex Code
6109 \begin_layout Plain Layout
6116 \begin_inset Flex Code
6119 \begin_layout Plain Layout
6126 \begin_inset Flex Code
6129 \begin_layout Plain Layout
6139 (If these variables are not predefined, you have to define them.) You'll
6140 probably need root permissions to create or modify the `local' tree, but
6141 not for your `user' tree.
6142 \begin_inset Newline newline
6145 In general, it is recommended to install in the user tree because your user
6146 will not be modified or even overwritten when you upgrade your system.
6147 It will typically also be backed up together with everything else when
6148 you backup your home directory (which, of course, you do on a regular basis).
6151 \begin_layout Enumerate
6152 On Windows, if you want the new package to be available for all users on
6153 your system, change to the folder where \SpecialChar LaTeX
6154 is installed and then change to
6156 \begin_inset Flex Code
6159 \begin_layout Plain Layout
6170 (For MiK\SpecialChar TeX
6171 , this would be by default the folder
6172 \begin_inset Flex Code
6175 \begin_layout Plain Layout
6193 \begin_layout Plain Layout
6194 Note that this will be the correct path only on English installations.
6195 On a German one, it would be
6196 \begin_inset Flex Code
6199 \begin_layout Plain Layout
6213 , and similarly for other languages.
6218 Create there a new folder
6219 \begin_inset Flex Code
6222 \begin_layout Plain Layout
6228 and copy all files of the package into it.
6230 \begin_inset Newline newline
6233 If the package should only available for you or you don't have admin permissions
6234 , do the same, but in the local \SpecialChar LaTeX
6237 \begin_inset space \thinspace{}
6240 g., for MiK\SpecialChar TeX
6242 \begin_inset space ~
6245 2.8 under Windows XP, this would be the folder:
6246 \begin_inset Newline newline
6252 \begin_inset Flex Code
6255 \begin_layout Plain Layout
6258 Documents and Settings
6270 \begin_inset Newline newline
6276 \begin_inset Phantom HPhantom
6279 \begin_layout Plain Layout
6290 \begin_inset Flex Code
6293 \begin_layout Plain Layout
6306 \begin_inset Newline newline
6309 On Vista, it would be:
6310 \begin_inset Newline newline
6314 \begin_inset Flex Code
6317 \begin_layout Plain Layout
6343 \begin_layout Enumerate
6344 Now one only need to tell \SpecialChar LaTeX
6345 that there are new files.
6346 This depends on the used \SpecialChar LaTeX
6351 \begin_layout Enumerate
6352 For \SpecialChar TeX
6353 Live execute the command
6354 \begin_inset Flex Code
6357 \begin_layout Plain Layout
6364 If you installed the package for all users, then you will probably need
6365 to have root permissions for that.
6368 \begin_layout Enumerate
6369 For MiK\SpecialChar TeX
6370 , if you have installed the package for all users, start the program
6372 \begin_inset Quotes eld
6376 \begin_inset space ~
6380 \begin_inset Quotes erd
6383 and press the button marked
6384 \begin_inset Quotes eld
6388 \begin_inset Quotes erd
6392 Otherwise start the program
6393 \begin_inset Quotes eld
6397 \begin_inset Quotes erd
6404 \begin_layout Enumerate
6405 Finally, you need to tell \SpecialChar LyX
6406 that there are new packages available.
6407 So, in \SpecialChar LyX
6409 \begin_inset Flex Noun
6412 \begin_layout Plain Layout
6415 \SpecialChar menuseparator
6421 and then restart \SpecialChar LyX
6425 \begin_layout Standard
6426 Now the package is installed.
6427 In our example, the document class
6428 \begin_inset Flex Code
6431 \begin_layout Plain Layout
6433 \begin_inset space ~
6441 will now be available under
6442 \begin_inset Flex Noun
6445 \begin_layout Plain Layout
6446 Document\SpecialChar menuseparator
6447 Settings\SpecialChar menuseparator
6457 \begin_layout Standard
6458 If you would like to use a \SpecialChar LaTeX
6459 document class that is not even listed in the
6461 \begin_inset Flex Noun
6464 \begin_layout Plain Layout
6465 Document\SpecialChar menuseparator
6466 Settings\SpecialChar menuseparator
6472 , then you need to create a `layout' file for it.
6473 That is the topic of the next section.
6476 \begin_layout Section
6477 Types of layout files
6480 \begin_layout Standard
6481 This section describes the various sorts of \SpecialChar LyX
6482 files that contain layout informati
6484 These files describe various paragraph and character styles, determining
6485 how \SpecialChar LyX
6486 should display them and how they should be translated into \SpecialChar LaTeX
6488 XHTML, or whatever output format is being used.
6492 \begin_layout Standard
6493 We shall try to provide a thorough description of the process of writing
6495 However, there are so many different types of documents supported even
6496 by just \SpecialChar LaTeX
6497 that we can't hope to cover every different possibility or problem
6498 you might encounter.
6499 The \SpecialChar LyX
6500 users' list is frequented by people with lots of experience with layout
6501 design who are willing to share what they've learned, so please feel free
6502 to ask questions there.
6505 \begin_layout Standard
6506 As you prepare to write a new layout, it is extremely helpful to look at
6507 the layouts distributed with \SpecialChar LyX
6509 If you write a \SpecialChar LyX
6510 layout for a \SpecialChar LaTeX
6511 document class that might also be used by
6512 others, or write a module that might be useful to others, then you should
6513 consider posting your layout to the
6514 \begin_inset CommandInset href
6516 name "layout section on the LyX wiki"
6517 target "http://wiki.lyx.org/Layouts/Layouts"
6521 or even to the \SpecialChar LyX
6522 developers' list, so that it might be included in \SpecialChar LyX
6527 \begin_layout Plain Layout
6528 Note that \SpecialChar LyX
6529 is licensed under the General Public License, so any material
6530 that is contributed to \SpecialChar LyX
6531 must be similarly licensed.
6539 \begin_layout Subsection
6541 \begin_inset CommandInset label
6543 name "subsec:Layout-modules"
6550 \begin_layout Standard
6551 We have spoken to this point about `layout files'.
6552 But there are different sorts of files that contain layout information.
6553 Layout files, strictly so called, have the
6554 \begin_inset Flex Code
6557 \begin_layout Plain Layout
6563 extension and provide \SpecialChar LyX
6564 with information about document classes.
6565 Since \SpecialChar LyX
6566 1.6 layout information can also be contained in layout
6571 \begin_inset Flex Code
6574 \begin_layout Plain Layout
6581 Modules are to \SpecialChar LaTeX
6582 packages much as layouts are to \SpecialChar LaTeX
6583 classes, and some modules—such
6585 \begin_inset Flex Code
6588 \begin_layout Plain Layout
6594 module—specifically provide support for one package.
6595 In a sense, layout modules are similar to included
6599 \begin_layout Plain Layout
6600 These can have any extension, but by convention have the
6601 \begin_inset Flex Code
6604 \begin_layout Plain Layout
6616 \begin_inset Flex Code
6619 \begin_layout Plain Layout
6625 —in that modules are not specific to a given document class but may be used
6626 with many different classes.
6627 The difference is that using an included file with
6628 \begin_inset Flex Code
6631 \begin_layout Plain Layout
6637 requires editing that file.
6638 Modules, by contrast, are selected in the
6639 \begin_inset Flex Noun
6642 \begin_layout Plain Layout
6643 Document\SpecialChar menuseparator
6652 \begin_layout Standard
6653 Building modules is the easiest way to get started with layout editing,
6654 since it can be as simple as adding a single new paragraph style or flex
6656 But modules may, in principle, contain anything a layout file can contain.
6659 \begin_layout Standard
6660 After creating a new module and copying it to the
6661 \begin_inset Flex Code
6664 \begin_layout Plain Layout
6670 folder, you will need to reconfigure and then restart \SpecialChar LyX
6673 However, changes you make to the module will be seen immediately, if you
6675 \begin_inset Flex Noun
6678 \begin_layout Plain Layout
6679 Document\SpecialChar menuseparator
6685 , highlight something, and then hit
6686 \begin_inset Quotes eld
6690 \begin_inset Quotes erd
6696 It is strongly recommended that you save your work before doing this
6701 it is strongly recommended that you not attempt to edit modules while simultaneo
6702 usly working on actual documents
6705 Though of course the developers strive to keep \SpecialChar LyX
6706 stable in such situations,
6707 syntax errors and the like in your module file could cause strange behavior.
6710 \begin_layout Subsubsection
6714 \begin_layout Standard
6715 Modules are to \SpecialChar LyX
6716 as packages are to \SpecialChar LaTeX
6718 Sometimes, however, you find yourself wanting a specific inset or character
6719 style just for one document and writing a module that will also be available
6720 to other documents makes little sense.
6721 What you need is \SpecialChar LyX
6723 \begin_inset Quotes eld
6727 \begin_inset Quotes erd
6733 \begin_layout Standard
6734 You will find it under
6736 Document\SpecialChar menuseparator
6737 Settings\SpecialChar menuseparator
6741 The large text box allows you to enter anything that you might enter in
6742 a layout file or module.
6743 You can think of a document's local layout, in fact, as a module that belongs
6745 So, in particular, you must enter a
6746 \begin_inset Flex Code
6749 \begin_layout Plain Layout
6756 Any format is acceptable, but one would normally use the format current
6758 (In \SpecialChar LyX
6759 2.2, the current layout format is 60.)
6762 \begin_layout Standard
6763 When you have entered something in the
6764 \begin_inset Flex Code
6767 \begin_layout Plain Layout
6773 pane, \SpecialChar LyX
6775 \begin_inset Quotes eld
6779 \begin_inset Quotes erd
6782 button at the bottom.
6783 Clicking this button will cause \SpecialChar LyX
6784 to determine whether what you have entered
6785 is valid layout information for the chosen format.
6787 will report the result but, unfortunately, will not tell you what errors
6788 there might have been.
6789 These will be written to the terminal, however, if \SpecialChar LyX
6790 is started from a terminal.
6791 You will not be permitted to save your local layout until you have entered
6795 \begin_layout Standard
6796 The warnings at the end of the previous section apply here, too.
6797 Do not play with local layout while you are actually working, especially
6798 if you have not saved your document.
6799 That said, using local layout with a test document can be a very convenient
6800 way to try out layout ideas, or even to start developing a module.
6803 \begin_layout Subsection
6805 \begin_inset Flex Noun
6808 \begin_layout Plain Layout
6817 \begin_layout Standard
6818 There are two situations you are likely to encounter when wanting to support
6819 a new \SpecialChar LaTeX
6820 document class, involving style (
6821 \begin_inset Flex Code
6824 \begin_layout Plain Layout
6830 ) files and \SpecialChar LaTeX2e
6832 \begin_inset Flex Code
6835 \begin_layout Plain Layout
6842 Supporting a style file is usually fairly easy.
6843 Supporting a new class file is a bit harder.
6844 We'll discuss the former in this section and the latter in the next.
6845 Similar remarks apply, of course, if you want to support a new DocBook
6849 \begin_layout Standard
6850 The easier case is the one in which your new document class is provided
6851 as a style file that is to be used in conjunction with an already supported
6853 For the sake of the example, we'll assume that the style file is called
6855 \begin_inset Flex Noun
6858 \begin_layout Plain Layout
6864 and that it is meant to be used with
6865 \begin_inset Flex Noun
6868 \begin_layout Plain Layout
6874 , which is a standard class.
6878 \begin_layout Standard
6879 Start by copying the existing class's layout file into your local directory:
6883 \begin_layout Plain Layout
6884 Of course, which directory is your local directory will vary by platform,
6885 and \SpecialChar LyX
6886 allows you to specify your local directory on startup, too, using
6888 \begin_inset Flex Code
6891 \begin_layout Plain Layout
6905 \begin_layout LyX-Code
6906 cp report.layout ~/.lyx/layouts/myclass.layout
6909 \begin_layout Standard
6911 \begin_inset Flex Code
6914 \begin_layout Plain Layout
6920 and change the line:
6923 \begin_layout LyX-Code
6926 DeclareLaTeXClass{report}
6929 \begin_layout Standard
6933 \begin_layout LyX-Code
6936 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6939 \begin_layout Standard
6943 \begin_layout LyX-Code
6945 \begin_inset Newline newline
6951 \begin_inset Newline newline
6957 \begin_layout Standard
6958 near the top of the file.
6961 \begin_layout Standard
6962 Start \SpecialChar LyX
6964 \begin_inset Flex Noun
6967 \begin_layout Plain Layout
6968 Tools\SpecialChar menuseparator
6975 Then restart \SpecialChar LyX
6976 and try creating a new document.
6978 \begin_inset Flex Noun
6981 \begin_layout Plain Layout
6987 " as a document class option in the
6988 \begin_inset Flex Noun
6991 \begin_layout Plain Layout
6992 Document\SpecialChar menuseparator
6999 It is likely that some of the sectioning commands and such in your new
7000 class will work differently from how they worked in the base class—
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7010 in this example—so you can fiddle around with the settings for the different
7011 sections if you wish.
7012 The layout information for sections is contained in
7013 \begin_inset Flex Code
7016 \begin_layout Plain Layout
7022 , but you do not need to copy and change this file.
7023 Instead, you can simply add your changes to your layout file, after the
7025 \begin_inset Flex Code
7028 \begin_layout Plain Layout
7034 , which itself includes
7035 \begin_inset Flex Code
7038 \begin_layout Plain Layout
7045 For example, you might add these lines:
7048 \begin_layout LyX-Code
7052 \begin_layout LyX-Code
7056 \begin_layout LyX-Code
7060 \begin_layout LyX-Code
7064 \begin_layout LyX-Code
7068 \begin_layout Standard
7069 to change the font for chapter headings to sans-serif.
7070 This will override (or, in this case, add to) the existing declaration
7071 for the Chapter style.
7075 \begin_layout Standard
7076 Your new package may also provide commands or environments not present in
7078 In this case, you will want to add these to the layout file.
7080 \begin_inset CommandInset ref
7082 reference "sec:TextClass"
7086 for information on how to do so.
7089 \begin_layout Standard
7091 \begin_inset Flex Noun
7094 \begin_layout Plain Layout
7100 can be used with several different document classes, and even if it cannot,
7101 you might find it easiest just to write a module that you can load with
7103 The simplest possible such module would be:
7106 \begin_layout LyX-Code
7109 DeclareLyXModule{My Package}
7112 \begin_layout LyX-Code
7116 \begin_layout LyX-Code
7117 #Support for mypkg.sty.
7120 \begin_layout LyX-Code
7122 \begin_inset Newline newline
7128 \begin_layout LyX-Code
7130 \begin_inset Newline newline
7136 \begin_layout LyX-Code
7138 \begin_inset Newline newline
7144 \begin_inset Newline newline
7150 \begin_layout Standard
7151 A more complex module might modify the behavior of some existing constructs
7152 or define some new ones.
7154 \begin_inset CommandInset ref
7156 reference "sec:TextClass"
7163 \begin_layout Subsection
7165 \begin_inset Flex Noun
7168 \begin_layout Plain Layout
7177 \begin_layout Standard
7178 There are two possibilities here.
7179 One is that the class file is itself based upon an existing document class.
7180 For example, many thesis classes are based upon
7181 \begin_inset Flex Noun
7184 \begin_layout Plain Layout
7191 To see whether yours is, look for a line like
7194 \begin_layout LyX-Code
7200 \begin_layout Standard
7202 If so, then you may proceed largely as in the previous section, though
7204 \begin_inset Flex Code
7207 \begin_layout Plain Layout
7208 Declare\SpecialChar LaTeX
7214 line will be different.
7215 If your new class is
7216 \begin_inset Flex Code
7219 \begin_layout Plain Layout
7225 and it is based upon
7226 \begin_inset Flex Code
7229 \begin_layout Plain Layout
7235 , then the line should read:
7239 \begin_layout Plain Layout
7240 And it will be easiest if you save the file to
7241 \begin_inset Flex Code
7244 \begin_layout Plain Layout
7251 assumes that the document class has the same name as the layout file.
7260 \begin_layout LyX-Code
7263 DeclareLaTeXClass[thesis,book]{thesis}
7266 \begin_layout Standard
7267 If, on the other hand, the new class is not based upon an existing class,
7268 you will probably have to
7269 \begin_inset Quotes eld
7273 \begin_inset Quotes erd
7277 We strongly suggest copying an existing layout file which uses a similar
7279 class and then modifying it, if you can do so.
7280 At least use an existing file as a starting point so you can find out what
7281 items you need to worry about.
7282 Again, the specifics are covered below.
7285 \begin_layout Subsection
7287 \begin_inset CommandInset label
7289 name "subsec:Creating-Templates"
7296 \begin_layout Standard
7297 Once you have written a layout file for a new document class, you might
7298 want to consider writing a
7303 A template acts as a kind of tutorial for your layout, showing how it might
7304 be used, though containing dummy content.
7305 You can of course look at the various templates included with \SpecialChar LyX
7309 \begin_layout Standard
7310 Templates are created just like usual documents: using \SpecialChar LyX
7312 The only difference is that usual documents contain all possible settings,
7313 including the font scheme and the paper size.
7314 Usually a user doesn't want a template to overwrite his preferred settings
7315 for such parameters.
7316 For that reason, the designer of a template should remove the corresponding
7318 \begin_inset Flex Code
7321 \begin_layout Plain Layout
7330 \begin_inset Flex Code
7333 \begin_layout Plain Layout
7341 from the template \SpecialChar LyX
7343 This can be done with any simple text-editor, for example
7344 \begin_inset Flex Code
7347 \begin_layout Plain Layout
7354 \begin_inset Flex Code
7357 \begin_layout Plain Layout
7366 \begin_layout Standard
7367 Put the edited template files you create in
7368 \begin_inset Flex Code
7371 \begin_layout Plain Layout
7377 , copy the ones you use from the global template directory in
7378 \begin_inset Flex Code
7381 \begin_layout Plain Layout
7387 to the same place, and redefine the template path in the
7388 \begin_inset Flex Noun
7391 \begin_layout Plain Layout
7392 Tools\SpecialChar menuseparator
7393 Preferences\SpecialChar menuseparator
7402 \begin_layout Standard
7403 Note, by the way, that there is a template which has a particular meaning:
7405 \begin_inset Flex Code
7408 \begin_layout Plain Layout
7415 This template is loaded every time you create a new document with
7416 \begin_inset Flex Noun
7419 \begin_layout Plain Layout
7420 File\SpecialChar menuseparator
7426 in order to provide useful defaults.
7427 To create this template from inside \SpecialChar LyX
7428 , all you have to do is to open a document
7429 with the correct settings, and use the
7430 \begin_inset Flex Noun
7433 \begin_layout Plain Layout
7434 Save as Document Defaults
7442 \begin_layout Subsection
7443 Upgrading old layout files
7446 \begin_layout Standard
7447 The format of layout files changes with each \SpecialChar LyX
7448 release, so old layout files
7449 need to be converted to the new format.
7451 reads a layout file in an older format, it automatically calls the
7453 \begin_inset Flex Code
7456 \begin_layout Plain Layout
7462 to convert it to a temporary file in current format.
7463 The original file is left untouched.
7464 If you use the layout file often, then, you may want to convert it permanently,
7465 so that \SpecialChar LyX
7466 does not have to do so itself every time.
7467 To do this, you can call the converter manually:
7470 \begin_layout Enumerate
7472 \begin_inset Flex Code
7475 \begin_layout Plain Layout
7482 \begin_inset Flex Code
7485 \begin_layout Plain Layout
7494 \begin_layout Enumerate
7496 \begin_inset Newline newline
7500 \begin_inset Flex Code
7503 \begin_layout Plain Layout
7504 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7510 \begin_inset Newline newline
7514 \begin_inset Flex Code
7517 \begin_layout Plain Layout
7523 is the name of your \SpecialChar LyX
7527 \begin_layout Standard
7528 Note that manual conversion does not affect included files, so these will
7529 have to be converted separately.
7532 \begin_layout Section
7533 \begin_inset CommandInset label
7535 name "sec:TextClass"
7539 The layout file format
7542 \begin_layout Standard
7543 The following sections describe how layout files are structured and written.
7544 Our advice is to go slowly, save and test often.
7545 It is really not that hard, except that the multitude of options can become
7546 overwhelming, especially if you try to check out too many at once.
7547 It becomes easier if you use existing layouts of \SpecialChar LyX
7548 as examples/reference
7549 or if you modify an existing layout to your needs.
7552 \begin_layout Standard
7553 Note that all the tags used in layout files are case-insensitive.
7555 \begin_inset Flex Code
7558 \begin_layout Plain Layout
7565 \begin_inset Flex Code
7568 \begin_layout Plain Layout
7575 \begin_inset Flex Code
7578 \begin_layout Plain Layout
7584 are really the same tag.
7585 The possible arguments are printed in brackets after the tag's name.
7586 The default argument is typeset
7587 \begin_inset Flex Code
7590 \begin_layout Plain Layout
7599 If the argument has a data type like
7600 \begin_inset Quotes eld
7604 \begin_inset Quotes erd
7608 \begin_inset Quotes eld
7612 \begin_inset Quotes erd
7615 , the default is shown like this:
7616 \begin_inset Flex Code
7619 \begin_layout Plain Layout
7630 \begin_layout Subsection
7631 The document class declaration and classification
7634 \begin_layout Standard
7635 Lines in a layout file which begin with
7636 \begin_inset Flex Code
7639 \begin_layout Plain Layout
7646 There is one exception to this rule.
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7657 files should begin with lines like:
7660 \begin_layout LyX-Code
7663 #% Do not delete the line below; configure depends on this
7666 \begin_layout LyX-Code
7671 DeclareLaTeXClass{Article (Standard Class)}
7674 \begin_layout LyX-Code
7679 DeclareCategory{Articles}
7682 \begin_layout Standard
7683 The second and third lines are used when you (re)configure \SpecialChar LyX
7685 The layout file is read by the \SpecialChar LaTeX
7687 \begin_inset Flex Code
7690 \begin_layout Plain Layout
7696 , in a special mode where
7697 \begin_inset Flex Code
7700 \begin_layout Plain Layout
7707 The first line is just a \SpecialChar LaTeX
7708 comment, the second one contains the mandatory
7709 declaration of the text class and the third line contains the optional
7710 classification of the class.
7711 If these lines appear in a file named
7712 \begin_inset Flex Code
7715 \begin_layout Plain Layout
7721 , then they define a text class of name
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7731 (the name of the layout file) which uses the \SpecialChar LaTeX
7733 \begin_inset Flex Code
7736 \begin_layout Plain Layout
7742 (the default is to use the same name as the layout).
7744 \begin_inset Quotes eld
7747 Article (Standard Class)
7748 \begin_inset Quotes erd
7751 that appears above is used as a description of the text class in the
7752 \begin_inset Flex Noun
7755 \begin_layout Plain Layout
7756 Document\SpecialChar menuseparator
7764 \begin_inset Quotes eld
7768 \begin_inset Quotes erd
7771 in the example) is also used in the
7772 \begin_inset Flex Noun
7775 \begin_layout Plain Layout
7776 Document\SpecialChar menuseparator
7782 dialog: the text classes are grouped by these categories (which are usually
7783 genres, so typical categories are
7784 \begin_inset Quotes eld
7788 \begin_inset Quotes erd
7792 \begin_inset Quotes eld
7796 \begin_inset Quotes erd
7800 \begin_inset Quotes eld
7804 \begin_inset Quotes erd
7808 \begin_inset Quotes eld
7812 \begin_inset Quotes erd
7816 \begin_inset Quotes eld
7820 \begin_inset Quotes erd
7824 \begin_inset Quotes eld
7828 \begin_inset Quotes erd
7832 If no category has been declared, the class will be put in the
7833 \begin_inset Quotes eld
7837 \begin_inset Quotes erd
7843 \begin_layout Standard
7844 Let's assume that you wrote your own text class that uses the
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7854 document class, but where you changed the appearance of the section headings.
7855 If you put it in a file
7856 \begin_inset Flex Code
7859 \begin_layout Plain Layout
7865 , the header of this file should be:
7868 \begin_layout LyX-Code
7871 #% Do not delete the line below; configure depends on this
7874 \begin_layout LyX-Code
7879 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7882 \begin_layout LyX-Code
7887 DeclareCategory{Articles}
7890 \begin_layout Standard
7891 This declares a text class
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7901 , associated with the \SpecialChar LaTeX
7903 \begin_inset Flex Code
7906 \begin_layout Plain Layout
7913 \begin_inset Quotes eld
7916 Article (with My Own Headings)
7917 \begin_inset Quotes erd
7921 If your text class depends on several packages, you can declare it as:
7924 \begin_layout LyX-Code
7927 #% Do not delete the line below; configure depends on this
7930 \begin_layout LyX-Code
7935 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7938 \begin_layout LyX-Code
7943 DeclareCategory{Articles}
7946 \begin_layout Standard
7947 This indicates that your text class uses the
7948 \begin_inset Flex Code
7951 \begin_layout Plain Layout
7958 Finally, it is also possible to declare classes for DocBook code.
7959 Typical declarations will look like:
7962 \begin_layout LyX-Code
7965 #% Do not delete the line below; configure depends on this
7968 \begin_layout LyX-Code
7973 DeclareDocBookClass[article]{SGML (DocBook Article)}
7976 \begin_layout LyX-Code
7981 DeclareCategory{Articles (DocBook)}
7984 \begin_layout Standard
7985 Note that these declarations can also be given an optional parameter declaring
7986 the name of the document class (but not a list).
7989 \begin_layout Standard
7990 So, to be as explicit as possible, the form of the layout declaration is:
7993 \begin_layout LyX-Code
7998 DeclareLaTeXClass[class,package.sty]{layout description}
8001 \begin_layout LyX-Code
8006 DeclareCategory{category}
8009 \begin_layout Standard
8010 The class need only be specified if the name of the \SpecialChar LaTeX
8012 name of the layout file are different or if there are packages to load.
8013 If the name of the class file is not specified, then \SpecialChar LyX
8015 that it is the same as the name of the layout file.
8018 \begin_layout Standard
8019 When the text class has been modified to your taste, all you have to do
8020 is to copy it either to
8021 \begin_inset Flex Code
8024 \begin_layout Plain Layout
8031 \begin_inset Flex Code
8034 \begin_layout Plain Layout
8041 \begin_inset Flex Noun
8044 \begin_layout Plain Layout
8045 Tools\SpecialChar menuseparator
8051 , exit \SpecialChar LyX
8053 Then your new text class should be available along with the others.
8056 \begin_layout Standard
8057 Once the layout file is installed, you can edit it and see your changes
8058 without having to reconfigure or to restart \SpecialChar LyX
8064 \begin_layout Plain Layout
8065 In versions of \SpecialChar LyX
8066 prior to 1.6, this was not true.
8067 As a result, editing layout files was very time consuming, since you had
8068 constantly to restart \SpecialChar LyX
8074 You can force a reload of the current layout by using the \SpecialChar LyX
8076 \begin_inset Flex Noun
8079 \begin_layout Plain Layout
8086 There is no default binding for this function—though, of course, you can
8087 bind it to a key yourself.
8088 But you will normally use this function simply by entering it in the mini-buffe
8093 \begin_layout Standard
8099 \begin_inset Flex Noun
8102 \begin_layout Plain Layout
8108 is very much an `advanced feature'.
8113 recommended that you save your work before using this function.
8118 recommended that you not attempt to edit layout information while simultaneousl
8119 y working on a document that you care about.
8120 Use a test document.
8121 Syntax errors and the like in your layout file could cause peculiar behavior.
8122 In particular, such errors could cause \SpecialChar LyX
8123 to regard the current layout as
8124 invalid and to attempt to switch to some other layout.
8128 \begin_layout Plain Layout
8129 Really bad syntax errors may even caused \SpecialChar LyX
8131 This is because certain sorts of errors may make \SpecialChar LyX
8142 The \SpecialChar LyX
8143 team strives to keep \SpecialChar LyX
8144 stable in such situations, but safe is better
8149 \begin_layout Plain Layout
8150 While we're giving advice: make regular backups.
8151 And be nice to your mother.
8159 \begin_layout Subsection
8160 The Module declaration
8163 \begin_layout Standard
8164 A module must begin with a line like the following:
8167 \begin_layout LyX-Code
8170 DeclareLyXModule[endnotes.sty]{Endnotes}
8173 \begin_layout Standard
8174 The mandatory argument, in curly brackets, is the name of the module, as
8176 \begin_inset Flex Noun
8179 \begin_layout Plain Layout
8180 Document\SpecialChar menuseparator
8181 Settings\SpecialChar menuseparator
8188 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8190 on which the module depends.
8191 It is also possible to use the form
8192 \begin_inset Flex Noun
8195 \begin_layout Plain Layout
8201 as an optional argument, which declares that the module can only be used
8202 when there exists a conversion chain between the formats `
8203 \begin_inset Flex Code
8206 \begin_layout Plain Layout
8213 \begin_inset Flex Code
8216 \begin_layout Plain Layout
8225 \begin_layout Standard
8226 The module declaration should then be followed by lines like the following
8230 \begin_layout Plain Layout
8231 Preferably in English if the module should be published with \SpecialChar LyX
8233 This description will appear in the list of messages to be translated and
8234 will be thus translated with the next interface update.
8242 \begin_layout LyX-Code
8246 \begin_layout LyX-Code
8247 #Adds an endnote command, in addition to footnotes.
8251 \begin_layout LyX-Code
8252 #You will need to add
8254 theendnotes in TeX code where you
8257 \begin_layout LyX-Code
8258 #want the endnotes to appear.
8262 \begin_layout LyX-Code
8266 \begin_layout LyX-Code
8267 #Requires: somemodule | othermodule
8270 \begin_layout LyX-Code
8271 #Excludes: badmodule
8274 \begin_layout Standard
8275 The description is used in
8276 \begin_inset Flex Noun
8279 \begin_layout Plain Layout
8280 Document\SpecialChar menuseparator
8281 Settings\SpecialChar menuseparator
8287 to provide the user with information about what the module does.
8289 \begin_inset Flex Code
8292 \begin_layout Plain Layout
8298 line is used to identify other modules with which this one must be used;
8300 \begin_inset Flex Code
8303 \begin_layout Plain Layout
8309 line is used to identify modules with which this one may not be used.
8310 Both are optional, and, as shown, multiple modules should be separated
8311 with the pipe symbol: |.
8312 Note that the required modules are treated disjunctively:
8316 of the required modules must be used.
8321 excluded module may be used.
8322 Note that modules are identified here by their filenames without the
8323 \begin_inset Flex Code
8326 \begin_layout Plain Layout
8334 \begin_inset Flex Code
8337 \begin_layout Plain Layout
8344 \begin_inset Flex Code
8347 \begin_layout Plain Layout
8356 \begin_layout Subsection
8360 \begin_layout Standard
8361 The first non-comment line of any layout file, included file, or module
8366 contain the file format number:
8369 \begin_layout Description
8370 \begin_inset Flex Code
8373 \begin_layout Plain Layout
8380 \begin_inset Flex Code
8383 \begin_layout Plain Layout
8389 ] The format number of the layout file.
8392 \begin_layout Standard
8393 This tag was introduced with \SpecialChar LyX
8395 \begin_inset space ~
8399 Layout files from older \SpecialChar LyX
8400 versions do not have an explicit file format and
8401 are considered to have
8402 \begin_inset Flex Code
8405 \begin_layout Plain Layout
8407 \begin_inset space ~
8416 The format for the present version of \SpecialChar LyX
8418 But each version of \SpecialChar LyX
8419 is capable of reading earlier versions' layout files,
8420 just as they are capable of reading files produced by earlier versions
8423 There is, however, no provision for converting to earlier formats.
8426 \begin_layout Subsection
8427 \begin_inset CommandInset label
8429 name "subsec:General-text-class"
8433 General text class parameters
8436 \begin_layout Standard
8437 These are general parameters that govern the behavior of an entire document
8443 mean that they must appear in
8444 \begin_inset Flex Code
8447 \begin_layout Plain Layout
8453 files rather than in modules.
8454 A module can contain any layout tag.)
8457 \begin_layout Description
8458 \begin_inset Flex Code
8461 \begin_layout Plain Layout
8467 Adds information that will be output in the
8468 \begin_inset Flex Code
8471 \begin_layout Plain Layout
8477 block when the document is output to XHTML.
8478 Typically, this would be used to output CSS style information, but it can
8479 be used for anything that can appear in
8480 \begin_inset Flex Code
8483 \begin_layout Plain Layout
8491 \begin_inset Quotes eld
8495 \begin_inset Flex Code
8498 \begin_layout Plain Layout
8505 \begin_inset Quotes erd
8511 \begin_layout Description
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8521 Adds information to the document preamble.
8523 \begin_inset Newline newline
8527 \begin_inset Quotes eld
8531 \begin_inset Flex Code
8534 \begin_layout Plain Layout
8541 \begin_inset Quotes erd
8547 \begin_layout Description
8548 \begin_inset Flex Code
8551 \begin_layout Plain Layout
8557 Defines formats for use in the display of bibliographic information.
8559 \begin_inset CommandInset ref
8561 reference "subsec:Citation-format-description"
8567 \begin_inset Quotes eld
8571 \begin_inset Flex Code
8574 \begin_layout Plain Layout
8581 \begin_inset Quotes erd
8587 \begin_layout Description
8588 \begin_inset Flex Code
8591 \begin_layout Plain Layout
8597 Describes various global options supported by the document class.
8599 \begin_inset CommandInset ref
8601 reference "subsec:ClassOptions"
8607 \begin_inset Quotes eld
8611 \begin_inset Flex Code
8614 \begin_layout Plain Layout
8621 \begin_inset Quotes erd
8627 \begin_layout Description
8628 \begin_inset Flex Code
8631 \begin_layout Plain Layout
8638 \begin_inset Flex Code
8641 \begin_layout Plain Layout
8650 \begin_inset space \thinspace{}
8654 \begin_inset Flex Code
8657 \begin_layout Plain Layout
8663 ] Whether the class should
8667 to having one or two columns.
8668 Can be changed in the
8669 \begin_inset Flex Noun
8672 \begin_layout Plain Layout
8673 Document\SpecialChar menuseparator
8682 \begin_layout Description
8683 \begin_inset Flex Code
8686 \begin_layout Plain Layout
8693 \begin_inset Flex Code
8696 \begin_layout Plain Layout
8702 ] This sequence defines the properties for a counter.
8703 If the counter does not yet exist, it is created; if it does exist, it
8706 \begin_inset Quotes eld
8710 \begin_inset Flex Code
8713 \begin_layout Plain Layout
8720 \begin_inset Quotes erd
8724 \begin_inset Newline newline
8728 \begin_inset CommandInset ref
8730 reference "subsec:Counters"
8734 for details on counters.
8737 \begin_layout Description
8738 \begin_inset Flex Code
8741 \begin_layout Plain Layout
8747 Sets the default font used to display the document.
8749 \begin_inset CommandInset ref
8751 reference "subsec:Font-description"
8755 for how to declare fonts.
8757 \begin_inset Quotes eld
8761 \begin_inset Flex Code
8764 \begin_layout Plain Layout
8771 \begin_inset Quotes erd
8777 \begin_layout Description
8778 \begin_inset Flex Code
8781 \begin_layout Plain Layout
8788 \begin_inset Flex Code
8791 \begin_layout Plain Layout
8797 ] Specifies a module to be included by default with this document class.
8798 The module is specified as filename without the
8799 \begin_inset Flex Code
8802 \begin_layout Plain Layout
8809 The user can still remove the module, but it will be active at the outset.
8810 (This applies only when new files are created, or when this class is chosen
8811 for an existing document.)
8814 \begin_layout Description
8815 \begin_inset Flex Code
8818 \begin_layout Plain Layout
8825 \begin_inset Flex Code
8828 \begin_layout Plain Layout
8834 ] This is the style that will be assigned to new paragraphs, usually
8835 \begin_inset Flex Noun
8838 \begin_layout Plain Layout
8845 This will default to the first defined style if not given, but you are
8846 encouraged to use this directive.
8849 \begin_layout Description
8850 \begin_inset Flex Code
8853 \begin_layout Plain Layout
8860 \begin_inset Flex Code
8863 \begin_layout Plain Layout
8869 ] This tag indicates that the module (which is specified by filename without
8871 \begin_inset Flex Code
8874 \begin_layout Plain Layout
8880 extension) cannot be used with this document class.
8881 This might be used in a journal-specific layout file to prevent, say, the
8883 \begin_inset Flex Code
8886 \begin_layout Plain Layout
8892 module that numbers theorems by section.
8897 be used in a module.
8898 Modules have their own way of excluding other modules (see
8899 \begin_inset CommandInset ref
8901 reference "subsec:Layout-modules"
8908 \begin_layout Description
8909 \begin_inset Flex Code
8912 \begin_layout Plain Layout
8918 Defines a new float.
8920 \begin_inset CommandInset ref
8922 reference "subsec:Floats"
8928 \begin_inset Quotes eld
8932 \begin_inset Flex Code
8935 \begin_layout Plain Layout
8942 \begin_inset Quotes erd
8948 \begin_layout Description
8949 \begin_inset Flex Code
8952 \begin_layout Plain Layout
8958 Sets the information that will be output in the
8959 \begin_inset Flex Code
8962 \begin_layout Plain Layout
8968 block when this document class is output to XHTML.
8969 Note that this will completely override any prior
8970 \begin_inset Flex Code
8973 \begin_layout Plain Layout
8980 \begin_inset Flex Code
8983 \begin_layout Plain Layout
8991 \begin_inset Newline newline
8995 \begin_inset Flex Code
8998 \begin_layout Plain Layout
9004 if you just want to add material to the preamble.) Must end with
9005 \begin_inset Quotes eld
9009 \begin_inset Flex Code
9012 \begin_layout Plain Layout
9019 \begin_inset Quotes erd
9025 \begin_layout Description
9026 \begin_inset Flex Code
9029 \begin_layout Plain Layout
9036 \begin_inset Flex Code
9039 \begin_layout Plain Layout
9045 ] The style to use for the table of contents, bibliography, and so forth,
9046 when the document is output to HTML.
9047 For articles, this should normally be
9048 \begin_inset Flex Code
9051 \begin_layout Plain Layout
9058 \begin_inset Flex Code
9061 \begin_layout Plain Layout
9068 If it is not given, then \SpecialChar LyX
9069 will attempt to figure out which layout to use.
9072 \begin_layout Description
9073 \begin_inset Flex Code
9076 \begin_layout Plain Layout
9083 \begin_inset Flex Code
9086 \begin_layout Plain Layout
9092 ] Modifies the properties of the given counter.
9093 If the counter does not exist, the statement is ignored.
9095 \begin_inset Quotes eld
9099 \begin_inset Flex Code
9102 \begin_layout Plain Layout
9109 \begin_inset Quotes erd
9113 \begin_inset Newline newline
9117 \begin_inset CommandInset ref
9119 reference "subsec:Counters"
9123 for details on counters.
9126 \begin_layout Description
9127 \begin_inset Flex Code
9130 \begin_layout Plain Layout
9137 \begin_inset Flex Code
9140 \begin_layout Plain Layout
9146 ] This allows you to include another layout definition file within yours
9147 to avoid duplicating commands.
9148 Common examples are the standard layout files, for example,
9149 \begin_inset Flex Code
9152 \begin_layout Plain Layout
9158 , which contains most of the basic layouts.
9161 \begin_layout Description
9162 \begin_inset Flex Code
9165 \begin_layout Plain Layout
9172 \begin_inset Flex Code
9175 \begin_layout Plain Layout
9181 ] This section (re-)defines the layout of an inset.
9182 It can be applied to an existing inset or to a new, user-defined inset,
9183 e.g., a new character style.
9185 \begin_inset Quotes eld
9189 \begin_inset Flex Code
9192 \begin_layout Plain Layout
9199 \begin_inset Quotes erd
9203 \begin_inset Newline newline
9207 \begin_inset CommandInset ref
9209 reference "subsec:Flex-insets-and"
9213 for more information.
9217 \begin_layout Description
9218 \begin_inset Flex Code
9221 \begin_layout Plain Layout
9228 \begin_inset Flex Code
9231 \begin_layout Plain Layout
9237 ] A string that indicates the width of the left margin on the screen, for
9239 \begin_inset Quotes eld
9243 \begin_inset Flex Code
9246 \begin_layout Plain Layout
9253 \begin_inset Quotes erd
9257 (Note that this is not a `length', like
9258 \begin_inset Quotes eld
9262 \begin_inset Quotes erd
9268 \begin_layout Description
9269 \begin_inset Flex Code
9272 \begin_layout Plain Layout
9279 \begin_inset Flex Code
9282 \begin_layout Plain Layout
9288 ] Modifies the properties of the given paragraph style.
9289 If the style does not exist, this section is ignored.
9291 \begin_inset Quotes eld
9295 \begin_inset Flex Code
9298 \begin_layout Plain Layout
9305 \begin_inset Quotes erd
9311 \begin_layout Description
9312 \begin_inset Flex Code
9315 \begin_layout Plain Layout
9322 \begin_inset Flex Code
9325 \begin_layout Plain Layout
9331 ] Deletes an existing counter, usually one defined in an included file.
9334 \begin_layout Description
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9345 \begin_inset Flex Code
9348 \begin_layout Plain Layout
9354 ] Deletes an existing float.
9355 This is particularly useful when you want to suppress a float that has
9356 been defined in an input file.
9359 \begin_layout Description
9360 \begin_inset Flex Code
9363 \begin_layout Plain Layout
9370 \begin_inset Flex Code
9373 \begin_layout Plain Layout
9379 ] Deletes an existing style.
9382 \begin_layout Description
9383 \begin_inset Flex Code
9386 \begin_layout Plain Layout
9393 \begin_inset Flex Code
9396 \begin_layout Plain Layout
9402 ] The file format (as defined in the \SpecialChar LyX
9403 preferences) produced by this document
9405 It is mainly useful when
9406 \begin_inset Flex Code
9409 \begin_layout Plain Layout
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9425 and one wants to define a new type of literate document.
9426 The format is reset to
9427 \begin_inset Quotes eld
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9441 \begin_inset Quotes erd
9445 \begin_inset Quotes eld
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9459 \begin_inset Quotes erd
9462 when the corresponding
9463 \begin_inset Flex Code
9466 \begin_layout Plain Layout
9472 parameter is encountered.
9475 \begin_layout Description
9476 \begin_inset Flex Code
9479 \begin_layout Plain Layout
9486 \begin_inset Flex Code
9489 \begin_layout Plain Layout
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9510 \begin_inset Flex Code
9513 \begin_layout Plain Layout
9519 ] Specifies what sort of output documents using this class will produce.
9522 \begin_layout Description
9523 \begin_inset Flex Code
9526 \begin_layout Plain Layout
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9543 \begin_inset Flex Code
9546 \begin_layout Plain Layout
9552 ] Specifies options, given in the second string, for the package named by
9555 \begin_inset Quotes eld
9559 \begin_inset Flex Code
9562 \begin_layout Plain Layout
9563 PackageOptions natbib square
9569 \begin_inset Quotes erd
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9582 to be loaded with the
9583 \begin_inset Flex Code
9586 \begin_layout Plain Layout
9593 (For \SpecialChar TeX
9594 perts, this causes \SpecialChar LyX
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9602 PassOptionsToPackage{natbib}{square}
9608 \begin_inset Flex Code
9611 \begin_layout Plain Layout
9620 \begin_layout Description
9621 \begin_inset Flex Code
9624 \begin_layout Plain Layout
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9643 \begin_inset Flex Code
9646 \begin_layout Plain Layout
9653 \begin_inset Flex Code
9656 \begin_layout Plain Layout
9662 ] The default pagestyle.
9663 Can be changed in the
9664 \begin_inset Flex Noun
9667 \begin_layout Plain Layout
9668 Document\SpecialChar menuseparator
9677 \begin_layout Description
9678 \begin_inset Flex Code
9681 \begin_layout Plain Layout
9687 Sets the preamble for the \SpecialChar LaTeX
9689 Note that this will completely override any prior
9690 \begin_inset Flex Code
9693 \begin_layout Plain Layout
9700 \begin_inset Flex Code
9703 \begin_layout Plain Layout
9711 \begin_inset Flex Code
9714 \begin_layout Plain Layout
9720 if you just want to add material to the preamble.) Must end with
9721 \begin_inset Quotes eld
9725 \begin_inset Flex Code
9728 \begin_layout Plain Layout
9735 \begin_inset Quotes erd
9741 \begin_layout Description
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9752 \begin_inset Flex Code
9755 \begin_layout Plain Layout
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9774 \begin_inset space \thinspace{}
9778 \begin_inset Flex Code
9781 \begin_layout Plain Layout
9787 ] Whether the class already provides the feature
9788 \begin_inset Flex Code
9791 \begin_layout Plain Layout
9798 A feature is in general the name of a package (e.
9799 \begin_inset space \thinspace{}
9803 \begin_inset space \space{}
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9817 \begin_inset Flex Code
9820 \begin_layout Plain Layout
9827 \begin_inset space \thinspace{}
9831 \begin_inset space \space{}
9835 \begin_inset Flex Code
9838 \begin_layout Plain Layout
9845 \begin_inset Flex Code
9848 \begin_layout Plain Layout
9856 \begin_inset CommandInset ref
9858 reference "chap:List-of-functions"
9862 for the list of features.
9865 \begin_layout Description
9866 \begin_inset Flex Code
9869 \begin_layout Plain Layout
9876 \begin_inset Flex Code
9879 \begin_layout Plain Layout
9885 ] Indicates that this layout provides the functionality of the module mentioned,
9886 which should be specified by the filename without the
9887 \begin_inset Flex Code
9890 \begin_layout Plain Layout
9897 This will typically be used if the layout includes the module directly,
9898 rather than using the
9899 \begin_inset Flex Code
9902 \begin_layout Plain Layout
9908 tag to indicate that it ought to be used.
9909 It could also be used in a module that provided an alternate implementation
9910 of the same functionality.
9913 \begin_layout Description
9914 \begin_inset Flex Code
9917 \begin_layout Plain Layout
9924 \begin_inset Flex Code
9927 \begin_layout Plain Layout
9933 ] Creates a new paragraph style if it does not already exist.
9934 If the style does exist, this section is ignored.
9936 \begin_inset Quotes eld
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9950 \begin_inset Quotes erd
9956 \begin_layout Description
9957 \begin_inset Flex Code
9960 \begin_layout Plain Layout
9967 \begin_inset Flex Code
9970 \begin_layout Plain Layout
9976 ] Whether the class requires the feature
9977 \begin_inset Flex Code
9980 \begin_layout Plain Layout
9987 Multiple features must be separated by commas.
9988 Note that you can only request supported features.
9990 \begin_inset CommandInset ref
9992 reference "chap:List-of-functions"
9996 for the list of features.).
9997 If you require a package with specific options, you can additionally use
9999 \begin_inset Flex Code
10002 \begin_layout Plain Layout
10011 \begin_layout Description
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10022 \begin_inset Flex Code
10025 \begin_layout Plain Layout
10031 ] A string that indicates the width of the right margin on the screen, for
10033 \begin_inset Quotes eld
10037 \begin_inset Flex Code
10040 \begin_layout Plain Layout
10047 \begin_inset Quotes erd
10053 \begin_layout Description
10054 \begin_inset Flex Code
10057 \begin_layout Plain Layout
10064 \begin_inset Flex Code
10067 \begin_layout Plain Layout
10073 ] Sets which divisions get numbered.
10075 \begin_inset Newline newline
10079 \begin_inset Flex Code
10082 \begin_layout Plain Layout
10088 counter in \SpecialChar LaTeX
10092 \begin_layout Description
10093 \begin_inset Flex Code
10096 \begin_layout Plain Layout
10103 \begin_inset Flex Code
10106 \begin_layout Plain Layout
10115 \begin_inset space \thinspace{}
10119 \begin_inset Flex Code
10122 \begin_layout Plain Layout
10128 ] Whether the class-default should be printing on one or both sides of the
10130 Can be changed in the
10131 \begin_inset Flex Noun
10134 \begin_layout Plain Layout
10135 Document\SpecialChar menuseparator
10144 \begin_layout Description
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10164 ] This sequence defines a paragraph style.
10165 If the style does not yet exist, it is created; if it does exist, its parameter
10168 \begin_inset Quotes eld
10172 \begin_inset Flex Code
10175 \begin_layout Plain Layout
10182 \begin_inset Quotes erd
10186 \begin_inset Newline newline
10190 \begin_inset CommandInset ref
10192 reference "subsec:Paragraph-Styles"
10196 for details on paragraph styles.
10199 \begin_layout Description
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 ] The name of the command or environment to be used with
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10232 \begin_layout Description
10233 \begin_inset Flex Code
10236 \begin_layout Plain Layout
10243 \begin_inset Flex Code
10246 \begin_layout Plain Layout
10255 \begin_inset Flex Code
10258 \begin_layout Plain Layout
10264 ] Indicates what kind of markup is used to define the title of a document.
10266 \begin_inset Flex Code
10269 \begin_layout Plain Layout
10275 means that the macro with name
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10285 will be inserted after the last layout which has
10286 \begin_inset Quotes eld
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10295 \begin_inset space ~
10304 \begin_inset Quotes erd
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10318 corresponds to the case where all layouts which have
10319 \begin_inset Quotes eld
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10328 \begin_inset space ~
10337 \begin_inset Quotes erd
10340 should be enclosed into the
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10353 \begin_layout Description
10354 \begin_inset Flex Code
10357 \begin_layout Plain Layout
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10373 ] Sets which divisions are included in the table of contents.
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10384 counter in \SpecialChar LaTeX
10388 \begin_layout Subsection
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10399 \begin_inset CommandInset label
10401 name "subsec:ClassOptions"
10408 \begin_layout Standard
10410 \begin_inset Flex Code
10413 \begin_layout Plain Layout
10419 section can contain the following entries:
10422 \begin_layout Description
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10442 ] The list of available font sizes for the document's main font, separated
10444 \begin_inset Quotes eld
10448 \begin_inset Flex Code
10451 \begin_layout Plain Layout
10458 \begin_inset Quotes erd
10464 \begin_layout Description
10465 \begin_inset Flex Code
10468 \begin_layout Plain Layout
10474 Used to set the DTD line with XML-based output classes.
10476 \begin_inset space \thinspace{}
10480 \begin_inset Quotes eld
10483 -//OASIS//DTD DocBook V4.2//EN
10484 \begin_inset Quotes erd
10490 \begin_layout Description
10491 \begin_inset Flex Code
10494 \begin_layout Plain Layout
10501 \begin_inset Flex Code
10504 \begin_layout Plain Layout
10505 string="empty|plain|headings|fancy"
10510 ] The list of available page sty\SpecialChar softhyphen
10512 \begin_inset Quotes eld
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10526 \begin_inset Quotes erd
10532 \begin_layout Description
10533 \begin_inset Flex Code
10536 \begin_layout Plain Layout
10543 \begin_inset Flex Code
10546 \begin_layout Plain Layout
10552 ] Some document class options, separated by a comma, that will be added
10553 to the optional part of the
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10568 \begin_layout Standard
10570 \begin_inset Flex Code
10573 \begin_layout Plain Layout
10579 section must end with
10580 \begin_inset Quotes eld
10584 \begin_inset Flex Code
10587 \begin_layout Plain Layout
10594 \begin_inset Quotes erd
10600 \begin_layout Subsection
10602 \begin_inset CommandInset label
10604 name "subsec:Paragraph-Styles"
10611 \begin_layout Standard
10612 A paragraph style description looks like this:
10616 \begin_layout Plain Layout
10617 Note that this will either define a new style or modify an existing one.
10625 \begin_layout LyX-Code
10632 \begin_layout LyX-Code
10636 \begin_layout LyX-Code
10640 \begin_layout Standard
10641 where the following commands are allowed:
10644 \begin_layout Description
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10663 , left, right, center
10668 ] Paragraph alignment.
10671 \begin_layout Description
10672 \begin_inset Flex Code
10675 \begin_layout Plain Layout
10682 \begin_inset Flex Code
10685 \begin_layout Plain Layout
10690 , left, right, center
10695 ] A comma separated list of permitted alignments.
10696 (Some \SpecialChar LaTeX
10697 styles prohibit certain alignments, since those wouldn't make sense.
10698 For example a right-aligned or centered enumeration isn't possible.)
10701 \begin_layout Description
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10712 \begin_inset Flex Code
10715 \begin_layout Plain Layout
10721 ] Defines argument number <int> of a command\SpecialChar breakableslash
10722 environment associated with
10724 This is useful for things like section headings, and only makes sense with
10727 Every (optional or required) argument of a command or environment – except
10728 for the required argument that is associated with the content of the paragraph
10729 itself – has a separate definition, where the number specifies the order
10731 The definition must end with
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10742 So a command with two optional arguments has:
10746 \begin_layout Quote
10752 \begin_layout Quote
10758 \begin_layout Quote
10764 \begin_layout Quote
10770 \begin_layout Quote
10776 \begin_layout Quote
10782 \begin_layout Standard
10784 \begin_inset Flex Code
10787 \begin_layout Plain Layout
10793 definition, the following specifications are possible:
10796 \begin_layout Itemize
10797 \begin_inset Flex Code
10800 \begin_layout Plain Layout
10807 \begin_inset Flex Code
10810 \begin_layout Plain Layout
10816 The string that will appear both in the menu (to insert this argument)
10817 and on the argument inset button (unless you also specify a separate
10818 \begin_inset Flex Code
10821 \begin_layout Plain Layout
10828 For the menu, you can define an accelerator by appending the respective
10829 character to the string, divided by
10830 \begin_inset Quotes eld
10834 \begin_inset Quotes erd
10838 \begin_inset space \thinspace{}
10842 \begin_inset space \space{}
10846 \begin_inset Quotes eld
10850 \begin_inset Flex Code
10853 \begin_layout Plain Layout
10860 \begin_inset Quotes erd
10866 \begin_layout Itemize
10867 \begin_inset Flex Code
10870 \begin_layout Plain Layout
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10886 A separate string for the menu.
10887 You can define an accelerator by appending the respective character to
10888 the string, divided by
10889 \begin_inset Quotes eld
10893 \begin_inset Quotes erd
10897 \begin_inset space \thinspace{}
10901 \begin_inset space \space{}
10905 \begin_inset Quotes eld
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10919 \begin_inset Quotes erd
10923 This specification is optional.
10924 If it is not given the
10925 \begin_inset Flex Code
10928 \begin_layout Plain Layout
10934 will be used instead for the menu.
10937 \begin_layout Itemize
10938 \begin_inset Flex Code
10941 \begin_layout Plain Layout
10948 \begin_inset Flex Code
10951 \begin_layout Plain Layout
10957 A longer explanatory text that appears in the tooltip when hovering over
10958 the argument inset.
10961 \begin_layout Itemize
10962 \begin_inset Flex Code
10965 \begin_layout Plain Layout
10972 \begin_inset Flex Code
10975 \begin_layout Plain Layout
10984 \begin_inset space \thinspace{}
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10997 ] Declare if this is a mandatory (1) or an optional (0) argument.
10998 Mandatory arguments will be output empty if not given, while optional arguments
10999 will not be output at all.
11000 By default, mandatory arguments are delimited by
11001 \begin_inset Flex Code
11004 \begin_layout Plain Layout
11010 , while optional arguments are delimited by
11011 \begin_inset Flex Code
11014 \begin_layout Plain Layout
11023 \begin_layout Itemize
11024 \begin_inset Flex Code
11027 \begin_layout Plain Layout
11034 \begin_inset Flex Code
11037 \begin_layout Plain Layout
11043 defines another argument (by its number) which this argument requires to
11044 be output if it is itself output.
11046 \begin_inset space \thinspace{}
11049 g., in \SpecialChar LaTeX
11050 commands, optional arguments often require previous optional arguments
11051 to be output (at least empty), as in
11052 \begin_inset Flex Code
11055 \begin_layout Plain Layout
11058 command[][argument]{text}
11064 This can be achieved by the statement
11065 \begin_inset Flex Code
11068 \begin_layout Plain Layout
11075 \begin_inset Flex Code
11078 \begin_layout Plain Layout
11087 \begin_layout Itemize
11088 \begin_inset Flex Code
11091 \begin_layout Plain Layout
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11107 defines a custom left delimiter (instead of
11108 \begin_inset Flex Code
11111 \begin_layout Plain Layout
11118 \begin_inset Flex Code
11121 \begin_layout Plain Layout
11128 A line break in the output can be indicated by
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11141 \begin_layout Itemize
11142 \begin_inset Flex Code
11145 \begin_layout Plain Layout
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11161 defines a custom right delimiter (instead of
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11172 \begin_inset Flex Code
11175 \begin_layout Plain Layout
11182 A line break in the output can be indicated by
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11195 \begin_layout Itemize
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11206 \begin_inset Flex Code
11209 \begin_layout Plain Layout
11215 defines an argument that is inserted if and only if no user-specified arguments
11217 \begin_inset space \thinspace{}
11221 \begin_inset space \space{}
11224 if no argument inset has been inserted (note that also an empty argument
11225 inset omits the DefaultArg).
11226 Multiple arguments need to be separated by comma.
11229 \begin_layout Itemize
11230 \begin_inset Flex Code
11233 \begin_layout Plain Layout
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11249 defines an argument that is inserted in any case (alone or in addition
11250 to user-specified arguments).
11251 Multiple arguments need to be separated by comma.
11254 \begin_layout Itemize
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11264 The font used for the argument content, see
11265 \begin_inset CommandInset ref
11267 reference "subsec:Font-description"
11274 \begin_layout Itemize
11275 \begin_inset Flex Code
11278 \begin_layout Plain Layout
11284 The font used for the label; see
11285 \begin_inset CommandInset ref
11287 reference "subsec:Font-description"
11294 \begin_layout Itemize
11295 \begin_inset Flex Code
11298 \begin_layout Plain Layout
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11313 , Minimalistic, Conglomerate
11318 ] describes the rendering style used for the inset's frame and buttons.
11321 \begin_layout Itemize
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11332 \begin_inset Flex Code
11335 \begin_layout Plain Layout
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11351 , this argument is automatically inserted when the respective style is selected.
11352 Currently, only one argument per style\SpecialChar breakableslash
11353 layout can be automatically inserted.
11356 \begin_layout Itemize
11357 \begin_inset Flex Code
11360 \begin_layout Plain Layout
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11377 \begin_inset Flex Code
11380 \begin_layout Plain Layout
11386 , this argument will be inserted with a copy of the co-text (either selected
11387 text or the whole paragraph) as content.
11390 \begin_layout Itemize
11391 \begin_inset Flex Code
11394 \begin_layout Plain Layout
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11405 string of characters
11414 Defines individual characters that should be output in raw form, meaning
11415 without special translations that \SpecialChar LaTeX
11417 Note that, contrary to PassThru, this needs to be explicitly defined for
11419 That is, arguments do not inherit PassThruChars from their parent inset
11423 \begin_layout Standard
11424 By default, the text entered in the \SpecialChar LyX
11425 workarea in the respective layout is
11426 the last (mandatory) argument of a command if the
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11447 However, arguments with the prefix
11448 \begin_inset Flex Code
11451 \begin_layout Plain Layout
11457 are output after this workarea argument.
11458 Note that post-argument numbering restarts at 1, so the first argument
11459 following the workarea argument is
11460 \begin_inset Flex Code
11463 \begin_layout Plain Layout
11470 Post-arguments are ignored in any other
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11493 \begin_layout Standard
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11507 \begin_inset Flex Code
11510 \begin_layout Plain Layout
11519 \begin_inset Flex Code
11522 \begin_layout Plain Layout
11528 followed by the number (e.
11529 \begin_inset space \thinspace{}
11533 \begin_inset space \space{}
11537 \begin_inset Flex Code
11540 \begin_layout Plain Layout
11550 \begin_layout Description
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11560 Note that this will completely override any prior
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11570 declaration for this style.
11572 \begin_inset Quotes eld
11576 \begin_inset Flex Code
11579 \begin_layout Plain Layout
11586 \begin_inset Quotes erd
11591 \begin_inset CommandInset ref
11593 reference "subsec:I18n"
11597 for details on its use.
11600 \begin_layout Description
11601 \begin_inset Flex Code
11604 \begin_layout Plain Layout
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11624 \begin_layout Plain Layout
11625 Note that a `float' here is a real number, such as: 1.5.
11630 The vertical space with which the last of a chain of paragraphs with this
11631 style is separated from the following paragraph.
11632 If the next paragraph has another style, the separations are not simply
11633 added, but the maximum is taken.
11636 \begin_layout Description
11637 \begin_inset Flex Code
11640 \begin_layout Plain Layout
11647 \begin_inset Flex Code
11650 \begin_layout Plain Layout
11656 ] The category for this style.
11657 This is used to group related styles in the style combobox on the toolbar.
11658 Any string can be used, but you may want to use existing categories with
11663 \begin_layout Description
11664 \begin_inset Flex Code
11667 \begin_layout Plain Layout
11673 Depth of XML command.
11674 Used only with XML-type formats.
11677 \begin_layout Description
11678 \begin_inset Flex Code
11681 \begin_layout Plain Layout
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11697 ] Copies all the features of an existing style into the current one.
11701 \begin_layout Description
11702 \begin_inset Flex Code
11705 \begin_layout Plain Layout
11712 \begin_inset Flex Code
11715 \begin_layout Plain Layout
11721 ] The name of a style whose preamble should be output
11726 This allows to ensure some ordering of the preamble snippets when macros
11727 definitions depend on one another.
11731 \begin_layout Plain Layout
11732 Note that, besides that functionality, there is no way to ensure any ordering
11734 The ordering that you see in a given version of \SpecialChar LyX
11735 may change without warning
11744 \begin_layout Description
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11763 , Box, Filled_Box, Static
11768 ] The type of label that stands at the end of the paragraph (or sequence
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11780 \begin_inset Newline newline
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11794 \begin_inset Flex Code
11797 \begin_layout Plain Layout
11804 \begin_inset Flex Code
11807 \begin_layout Plain Layout
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11825 \begin_inset Quotes eld
11829 \begin_inset Quotes erd
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11843 \begin_inset space \space{}
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11856 ) is a white (resp.
11857 \begin_inset space ~
11860 black) square suitable for end of proof markers,
11861 \begin_inset Flex Code
11864 \begin_layout Plain Layout
11870 is an explicit text string.
11873 \begin_layout Description
11874 \begin_inset Flex Code
11877 \begin_layout Plain Layout
11884 \begin_inset Flex Code
11887 \begin_layout Plain Layout
11893 ] The string used for a label with a
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11904 \begin_inset Newline newline
11908 \begin_inset Flex Code
11911 \begin_layout Plain Layout
11921 \begin_layout Description
11922 \begin_inset Flex Code
11925 \begin_layout Plain Layout
11931 The font used for both the text body
11937 \begin_inset CommandInset ref
11939 reference "subsec:Font-description"
11944 Note that defining this font automatically defines the
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11955 So you should define this one first if you also want to define
11956 \begin_inset Flex Code
11959 \begin_layout Plain Layout
11968 \begin_layout Description
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11988 ] Used for backporting new styles to stable \SpecialChar LyX
11990 The first stable version that supports this tag is \SpecialChar LyX
11992 The argument is a number which may either be 0, -1 or any value greater
11995 \begin_inset Flex Code
11998 \begin_layout Plain Layout
12004 flag of a style is greater than zero, it will always be written to the
12006 If a .lyx file is read, the style definitions from the document header are
12007 added to the document class.
12008 Therefore even older \SpecialChar LyX
12009 versions can handle the style.
12011 \begin_inset Flex Code
12014 \begin_layout Plain Layout
12020 is a version number: if the style is read, and the version number is less
12021 than the version number of the already existing style in the document class,
12022 the new style is ignored.
12023 If the version number is greater, the new style replaces the existing style.
12024 A value of -1 means an infinite version number, i.
12025 \begin_inset space \thinspace{}
12029 \begin_inset space \space{}
12032 the style is always used.
12035 \begin_layout Description
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12046 \begin_inset Flex Code
12049 \begin_layout Plain Layout
12058 \begin_inset space \thinspace{}
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12071 ] Usually \SpecialChar LyX
12072 does not allow you to insert more than one space between words,
12073 since a space is considered as the separation between two words, not a
12074 character or symbol of its own.
12075 This is a very fine thing but sometimes annoying, for example, when typing
12076 program code or plain \SpecialChar LaTeX
12079 \begin_inset Flex Code
12082 \begin_layout Plain Layout
12089 Note that \SpecialChar LyX
12090 will create protected blanks for the additional blanks when
12091 in another mode than \SpecialChar LaTeX
12095 \begin_layout Description
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12105 These tags are used with XHTML output.
12107 \begin_inset CommandInset ref
12109 reference "subsec:Paragraph-Style-XHTML"
12116 \begin_layout Description
12117 \begin_inset Flex Code
12120 \begin_layout Plain Layout
12126 [FIXME] (Used only with XML-type formats.)
12129 \begin_layout Description
12130 \begin_inset Flex Code
12133 \begin_layout Plain Layout
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12152 \begin_inset space \thinspace{}
12156 \begin_inset Flex Code
12159 \begin_layout Plain Layout
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12175 , marks the style as to be included in the document preamble and not in
12177 This is useful for document classes that want such information as the title
12178 and author to appear in the preamble.
12179 Note that this works only for styles for which the
12180 \begin_inset Flex Code
12183 \begin_layout Plain Layout
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Flex Code
12203 \begin_layout Plain Layout
12212 \begin_layout Description
12213 \begin_inset Flex Code
12216 \begin_layout Plain Layout
12223 \begin_inset Flex Code
12226 \begin_layout Plain Layout
12235 \begin_inset space \thinspace{}
12239 \begin_inset Flex Code
12242 \begin_layout Plain Layout
12249 \begin_inset Flex Code
12252 \begin_layout Plain Layout
12258 , marks the style as being part of a title block (see also the
12259 \begin_inset Flex Code
12262 \begin_layout Plain Layout
12269 \begin_inset Flex Code
12272 \begin_layout Plain Layout
12281 \begin_layout Description
12282 \begin_inset Flex Code
12285 \begin_layout Plain Layout
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12301 ] The \SpecialChar LaTeX
12302 command sequence declaring an item in a list.
12303 The command is to be defined without the preceding backslash (the default
12305 \begin_inset Quotes eld
12309 \begin_inset Quotes erd
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12324 in the \SpecialChar LaTeX
12328 \begin_layout Description
12329 \begin_inset Flex Code
12332 \begin_layout Plain Layout
12339 \begin_inset Flex Code
12342 \begin_layout Plain Layout
12348 ] This provides extra space between paragraphs that have the same style.
12349 If you put other styles into an environment, each is separated with the
12351 \begin_inset Flex Code
12354 \begin_layout Plain Layout
12361 But the whole items of the environment are additionally separated with
12363 \begin_inset Flex Code
12366 \begin_layout Plain Layout
12373 Note that this is a
12378 \begin_layout Description
12379 \begin_inset Flex Code
12382 \begin_layout Plain Layout
12388 [FIXME] (Used only with XML-type formats.)
12391 \begin_layout Description
12392 \begin_inset Flex Code
12395 \begin_layout Plain Layout
12402 \begin_inset Flex Code
12405 \begin_layout Plain Layout
12414 \begin_inset space \thinspace{}
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12427 ] Usually \SpecialChar LyX
12428 does not allow you to leave a paragraph empty, since it would
12429 lead to empty \SpecialChar LaTeX
12431 There are some cases where this could be desirable however: in a letter
12432 template, the required fields can be provided as empty fields, so that
12433 people do not forget them; in some special classes, a style can be used
12434 as some kind of break, which does not contain actual text.
12437 \begin_layout Description
12438 \begin_inset Flex Code
12441 \begin_layout Plain Layout
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12457 ] The vertical space between the label and the text body.
12458 Only used for labels that are above the text body (
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12469 \begin_inset Newline newline
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12477 Centered_Top_Environment
12485 \begin_layout Description
12486 \begin_inset Flex Code
12489 \begin_layout Plain Layout
12496 \begin_inset Flex Code
12499 \begin_layout Plain Layout
12505 ] The name of the counter for automatic numbering.
12506 In order to have the counter appear with your label, you will need to reference
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12520 This will work with
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12551 \begin_inset Flex Code
12554 \begin_layout Plain Layout
12561 \begin_inset Newline newline
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12588 , though this case is a bit complicated.
12589 Suppose you declare
12590 \begin_inset Quotes eld
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12598 LabelCounter myenum
12604 \begin_inset Quotes erd
12608 Then the actual counters used are
12609 \begin_inset Flex Code
12612 \begin_layout Plain Layout
12619 \begin_inset Flex Code
12622 \begin_layout Plain Layout
12629 \begin_inset Flex Code
12632 \begin_layout Plain Layout
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12648 , much as in \SpecialChar LaTeX
12650 These counters must all be declared separately.
12651 \begin_inset Newline newline
12655 \begin_inset CommandInset ref
12657 reference "subsec:Counters"
12661 for details on counters.
12664 \begin_layout Description
12665 \begin_inset Flex Code
12668 \begin_layout Plain Layout
12674 The font used for the label.
12676 \begin_inset CommandInset ref
12678 reference "subsec:Font-description"
12685 \begin_layout Description
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12705 ] Text that indicates how far a label should be indented.
12708 \begin_layout Description
12709 \begin_inset Flex Code
12712 \begin_layout Plain Layout
12719 \begin_inset Flex Code
12722 \begin_layout Plain Layout
12728 ] Text that indicates the amount of horizontal space between the label and
12730 Only used for labels that are not above the text body.
12733 \begin_layout Description
12734 \begin_inset Flex Code
12737 \begin_layout Plain Layout
12744 \begin_inset Flex Code
12747 \begin_layout Plain Layout
12753 ] The string used for the label.
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12764 is set, this string can be contain the special formatting commands described
12766 \begin_inset CommandInset ref
12768 reference "subsec:Counters"
12775 \begin_layout Description
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12780 LabelStringAppendix
12786 \begin_inset Flex Code
12789 \begin_layout Plain Layout
12795 ] This is used inside the appendix instead of
12796 \begin_inset Newline newline
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12811 \begin_inset Flex Code
12814 \begin_layout Plain Layout
12821 \begin_inset Newline newline
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12829 LabelStringAppendix
12837 \begin_layout Description
12838 \begin_inset Flex Code
12841 \begin_layout Plain Layout
12847 [FIXME] (Used only with XML-type formats.)
12850 \begin_layout Description
12851 \begin_inset Flex Code
12854 \begin_layout Plain Layout
12861 \begin_inset Flex Code
12864 \begin_layout Plain Layout
12869 , Manual, Static, Above,
12870 \begin_inset Newline newline
12873 Centered, Sensitive, Enumerate,
12874 \begin_inset Newline newline
12877 Itemize, Bibliography
12886 \begin_layout Description
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12896 means the label is the very first word (up to the first real blank).
12897 Use protected spaces if you want more than one word as the label.
12901 \begin_layout Description
12902 \begin_inset Flex Code
12905 \begin_layout Plain Layout
12911 means the label is simply what is declared as
12912 \begin_inset Flex Code
12915 \begin_layout Plain Layout
12922 This will be displayed
12923 \begin_inset Quotes eld
12927 \begin_inset Quotes erd
12930 , at the beginning of the paragraph.
12932 \begin_inset Flex Code
12935 \begin_layout Plain Layout
12942 \begin_inset Flex Code
12945 \begin_layout Plain Layout
12951 , then it will be displayed only in the first paragraph of any sequence
12952 of paragraphs with the same
12953 \begin_inset Flex Code
12956 \begin_layout Plain Layout
12965 \begin_layout Description
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12976 \begin_inset space ~
12980 \begin_inset space ~
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12993 are special cases of
12994 \begin_inset Flex Code
12997 \begin_layout Plain Layout
13004 The label will be printed above the paragraph either at the beginning of
13005 the line or centered.
13008 \begin_layout Description
13009 \begin_inset Flex Code
13012 \begin_layout Plain Layout
13018 is a special case for the caption-labels
13019 \begin_inset Quotes eld
13023 \begin_inset Quotes erd
13027 \begin_inset Quotes eld
13031 \begin_inset Quotes erd
13035 \begin_inset Newline newline
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13048 means the (hardcoded) label string depends on the kind of float: It is
13049 hardcoded to be `FloatType N', where N is the value of the counter associated
13051 For the case that a caption is inserted outside of a float the
13052 \begin_inset Flex Code
13055 \begin_layout Plain Layout
13062 \begin_inset Quotes eld
13066 \begin_inset Quotes erd
13072 \begin_layout Description
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13082 produces the usual sort of enumeration labels.
13083 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13084 small Roman numerals, and uppercase letters for the four possible depths.
13087 \begin_layout Description
13088 \begin_inset Flex Code
13091 \begin_layout Plain Layout
13097 produces various bullets at the different levels.
13098 It is also hardcoded.
13101 \begin_layout Description
13102 \begin_inset Flex Code
13105 \begin_layout Plain Layout
13111 should be used only with
13112 \begin_inset Flex Code
13115 \begin_layout Plain Layout
13116 LatexType BibEnvironment
13125 \begin_layout Description
13126 \begin_inset Flex Code
13129 \begin_layout Plain Layout
13135 Note that this will completely override any prior
13136 \begin_inset Flex Code
13139 \begin_layout Plain Layout
13145 declaration for this style.
13147 \begin_inset Quotes eld
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13161 \begin_inset Quotes erd
13166 \begin_inset CommandInset ref
13168 reference "subsec:I18n"
13172 for details on its use.
13175 \begin_layout Description
13176 \begin_inset Flex Code
13179 \begin_layout Plain Layout
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13195 ] The name of the corresponding \SpecialChar LaTeX
13197 Either the environment or command name.
13200 \begin_layout Description
13201 \begin_inset Flex Code
13204 \begin_layout Plain Layout
13211 \begin_inset Flex Code
13214 \begin_layout Plain Layout
13220 ] An optional parameter for the corresponding
13221 \begin_inset Flex Code
13224 \begin_layout Plain Layout
13231 This parameter cannot be changed from within \SpecialChar LyX
13233 \begin_inset Flex Code
13236 \begin_layout Plain Layout
13242 for customizable parameters).
13243 This will be output as is after all \SpecialChar LaTeX
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13257 \begin_layout Description
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13268 \begin_inset Flex Code
13271 \begin_layout Plain Layout
13276 , Command, Environment, Item_Environment,
13277 \begin_inset Newline newline
13280 List_Environment, Bib_Environment
13285 ] How the style should be translated into \SpecialChar LaTeX
13290 \begin_layout Plain Layout
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13300 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13301 Visit the SGML class files for specific examples.
13310 \begin_layout Description
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13320 means nothing special.
13323 \begin_layout Description
13324 \begin_inset Flex Code
13327 \begin_layout Plain Layout
13334 \begin_inset Flex Code
13337 \begin_layout Plain Layout
13344 {\SpecialChar ldots
13353 \begin_layout Description
13354 \begin_inset Flex Code
13357 \begin_layout Plain Layout
13364 \begin_inset Flex Code
13367 \begin_layout Plain Layout
13374 }\SpecialChar ldots
13390 \begin_layout Description
13391 \begin_inset Flex Code
13394 \begin_layout Plain Layout
13401 \begin_inset Flex Code
13404 \begin_layout Plain Layout
13411 \begin_inset Flex Code
13414 \begin_layout Plain Layout
13422 is generated for each paragraph of this environment.
13426 \begin_layout Description
13427 \begin_inset Flex Code
13430 \begin_layout Plain Layout
13437 \begin_inset Flex Code
13440 \begin_layout Plain Layout
13447 \begin_inset Newline newline
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13460 is passed as an argument to the environment.
13461 \begin_inset Newline newline
13465 \begin_inset Flex Code
13468 \begin_layout Plain Layout
13474 can be defined in the
13475 \begin_inset Flex Noun
13478 \begin_layout Plain Layout
13479 Edit\SpecialChar menuseparator
13481 \begin_inset space ~
13492 \begin_layout Description
13493 \begin_inset Flex Code
13496 \begin_layout Plain Layout
13503 \begin_inset Flex Code
13506 \begin_layout Plain Layout
13512 but adds the necessary mandatory argument (the longest label) to the begin
13513 statement of the bibliography environment:
13514 \begin_inset Newline newline
13518 \begin_inset Flex Code
13521 \begin_layout Plain Layout
13524 begin{thebibliography}{99}
13530 It is therefore only useful for bibliography environments.
13531 The default longest label
13532 \begin_inset Quotes eld
13536 \begin_inset Quotes erd
13539 can be changed by the user in the paragraph settings of a bibliography
13543 \begin_layout Standard
13544 Putting the last few things together, the \SpecialChar LaTeX
13545 output will be either:
13548 \begin_layout LyX-Code
13551 LatexName[LatexParam]{\SpecialChar ldots
13555 \begin_layout Standard
13559 \begin_layout LyX-Code
13562 begin{LatexName}[LatexParam] \SpecialChar ldots
13568 \begin_layout Standard
13569 depending upon the \SpecialChar LaTeX
13574 \begin_layout Description
13575 \begin_inset Flex Code
13578 \begin_layout Plain Layout
13585 \begin_inset Flex Code
13588 \begin_layout Plain Layout
13594 ] A string that is put at the beginning of the style content.
13595 A line break in the output can be indicated by
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13608 \begin_layout Description
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13619 \begin_inset Flex Code
13622 \begin_layout Plain Layout
13628 ] If you put styles into environments, the different
13629 \begin_inset Flex Code
13632 \begin_layout Plain Layout
13638 are not simply added, but added with a factor
13639 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13643 Note that this parameter is also used when
13644 \begin_inset Flex Code
13647 \begin_layout Plain Layout
13654 \begin_inset Flex Code
13657 \begin_layout Plain Layout
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13674 Then it is added to the manual or dynamic margin.
13675 \begin_inset Newline newline
13679 \begin_inset Quotes eld
13683 \begin_inset Flex Code
13686 \begin_layout Plain Layout
13693 \begin_inset Quotes erd
13696 means that the paragraph is indented with the width of
13697 \begin_inset Quotes eld
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13711 \begin_inset Quotes erd
13714 in the normal font.
13715 You can get a negative width by prefixing the string with
13716 \begin_inset Quotes eld
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 \begin_inset Quotes erd
13734 This way was chosen so that the look is the same with each used screen
13738 \begin_layout Description
13739 \begin_inset Flex Code
13742 \begin_layout Plain Layout
13749 \begin_inset Flex Code
13752 \begin_layout Plain Layout
13757 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13763 \begin_inset Newline newline
13766 The kind of margin that the style has on the left side.
13770 \begin_layout Description
13771 \begin_inset Flex Code
13774 \begin_layout Plain Layout
13780 just means a fixed margin.
13783 \begin_layout Description
13784 \begin_inset Flex Code
13787 \begin_layout Plain Layout
13793 means that the left margin depends on the string entered in the
13794 \begin_inset Flex Noun
13797 \begin_layout Plain Layout
13798 Edit\SpecialChar menuseparator
13800 \begin_inset space ~
13809 This is used to typeset nice lists without tabulators.
13812 \begin_layout Description
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13822 means that the margin depends on the size of the label.
13823 This is used for automatic enumerated headlines.
13824 It is obvious that the headline
13825 \begin_inset Quotes eld
13828 5.4.3.2.1 Very long headline
13829 \begin_inset Quotes erd
13832 must have a wider left margin (as wide as
13833 \begin_inset Quotes eld
13837 \begin_inset Quotes erd
13840 plus the space) than
13841 \begin_inset Quotes eld
13844 3.2 Very long headline
13845 \begin_inset Quotes erd
13849 \begin_inset Quotes eld
13853 \begin_inset Quotes erd
13856 are not able to do this.
13859 \begin_layout Description
13860 \begin_inset Flex Code
13863 \begin_layout Plain Layout
13869 is similar, but only the very first row of the paragraph is dynamic, while
13870 the others are static; this is used, for example, for descriptions.
13873 \begin_layout Description
13874 \begin_inset Flex Code
13877 \begin_layout Plain Layout
13883 means the margin is chosen in a way that the longest row of this paragraph
13884 fits to the right margin.
13885 This is used to typeset an address on the right edge of the page.
13889 \begin_layout Description
13890 \begin_inset Flex Code
13893 \begin_layout Plain Layout
13900 \begin_inset Flex Code
13903 \begin_layout Plain Layout
13912 \begin_inset space \thinspace{}
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13925 ] Whether fragile commands in this style should be
13926 \begin_inset Flex Code
13929 \begin_layout Plain Layout
13942 whether this command should itself be protected.)
13945 \begin_layout Description
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13956 \begin_inset Flex Code
13959 \begin_layout Plain Layout
13966 \begin_inset space \thinspace{}
13970 \begin_inset Flex Code
13973 \begin_layout Plain Layout
13981 ] Whether newlines are translated into \SpecialChar LaTeX
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13997 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
13999 inside \SpecialChar LyX
14003 \begin_layout Description
14004 \begin_inset Flex Code
14007 \begin_layout Plain Layout
14014 \begin_inset Flex Code
14017 \begin_layout Plain Layout
14026 \begin_inset space \thinspace{}
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14039 ] If set to true, and if
14040 \begin_inset Flex Code
14043 \begin_layout Plain Layout
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14059 ) paragraphs are being indented, then the indentation of such a paragraph
14060 following one of this type will be suppressed.
14061 (So this will not affect the display of non-default paragraphs.)
14064 \begin_layout Description
14065 \begin_inset Flex Code
14068 \begin_layout Plain Layout
14075 \begin_inset Flex Code
14078 \begin_layout Plain Layout
14084 ] Name of a style that has replaced this style.
14085 This is used to rename a style, while keeping backward compatibility.
14088 \begin_layout Description
14089 \begin_inset Flex Code
14092 \begin_layout Plain Layout
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14109 \begin_inset space \thinspace{}
14113 \begin_inset Flex Code
14116 \begin_layout Plain Layout
14122 ] Determines whether consecutive pragraphs of the same type are treated
14123 as belonging together.
14124 This has the effect that the
14125 \begin_inset Flex Code
14128 \begin_layout Plain Layout
14134 is only printed once before such a group.
14135 By default, this is true for
14136 \begin_inset Flex Code
14139 \begin_layout Plain Layout
14146 \begin_inset Flex Code
14149 \begin_layout Plain Layout
14156 \begin_inset Flex Code
14159 \begin_layout Plain Layout
14165 and false for all other types.
14168 \begin_layout Description
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14191 \begin_inset space \thinspace{}
14195 \begin_inset Flex Code
14198 \begin_layout Plain Layout
14204 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14206 but only by a line break; together with
14207 \begin_inset Flex Code
14210 \begin_layout Plain Layout
14216 , this allows to emulate a plain text editor (like the ERT inset).
14219 \begin_layout Description
14220 \begin_inset Flex Code
14223 \begin_layout Plain Layout
14230 \begin_inset Flex Code
14233 \begin_layout Plain Layout
14239 ] The indent of the very first line of a paragraph.
14241 \begin_inset Newline newline
14245 \begin_inset Flex Code
14248 \begin_layout Plain Layout
14254 will be fixed for a certain style.
14255 The exception is the default style, since the indentation for these paragraphs
14256 can be prohibited with
14257 \begin_inset Flex Code
14260 \begin_layout Plain Layout
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14277 style paragraphs inside environments use the
14278 \begin_inset Flex Code
14281 \begin_layout Plain Layout
14287 of the environment, not their native one.
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14298 paragraphs inside an enumeration are not indented.
14301 \begin_layout Description
14302 \begin_inset Flex Code
14305 \begin_layout Plain Layout
14312 \begin_inset Flex Code
14315 \begin_layout Plain Layout
14321 ] The vertical space between two paragraphs of this style.
14324 \begin_layout Description
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14345 allows the user to choose either
14346 \begin_inset Quotes eld
14350 \begin_inset Quotes erd
14354 \begin_inset Quotes eld
14358 \begin_inset Quotes erd
14361 to separate paragraphs.
14363 \begin_inset Quotes eld
14367 \begin_inset Quotes erd
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14382 \begin_inset Quotes eld
14386 \begin_inset Quotes erd
14390 \begin_inset Flex Code
14393 \begin_layout Plain Layout
14399 is ignored and all paragraphs are separated by the
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14410 The vertical space is calculated with
14411 \begin_inset Flex Code
14414 \begin_layout Plain Layout
14416 \begin_inset space ~
14425 \begin_inset Flex Code
14428 \begin_layout Plain Layout
14434 is the height of a row with the normal font.
14435 This way, the look stays the same with different screen fonts.
14438 \begin_layout Description
14439 \begin_inset Flex Code
14442 \begin_layout Plain Layout
14449 \begin_inset Flex Code
14452 \begin_layout Plain Layout
14461 \begin_inset space \thinspace{}
14465 \begin_inset Flex Code
14468 \begin_layout Plain Layout
14474 ] Whether the contents of this paragraph should be output in raw form, meaning
14475 without special translations that \SpecialChar LaTeX
14479 \begin_layout Description
14480 \begin_inset Flex Code
14483 \begin_layout Plain Layout
14490 \begin_inset Flex Code
14493 \begin_layout Plain Layout
14503 Defines individual characters that should be output in raw form, meaning
14504 without special translations that \SpecialChar LaTeX
14508 \begin_layout Description
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14518 Information to be included in the \SpecialChar LaTeX
14519 preamble when this style is used.
14520 Used to define macros, load packages, etc., required by this particular
14523 \begin_inset Quotes eld
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14537 \begin_inset Quotes erd
14543 \begin_layout Description
14544 \begin_inset Flex Code
14547 \begin_layout Plain Layout
14554 \begin_inset Flex Code
14557 \begin_layout Plain Layout
14563 ] The prefix to use when creating labels referring to paragraphs of this
14565 This allows the use of formatted references.
14568 \begin_layout Description
14569 \begin_inset Flex Code
14572 \begin_layout Plain Layout
14579 \begin_inset Flex Code
14582 \begin_layout Plain Layout
14588 ] Whether the style requires the feature
14589 \begin_inset Flex Code
14592 \begin_layout Plain Layout
14599 \begin_inset CommandInset ref
14601 reference "chap:List-of-functions"
14605 for the list of features).
14606 If you require a package with specific options, you can additionally use
14608 \begin_inset Flex Code
14611 \begin_layout Plain Layout
14617 as a general text class parameter (see
14618 \begin_inset CommandInset ref
14620 reference "subsec:General-text-class"
14627 \begin_layout Description
14628 \begin_inset Flex Code
14631 \begin_layout Plain Layout
14638 \begin_inset Flex Code
14641 \begin_layout Plain Layout
14650 \begin_inset Flex Code
14653 \begin_layout Plain Layout
14659 ] Resets the \SpecialChar LaTeX
14660 arguments of this style (as defined via the
14661 \begin_inset Flex Code
14664 \begin_layout Plain Layout
14671 This is useful if you have copied a style via
14672 \begin_inset Flex Code
14675 \begin_layout Plain Layout
14681 , but you do not want to inherit its (required and optional) arguments.
14682 \change_inserted 2089657418 1476488475
14686 \begin_layout Description
14688 \change_inserted 2089657418 1476488475
14689 \begin_inset Flex Code
14692 \begin_layout Plain Layout
14694 \change_inserted 2089657418 1476488475
14701 \begin_inset Flex Code
14704 \begin_layout Plain Layout
14706 \change_inserted 2089657418 1476488475
14715 \begin_inset Flex Code
14718 \begin_layout Plain Layout
14720 \change_inserted 2089657418 1476488475
14726 ] Resumes a counter that is usually reset at each new sequence of layouts.
14727 This is currently only useful when
14728 \begin_inset Flex Code
14731 \begin_layout Plain Layout
14733 \change_inserted 2089657418 1476488475
14740 \begin_inset Flex Code
14743 \begin_layout Plain Layout
14745 \change_inserted 2089657418 1476488475
14756 \begin_layout Description
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14776 ] A string that is put at the end of the layout content.
14777 A line break in the output can be indicated by
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14790 \begin_layout Description
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14811 \begin_inset Flex Code
14814 \begin_layout Plain Layout
14823 \begin_layout Description
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14834 \begin_inset Flex Code
14837 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14871 \begin_inset space ~
14879 ] This defines what the default spacing should be in the style.
14881 \begin_inset Flex Code
14884 \begin_layout Plain Layout
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14910 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14911 If you specify the argument
14912 \begin_inset Flex Code
14915 \begin_layout Plain Layout
14921 , then you must also provide a value argument which will be the actual multiplie
14923 Note that, contrary to other parameters,
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14933 implies the generation of specific \SpecialChar LaTeX
14934 code, using the \SpecialChar LaTeX
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14950 \begin_layout Description
14951 \begin_inset Flex Code
14954 \begin_layout Plain Layout
14961 \begin_inset Flex Code
14964 \begin_layout Plain Layout
14971 \begin_inset space \thinspace{}
14975 \begin_inset Flex Code
14978 \begin_layout Plain Layout
14986 ] Allow spell-checking paragraphs of this style.
14988 \change_inserted 2089657418 1476488264
14992 \begin_layout Description
14994 \change_inserted 2089657418 1476488264
14995 \begin_inset Flex Code
14998 \begin_layout Plain Layout
15000 \change_inserted 2089657418 1476488264
15007 \begin_inset Flex Code
15010 \begin_layout Plain Layout
15012 \change_inserted 2089657418 1476488264
15021 \begin_inset Flex Code
15024 \begin_layout Plain Layout
15026 \change_inserted 2089657418 1476488264
15032 ] Steps the master counter of a given counter at the beginning of a new
15033 sequence of layouts.
15034 This is currently only useful when
15035 \begin_inset Flex Code
15038 \begin_layout Plain Layout
15040 \change_inserted 2089657418 1476488264
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15052 \change_inserted 2089657418 1476488264
15063 \begin_layout Description
15064 \begin_inset Flex Code
15067 \begin_layout Plain Layout
15073 The font used for the text body .
15075 \begin_inset CommandInset ref
15077 reference "subsec:Font-description"
15084 \begin_layout Description
15085 \begin_inset Flex Code
15088 \begin_layout Plain Layout
15097 \begin_inset Flex Code
15100 \begin_layout Plain Layout
15110 The level of the style in the table of contents.
15111 This is used for automatic numbering of section headings.
15114 \begin_layout Description
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15141 \begin_inset Flex Code
15144 \begin_layout Plain Layout
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15160 ] This tag determines whether the first line indentation of this paragraph
15161 can be toggled via the Paragraph settings dialog.
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15178 is set, indentation can be toggled if the document settings use
15179 \begin_inset Quotes eld
15183 \begin_inset Quotes erd
15186 paragraph style, with
15187 \begin_inset Flex Code
15190 \begin_layout Plain Layout
15196 , indentation can always be toggled, notwithstanding the document settings,
15198 \begin_inset Flex Code
15201 \begin_layout Plain Layout
15207 , indentation can never be toggled.
15210 \begin_layout Description
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15230 ] The vertical space with which the very first of a chain of paragraphs
15231 with this style is separated from the previous paragraph.
15232 If the previous paragraph has another style, the separations are not simply
15233 added, but the maximum is taken.
15236 \begin_layout Subsection
15237 \begin_inset CommandInset label
15243 Internationalization of Paragraph Styles
15246 \begin_layout Standard
15248 has long supported internationalization of layout information, but, until
15249 version 2.0, this applied only to the user interface and not to, say, PDF
15251 Thus, French authors were forced to resort to ugly hacks if they wanted
15256 1' instead of `Theorem 1'.
15257 Thanks to Georg Baum, that is no longer the case.
15260 \begin_layout Standard
15262 \begin_inset Flex Code
15265 \begin_layout Plain Layout
15271 defines text that is to appear in the typeset document, it may use
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15291 to support non-English and even multi-language documents correctly.
15292 The following excerpt (from the
15293 \begin_inset Flex Code
15296 \begin_layout Plain Layout
15302 file) shows how this works:
15305 \begin_layout LyX-Code
15310 \begin_layout LyX-Code
15313 theoremstyle{remark}
15316 \begin_layout LyX-Code
15319 newtheorem{claim}[thm]{
15326 \begin_layout LyX-Code
15330 \begin_layout LyX-Code
15334 \begin_layout LyX-Code
15339 claimname}{_(Claim)}
15342 \begin_layout LyX-Code
15346 \begin_layout LyX-Code
15350 \begin_layout LyX-Code
15359 claimname}{_(Claim)}}
15362 \begin_layout LyX-Code
15367 \begin_layout Standard
15368 In principle, any legal \SpecialChar LaTeX
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15380 \begin_inset Flex Code
15383 \begin_layout Plain Layout
15389 tags, but in practice they will typically look as they do here.
15390 The key to correct translation of the typeset text is the definition of
15391 the \SpecialChar LaTeX
15393 \begin_inset Flex Code
15396 \begin_layout Plain Layout
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15420 \begin_layout Standard
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15431 tag provides for internationalization based upon the overall language of
15433 The contents of the tag will be included in the preamble, just as with
15435 \begin_inset Flex Code
15438 \begin_layout Plain Layout
15445 What makes it special is the use of the
15446 \begin_inset Quotes eld
15450 \begin_inset Quotes erd
15454 \begin_inset Flex Code
15457 \begin_layout Plain Layout
15463 , which will be replaced, when \SpecialChar LyX
15464 produces \SpecialChar LaTeX
15465 output, with the translation of
15466 its argument into the document language.
15469 \begin_layout Standard
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15480 tag is more complex, since it is meant to provide support for multi-language
15481 documents and so offers an interface to the
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15492 Its contents will be added to the preamble once for each language that
15493 appears in the document.
15494 In this case, the argument to
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15504 will be replaced with its translation into the language in question; the
15506 \begin_inset Flex Code
15509 \begin_layout Plain Layout
15515 is replaced by the language name (as used by the babel package).
15518 \begin_layout Standard
15519 A German document that also included a French section would thus have the
15520 following in the preamble:
15523 \begin_layout LyX-Code
15532 claimname}{Affirmation}}
15533 \begin_inset Newline newline
15544 claimname}{Behauptung}}
15545 \begin_inset Newline newline
15552 claimname}{Behauptung}
15555 \begin_layout Standard
15558 \begin_inset Flex Code
15561 \begin_layout Plain Layout
15567 will then conspire to produce the correct text in the output.
15570 \begin_layout Standard
15571 One important point to note here is that the translations are provided by
15573 itself, through the file
15574 \begin_inset Flex Code
15577 \begin_layout Plain Layout
15584 This means, in effect, that
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15604 are really only of use in layout files that are provided with \SpecialChar LyX
15606 entered in user-created layout files will not be seen by \SpecialChar LyX
15607 's internationalizatio
15608 n routines unless the
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15618 file is modified accordingly.
15619 That said, however, any layout created with the intention that it will
15620 be included with \SpecialChar LyX
15621 should use these tags where appropriate.
15622 Please note that the paragraph style translations provided by \SpecialChar LyX
15624 change with a minor update (e.
15625 \begin_inset space \thinspace{}
15629 \begin_inset space \space{}
15632 from version 2.1.x to 2.1.y).
15633 It is however quite likely that a major update (e.
15634 \begin_inset space \thinspace{}
15638 \begin_inset space \space{}
15641 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15644 \begin_layout Subsection
15646 \begin_inset CommandInset label
15648 name "subsec:Floats"
15655 \begin_layout Standard
15656 It is necessary to define the floats (
15657 \begin_inset Flex Noun
15660 \begin_layout Plain Layout
15667 \begin_inset Flex Noun
15670 \begin_layout Plain Layout
15676 , \SpecialChar ldots
15677 ) in the text class itself.
15678 Standard floats are included in the file
15679 \begin_inset Flex Code
15682 \begin_layout Plain Layout
15688 , so you may have to do no more than add
15691 \begin_layout LyX-Code
15692 Input stdfloats.inc
15695 \begin_layout Standard
15696 to your layout file.
15697 If you want to implement a text class that proposes some other float types
15698 (like the AGU class bundled with \SpecialChar LyX
15699 ), the information below will hopefully
15703 \begin_layout Description
15704 \begin_inset Flex Code
15707 \begin_layout Plain Layout
15714 \begin_inset Flex Code
15717 \begin_layout Plain Layout
15723 =!htbpH] Allowed placement options for this float type.
15724 The value is a string of placement characters.
15725 Possible characters include:
15730 \begin_inset Quotes eld
15734 \begin_inset Quotes erd
15742 \begin_inset Quotes eld
15746 \begin_inset Quotes erd
15754 \begin_inset Quotes eld
15758 \begin_inset Quotes erd
15766 \begin_inset Quotes eld
15770 \begin_inset Quotes erd
15778 \begin_inset Quotes eld
15782 \begin_inset Quotes erd
15790 \begin_inset Quotes eld
15794 \begin_inset Quotes erd
15798 The order of the characters in the string does not matter.
15799 If no placement options are allowed, use the string
15806 \begin_layout Description
15807 \begin_inset Flex Code
15810 \begin_layout Plain Layout
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15829 \begin_inset space \thinspace{}
15835 \begin_inset Flex Code
15838 \begin_layout Plain Layout
15848 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15864 if the float does not support this feature.
15867 \begin_layout Description
15868 \begin_inset Flex Code
15871 \begin_layout Plain Layout
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15890 \begin_inset space \thinspace{}
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15909 ] Defines whether the float has a starred variant that spans columns in
15910 a two column paragraph.
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15921 if the float does not support this feature.
15924 \begin_layout Description
15925 \begin_inset Flex Code
15928 \begin_layout Plain Layout
15935 \begin_inset Flex Code
15938 \begin_layout Plain Layout
15945 \begin_inset Quotes erd
15949 \begin_inset Quotes erd
15952 ] The file name extension of an auxiliary file for the list of figures (or
15955 writes the captions to this file.
15958 \begin_layout Description
15959 \begin_inset Flex Code
15962 \begin_layout Plain Layout
15969 \begin_inset Flex Code
15972 \begin_layout Plain Layout
15979 \begin_inset Quotes erd
15983 \begin_inset Quotes erd
15986 ] The string that will be used in the menus and also for the caption.
15987 This is translated to the current language if babel is used.
15990 \begin_layout Description
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16000 These tags control the XHTML output.
16002 \begin_inset CommandInset ref
16004 reference "sec:Tags-for-XHTML"
16011 \begin_layout Description
16012 \begin_inset Flex Code
16015 \begin_layout Plain Layout
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16036 \begin_inset space \thinspace{}
16040 \begin_inset Flex Code
16043 \begin_layout Plain Layout
16049 ] Indicates whether the float is already defined in the document class or
16050 if instead the \SpecialChar LaTeX
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16061 needs to be loaded to define it on-the-fly.
16063 \begin_inset Flex Code
16066 \begin_layout Plain Layout
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16083 It should be set to
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16093 if the float is already defined by the \SpecialChar LaTeX
16097 \begin_layout Description
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16108 \begin_inset Flex Code
16111 \begin_layout Plain Layout
16118 \begin_inset Quotes erd
16122 \begin_inset Quotes erd
16125 ] The command used to generate a list of floats of this type; the leading
16134 \begin_inset Flex Code
16137 \begin_layout Plain Layout
16143 is false, since there is no standard way to generate this command.
16145 \begin_inset Flex Code
16148 \begin_layout Plain Layout
16154 is true, since in that case there is a standard way to define the command.
16157 \begin_layout Description
16158 \begin_inset Flex Code
16161 \begin_layout Plain Layout
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16178 \begin_inset Quotes erd
16182 \begin_inset Quotes erd
16185 ] A title for a list of floats of this kind (list of figures, tables, or
16187 It is used for the screen label within \SpecialChar LyX
16188 , it is used by \SpecialChar LaTeX
16190 it is used as the title in the XHTML output.
16191 It will be translated to the document language.
16194 \begin_layout Description
16195 \begin_inset Flex Code
16198 \begin_layout Plain Layout
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16215 \begin_inset Quotes erd
16219 \begin_inset Quotes erd
16222 ] This (optional) argument determines whether floats of this class will
16223 be numbered within some sectional unit of the document.
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16235 \begin_inset Quotes eld
16239 \begin_inset Flex Code
16242 \begin_layout Plain Layout
16249 \begin_inset Quotes erd
16252 , the floats will be numbered within chapters.
16256 \begin_layout Description
16257 \begin_inset Flex Code
16260 \begin_layout Plain Layout
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16277 \begin_inset Quotes erd
16281 \begin_inset Quotes erd
16284 ] The default placement for the given class of floats.
16285 The string should be as in standard \SpecialChar LaTeX
16287 \begin_inset Flex Code
16290 \begin_layout Plain Layout
16297 \begin_inset Flex Code
16300 \begin_layout Plain Layout
16307 \begin_inset Flex Code
16310 \begin_layout Plain Layout
16317 \begin_inset Flex Code
16320 \begin_layout Plain Layout
16326 for top, bottom, page, and here, respectively.
16330 \begin_layout Plain Layout
16331 Note that the order of these letters in the string is irrelevant, like in
16338 On top of that there is a new type,
16339 \begin_inset Flex Code
16342 \begin_layout Plain Layout
16348 , which does not really correspond to a float, since it means: put it
16349 \begin_inset Quotes eld
16353 \begin_inset Quotes erd
16357 Note however that the
16358 \begin_inset Flex Code
16361 \begin_layout Plain Layout
16367 specifier is special and, because of implementation details, cannot be
16368 used in non-built in float types.
16369 If you do not understand what this means, just use
16370 \begin_inset Quotes eld
16374 \begin_inset Flex Code
16377 \begin_layout Plain Layout
16384 \begin_inset Quotes erd
16390 \begin_layout Description
16391 \begin_inset Flex Code
16394 \begin_layout Plain Layout
16401 \begin_inset Flex Code
16404 \begin_layout Plain Layout
16410 ] The prefix to use when creating labels referring to floats of this type.
16411 This allows the use of formatted references.
16412 Note that you can remove any
16413 \begin_inset Flex Code
16416 \begin_layout Plain Layout
16422 set by a copied style by using the special value
16423 \begin_inset Quotes eld
16427 \begin_inset Quotes erd
16430 , which must be all caps.
16433 \begin_layout Description
16434 \begin_inset Flex Code
16437 \begin_layout Plain Layout
16444 \begin_inset Flex Code
16447 \begin_layout Plain Layout
16454 \begin_inset Quotes erd
16458 \begin_inset Quotes erd
16461 ] The style used when defining the float using
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16476 \begin_layout Description
16477 \begin_inset Flex Code
16480 \begin_layout Plain Layout
16487 \begin_inset Flex Code
16490 \begin_layout Plain Layout
16497 \begin_inset Quotes erd
16501 \begin_inset Quotes erd
16505 \begin_inset Quotes eld
16509 \begin_inset Quotes erd
16512 of the new class of floats, like program or algorithm.
16513 After the appropriate
16514 \begin_inset Flex Code
16517 \begin_layout Plain Layout
16526 \begin_inset Flex Code
16529 \begin_layout Plain Layout
16538 \begin_inset Flex Code
16541 \begin_layout Plain Layout
16552 \begin_layout Description
16553 \begin_inset Flex Code
16556 \begin_layout Plain Layout
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16573 \begin_inset space \thinspace{}
16577 \begin_inset Flex Code
16580 \begin_layout Plain Layout
16588 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16599 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16603 \begin_layout Standard
16604 Note that defining a float with type
16605 \begin_inset Flex Code
16608 \begin_layout Plain Layout
16616 automatically defines the corresponding counter with name
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16631 \begin_layout Subsection
16632 Flex insets and InsetLayout
16633 \begin_inset CommandInset label
16635 name "subsec:Flex-insets-and"
16642 \begin_layout Standard
16643 Flex insets come in three different kinds:
16646 \begin_layout Itemize
16648 \begin_inset Flex Code
16651 \begin_layout Plain Layout
16657 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16685 \begin_layout Itemize
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16696 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16698 footnote, and the like.
16699 An obvious example is an endnote inset, which is defined in the
16700 \begin_inset Flex Code
16703 \begin_layout Plain Layout
16712 \begin_layout Itemize
16714 \begin_inset Flex Code
16717 \begin_layout Plain Layout
16723 ): For use with DocBook classes.
16726 \begin_layout Standard
16727 Flex insets are defined using the
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16737 tag, which shall be explained in a moment.
16740 \begin_layout Standard
16742 \begin_inset Flex Code
16745 \begin_layout Plain Layout
16751 tag also serves another function: It can be used to customize the general
16752 layout of many different types of insets.
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16763 can be used to customize the layout parameters for footnotes, marginal
16764 notes, note insets, \SpecialChar TeX
16765 code (ERT) insets, branches, listings, indexes, boxes,
16766 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16769 \begin_layout Standard
16771 \begin_inset Flex Code
16774 \begin_layout Plain Layout
16780 definition must begin with a line of the form:
16783 \begin_layout LyX-Code
16787 \begin_layout Standard
16789 \begin_inset Flex Code
16792 \begin_layout Plain Layout
16798 indicates the inset whose layout is being defined, and here there are four
16802 \begin_layout Enumerate
16803 The layout for a pre-existing inset is being modified.
16804 In this case, can be
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16814 any one of the following:
16815 \begin_inset Flex Code
16818 \begin_layout Plain Layout
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16845 \begin_inset Flex Code
16848 \begin_layout Plain Layout
16855 \begin_inset Flex Code
16858 \begin_layout Plain Layout
16865 \begin_inset Flex Code
16868 \begin_layout Plain Layout
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16885 \begin_inset Flex Code
16888 \begin_layout Plain Layout
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16905 \begin_inset Flex Code
16908 \begin_layout Plain Layout
16915 \begin_inset Flex Code
16918 \begin_layout Plain Layout
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16965 \begin_inset Flex Code
16968 \begin_layout Plain Layout
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17017 \begin_layout Enumerate
17018 The layout for a Flex inset is being defined.
17020 \begin_inset Flex Code
17023 \begin_layout Plain Layout
17029 must be of the form
17030 \begin_inset Quotes eld
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17044 \begin_inset Quotes erd
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17057 may be be any valid identifier not used by a pre-existing Flex inset.
17058 The identifier may include spaces, but in that case the whole thing must
17059 be wrapped in quotes.
17060 Note that the definition of a flex inset
17065 \begin_inset Flex Code
17068 \begin_layout Plain Layout
17074 entry, declaring which type of inset it defines.
17077 \begin_layout Enumerate
17078 The layout for user specific branch is being defined.
17080 \begin_inset Flex Code
17083 \begin_layout Plain Layout
17089 must be of the form
17090 \begin_inset Quotes eld
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17104 \begin_inset Quotes erd
17108 \begin_inset Flex Code
17111 \begin_layout Plain Layout
17117 may be be any valid identifier of branch defined in user's document.
17118 The identifier may include spaces, but in that case the whole thing must
17119 be wrapped in quotes.
17120 The main purpose of this feature is to allow \SpecialChar LaTeX
17121 wrapping around specific
17122 branches as user needs.
17125 \begin_layout Enumerate
17126 The layout of a user (or class) specific caption is being defined.
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17137 must be of the form
17138 \begin_inset Quotes eld
17142 \begin_inset Flex Code
17145 \begin_layout Plain Layout
17152 \begin_inset Quotes erd
17156 \begin_inset Flex Code
17159 \begin_layout Plain Layout
17165 specifies the name of the caption as it appears in the menu.
17166 Have a look at the standard caption (
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17176 ), the specific captions of the KOMA-Script classes (
17177 \begin_inset Flex Code
17180 \begin_layout Plain Layout
17187 \begin_inset Flex Code
17190 \begin_layout Plain Layout
17199 \begin_inset space ~
17205 \begin_inset Flex Code
17208 \begin_layout Plain Layout
17214 ) for applications.
17217 \begin_layout Standard
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17228 definition can contain the following entries:
17231 \begin_layout Description
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17251 ] Defines argument number of a command\SpecialChar breakableslash
17252 environment associated with the current
17254 The definition must end with
17255 \begin_inset Flex Code
17258 \begin_layout Plain Layout
17266 \begin_inset CommandInset ref
17268 reference "subsec:Paragraph-Styles"
17275 \begin_layout Description
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17285 Preamble for changing language commands; see
17286 \begin_inset CommandInset ref
17288 reference "subsec:I18n"
17295 \begin_layout Description
17296 \begin_inset Flex Code
17299 \begin_layout Plain Layout
17306 \begin_inset Flex Code
17309 \begin_layout Plain Layout
17315 ] The color for the inset's background.
17317 \begin_inset CommandInset ref
17319 reference "chap:Names-of-colors"
17323 for a list of the available color names.
17326 \begin_layout Description
17327 \begin_inset Flex Code
17330 \begin_layout Plain Layout
17337 \begin_inset Flex Code
17340 \begin_layout Plain Layout
17349 \begin_inset space \thinspace{}
17353 \begin_inset Flex Code
17356 \begin_layout Plain Layout
17362 ] Whether to use the content of the inset as the label, when the inset is
17367 \begin_layout Description
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17378 \begin_inset Flex Code
17381 \begin_layout Plain Layout
17387 ] As with paragraph styles, see
17388 \begin_inset CommandInset ref
17390 reference "subsec:Paragraph-Styles"
17395 Note that you need to specify the complete type, e.
17396 \begin_inset space \thinspace{}
17400 \begin_inset space ~
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17408 CopyStyle Flex:<name>
17416 \begin_layout Description
17417 \begin_inset Flex Code
17420 \begin_layout Plain Layout
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17439 \begin_inset space \thinspace{}
17443 \begin_inset Flex Code
17446 \begin_layout Plain Layout
17452 ] Indicates whether the user may employ the Paragraph Settings dialog to
17453 customize the paragraph.
17456 \begin_layout Description
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17467 \begin_inset Flex Code
17470 \begin_layout Plain Layout
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17487 \begin_inset Flex Code
17490 \begin_layout Plain Layout
17496 , describing the rendering style used for the inset's frame and buttons.
17497 Footnotes generally use
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17507 , ERT insets generally
17508 \begin_inset Flex Code
17511 \begin_layout Plain Layout
17517 , and character styles
17518 \begin_inset Flex Code
17521 \begin_layout Plain Layout
17530 \begin_layout Description
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17553 \begin_inset space \thinspace{}
17559 \begin_inset Flex Code
17562 \begin_layout Plain Layout
17571 \begin_inset Flex Code
17574 \begin_layout Plain Layout
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17591 Indicates whether the environment will stand on its own in the output or
17592 will appear inline with the surrounding text.
17593 If set to false, it is supposed that the \SpecialChar LaTeX
17594 environment ignores white space
17595 (including one newline character) after the
17596 \begin_inset Flex Code
17599 \begin_layout Plain Layout
17612 \begin_inset Flex Code
17615 \begin_layout Plain Layout
17631 \begin_layout Description
17632 \begin_inset Flex Code
17635 \begin_layout Plain Layout
17641 Required at the end of the
17642 \begin_inset Flex Code
17645 \begin_layout Plain Layout
17654 \begin_layout Description
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 The font used for both the text body
17670 \begin_inset CommandInset ref
17672 reference "subsec:Font-description"
17677 Note that defining this font automatically defines the
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17687 to the same value, so define this first and define
17688 \begin_inset Flex Code
17691 \begin_layout Plain Layout
17697 later if you want them to be different.
17700 \begin_layout Description
17701 \begin_inset Flex Code
17704 \begin_layout Plain Layout
17705 FixedWidthPreambleEncoding
17711 \begin_inset Flex Code
17714 \begin_layout Plain Layout
17723 \begin_inset space \thinspace{}
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17736 ] Force a fixed width encoding for the translated contents of
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17756 code generated by this layout.
17757 This is needed for special \SpecialChar LaTeX
17762 that do not work with variable width encodings such as
17767 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
17768 backends such as Xe\SpecialChar TeX
17770 Lua\SpecialChar TeX
17774 \begin_layout Description
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17779 ForceLocalFontSwitch
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17797 \begin_inset space \thinspace{}
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17810 ] When using babel, always use a local font switch (
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17822 ), never a global one (such as
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17837 \begin_layout Description
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17848 \begin_inset Flex Code
17851 \begin_layout Plain Layout
17860 \begin_inset space \thinspace{}
17864 \begin_inset Flex Code
17867 \begin_layout Plain Layout
17874 \begin_inset Quotes eld
17878 \begin_inset Quotes erd
17881 language, leading to Left-to-Right (Latin) output, e.
17882 \begin_inset space \thinspace{}
17886 \begin_inset space \space{}
17889 in \SpecialChar TeX
17894 \begin_layout Description
17895 \begin_inset Flex Code
17898 \begin_layout Plain Layout
17905 \begin_inset Flex Code
17908 \begin_layout Plain Layout
17917 \begin_inset space \thinspace{}
17921 \begin_inset Flex Code
17924 \begin_layout Plain Layout
17930 ] Force a a line break in the \SpecialChar LaTeX
17931 output before the inset starts and after
17933 This assures the inset itself is output on its own lines, for parsing purposes.
17936 \begin_layout Description
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17959 \begin_inset space \thinspace{}
17963 \begin_inset Flex Code
17966 \begin_layout Plain Layout
17972 ] Indicates whether the
17973 \begin_inset Flex Code
17976 \begin_layout Plain Layout
17982 should be used or, instead, the user can change the paragraph style used
17987 \begin_layout Description
17988 \begin_inset Flex Code
17991 \begin_layout Plain Layout
17998 \begin_inset Flex Code
18001 \begin_layout Plain Layout
18010 \begin_inset space \thinspace{}
18014 \begin_inset Flex Code
18017 \begin_layout Plain Layout
18023 ] As with paragraph styles, see
18024 \begin_inset CommandInset ref
18026 reference "subsec:Paragraph-Styles"
18033 \begin_layout Description
18034 \begin_inset Flex Code
18037 \begin_layout Plain Layout
18043 These tags control the XHTML output.
18045 \begin_inset CommandInset ref
18047 reference "sec:Tags-for-XHTML"
18054 \begin_layout Description
18055 \begin_inset Flex Code
18058 \begin_layout Plain Layout
18065 \begin_inset Flex Code
18068 \begin_layout Plain Layout
18077 \begin_inset space \thinspace{}
18081 \begin_inset Flex Code
18084 \begin_layout Plain Layout
18090 ] Whether to include the contents of this inset in the strings generated
18091 for the `Outline' pane.
18092 One would not, for example, want the content of a footnote in a section
18093 header to be included in the TOC displayed in the outline, but one would
18094 normally want the content of a character style displayed.
18095 Default is false: not to include.
18098 \begin_layout Description
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18123 \begin_inset space \thinspace{}
18127 \begin_inset Flex Code
18130 \begin_layout Plain Layout
18136 ] As with paragraph styles, see
18137 \begin_inset CommandInset ref
18139 reference "subsec:Paragraph-Styles"
18146 \begin_layout Description
18147 \begin_inset Flex Code
18150 \begin_layout Plain Layout
18156 The font used for the label.
18158 \begin_inset CommandInset ref
18160 reference "subsec:Font-description"
18165 Note that this definition can never appear before
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18175 , lest it be ineffective.
18178 \begin_layout Description
18179 \begin_inset Flex Code
18182 \begin_layout Plain Layout
18189 \begin_inset Flex Code
18192 \begin_layout Plain Layout
18199 \begin_inset Quotes erd
18203 \begin_inset Quotes erd
18206 ] What will be displayed on the button or elsewhere as the inset label.
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18219 \begin_inset Flex Code
18222 \begin_layout Plain Layout
18228 ) modify this label on the fly.
18231 \begin_layout Description
18232 \begin_inset Flex Code
18235 \begin_layout Plain Layout
18241 Language dependent preamble; see
18242 \begin_inset CommandInset ref
18244 reference "subsec:I18n"
18251 \begin_layout Description
18252 \begin_inset Flex Code
18255 \begin_layout Plain Layout
18262 \begin_inset Flex Code
18265 \begin_layout Plain Layout
18271 ] The name of the corresponding \SpecialChar LaTeX
18273 Either the environment or command name.
18276 \begin_layout Description
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18287 \begin_inset Flex Code
18290 \begin_layout Plain Layout
18296 ] The optional parameter for the corresponding
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 stuff, including possible bracket pairs like
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18317 This parameter cannot be changed from within \SpecialChar LyX
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18328 for customizable parameters).
18329 It will be output as is after all \SpecialChar LaTeX
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18343 \begin_layout Description
18344 \begin_inset Flex Code
18347 \begin_layout Plain Layout
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18358 Command, Environment, None
18363 ] How the style should be translated into \SpecialChar LaTeX
18368 \begin_layout Plain Layout
18369 \begin_inset Flex Code
18372 \begin_layout Plain Layout
18378 is perhaps a bit misleading, since these rules apply to SGML classes too.
18379 Visit the SGML class files for specific examples.
18388 \begin_layout Description
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18398 means nothing special
18401 \begin_layout Description
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18422 {\SpecialChar ldots
18431 \begin_layout Description
18432 \begin_inset Flex Code
18435 \begin_layout Plain Layout
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18452 }\SpecialChar ldots
18467 \begin_layout Standard
18468 Putting the last few things together, the \SpecialChar LaTeX
18469 output will be either:
18472 \begin_layout LyX-Code
18475 LatexName[LatexParam]{\SpecialChar ldots
18479 \begin_layout Standard
18483 \begin_layout LyX-Code
18486 begin{LatexName}[LatexParam] \SpecialChar ldots
18492 \begin_layout Standard
18493 depending upon the \SpecialChar LaTeX
18498 \begin_layout Description
18499 \begin_inset Flex Code
18502 \begin_layout Plain Layout
18509 \begin_inset Flex Code
18512 \begin_layout Plain Layout
18518 ] A string that is put at the beginning of the layout content.
18519 A line break in the output can be indicated by
18520 \begin_inset Flex Code
18523 \begin_layout Plain Layout
18532 \begin_layout Description
18533 \begin_inset Flex Code
18536 \begin_layout Plain Layout
18543 \begin_inset Flex Code
18546 \begin_layout Plain Layout
18553 \begin_inset Flex Code
18556 \begin_layout Plain Layout
18563 \begin_inset Flex Code
18566 \begin_layout Plain Layout
18573 \begin_inset Flex Code
18576 \begin_layout Plain Layout
18582 (indicating a dummy definition ending definitions of charstyles, etc).
18583 This entry is required in and is only meaningful for Flex insets.
18584 Among other things, it determines on which menu this inset will appear.
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18596 \begin_inset Flex Code
18599 \begin_layout Plain Layout
18605 will automatically set
18606 \begin_inset Flex Code
18609 \begin_layout Plain Layout
18616 \begin_inset Flex Code
18619 \begin_layout Plain Layout
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18636 can be set to true, or
18637 \begin_inset Flex Code
18640 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18656 insets by setting it
18661 \begin_inset Flex Code
18664 \begin_layout Plain Layout
18673 \begin_layout Description
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18684 \begin_inset Flex Code
18687 \begin_layout Plain Layout
18696 \begin_inset space \thinspace{}
18700 \begin_inset Flex Code
18703 \begin_layout Plain Layout
18709 ] Whether multiple paragraphs are permitted in this inset.
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18720 to the same value and
18721 \begin_inset Flex Code
18724 \begin_layout Plain Layout
18730 to the opposite value.
18731 These can be reset to other values, if they are used
18736 \begin_inset Flex Code
18739 \begin_layout Plain Layout
18749 \begin_layout Description
18750 \begin_inset Flex Code
18753 \begin_layout Plain Layout
18760 \begin_inset Flex Code
18763 \begin_layout Plain Layout
18772 \begin_inset space \thinspace{}
18776 \begin_inset Flex Code
18779 \begin_layout Plain Layout
18785 ] Whether fragile commands in this inset should be
18786 \begin_inset Flex Code
18789 \begin_layout Plain Layout
18802 whether the command should itself be protected.) Default is false.
18805 \begin_layout Description
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18825 ] Deletes an existing
18826 \begin_inset Flex Code
18829 \begin_layout Plain Layout
18838 \begin_layout Description
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18859 \begin_inset Flex Code
18862 \begin_layout Plain Layout
18868 that has replaced this
18869 \begin_inset Flex Code
18872 \begin_layout Plain Layout
18879 This is used to rename an
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18889 , while keeping backward compatibility.
18892 \begin_layout Description
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18915 \begin_inset space \thinspace{}
18919 \begin_inset Flex Code
18922 \begin_layout Plain Layout
18928 ] As with paragraph styles, see
18929 \begin_inset CommandInset ref
18931 reference "subsec:Paragraph-Styles"
18939 \begin_layout Description
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18962 \begin_inset space \thinspace{}
18966 \begin_inset Flex Code
18969 \begin_layout Plain Layout
18975 ] As with paragraph styles, see
18976 \begin_inset CommandInset ref
18978 reference "subsec:Paragraph-Styles"
18986 \begin_layout Description
18987 \begin_inset Flex Code
18990 \begin_layout Plain Layout
18996 As with paragraph styles, see
18997 \begin_inset CommandInset ref
18999 reference "subsec:Paragraph-Styles"
19006 \begin_layout Description
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19017 \begin_inset Flex Code
19020 \begin_layout Plain Layout
19026 ] The prefix to use when creating labels referring to insets of this type.
19027 This allows the use of formatted references.
19030 \begin_layout Description
19031 \begin_inset Flex Code
19034 \begin_layout Plain Layout
19041 \begin_inset Flex Code
19044 \begin_layout Plain Layout
19050 ] As with paragraph styles, see
19051 \begin_inset CommandInset ref
19053 reference "subsec:Paragraph-Styles"
19060 \begin_layout Description
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19071 \begin_inset Flex Code
19074 \begin_layout Plain Layout
19083 \begin_inset space \thinspace{}
19087 \begin_inset Flex Code
19090 \begin_layout Plain Layout
19096 ] Resets the \SpecialChar LaTeX
19097 arguments of this layout (as defined via the
19098 \begin_inset Flex Code
19101 \begin_layout Plain Layout
19108 This is useful if you have copied a style via
19109 \begin_inset Flex Code
19112 \begin_layout Plain Layout
19118 , but you do not want to inherit its (required and optional) arguments.
19121 \begin_layout Description
19122 \begin_inset Flex Code
19125 \begin_layout Plain Layout
19132 \begin_inset Flex Code
19135 \begin_layout Plain Layout
19142 \begin_inset space \thinspace{}
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19157 ] Whether this inset should use the font of its surrounding environment
19159 Default is false: use the font of the surrounding environment.
19162 \begin_layout Description
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19173 \begin_inset Flex Code
19176 \begin_layout Plain Layout
19182 ] A string that is put at the end of the layout content.
19183 A line break in the output can be indicated by
19184 \begin_inset Flex Code
19187 \begin_layout Plain Layout
19196 \begin_layout Description
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19207 \begin_inset Flex Code
19210 \begin_layout Plain Layout
19217 \begin_inset space \thinspace{}
19221 \begin_inset Flex Code
19224 \begin_layout Plain Layout
19232 ] Allow spell-checking the contents of this inset.
19236 \begin_layout Subsection
19238 \begin_inset CommandInset label
19240 name "subsec:Counters"
19247 \begin_layout Standard
19248 It is necessary to define the counters (
19249 \begin_inset Flex Noun
19252 \begin_layout Plain Layout
19259 \begin_inset Flex Noun
19262 \begin_layout Plain Layout
19268 , \SpecialChar ldots
19269 ) in the text class itself.
19270 The standard counters are defined in the file
19271 \begin_inset Flex Code
19274 \begin_layout Plain Layout
19280 , so you may have to do no more than add
19283 \begin_layout LyX-Code
19284 Input stdcounters.inc
19287 \begin_layout Standard
19288 to your layout file to get them to work.
19289 But if you want to define custom counters, then you can do so.
19290 The counter declaration must begin with:
19293 \begin_layout LyX-Code
19294 Counter CounterName
19297 \begin_layout Standard
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19308 ' is replaced by the name of the counter.
19309 And it must end with
19310 \begin_inset Quotes eld
19314 \begin_inset Flex Code
19317 \begin_layout Plain Layout
19324 \begin_inset Quotes erd
19328 The following parameters can also be used:
19331 \begin_layout Description
19332 \begin_inset Flex Code
19335 \begin_layout Plain Layout
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19351 ] Sets the initial value for the counter, to which it will be reset whenever
19353 Normally, one will want the default, 1.
19356 \begin_layout Description
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19377 \begin_inset Quotes erd
19381 \begin_inset Quotes erd
19384 ] When defined, this string defines how the counter is displayed.
19385 Setting this value sets
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19390 LabelStringAppendix
19396 The following special constructs can be used in the string:
19400 \begin_layout Itemize
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19412 will be replaced by the expansion of the
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19423 \begin_inset Flex Code
19426 \begin_layout Plain Layout
19427 LabelStringAppendix
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19446 \begin_layout Itemize
19447 counter values can be expressed using \SpecialChar LaTeX
19449 \begin_inset Newline newline
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19488 \begin_layout Plain Layout
19498 Actually, the situation is a bit more complicated: any
19517 other than those described below will produce arabic numerals.
19518 It would not be surprising to see this change in the future.
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19533 : 1, 2, 3,\SpecialChar ldots
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19544 for lower-case letters: a, b, c, \SpecialChar ldots
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19555 for upper-case letters: A, B, C, \SpecialChar ldots
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19566 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19568 \begin_inset Flex Code
19571 \begin_layout Plain Layout
19577 for upper-case roman numerals: I, II, III\SpecialChar ldots
19579 \begin_inset Flex Code
19582 \begin_layout Plain Layout
19588 for hebrew numerals.
19592 \begin_layout Standard
19593 If LabelString is not defined, a default value is constructed as follows:
19594 if the counter has a master counter
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19605 \begin_inset Flex Code
19608 \begin_layout Plain Layout
19615 \begin_inset Newline newline
19619 \begin_inset Flex Code
19622 \begin_layout Plain Layout
19632 is used; otherwise the string
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19647 \begin_layout Description
19648 \begin_inset Flex Code
19651 \begin_layout Plain Layout
19652 LabelStringAppendix
19658 \begin_inset Flex Code
19661 \begin_layout Plain Layout
19668 \begin_inset Quotes erd
19672 \begin_inset Quotes erd
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19685 , but for use in the Appendix.
19688 \begin_layout Description
19689 \begin_inset Flex Code
19692 \begin_layout Plain Layout
19699 \begin_inset Flex Code
19702 \begin_layout Plain Layout
19709 \begin_inset Quotes erd
19713 \begin_inset Quotes erd
19716 ] A format for use with formatted references to this counter.
19717 For example, one might want to have references to section numbers appear
19719 \begin_inset Quotes eld
19723 \begin_inset Quotes erd
19727 The string should contain
19728 \begin_inset Quotes eld
19732 \begin_inset Quotes erd
19736 This will be replaced by the counter number itself.
19737 So, for sections, it would be: Section ##.
19740 \begin_layout Description
19741 \begin_inset Flex Code
19744 \begin_layout Plain Layout
19751 \begin_inset Flex Code
19754 \begin_layout Plain Layout
19761 \begin_inset Quotes erd
19765 \begin_inset Quotes erd
19768 ] If this is set to the name of another counter, the present counter will
19769 be reset every time the other one is increased.
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19793 \begin_layout Subsection
19795 \begin_inset CommandInset label
19797 name "subsec:Font-description"
19804 \begin_layout Standard
19805 A font description looks like this:
19808 \begin_layout LyX-Code
19822 \begin_layout LyX-Code
19826 \begin_layout LyX-Code
19830 \begin_layout Standard
19831 The following commands are available:
19834 \begin_layout Description
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19937 \begin_inset Flex Code
19940 \begin_layout Plain Layout
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20037 \begin_inset Flex Code
20040 \begin_layout Plain Layout
20049 \begin_layout Description
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20094 \begin_layout Description
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20114 ] Valid arguments are:
20115 \begin_inset Flex Code
20118 \begin_layout Plain Layout
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20155 \begin_inset Flex Code
20158 \begin_layout Plain Layout
20165 \begin_inset Flex Code
20168 \begin_layout Plain Layout
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20195 \begin_inset Flex Code
20198 \begin_layout Plain Layout
20205 \begin_inset Flex Code
20208 \begin_layout Plain Layout
20215 \begin_inset Flex Code
20218 \begin_layout Plain Layout
20225 \begin_inset Flex Code
20228 \begin_layout Plain Layout
20235 Each of these turns on or off the corresponding attribute.
20237 \begin_inset Flex Code
20240 \begin_layout Plain Layout
20246 turns on emphasis, and
20247 \begin_inset Flex Code
20250 \begin_layout Plain Layout
20258 \begin_inset Newline newline
20261 If the latter seems puzzling, remember that the font settings for the present
20262 context are generally inherited from the surrounding context.
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20273 would turn off the emphasis that was anyway in effect, say, in a theorem
20277 \begin_layout Description
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20300 \begin_inset Flex Code
20303 \begin_layout Plain Layout
20312 \begin_layout Description
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20345 \begin_inset Flex Code
20348 \begin_layout Plain Layout
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20367 \begin_layout Description
20368 \begin_inset Flex Code
20371 \begin_layout Plain Layout
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20398 \begin_inset Flex Code
20401 \begin_layout Plain Layout
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20462 \begin_layout Subsection
20463 \begin_inset CommandInset label
20465 name "subsec:Citation-format-description"
20469 Citation format description
20472 \begin_layout Standard
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20483 blocks are used to describe how bibliographic information should be displayed,
20484 both within \SpecialChar LyX
20485 itself (in the citation dialog and in tooltips, for example)
20486 and in XHTML output.
20487 Such a block might look like this:
20490 \begin_layout LyX-Code
20494 \begin_layout LyX-Code
20498 \begin_layout LyX-Code
20502 \begin_layout LyX-Code
20506 \begin_layout Standard
20507 The individual lines define how the bibliographic information associated
20508 with an article or book, respectively, is to be displayed, and such a definitio
20509 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20512 defines a default format in the source code that will be used if no specific
20513 definition has been given.
20515 predefines several formats in the file
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20525 , which is included in most of \SpecialChar LyX
20526 's document classes.
20529 \begin_layout Standard
20530 The definitions use a simple language that allows Bib\SpecialChar TeX
20531 keys to be replaced
20533 Keys should be enclosed in
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20554 So a simple definition might look like this:
20557 \begin_layout LyX-Code
20559 \begin_inset Quotes eld
20563 \begin_inset Quotes erd
20569 \begin_layout Standard
20570 This would print the author, followed by a comma, followed by the title,
20571 in quotes, followed by a period.
20574 \begin_layout Standard
20575 Of course, sometimes you may want to print a key only if it exists.
20576 This can be done by using a conditional construction, such as:
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20582 \begin_inset space ~
20592 \begin_inset Flex Code
20595 \begin_layout Plain Layout
20601 key exists, then print
20602 \begin_inset Quotes eld
20606 \begin_inset space ~
20610 \begin_inset Quotes erd
20613 followed by the volume key.
20614 It is also possible to have an else clause in the conditional, such as:
20615 \begin_inset Newline newline
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20623 {%author%[[%author%]][[%editor%, ed.]]}
20629 \begin_inset Newline newline
20633 \begin_inset Flex Code
20636 \begin_layout Plain Layout
20642 key is printed if it exists; otherwise, the editor key is printed, followed
20644 \begin_inset Quotes eld
20648 \begin_inset space ~
20652 \begin_inset Quotes erd
20655 Note that the key is again enclosed in
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20665 signs; the entire conditional is enclosed in braces; and the if and else
20666 clauses are enclosed in double brackets,
20667 \begin_inset Quotes eld
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20681 \begin_inset Quotes eld
20685 \begin_inset Quotes eld
20689 \begin_inset Flex Code
20692 \begin_layout Plain Layout
20699 \begin_inset Quotes erd
20703 There must be no space between any of these.
20706 \begin_layout Standard
20707 There is one other piece of syntax available in definitions, which looks
20709 \begin_inset Flex Code
20712 \begin_layout Plain Layout
20719 This defines a piece of formatting information that is to be used when
20721 \begin_inset Quotes eld
20725 \begin_inset Quotes erd
20729 Obviously, we do not want to output HTML tags when writing plain text,
20730 so they should be wrapped in
20731 \begin_inset Quotes eld
20735 \begin_inset Quotes erd
20739 \begin_inset Quotes eld
20743 \begin_inset Quotes erd
20749 \begin_layout Standard
20750 Two special sorts of definitions are also possible in a
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20761 An example of the first would be:
20764 \begin_layout LyX-Code
20766 \begin_inset Quotes eld
20770 \begin_inset Quotes erd
20776 \begin_layout Standard
20777 This is an abbreviation, or macro, and it can be used by treating it as
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20800 exactly as it would treat its definition.
20801 So, let us issue the obvious
20809 \begin_layout LyX-Code
20813 \begin_layout Standard
20814 or anything like it.
20816 shouldn't go into an infinite loop, but it may go into a long one before
20820 \begin_layout Standard
20821 The second sort of special definition might look like this:
20824 \begin_layout LyX-Code
20828 \begin_layout Standard
20829 This defines a translatable piece of text, which allows relevant parts of
20830 the bibliography to be translated.
20831 It can be included in a definition by treating it as a key:
20832 \begin_inset Flex Code
20835 \begin_layout Plain Layout
20842 Several of these are predefined in
20843 \begin_inset Flex Code
20846 \begin_layout Plain Layout
20853 Note that these are not macros, in the sense just defined.
20854 They will not be expanded.
20857 \begin_layout Standard
20858 So here then is an example that use all these features:
20859 \begin_inset VSpace defskip
20865 \begin_layout Standard
20869 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20872 \begin_layout Standard
20873 \begin_inset VSpace defskip
20876 This defines a macro that prints the author, followed by a comma, if the
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20887 key is defined, or else prints the name of the editor, followed by the
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20898 or its translation (it is by default
20899 \begin_inset Quotes eld
20903 \begin_inset Quotes erd
20907 \begin_inset Flex Code
20910 \begin_layout Plain Layout
20917 Note that this is in fact defined in
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20927 , so you can use it in your own definitions, or re-definitions, if you load
20931 \begin_layout Section
20932 \begin_inset CommandInset label
20934 name "sec:Tags-for-XHTML"
20938 Tags for XHTML output
20941 \begin_layout Standard
20942 As with \SpecialChar LaTeX
20943 or DocBook, the format of \SpecialChar LyX
20944 's XHTML output is also controlled by
20945 layout information.
20946 In general, \SpecialChar LyX
20947 provides sensible defaults and, as mentioned earlier, it will
20948 even construct default CSS style rules from the other layout tags.
20949 For example, \SpecialChar LyX
20950 will attempt to use the information provided in the
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20960 declaration for the Chapter style to write CSS that will appropriately
20961 format chapter headings.
20964 \begin_layout Standard
20965 In many cases, then, you may not have to do anything at all to get acceptable
20966 XHTML output for your own environments, custom insets, and so forth.
20967 But in some cases you will, and so \SpecialChar LyX
20968 provides a number of layout tags that
20969 can be used to customize the XHTML and CSS that are generated.
20972 \begin_layout Standard
20973 Note that there are two tags,
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20993 that may appear outside style and inset declarations.
20995 \begin_inset CommandInset ref
20997 reference "subsec:General-text-class"
21001 for details on these.
21004 \begin_layout Subsection
21005 \begin_inset CommandInset label
21007 name "subsec:Paragraph-Style-XHTML"
21014 \begin_layout Standard
21015 The sort of XHTML \SpecialChar LyX
21016 outputs for a paragraph depends upon whether we are dealing
21017 with a normal paragraph, a command, or an environment, where this is itself
21018 determined by the contents of the corresponding
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21033 \begin_layout Standard
21034 For a command or normal paragraph, the output XHTML has the following form:
21037 \begin_layout LyX-Code
21039 \begin_inset Quotes erd
21043 \begin_inset Quotes erd
21049 \begin_layout LyX-Code
21051 \begin_inset Quotes erd
21055 \begin_inset Quotes erd
21061 \begin_layout LyX-Code
21062 Contents of the paragraph.
21065 \begin_layout LyX-Code
21069 \begin_layout Standard
21070 The label tags are of course omitted if the paragraph does not have a label.
21073 \begin_layout Standard
21074 For an environment that is not some sort of list, the XHTML takes this form:
21077 \begin_layout LyX-Code
21079 \begin_inset Quotes erd
21083 \begin_inset Quotes erd
21089 \begin_layout LyX-Code
21091 \begin_inset Quotes erd
21095 \begin_inset Quotes erd
21099 \begin_inset Quotes erd
21103 \begin_inset Quotes erd
21106 >Environment Label</labeltag>First paragraph.</itemtag>
21109 \begin_layout LyX-Code
21110 <itemtag>Second paragraph.</itemtag>
21113 \begin_layout LyX-Code
21117 \begin_layout Standard
21118 Note that the label is output only for the first paragraph, as it should
21119 be for a theorem, for example.
21123 \begin_layout Standard
21124 For a list, we have one of these forms:
21127 \begin_layout LyX-Code
21129 \begin_inset Quotes erd
21133 \begin_inset Quotes erd
21139 \begin_layout LyX-Code
21141 \begin_inset Quotes erd
21145 \begin_inset Quotes erd
21149 \begin_inset Quotes erd
21153 \begin_inset Quotes erd
21156 >List Label</labeltag>First item.</itemtag>
21159 \begin_layout LyX-Code
21161 \begin_inset Quotes erd
21165 \begin_inset Quotes erd
21169 \begin_inset Quotes erd
21173 \begin_inset Quotes erd
21176 >List Label</labeltag>Second item.</itemtag>
21179 \begin_layout LyX-Code
21183 \begin_layout LyX-Code
21187 \begin_layout LyX-Code
21189 \begin_inset Quotes erd
21193 \begin_inset Quotes erd
21199 \begin_layout LyX-Code
21201 \begin_inset Quotes erd
21205 \begin_inset Quotes erd
21208 >List Label</labeltag><itemtag attr=
21209 \begin_inset Quotes erd
21213 \begin_inset Quotes erd
21216 >First item.</itemtag>
21219 \begin_layout LyX-Code
21221 \begin_inset Quotes erd
21225 \begin_inset Quotes erd
21228 >List Label</labeltag><itemtag attr=
21229 \begin_inset Quotes erd
21233 \begin_inset Quotes erd
21236 >Second item.</itemtag>
21239 \begin_layout LyX-Code
21243 \begin_layout Standard
21244 Note the different orders of
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 Which order we get depends upon the setting of
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21285 is false (the default), you get the first of these, with the label within
21286 the item; if true, you get the second, with the label outside the item.
21289 \begin_layout Standard
21290 The specific tags and attributes output for each paragraph type can be controlle
21291 d by means of the layout tags we are about to describe.
21292 As mentioned earlier, however, \SpecialChar LyX
21293 uses sensible defaults for many of these,
21294 so you often may not need to do very much to get good XHTML output.
21295 Think of the available tags as there so you can tweak things to your liking.
21298 \begin_layout Description
21299 \begin_inset Flex Code
21302 \begin_layout Plain Layout
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21318 ] Specifies attribute information to be output with the main tag.
21320 \begin_inset Quotes eld
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21334 \begin_inset Quotes erd
21338 By default, \SpecialChar LyX
21340 \begin_inset Quotes eld
21344 \begin_inset Flex Code
21347 \begin_layout Plain Layout
21354 \begin_inset Quotes erd
21358 \begin_inset Flex Code
21361 \begin_layout Plain Layout
21367 is the \SpecialChar LyX
21368 name of the layout, made lowercase, for example: chapter.
21373 contain any style information.
21375 \begin_inset Flex Code
21378 \begin_layout Plain Layout
21387 \begin_layout Description
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21398 \begin_inset Flex Code
21401 \begin_layout Plain Layout
21411 ] Whether to output the default CSS information \SpecialChar LyX
21412 generates for this layout,
21413 even if additional information is explicitly provided via
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21434 allows you to alter or augment the generated CSS, rather than to override
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21449 \begin_layout Description
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21460 \begin_inset Flex Code
21463 \begin_layout Plain Layout
21469 ] The tag to be used for individual paragraphs of environments, replacing
21471 \begin_inset Flex Code
21474 \begin_layout Plain Layout
21480 in the examples above.
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21494 \begin_layout Description
21495 \begin_inset Flex Code
21498 \begin_layout Plain Layout
21505 \begin_inset Flex Code
21508 \begin_layout Plain Layout
21514 ] Attributes for the item tag.
21516 \begin_inset Quotes eld
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21524 class=`layoutname_item'
21530 \begin_inset Quotes erd
21538 contain any style information.
21540 \begin_inset Flex Code
21543 \begin_layout Plain Layout
21552 \begin_layout Description
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21572 ] The tag to be used for paragraph and item labels, replacing
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21582 in the examples above.
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21614 \begin_inset Flex Code
21617 \begin_layout Plain Layout
21618 Centered_Top_Environment
21623 , in which case it defaults to
21624 \begin_inset Flex Code
21627 \begin_layout Plain Layout
21636 \begin_layout Description
21637 \begin_inset Flex Code
21640 \begin_layout Plain Layout
21647 \begin_inset Flex Code
21650 \begin_layout Plain Layout
21656 ] Attributes for the label tag.
21658 \begin_inset Quotes eld
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21666 class=`layoutname_label'
21672 \begin_inset Quotes erd
21680 contain any style information.
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21694 \begin_layout Description
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21718 ] Meaningful only for list-like environments, this tag controls whether
21719 the label tag is output before or inside the item tag.
21720 This is used, for example, in the description environment, where we want
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21726 <dt>\SpecialChar ldots
21727 </dt><dd>\SpecialChar ldots
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21744 : The label tag is output inside the item tag.
21747 \begin_layout Description
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21757 Information to be output in the
21758 \begin_inset Flex Code
21761 \begin_layout Plain Layout
21767 section when this style is used.
21768 This might, for example, be used to include a
21769 \begin_inset Flex Code
21772 \begin_layout Plain Layout
21779 \begin_inset Flex Code
21782 \begin_layout Plain Layout
21791 \begin_layout Description
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21801 CSS style information to be included when this style is used.
21802 Note that this will automatically be wrapped in a layout-generated
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21812 block, so only the CSS itself need be included.
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21826 \begin_layout Description
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21837 \begin_inset Flex Code
21840 \begin_layout Plain Layout
21846 ] The tag to be used for the main label, replacing
21847 \begin_inset Flex Code
21850 \begin_layout Plain Layout
21856 in the examples above.
21858 \begin_inset Flex Code
21861 \begin_layout Plain Layout
21870 \begin_layout Description
21871 \begin_inset Flex Code
21874 \begin_layout Plain Layout
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21894 ] Marks this style as the one to be used to generate the
21895 \begin_inset Flex Code
21898 \begin_layout Plain Layout
21904 tag for the XHTML file.
21905 By default, it is false.
21907 \begin_inset Flex Code
21910 \begin_layout Plain Layout
21916 file sets it to true for the
21917 \begin_inset Flex Code
21920 \begin_layout Plain Layout
21930 \begin_layout Subsection
21934 \begin_layout Standard
21935 The XHTML output of insets can also be controlled by information in layout
21940 \begin_layout Plain Layout
21941 At present, this is true only for
21942 \begin_inset Quotes eld
21946 \begin_inset Quotes erd
21949 insets (insets you can type into) and is not true for
21950 \begin_inset Quotes eld
21954 \begin_inset Quotes erd
21957 insets (insets that are associated with dialog boxes).
21962 Here, too, \SpecialChar LyX
21963 tries to provide sensible defaults, and it constructs default
21965 But everything can be customized.
21968 \begin_layout Standard
21969 The XHTML \SpecialChar LyX
21970 outputs for an inset has the following form:
21973 \begin_layout LyX-Code
21975 \begin_inset Quotes erd
21979 \begin_inset Quotes erd
21985 \begin_layout LyX-Code
21986 <labeltag>Label</labeltag>
21989 \begin_layout LyX-Code
21991 \begin_inset Quotes erd
21995 \begin_inset Quotes erd
21998 >Contents of the inset.</innertag>
22001 \begin_layout LyX-Code
22005 \begin_layout Standard
22006 If the inset permits multiple paragraphs—that is, if
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22016 is true—then the contents of the inset will itself be output as paragraphs
22017 formatted according to the styles used for those paragraphs (standard,
22018 quote, and the like).
22019 The label tag is of course omitted if the paragraph does not have a label
22020 and, at present, is always
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22031 The inner tag is optional and, by default, does not appear.
22034 \begin_layout Standard
22035 The specific tags and attributes output for each inset can be controlled
22036 by means of the following layout tags.
22039 \begin_layout Description
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22050 \begin_inset Flex Code
22053 \begin_layout Plain Layout
22059 ] Specifies attribute information to be output with the main tag.
22061 \begin_inset Quotes eld
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22069 class=`myinset' onclick=`\SpecialChar ldots
22076 \begin_inset Quotes erd
22080 By default, \SpecialChar LyX
22082 \begin_inset Quotes eld
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22096 \begin_inset Quotes erd
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22109 is the \SpecialChar LyX
22110 name of the inset, made lowercase and with non-alphanumeric characters
22111 converted to underscores, for example: footnote.
22114 \begin_layout Description
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22138 ] Whether to output the default CSS information \SpecialChar LyX
22139 generates for this layout,
22140 even if additional information is explicitly provided via
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22161 allows you to alter or augment the generated CSS, rather than to override
22166 \begin_layout Description
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22186 ] Attributes for the inner tag.
22188 \begin_inset Quotes eld
22192 \begin_inset Flex Code
22195 \begin_layout Plain Layout
22196 class=`insetname_inner'
22202 \begin_inset Quotes erd
22208 \begin_layout Description
22209 \begin_inset Flex Code
22212 \begin_layout Plain Layout
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22228 ] The inner tag, replacing
22229 \begin_inset Flex Code
22232 \begin_layout Plain Layout
22238 in the examples above.
22239 By default, there is none.
22242 \begin_layout Description
22243 \begin_inset Flex Code
22246 \begin_layout Plain Layout
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22264 ] Whether this inset represents a standalone block of text (such as a footnote)
22265 or instead represents material that is included in the surrounding text
22266 (such as a branch).
22270 \begin_layout Description
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22281 \begin_inset Flex Code
22284 \begin_layout Plain Layout
22290 ] A label for this inset, possibly including a reference to a counter.
22291 For example, for footnote, it might be:
22292 \begin_inset Flex Code
22295 \begin_layout Plain Layout
22304 This is optional, and there is no default.
22307 \begin_layout Description
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22317 Information to be output in the
22318 \begin_inset Flex Code
22321 \begin_layout Plain Layout
22327 section when this style is used.
22328 This might, for example, be used to include a
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22339 \begin_inset Flex Code
22342 \begin_layout Plain Layout
22351 \begin_layout Description
22352 \begin_inset Flex Code
22355 \begin_layout Plain Layout
22361 CSS style information to be included when this style is used.
22362 Note that this will automatically be wrapped in a layout-generated
22363 \begin_inset Flex Code
22366 \begin_layout Plain Layout
22372 block, so only the CSS itself need be included.
22375 \begin_layout Description
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22386 \begin_inset Flex Code
22389 \begin_layout Plain Layout
22395 ] The tag to be used for the main label, replacing
22396 \begin_inset Flex Code
22399 \begin_layout Plain Layout
22405 in the examples above.
22406 The default depends upon the setting of
22407 \begin_inset Flex Code
22410 \begin_layout Plain Layout
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22426 is true, the default is
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22436 ; if it is false, the default is
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22449 \begin_layout Subsection
22453 \begin_layout Standard
22454 The XHTML output for floats too can be controlled by layout information.
22455 The output has the following form:
22458 \begin_layout LyX-Code
22460 \begin_inset Quotes erd
22464 \begin_inset Quotes erd
22470 \begin_layout LyX-Code
22471 Contents of the float.
22474 \begin_layout LyX-Code
22478 \begin_layout Standard
22479 The caption, if there is one, is a separate inset and will be output as
22481 Its appearance can be controlled via the InsetLayout for caption insets.
22485 \begin_layout Description
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22505 ] Specifies attribute information to be output with the main tag.
22507 \begin_inset Quotes eld
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22515 class=`myfloat' onclick=`\SpecialChar ldots
22522 \begin_inset Quotes erd
22526 By default, \SpecialChar LyX
22528 \begin_inset Quotes eld
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22536 class=`float float-floattype'
22542 \begin_inset Quotes erd
22546 \begin_inset Flex Code
22549 \begin_layout Plain Layout
22555 is \SpecialChar LyX
22556 's name for this type of float, as determined by the float declaration
22558 \begin_inset CommandInset ref
22560 reference "subsec:Floats"
22564 ), though made lowercase and with non-alphanumeric characters converted
22565 to underscores, for example: float-table.
22568 \begin_layout Description
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22578 CSS style information to be included when this float is used.
22579 Note that this will automatically be wrapped in a layout-generated
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22589 block, so only the CSS itself need be included.
22592 \begin_layout Description
22593 \begin_inset Flex Code
22596 \begin_layout Plain Layout
22603 \begin_inset Flex Code
22606 \begin_layout Plain Layout
22612 ] The tag to be used for this float, replacing
22613 \begin_inset Quotes eld
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22627 \begin_inset Quotes erd
22630 in the example above.
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22641 and will rarely need changing.
22644 \begin_layout Subsection
22645 Bibliography formatting
22648 \begin_layout Standard
22649 The bibliography can be formatted using
22650 \begin_inset Flex Code
22653 \begin_layout Plain Layout
22661 \begin_inset CommandInset ref
22663 reference "subsec:Citation-format-description"
22670 \begin_layout Subsection
22675 \begin_layout Standard
22676 We have several times mentioned that \SpecialChar LyX
22677 will generate default CSS style rules
22678 for both insets and paragraph styles, based upon the other layout information
22680 In this section, we shall say a word about which layout information \SpecialChar LyX
22685 \begin_layout Standard
22686 At present, \SpecialChar LyX
22687 auto-generates CSS only for font information, making use of
22689 \begin_inset Flex Code
22692 \begin_layout Plain Layout
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22709 \begin_inset Flex Code
22712 \begin_layout Plain Layout
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22739 \begin_inset CommandInset ref
22741 reference "subsec:Font-description"
22746 The translation is mostly straightforward and obvious.
22748 \begin_inset Quotes eld
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 \begin_inset Quotes erd
22766 \begin_inset Quotes eld
22770 \begin_inset Flex Code
22773 \begin_layout Plain Layout
22774 font-family: sans-serif;
22780 \begin_inset Quotes erd
22784 The correspondence of \SpecialChar LyX
22785 sizes and CSS sizes is a little less obvious but
22786 nonetheless intuitive.
22788 \begin_inset Flex Code
22791 \begin_layout Plain Layout
22798 \begin_inset Flex URL
22801 \begin_layout Plain Layout
22811 \begin_layout Chapter
22812 Including External Material
22813 \begin_inset CommandInset label
22815 name "chap:Including-External-Material"
22822 \begin_layout Standard
22823 \begin_inset Box Shadowbox
22833 height_special "totalheight"
22838 backgroundcolor "none"
22841 \begin_layout Plain Layout
22842 WARNING: This portion of the documentation has not been updated for some
22844 We certainly hope that it is still accurate, but there are no guarantees.
22852 \begin_layout Standard
22853 The use of material from sources external to \SpecialChar LyX
22854 is covered in detail in the
22860 This part of the manual covers what needs to happen behind the scenes for
22861 new sorts of material to be included.
22864 \begin_layout Section
22868 \begin_layout Standard
22869 The external material feature is based on the concept of a
22874 A template is a specification of how \SpecialChar LyX
22875 should interface with a certain kind
22877 As bundled, \SpecialChar LyX
22878 comes with predefined templates for Xfig figures, various
22879 raster format images, chess diagrams, and LilyPond music notation.
22880 You can check the actual list by using the menu
22881 \begin_inset Flex Noun
22884 \begin_layout Plain Layout
22885 Insert\SpecialChar menuseparator
22886 File\SpecialChar menuseparator
22893 Furthermore, it is possible to roll your own template to support a specific
22895 Later we'll describe in more detail what is involved, and hopefully you
22896 will submit all the templates you create so we can include them in a later
22901 \begin_layout Standard
22902 Another basic idea of the external material feature is to distinguish between
22903 the original file that serves as a base for final material and the produced
22904 file that is included in your exported or printed document.
22905 For example, consider the case of a figure produced with
22906 \begin_inset Flex Code
22909 \begin_layout Plain Layout
22916 The Xfig application itself works on an original file with the
22917 \begin_inset Flex Code
22920 \begin_layout Plain Layout
22927 Within Xfig, you create and change your figure, and when you are done,
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22939 When you want to include the figure in your document, you invoke
22940 \begin_inset Flex Code
22943 \begin_layout Plain Layout
22949 in order to create a PostScript file that can readily be included in your
22953 \begin_inset Flex Code
22956 \begin_layout Plain Layout
22962 file is the original file, and the PostScript file is the produced file.
22965 \begin_layout Standard
22966 This distinction is important in order to allow updating of the material
22967 while you are in the process of writing the document.
22968 Furthermore, it provides us with the flexibility that is needed to support
22969 multiple export formats.
22970 For instance, in the case of a plain text file, it is not exactly an award-winn
22971 ing idea to include the figure as raw PostScript.
22972 Instead, you would either prefer to just include a reference to the figure
22973 or try to invoke some graphics to ASCII converter to make the final result
22974 look similar to the real graphics.
22975 The external material management allows you to do this, because it is parametri
22976 zed on the different export formats that \SpecialChar LyX
22980 \begin_layout Standard
22981 Besides supporting the production of different products according to the
22982 exported format, it supports tight integration with editing and viewing
22984 In the case of an Xfig figure, you are able to invoke Xfig on the original
22985 file with a single click from within the external material dialog in \SpecialChar LyX
22987 and also preview the produced PostScript file with Ghostview with another
22989 No more fiddling around with the command line and/or file browsers to locate
22990 and manipulate the original or produced files.
22991 In this way, you are finally able to take full advantage of the many different
22992 applications that are relevant to use when you write your documents, and
22993 ultimately be more productive.
22996 \begin_layout Section
22997 The external template configuration file
23000 \begin_layout Standard
23001 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23003 However, be aware that doing this in an careless manner most probably
23007 introduce an easily exploitable security hole.
23008 So before you do this, please read the discussion about security in
23009 \begin_inset CommandInset ref
23011 reference "sec:Security-discussion"
23018 \begin_layout Standard
23019 Having said that, we encourage you to submit any interesting templates that
23024 \begin_layout Standard
23025 The external templates are defined in the
23026 \begin_inset Flex Code
23029 \begin_layout Plain Layout
23030 LyXDir/lib/external_templates
23036 You can place your own version in
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23041 UserDir/external_templates
23049 \begin_layout Standard
23050 A typical template looks like this:
23053 \begin_layout LyX-Code
23057 \begin_layout LyX-Code
23058 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23061 \begin_layout LyX-Code
23065 \begin_layout LyX-Code
23069 \begin_layout LyX-Code
23073 \begin_layout LyX-Code
23077 \begin_layout LyX-Code
23081 \begin_layout LyX-Code
23082 AutomaticProduction true
23085 \begin_layout LyX-Code
23089 \begin_layout LyX-Code
23093 \begin_layout LyX-Code
23097 \begin_layout LyX-Code
23098 TransformCommand Rotate RotationLatexCommand
23101 \begin_layout LyX-Code
23102 TransformCommand Resize ResizeLatexCommand
23105 \begin_layout LyX-Code
23106 Product "$$RotateFront$$ResizeFront
23109 \begin_layout LyX-Code
23114 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23117 \begin_layout LyX-Code
23118 $$ResizeBack$$RotateBack"
23121 \begin_layout LyX-Code
23125 \begin_layout LyX-Code
23126 UpdateResult "$$AbsPath$$Basename.pstex_t"
23129 \begin_layout LyX-Code
23130 Requirement "graphicx"
23133 \begin_layout LyX-Code
23134 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23137 \begin_layout LyX-Code
23138 ReferencedFile latex "$$AbsPath$$Basename.eps"
23141 \begin_layout LyX-Code
23142 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23145 \begin_layout LyX-Code
23149 \begin_layout LyX-Code
23153 \begin_layout LyX-Code
23154 TransformCommand Rotate RotationLatexCommand
23157 \begin_layout LyX-Code
23158 TransformCommand Resize ResizeLatexCommand
23161 \begin_layout LyX-Code
23162 Product "$$RotateFront$$ResizeFront
23165 \begin_layout LyX-Code
23170 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23173 \begin_layout LyX-Code
23174 $$ResizeBack$$RotateBack"
23177 \begin_layout LyX-Code
23178 UpdateFormat pdftex
23181 \begin_layout LyX-Code
23182 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23185 \begin_layout LyX-Code
23186 Requirement "graphicx"
23189 \begin_layout LyX-Code
23190 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23193 \begin_layout LyX-Code
23194 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23197 \begin_layout LyX-Code
23201 \begin_layout LyX-Code
23205 \begin_layout LyX-Code
23206 Product "[XFig: $$FName]"
23209 \begin_layout LyX-Code
23213 \begin_layout LyX-Code
23217 \begin_layout LyX-Code
23218 Product "<graphic fileref=
23220 "$$AbsOrRelPathMaster$$Basename.eps
23225 \begin_layout LyX-Code
23229 \begin_layout LyX-Code
23233 \begin_layout LyX-Code
23234 UpdateResult "$$AbsPath$$Basename.eps"
23237 \begin_layout LyX-Code
23238 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23241 \begin_layout LyX-Code
23242 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23245 \begin_layout LyX-Code
23249 \begin_layout LyX-Code
23253 \begin_layout Standard
23254 As you can see, the template is enclosed in
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23276 It contains a header specifying some general settings and, for each supported
23277 primary document file format, a section
23278 \begin_inset Flex Code
23281 \begin_layout Plain Layout
23289 \begin_inset Flex Code
23292 \begin_layout Plain Layout
23301 \begin_layout Subsection
23302 The template header
23305 \begin_layout Description
23306 \begin_inset Flex Code
23309 \begin_layout Plain Layout
23310 AutomaticProduction
23311 \begin_inset space ~
23319 Whether the file represented by the template must be generated by \SpecialChar LyX
23321 This command must occur exactly once.
23324 \begin_layout Description
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23330 \begin_inset space ~
23338 A glob pattern that is used in the file dialog to filter out the desired
23340 If there is more than one possible file extension (e.
23341 \begin_inset space \thinspace{}
23345 \begin_inset space \space{}
23349 \begin_inset Flex Code
23352 \begin_layout Plain Layout
23359 \begin_inset Flex Code
23362 \begin_layout Plain Layout
23368 ), use something like
23369 \begin_inset Flex Code
23372 \begin_layout Plain Layout
23379 This command must occur exactly once.
23382 \begin_layout Description
23383 \begin_inset Flex Code
23386 \begin_layout Plain Layout
23388 \begin_inset space ~
23396 The text that is displayed on the button.
23397 This command must occur exactly once.
23400 \begin_layout Description
23401 \begin_inset Flex Code
23404 \begin_layout Plain Layout
23406 \begin_inset space ~
23410 \begin_inset space ~
23418 The help text that is used in the External dialog.
23419 Provide enough information to explain to the user just what the template
23420 can provide him with.
23421 This command must occur exactly once.
23424 \begin_layout Description
23425 \begin_inset Flex Code
23428 \begin_layout Plain Layout
23430 \begin_inset space ~
23438 The file format of the original file.
23439 This must be the name of a format that is known to \SpecialChar LyX
23441 \begin_inset CommandInset ref
23443 reference "sec:Formats"
23449 \begin_inset Quotes eld
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23463 \begin_inset Quotes erd
23466 if the template can handle original files of more than one format.
23468 will attempt to interrogate the file itself in order to deduce its format
23470 This command must occur exactly once.
23473 \begin_layout Description
23474 \begin_inset Flex Code
23477 \begin_layout Plain Layout
23479 \begin_inset space ~
23487 A unique name for the template.
23488 It must not contain substitution macros (see below).
23491 \begin_layout Description
23492 \begin_inset Flex Code
23495 \begin_layout Plain Layout
23497 \begin_inset space ~
23500 Rotate|Resize|Clip|Extra
23505 This command specifies which transformations are supported by this template.
23506 It may occur zero or more times.
23507 This command enables the corresponding tabs in the external dialog.
23509 \begin_inset Flex Code
23512 \begin_layout Plain Layout
23518 command must have either a corresponding
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23529 \begin_inset Flex Code
23532 \begin_layout Plain Layout
23539 \begin_inset Flex Code
23542 \begin_layout Plain Layout
23549 Otherwise the transformation will not be supported by that format.
23552 \begin_layout Subsection
23556 \begin_layout Description
23557 \begin_inset Flex Code
23560 \begin_layout Plain Layout
23562 \begin_inset space ~
23565 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
23570 The primary document file format that this format definition is for.
23571 Not every template has a sensible representation in all document file formats.
23572 Please define nevertheless a
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23582 section for all templates.
23583 Use a dummy text when no representation is available.
23584 Then you can at least see a reference to the external material in the exported
23588 \begin_layout Description
23589 \begin_inset Flex Code
23592 \begin_layout Plain Layout
23594 \begin_inset space ~
23598 \begin_inset space ~
23606 This command defines an additional macro
23607 \begin_inset Flex Code
23610 \begin_layout Plain Layout
23616 for substitution in
23617 \begin_inset Flex Code
23620 \begin_layout Plain Layout
23628 \begin_inset Flex Code
23631 \begin_layout Plain Layout
23637 itself may contain substitution macros.
23638 The advantage over using
23639 \begin_inset Flex Code
23642 \begin_layout Plain Layout
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23658 is that the substituted value of
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23668 is sanitized so that it is a valid optional argument in the document format.
23669 This command may occur zero or more times.
23672 \begin_layout Description
23673 \begin_inset Flex Code
23676 \begin_layout Plain Layout
23678 \begin_inset space ~
23686 The text that is inserted in the exported document.
23687 This is actually the most important command and can be quite complex.
23688 This command must occur exactly once.
23691 \begin_layout Description
23692 \begin_inset Flex Code
23695 \begin_layout Plain Layout
23697 \begin_inset space ~
23705 This command specifies a preamble snippet that will be included in the
23708 It has to be defined using
23709 \begin_inset Flex Code
23712 \begin_layout Plain Layout
23720 \begin_inset Flex Code
23723 \begin_layout Plain Layout
23730 This command may occur zero or more times.
23733 \begin_layout Description
23734 \begin_inset Flex Code
23737 \begin_layout Plain Layout
23739 \begin_inset space ~
23743 \begin_inset space ~
23751 This command denotes files that are created by the conversion process and
23752 are needed for a particular export format.
23753 If the filename is relative, it is interpreted relative to the master document.
23754 This command may be given zero or more times.
23757 \begin_layout Description
23758 \begin_inset Flex Code
23761 \begin_layout Plain Layout
23763 \begin_inset space ~
23771 The name of a required \SpecialChar LaTeX
23773 The package is included via
23774 \begin_inset Flex Code
23777 \begin_layout Plain Layout
23785 in the \SpecialChar LaTeX
23787 This command may occur zero or more times.
23790 \begin_layout Description
23791 \begin_inset Flex Code
23794 \begin_layout Plain Layout
23796 \begin_inset space ~
23800 \begin_inset space ~
23803 RotationLatexCommand
23808 This command specifies that the built in \SpecialChar LaTeX
23809 command should be used for rotation.
23810 This command may occur once or not at all.
23813 \begin_layout Description
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23819 \begin_inset space ~
23823 \begin_inset space ~
23831 This command specifies that the built in \SpecialChar LaTeX
23832 command should be used for resizing.
23833 This command may occur once or not at all.
23836 \begin_layout Description
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23842 \begin_inset space ~
23846 \begin_inset space ~
23849 RotationLatexOption
23854 This command specifies that rotation is done via an optional argument.
23855 This command may occur once or not at all.
23858 \begin_layout Description
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23864 \begin_inset space ~
23868 \begin_inset space ~
23876 This command specifies that resizing is done via an optional argument.
23877 This command may occur once or not at all.
23880 \begin_layout Description
23881 \begin_inset Flex Code
23884 \begin_layout Plain Layout
23886 \begin_inset space ~
23890 \begin_inset space ~
23898 This command specifies that clipping is done via an optional argument.
23899 This command may occur once or not at all.
23902 \begin_layout Description
23903 \begin_inset Flex Code
23906 \begin_layout Plain Layout
23908 \begin_inset space ~
23912 \begin_inset space ~
23920 This command specifies that an extra optional argument is used.
23921 This command may occur once or not at all.
23924 \begin_layout Description
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23930 \begin_inset space ~
23938 The file format of the converted file.
23939 This must be the name of a format that is known to \SpecialChar LyX
23941 \begin_inset Flex Noun
23944 \begin_layout Plain Layout
23945 Tools\SpecialChar menuseparator
23946 Preferences\SpecialChar menuseparator
23947 File Handling\SpecialChar menuseparator
23954 This command must occur exactly once.
23955 If the resulting file format is PDF, you need to specify the format
23956 \begin_inset Flex Code
23959 \begin_layout Plain Layout
23966 This is the PDF format used for including graphics.
23967 The other defined PDF formats are for document export.
23970 \begin_layout Description
23971 \begin_inset Flex Code
23974 \begin_layout Plain Layout
23976 \begin_inset space ~
23984 The file name of the converted file.
23985 The file name must be absolute.
23986 This command must occur exactly once.
23989 \begin_layout Subsection
23990 Preamble definitions
23993 \begin_layout Standard
23994 The external template configuration file may contain additional preamble
23995 definitions enclosed by
23996 \begin_inset Flex Code
23999 \begin_layout Plain Layout
24007 \begin_inset Flex Code
24010 \begin_layout Plain Layout
24017 They can be used by the templates in the
24018 \begin_inset Flex Code
24021 \begin_layout Plain Layout
24030 \begin_layout Section
24031 The substitution mechanism
24034 \begin_layout Standard
24035 When the external material facility invokes an external program, it is done
24036 on the basis of a command defined in the template configuration file.
24037 These commands can contain various macros that are expanded before execution.
24038 Execution always take place in the directory of the containing document.
24041 \begin_layout Standard
24042 Also, whenever external material is to be displayed, the name will be produced
24043 by the substitution mechanism, and most other commands in the template
24044 definition support substitution as well.
24047 \begin_layout Standard
24048 The available macros are the following:
24051 \begin_layout Description
24052 \begin_inset Flex Code
24055 \begin_layout Plain Layout
24056 $$AbsOrRelPathMaster
24061 The file path, absolute or relative to the master \SpecialChar LyX
24065 \begin_layout Description
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24070 $$AbsOrRelPathParent
24075 The file path, absolute or relative to the \SpecialChar LyX
24079 \begin_layout Description
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24089 The absolute file path.
24092 \begin_layout Description
24093 \begin_inset Flex Code
24096 \begin_layout Plain Layout
24102 The filename without path and without the extension.
24105 \begin_layout Description
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24111 \begin_inset Quotes eld
24115 \begin_inset Quotes erd
24123 This macro will expand to the contents of the file with the name
24124 \begin_inset Flex Code
24127 \begin_layout Plain Layout
24136 \begin_layout Description
24137 \begin_inset Flex Code
24140 \begin_layout Plain Layout
24146 The file extension (including the dot).
24149 \begin_layout Description
24150 \begin_inset Flex Code
24153 \begin_layout Plain Layout
24159 This will be the string
24160 \begin_inset Quotes eld
24164 \begin_inset Quotes erd
24167 if the file is in JPEG format, otherwise it will be the string
24168 \begin_inset Quotes eld
24172 \begin_inset Quotes erd
24176 This is useful to avoid uneeded conversions for output formats that support
24177 both PNG and JPEG fomats.
24178 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24183 \begin_layout Description
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24193 The filename of the file specified in the external material dialog.
24194 This is either an absolute name, or it is relative to the \SpecialChar LyX
24198 \begin_layout Description
24199 \begin_inset Flex Code
24202 \begin_layout Plain Layout
24209 \begin_inset Flex Code
24212 \begin_layout Plain Layout
24218 (absolute name or relative to the \SpecialChar LyX
24222 \begin_layout Description
24223 \begin_inset Flex Code
24226 \begin_layout Plain Layout
24232 The file path, relative to the master \SpecialChar LyX
24236 \begin_layout Description
24237 \begin_inset Flex Code
24240 \begin_layout Plain Layout
24246 The file path, relative to the \SpecialChar LyX
24250 \begin_layout Description
24251 \begin_inset Flex Code
24254 \begin_layout Plain Layout
24260 This macro will expand to the absolute path of the system directory.
24261 This is typically used to point to the various helper scripts that are
24262 bundled with \SpecialChar LyX
24266 \begin_layout Description
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24276 A name and full path to a temporary file which will be automatically deleted
24277 whenever the containing document is closed, or the external material insertion
24281 \begin_layout Standard
24282 All path macros contain a trailing directory separator, so you can construct
24284 \begin_inset space \thinspace{}
24288 \begin_inset space \space{}
24291 the absolute filename with
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24296 $$AbsPath$$Basename$$Extension
24304 \begin_layout Standard
24305 The macros above are substituted in all commands unless otherwise noted.
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24316 supports additionally the following substitutions if they are enabled by
24318 \begin_inset Flex Code
24321 \begin_layout Plain Layout
24328 \begin_inset Flex Code
24331 \begin_layout Plain Layout
24340 \begin_layout Description
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24350 The front part of the resize command.
24353 \begin_layout Description
24354 \begin_inset Flex Code
24357 \begin_layout Plain Layout
24363 The back part of the resize command.
24366 \begin_layout Description
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24376 The front part of the rotation command.
24379 \begin_layout Description
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24389 The back part of the rotation command.
24392 \begin_layout Standard
24393 The value string of the
24394 \begin_inset Flex Code
24397 \begin_layout Plain Layout
24403 command supports additionally the following substitutions if they are enabled
24405 \begin_inset Flex Code
24408 \begin_layout Plain Layout
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24427 \begin_layout Description
24428 \begin_inset Flex Code
24431 \begin_layout Plain Layout
24440 \begin_layout Description
24441 \begin_inset Flex Code
24444 \begin_layout Plain Layout
24453 \begin_layout Description
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24466 \begin_layout Description
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24476 The rotation option.
24479 \begin_layout Standard
24480 You may ask why there are so many path macros.
24481 There are mainly two reasons:
24484 \begin_layout Enumerate
24485 Relative and absolute file names should remain relative or absolute, respectivel
24487 Users may have reasons to prefer either form.
24488 Relative names are useful for portable documents that should work on different
24489 machines, for example.
24490 Absolute names may be required by some programs.
24493 \begin_layout Enumerate
24495 treats relative file names differently than \SpecialChar LyX
24496 and other programs in nested
24498 For \SpecialChar LyX
24499 , a relative file name is always relative to the document that contains
24501 For \SpecialChar LaTeX
24502 , it is always relative to the master document.
24503 These two definitions are identical if you have only one document, but
24504 differ if you have a master document that includes part documents.
24505 That means that relative filenames must be transformed when presented to
24508 Fortunately \SpecialChar LyX
24509 does this automatically for you if you choose the right macros.
24512 \begin_layout Standard
24513 So which path macro should be used in new template definitions? The rule
24517 \begin_layout Itemize
24519 \begin_inset Flex Code
24522 \begin_layout Plain Layout
24528 if an absolute path is required.
24531 \begin_layout Itemize
24533 \begin_inset Flex Code
24536 \begin_layout Plain Layout
24537 $$AbsOrRelPathMaster
24542 if the substituted string is some kind of \SpecialChar LaTeX
24546 \begin_layout Itemize
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24552 $$AbsOrRelPathParent
24557 in order to preserve the user's choice.
24560 \begin_layout Standard
24561 There are special cases where this rule does not work and e.
24562 \begin_inset space \thinspace{}
24566 \begin_inset space \space{}
24569 relative names are needed, but normally it will work just fine.
24570 One example for such a case is the command
24571 \begin_inset Flex Code
24574 \begin_layout Plain Layout
24575 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24580 in the XFig template above: We can't use the absolute name because the
24582 \begin_inset Flex Code
24585 \begin_layout Plain Layout
24591 files needs the relative name in order to rewrite the file content.
24594 \begin_layout Section
24595 Security discussion
24596 \begin_inset CommandInset label
24598 name "sec:Security-discussion"
24605 \begin_layout Standard
24606 The external material feature interfaces with a lot of external programs
24607 and does so automatically, so we have to consider the security implications
24609 In particular, since you have the option of including your own filenames
24610 and/or parameter strings and those are expanded into a command, it seems
24611 that it would be possible to create a malicious document which executes
24612 arbitrary commands when a user views or prints the document.
24613 This is something we definitely want to avoid.
24616 \begin_layout Standard
24617 However, since the external program commands are specified in the template
24618 configuration file only, there are no security issues if \SpecialChar LyX
24619 is properly configure
24620 d with safe templates only.
24621 This is so because the external programs are invoked with the
24622 \begin_inset Flex Code
24625 \begin_layout Plain Layout
24631 -system call rather than the
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24641 system-call, so it's not possible to execute arbitrary commands from the
24642 filename or parameter section via the shell.
24645 \begin_layout Standard
24646 This also implies that you are restricted in what command strings you can
24647 use in the external material templates.
24648 In particular, pipes and redirection are not readily available.
24649 This has to be so if \SpecialChar LyX
24650 should remain safe.
24651 If you want to use some of the shell features, you should write a safe
24652 script to do this in a controlled manner, and then invoke the script from
24653 the command string.
24657 \begin_layout Standard
24658 It is possible to design a template that interacts directly with the shell,
24659 but since this would allow a malicious user to execute arbitrary commands
24660 by writing clever filenames and/or parameters, we generally recommend that
24661 you only use safe scripts that work with the
24662 \begin_inset Flex Code
24665 \begin_layout Plain Layout
24671 system call in a controlled manner.
24672 Of course, for use in a controlled environment, it can be tempting to just
24673 fall back to use ordinary shell scripts.
24674 If you do so, be aware that you
24678 provide an easily exploitable security hole in your system.
24679 Of course it stands to reason that such unsafe templates will never be
24680 included in the standard \SpecialChar LyX
24681 distribution, although we do encourage people
24682 to submit new templates in the open source tradition.
24683 But \SpecialChar LyX
24684 as shipped from the official distribution channels will never have
24688 \begin_layout Standard
24689 Including external material provides a lot of power, and you have to be
24690 careful not to introduce security hazards with this power.
24691 A subtle error in a single line in an innocent looking script can open
24692 the door to huge security problems.
24693 So if you do not fully understand the issues, we recommend that you consult
24694 a knowledgeable security professional or the \SpecialChar LyX
24695 development team if you have
24696 any questions about whether a given template is safe or not.
24697 And do this before you use it in an uncontrolled environment.
24700 \begin_layout Chapter
24702 List of supported \SpecialChar LyX
24703 functions to be used in layouts
24704 \begin_inset CommandInset label
24706 name "chap:List-of-functions"
24713 \begin_layout Standard
24715 \begin_inset Tabular
24716 <lyxtabular version="3" rows="11" columns="8">
24717 <features tabularvalignment="middle">
24718 <column alignment="left" valignment="top">
24719 <column alignment="left" valignment="top">
24720 <column alignment="left" valignment="top">
24721 <column alignment="left" valignment="top">
24722 <column alignment="left" valignment="top">
24723 <column alignment="left" valignment="top">
24724 <column alignment="left" valignment="top">
24725 <column alignment="left" valignment="top">
24727 <cell alignment="left" valignment="top" usebox="none">
24730 \begin_layout Plain Layout
24736 <cell alignment="left" valignment="top" usebox="none">
24739 \begin_layout Plain Layout
24745 <cell alignment="left" valignment="top" usebox="none">
24748 \begin_layout Plain Layout
24754 <cell alignment="left" valignment="top" usebox="none">
24757 \begin_layout Plain Layout
24763 <cell alignment="center" valignment="top" usebox="none">
24766 \begin_layout Plain Layout
24772 <cell alignment="center" valignment="top" usebox="none">
24775 \begin_layout Plain Layout
24781 <cell alignment="center" valignment="top" usebox="none">
24784 \begin_layout Plain Layout
24790 <cell alignment="center" valignment="top" usebox="none">
24793 \begin_layout Plain Layout
24801 <cell alignment="left" valignment="top" usebox="none">
24804 \begin_layout Plain Layout
24810 <cell alignment="left" valignment="top" usebox="none">
24813 \begin_layout Plain Layout
24819 <cell alignment="left" valignment="top" usebox="none">
24822 \begin_layout Plain Layout
24828 <cell alignment="left" valignment="top" usebox="none">
24831 \begin_layout Plain Layout
24837 <cell alignment="center" valignment="top" usebox="none">
24840 \begin_layout Plain Layout
24846 <cell alignment="center" valignment="top" usebox="none">
24849 \begin_layout Plain Layout
24855 <cell alignment="center" valignment="top" usebox="none">
24858 \begin_layout Plain Layout
24864 <cell alignment="center" valignment="top" usebox="none">
24867 \begin_layout Plain Layout
24875 <cell alignment="left" valignment="top" usebox="none">
24878 \begin_layout Plain Layout
24884 <cell alignment="left" valignment="top" usebox="none">
24887 \begin_layout Plain Layout
24893 <cell alignment="left" valignment="top" usebox="none">
24896 \begin_layout Plain Layout
24902 <cell alignment="left" valignment="top" usebox="none">
24905 \begin_layout Plain Layout
24911 <cell alignment="center" valignment="top" usebox="none">
24914 \begin_layout Plain Layout
24920 <cell alignment="center" valignment="top" usebox="none">
24923 \begin_layout Plain Layout
24929 <cell alignment="center" valignment="top" usebox="none">
24932 \begin_layout Plain Layout
24938 <cell alignment="center" valignment="top" usebox="none">
24941 \begin_layout Plain Layout
24949 <cell alignment="left" valignment="top" usebox="none">
24952 \begin_layout Plain Layout
24958 <cell alignment="left" valignment="top" usebox="none">
24961 \begin_layout Plain Layout
24967 <cell alignment="left" valignment="top" usebox="none">
24970 \begin_layout Plain Layout
24976 <cell alignment="left" valignment="top" usebox="none">
24979 \begin_layout Plain Layout
24985 <cell alignment="center" valignment="top" usebox="none">
24988 \begin_layout Plain Layout
24994 <cell alignment="center" valignment="top" usebox="none">
24997 \begin_layout Plain Layout
25003 <cell alignment="center" valignment="top" usebox="none">
25006 \begin_layout Plain Layout
25012 <cell alignment="center" valignment="top" usebox="none">
25015 \begin_layout Plain Layout
25023 <cell alignment="left" valignment="top" usebox="none">
25026 \begin_layout Plain Layout
25032 <cell alignment="left" valignment="top" usebox="none">
25035 \begin_layout Plain Layout
25041 <cell alignment="left" valignment="top" usebox="none">
25044 \begin_layout Plain Layout
25050 <cell alignment="left" valignment="top" usebox="none">
25053 \begin_layout Plain Layout
25059 <cell alignment="center" valignment="top" usebox="none">
25062 \begin_layout Plain Layout
25068 <cell alignment="center" valignment="top" usebox="none">
25071 \begin_layout Plain Layout
25077 <cell alignment="center" valignment="top" usebox="none">
25080 \begin_layout Plain Layout
25086 <cell alignment="center" valignment="top" usebox="none">
25089 \begin_layout Plain Layout
25097 <cell alignment="left" valignment="top" usebox="none">
25100 \begin_layout Plain Layout
25106 <cell alignment="left" valignment="top" usebox="none">
25109 \begin_layout Plain Layout
25115 <cell alignment="left" valignment="top" usebox="none">
25118 \begin_layout Plain Layout
25124 <cell alignment="left" valignment="top" usebox="none">
25127 \begin_layout Plain Layout
25133 <cell alignment="center" valignment="top" usebox="none">
25136 \begin_layout Plain Layout
25142 <cell alignment="center" valignment="top" usebox="none">
25145 \begin_layout Plain Layout
25151 <cell alignment="center" valignment="top" usebox="none">
25154 \begin_layout Plain Layout
25160 <cell alignment="center" valignment="top" usebox="none">
25163 \begin_layout Plain Layout
25171 <cell alignment="left" valignment="top" usebox="none">
25174 \begin_layout Plain Layout
25180 <cell alignment="left" valignment="top" usebox="none">
25183 \begin_layout Plain Layout
25189 <cell alignment="left" valignment="top" usebox="none">
25192 \begin_layout Plain Layout
25198 <cell alignment="left" valignment="top" usebox="none">
25201 \begin_layout Plain Layout
25207 <cell alignment="center" valignment="top" usebox="none">
25210 \begin_layout Plain Layout
25216 <cell alignment="center" valignment="top" usebox="none">
25219 \begin_layout Plain Layout
25225 <cell alignment="center" valignment="top" usebox="none">
25228 \begin_layout Plain Layout
25234 <cell alignment="center" valignment="top" usebox="none">
25237 \begin_layout Plain Layout
25245 <cell alignment="left" valignment="top" usebox="none">
25248 \begin_layout Plain Layout
25254 <cell alignment="left" valignment="top" usebox="none">
25257 \begin_layout Plain Layout
25263 <cell alignment="left" valignment="top" usebox="none">
25266 \begin_layout Plain Layout
25272 <cell alignment="left" valignment="top" usebox="none">
25275 \begin_layout Plain Layout
25281 <cell alignment="center" valignment="top" usebox="none">
25284 \begin_layout Plain Layout
25290 <cell alignment="center" valignment="top" usebox="none">
25293 \begin_layout Plain Layout
25299 <cell alignment="center" valignment="top" usebox="none">
25302 \begin_layout Plain Layout
25308 <cell alignment="center" valignment="top" usebox="none">
25311 \begin_layout Plain Layout
25319 <cell alignment="left" valignment="top" usebox="none">
25322 \begin_layout Plain Layout
25328 <cell alignment="left" valignment="top" usebox="none">
25331 \begin_layout Plain Layout
25337 <cell alignment="left" valignment="top" usebox="none">
25340 \begin_layout Plain Layout
25346 <cell alignment="left" valignment="top" usebox="none">
25349 \begin_layout Plain Layout
25355 <cell alignment="center" valignment="top" usebox="none">
25358 \begin_layout Plain Layout
25364 <cell alignment="center" valignment="top" usebox="none">
25367 \begin_layout Plain Layout
25373 <cell alignment="center" valignment="top" usebox="none">
25376 \begin_layout Plain Layout
25382 <cell alignment="center" valignment="top" usebox="none">
25385 \begin_layout Plain Layout
25393 <cell alignment="left" valignment="top" usebox="none">
25396 \begin_layout Plain Layout
25402 <cell alignment="left" valignment="top" usebox="none">
25405 \begin_layout Plain Layout
25411 <cell alignment="left" valignment="top" usebox="none">
25414 \begin_layout Plain Layout
25420 <cell alignment="left" valignment="top" usebox="none">
25423 \begin_layout Plain Layout
25429 <cell alignment="center" valignment="top" usebox="none">
25432 \begin_layout Plain Layout
25438 <cell alignment="center" valignment="top" usebox="none">
25441 \begin_layout Plain Layout
25447 <cell alignment="center" valignment="top" usebox="none">
25450 \begin_layout Plain Layout
25456 <cell alignment="center" valignment="top" usebox="none">
25459 \begin_layout Plain Layout
25467 <cell alignment="center" valignment="top" usebox="none">
25470 \begin_layout Plain Layout
25476 <cell alignment="center" valignment="top" usebox="none">
25479 \begin_layout Plain Layout
25485 <cell alignment="center" valignment="top" usebox="none">
25488 \begin_layout Plain Layout
25494 <cell alignment="center" valignment="top" usebox="none">
25497 \begin_layout Plain Layout
25503 <cell alignment="center" valignment="top" usebox="none">
25506 \begin_layout Plain Layout
25512 <cell alignment="center" valignment="top" usebox="none">
25515 \begin_layout Plain Layout
25521 <cell alignment="center" valignment="top" usebox="none">
25524 \begin_layout Plain Layout
25530 <cell alignment="center" valignment="top" usebox="none">
25533 \begin_layout Plain Layout
25547 \begin_layout Chapter
25548 Names of available colors to be used in layouts
25549 \begin_inset CommandInset label
25551 name "chap:Names-of-colors"
25558 \begin_layout Standard
25559 The colors listed here are the standard colors and the those that you can
25560 adjust in the \SpecialChar LyX
25564 \begin_layout Description
25577 No particular color – clear or default
25580 \begin_layout Description
25584 \begin_layout Description
25588 \begin_layout Description
25592 \begin_layout Description
25596 \begin_layout Description
25600 \begin_layout Description
25604 \begin_layout Description
25608 \begin_layout Description
25612 \begin_layout Description
25613 added_space Added space marker color
25616 \begin_layout Description
25617 addedtext Added text color
25620 \begin_layout Description
25621 appendix Appendix marker color
25624 \begin_layout Description
25625 background Background color
25628 \begin_layout Description
25629 bottomarea Bottom area color
25632 \begin_layout Description
25633 branchlabel Label color for branches
25636 \begin_layout Description
25637 buttonbg Color used for button background
25640 \begin_layout Description
25641 buttonhoverbg Color used for button background under focus
25644 \begin_layout Description
25645 buttonframe Color for inset button frames
25648 \begin_layout Description
25649 changebar Changebar color
25652 \begin_layout Description
25653 changedtextauthor1 Changed text color author 1
25656 \begin_layout Description
25657 changedtextauthor2 Changed text color author 2
25660 \begin_layout Description
25661 changedtextauthor3 Changed text color author 3
25664 \begin_layout Description
25665 changedtextauthor4 Changed text color author 4
25668 \begin_layout Description
25669 changedtextauthor5 Changed text color author 5
25672 \begin_layout Description
25673 collapsable_inset_frame Collapsable insets framecolor
25676 \begin_layout Description
25677 collapsable_inset_text Collapsable insets text color
25680 \begin_layout Description
25681 command Text color for command insets
25684 \begin_layout Description
25685 commandbg Background color for command insets
25688 \begin_layout Description
25689 commandframe Frame color for command insets
25692 \begin_layout Description
25693 comment color for comments
25696 \begin_layout Description
25697 commentbg Background color of comments
25700 \begin_layout Description
25701 cursor Cursor color
25704 \begin_layout Description
25705 deletedtext Deleted text color
25708 \begin_layout Description
25709 deletedtextmodifier Deleted text modifying color
25712 \begin_layout Description
25713 depthbar Color for the depth bars in the margin
25716 \begin_layout Description
25717 eolmarker End of line marker color
25720 \begin_layout Description
25721 error Color of the \SpecialChar LaTeX
25725 \begin_layout Description
25726 footlabel Label color for footnotes
25729 \begin_layout Description
25730 graphicsbg Graphics inset background color
25733 \begin_layout Description
25734 greyedout Label color for greyedout insets
25737 \begin_layout Description
25738 greyedoutbg Background color of greyedout inset
25741 \begin_layout Description
25742 greyedouttext Color for greyedout inset text
25745 \begin_layout Description
25746 indexlabel Label color for index insets
25749 \begin_layout Description
25750 ignore The color is ignored
25753 \begin_layout Description
25754 inherit The color is inherited
25757 \begin_layout Description
25758 inlinecompletion Inline completion color
25761 \begin_layout Description
25762 insetbg Inset marker background color
25765 \begin_layout Description
25766 insetframe Inset marker frame color
25769 \begin_layout Description
25770 language Color for marking foreign language words
25773 \begin_layout Description
25774 latex Text color in \SpecialChar LaTeX
25778 \begin_layout Description
25779 listingsbg Background color of listings inset
25782 \begin_layout Description
25783 marginlabel Label color for margin notes
25786 \begin_layout Description
25787 math Math inset text color
25790 \begin_layout Description
25791 mathbg Math inset background color
25794 \begin_layout Description
25795 mathcorners Math inset frame color not under focus
25798 \begin_layout Description
25799 mathframe Math inset frame color under focus
25802 \begin_layout Description
25803 mathline Math line color
25806 \begin_layout Description
25807 mathmacrobg Macro math inset background color
25810 \begin_layout Description
25811 mathmacroblend Macro math blended color
25814 \begin_layout Description
25815 mathmacroframe Macro math frame color
25818 \begin_layout Description
25819 mathmacrohoverbg Macro math inset background color hovered
25822 \begin_layout Description
25823 mathmacrolabel Macro math label color
25826 \begin_layout Description
25827 mathmacronewarg Macro template color for new parameters
25830 \begin_layout Description
25831 mathmacrooldarg Macro template color for old parameters
25834 \begin_layout Description
25835 newpage New page color
25838 \begin_layout Description
25839 nonunique_inlinecompletion Inline completion color for the non-unique part
25842 \begin_layout Description
25843 notebg Background color of notes
25846 \begin_layout Description
25847 notelabel Label color for notes
25850 \begin_layout Description
25851 pagebreak Page break/line break color
25854 \begin_layout Description
25855 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25858 \begin_layout Description
25859 phantomtext Text color for phantom insets
25862 \begin_layout Description
25863 preview The color used for previews
25866 \begin_layout Description
25867 previewframe Preview frame color
25870 \begin_layout Description
25871 regexpframe Color for regexp frame
25874 \begin_layout Description
25875 selection Background color of selected text
25878 \begin_layout Description
25879 selectiontext Foreground color of selected text
25882 \begin_layout Description
25883 shadedbg Background color of shaded box
25886 \begin_layout Description
25887 special Special chars text color
25890 \begin_layout Description
25891 tabularline Table line color
25894 \begin_layout Description
25895 tabularonoffline Table line color
25898 \begin_layout Description
25899 urllabel Label color for URL insets
25902 \begin_layout Description
25903 urltext Color for URL inset text